Analytics Admin Service

The Analytics Admin service allows you to use the Google Analytics Admin API v1 in Apps Script. The Google Analytics Admin API allows for programmatic access to the Google Analytics 4 (GA4) configuration data and is only compatible with GA4 properties.

Note: This is an advanced service that must be enabled before use.

Reference

For detailed information on this service, see the Google Analytics Admin API v1.

Like all advanced services in Apps Script, the AnalyticsAdmin 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 Admin API v1 support page.

Sample code

Run a report

The sample lists all the Google Analytics accounts available to a user by calling the accounts.list() method.

advanced/analyticsAdmin.gs

View on GitHub

/**
 * Logs the Google Analytics accounts accessible by the current user.
 */
function listAccounts() {
  try {
    accounts = AnalyticsAdmin.Accounts.list();
    if (!accounts.items || !accounts.items.length) {
      console.log('No accounts found.');
      return;
    }

    for (let i = 0; i < accounts.items.length; i++) {
      const account = accounts.items[i];
      console.log('Account: name "%s", displayName "%s".', account.name, account.displayName);
    }
  } catch (e) {
    // TODO (Developer) - Handle exception
    console.log('Failed with error: %s', e.error);
  }
}