Analytics Data Service

The Analytics Data service allows you to use the Google Analytics Data API v1 in Apps Script. This API gives Google Analytics users programmatic access to Google Analytics 4 (GA4) report data.

Reference

For detailed information on this service, see the Google Analytics Data API v1 reference documentation.

Like all advanced services in Apps Script, the AnalyticsData service uses the same objects, methods, and parameters as the public API. For more information, see How method signatures are determined.

To report issues and find other support, see the Google Analytics Data API v1 support page.

Sample code

Run a report

The sample runs a report to retrieve the active users count by city and stores the results in a new spreadsheet.

advanced/analyticsData.gs
/**
 * Runs a report of a Google Analytics 4 property ID. Creates a sheet with the
 * report.
 */
function runReport() {
  /**
   * TODO(developer): Uncomment this variable and replace with your
   *   Google Analytics 4 property ID before running the sample.
   */
  const propertyId = 'YOUR-GA4-PROPERTY-ID';

  var metric = AnalyticsData.newMetric();
  metric.name = 'activeUsers';

  var dimension = AnalyticsData.newDimension();
  dimension.name = 'city';

  var dateRange = AnalyticsData.newDateRange();
  dateRange.startDate = '2020-03-31';
  dateRange.endDate = 'today';

  var request = AnalyticsData.newRunReportRequest();
  request.dimensions = [ dimension ];
  request.metrics = [ metric ];
  request.dateRanges = dateRange;

  var report = AnalyticsData.Properties.runReport(request,
                                                  'properties/' + propertyId);
  if (report.rows) {
    var spreadsheet = SpreadsheetApp.create('Google Analytics Report');
    var sheet = spreadsheet.getActiveSheet();

    // Append the headers.
    var dimensionHeaders = report.dimensionHeaders.map(
      function(dimensionHeader) {
        return dimensionHeader.name;
    });
    var metricHeaders = report.metricHeaders.map(
      function(metricHeader) {
        return metricHeader.name;
    });
    var headers = [ ...dimensionHeaders, ...metricHeaders];

    sheet.appendRow(headers);

    // Append the results.
    var rows = report.rows.map( function(row) {
      var dimensionValues = row.dimensionValues.map(
        function(dimensionValue) {
          return dimensionValue.value;
      });
      var metricValues = row.metricValues.map(
        function(metricValues) {
          return metricValues.value;
      });
      return [ ...dimensionValues, ...metricValues];
    });

    sheet.getRange(2, 1, report.rows.length, headers.length)
        .setValues(rows);

    Logger.log('Report spreadsheet created: %s',
        spreadsheet.getUrl());
  } else {
    Logger.log('No rows returned.');
  }
}