Add runRealtimeReport sample for minute ranges

Author: jradcliff

google-analytics-data/runRealtimeReportWithMinuteRanges.js

@@ -0,0 +1,98 @@
+// 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.
+
+'use strict';
+
+/** Google Analytics Data API sample application demonstrating the creation of
+a realtime report using minute ranges.
+
+See https://developers.google.com/analytics/devguides/reporting/data/v1/rest/v1beta/properties/runReport#body.request_body.FIELDS.minute_ranges
+for more information.
+
+ Before you start the application, please review the comments starting with
+ "TODO(developer)" and update the code to use correct values.
+
+ Usage:
+ npm install
+ node runRealtimeReportWithMinuteRanges.js
+ */
+
+function main(propertyId = 'YOUR-GA4-PROPERTY-ID') {
+  // [START analyticsdata_run_realtime_report_with_minute_ranges]
+
+  // TODO(developer): Uncomment this variable and replace with your
+  // Google Analytics 4 property ID before running the sample.
+  // propertyId = 'YOUR-GA4-PROPERTY-ID';
+
+  // Imports the Google Analytics Data API client library.
+  const {BetaAnalyticsDataClient} = require('@google-analytics/data');
+
+  // Initialize client that will be used to send requests. This client only
+  // needs to be created once, and can be reused for multiple requests.
+  const analyticsDataClient = new BetaAnalyticsDataClient();
+
+  // Runs a report using two date ranges.
+  async function runRealtimeReportWithMinuteRanges() {
+    const [response] = await analyticsDataClient.runRealtimeReport({
+      property: `properties/${propertyId}`,
+      minuteRanges: [
+        {
+          name: '0-4 minutes ago',
+          start_minutes_ago: 4,
+          end_minutes_ago: 0,
+        },
+        {
+          name: '25-29 minutes ago',
+          start_minutes_ago: 29,
+          end_minutes_ago: 25,
+        },
+      ],
+      metrics: [
+        {
+          name: 'activeUsers',
+        },
+      ],
+    });
+    printRunReportResponse(response);
+  }
+
+  runRealtimeReportWithMinuteRanges();
+
+  // Prints results of a runReport call.
+  function printRunReportResponse(response) {
+    console.log(`${response.rowCount} rows received`);
+    response.dimensionHeaders.forEach(dimensionHeader => {
+      console.log(`Dimension header name: ${dimensionHeader.name}`);
+    });
+    response.metricHeaders.forEach(metricHeader => {
+      console.log(
+        `Metric header name: ${metricHeader.name} (${metricHeader.type})`
+      );
+    });
+
+    console.log('Report result:');
+    response.rows.forEach(row => {
+      console.log(
+        `${row.dimensionValues[0].value}, ${row.metricValues[0].value}`
+      );
+    });
+  }
+  // [END analyticsdata_run_realtime_report_with_minute_ranges]
+}
+
+process.on('unhandledRejection', err => {
+  console.error(err.message);
+  process.exitCode = 1;
+});
+main(...process.argv.slice(2));

google-analytics-data/test/runRealtimeReportWithMinuteRanges.test.js

@@ -0,0 +1,34 @@
+//
+// 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
+//
+//     https://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.
+//
+// ** This file is automatically generated by gapic-generator-typescript. **
+// ** https://github.com/googleapis/gapic-generator-typescript **
+// ** All changes to this file may be overwritten. **
+
+'use strict';
+
+const cp = require('child_process');
+const {assert} = require('chai');
+const {describe, it} = require('mocha');
+
+const execSync = cmd => cp.execSync(cmd, {encoding: 'utf-8'});
+
+const GA4_PROPERTY_ID = process.env.GA_TEST_PROPERTY_ID || '222596558';
+
+describe('Realtime report with minute ranges', () => {
+  it('should run realtime', async () => {
+    // eslint-disable-next-line no-unused-vars
+    const stdout = execSync(`node ./runRealtimeReportWithMinuteRanges.js ${GA4_PROPERTY_ID}`);
+    assert.match(stdout, /Report result/);
+  });
+});