feat: [AnalyticsData] add sample for run_report with aggregations (GoogleCloudPlatform#1707)

Author: anweshan

analyticsdata/src/run_report.php

@@ -32,6 +32,9 @@
 use Google\Analytics\Data\V1beta\MetricType;
 use Google\Analytics\Data\V1beta\RunReportResponse;
 
+/**
+* @param string $propertyID Your GA-4 Property ID
+*/
 function run_report(string $propertyId)
 {
     // [START analyticsdata_initialize]
@@ -63,7 +66,10 @@ function run_report(string $propertyId)
     printRunReportResponse($response);
 }
 
-// Print results of a runReport call.
+/**
+ * Print results of a runReport call.
+ * @param RunReportResponse $response
+ */
 function printRunReportResponse(RunReportResponse $response)
 {
     // [START analyticsdata_print_run_report_response_header]

analyticsdata/src/run_report_with_aggregations.php

@@ -0,0 +1,108 @@
+<?php
+/**
+ * Copyright 2022 Google LLC.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+* Google Analytics Data API sample application demonstrating the usage of
+* metric aggregations in a report.
+* See https://developers.google.com/analytics/devguides/reporting/data/v1/rest/v1beta/properties/runReport#body.request_body.FIELDS.metric_aggregations
+* for more information.
+* Usage:
+*   composer update
+*   php run_report_with_aggregations.php YOUR-GA4-PROPERTY-ID
+*/
+
+namespace Google\Cloud\Samples\Analytics\Data;
+
+// [START analyticsdata_run_report_with_aggregations]
+use Google\Analytics\Data\V1beta\BetaAnalyticsDataClient;
+use Google\Analytics\Data\V1beta\DateRange;
+use Google\Analytics\Data\V1beta\Dimension;
+use Google\Analytics\Data\V1beta\Metric;
+use Google\Analytics\Data\V1beta\MetricType;
+use Google\Analytics\Data\V1beta\MetricAggregation;
+use Google\Analytics\Data\V1beta\RunReportResponse;
+
+/**
+* @param string $propertyID Your GA-4 Property ID
+* Runs a report which includes total, maximum and minimum values
+* for each metric.
+*/
+function run_report_with_aggregations(string $propertyId)
+{
+    // [START analyticsdata_initialize]
+    // Imports the Google Analytics Data API client library.
+    $client = new BetaAnalyticsDataClient();
+    // [END analyticsdata_initialize]
+
+    // Make an API call.
+    $response = $client->runReport([
+        'property' => 'properties/' . $propertyId,
+        'dimensions' => [new Dimension(['name' => 'country'])],
+        'metrics' => [new Metric(['name' => 'sessions'])],
+        'dateRanges' => [
+            new DateRange([
+                'start_date' => '365daysAgo',
+                'end_date' => 'today',
+            ]),
+        ],
+        'metricAggregations' => [
+            MetricAggregation::TOTAL,
+            MetricAggregation::MAXIMUM,
+            MetricAggregation::MINIMUM
+        ]
+    ]);
+
+    printRunReportResponseWithAggregations($response);
+}
+
+/**
+ * Print results of a runReport call.
+ * @param RunReportResponse $response
+ */
+function printRunReportResponseWithAggregations($response)
+{
+    // [START analyticsdata_print_run_report_response_header]
+    printf('%s rows received%s', $response->getRowCount(), PHP_EOL);
+    foreach ($response->getDimensionHeaders() as $dimensionHeader) {
+        printf('Dimension header name: %s%s', $dimensionHeader->getName(), PHP_EOL);
+    }
+    foreach ($response->getMetricHeaders() as $metricHeader) {
+        printf(
+            'Metric header name: %s (%s)' . PHP_EOL,
+            $metricHeader->getName(),
+            MetricType::name($metricHeader->getType())
+        );
+    }
+    // [END analyticsdata_print_run_report_response_header]
+
+    // [START analyticsdata_print_run_report_response_rows]
+    print 'Report result: ' . PHP_EOL;
+
+    foreach ($response->getRows() as $row) {
+        printf(
+            '%s %s' . PHP_EOL,
+            $row->getDimensionValues()[0]->getValue(),
+            $row->getMetricValues()[0]->getValue()
+        );
+    }
+    // [END analyticsdata_print_run_report_response_rows]
+}
+// [END analyticsdata_run_report_with_aggregations]
+
+// The following 2 lines are only needed to run the samples
+require_once __DIR__ . '/../../testing/sample_helpers.php';
+return \Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);

analyticsdata/test/analyticsDataTest.php

@@ -50,4 +50,12 @@ public function testClientFromJsonCredentials()
             $this->assertStringContainsString('does-not-exist.json', $ex->getMessage());
         }
     }
+
+    public function testRunReportWithAggregations()
+    {
+        $propertyId = self::requireEnv('GA_TEST_PROPERTY_ID');
+        $output = $this->runFunctionSnippet('run_report_with_aggregations', [$propertyId]);
+
+        $this->assertRegExp('/Report result/', $output);
+    }
 }