@maxim_mazurok/gapi.client.analyticsreporting-v4 v0.0.20240123

TypeScript typings for Analytics Reporting API v4

Accesses Analytics report data. For detailed description please check documentation.

Installing

Install typings for Analytics Reporting API:

npm install @types/gapi.client.analyticsreporting-v4 --save-dev

Usage

You need to initialize Google API client in your code:

gapi.load('client', () => {
  // now we can use gapi.client
  // ...
});

Then load api client wrapper:

gapi.client.load(
  'https://analyticsreporting.googleapis.com/$discovery/rest?version=v4',
  () => {
    // now we can use:
    // gapi.client.analyticsreporting
  }
);

// Deprecated, use discovery document URL, see https://github.com/google/google-api-javascript-client/blob/master/docs/reference.md#----gapiclientloadname----version----callback--
gapi.client.load('analyticsreporting', 'v4', () => {
  // now we can use:
  // gapi.client.analyticsreporting
});

Don't forget to authenticate your client before sending any request to resources:

// declare client_id registered in Google Developers Console
var client_id = '',
  scope = [
    // View and manage your Google Analytics data
    'https://www.googleapis.com/auth/analytics',

    // See and download your Google Analytics data
    'https://www.googleapis.com/auth/analytics.readonly',
  ],
  immediate = true;
// ...

gapi.auth.authorize(
  {client_id: client_id, scope: scope, immediate: immediate},
  authResult => {
    if (authResult && !authResult.error) {
      /* handle successful authorization */
    } else {
      /* handle authorization error */
    }
  }
);

After that you can use Analytics Reporting API resources:

/*
Returns the Analytics data.
*/
await gapi.client.analyticsreporting.reports.batchGet({});

/*
Returns User Activity data.
*/
await gapi.client.analyticsreporting.userActivity.search({});