Google Analytics Data: Node.js Client

Data client for Node.js

A comprehensive list of changes in each version may be found in the CHANGELOG .

Read more about the client libraries for Cloud APIs, including the older Google APIs Client Libraries, in Client Libraries Explained .

Table of contents:

Quickstart
Samples
Versioning
Contributing
License

Quickstart

Before you begin

Select or create a Cloud Platform project .
Enable the Google Analytics Data API .
Set up authentication so you can access the API from your local workstation.

Installing the client library

 npm install @google-analytics/data

Using the client library

 /**
 * 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 
');

// Using a default constructor instructs the client to use the credentials
// specified in GOOGLE_APPLICATION_CREDENTIALS environment variable.
const analyticsDataClient = new BetaAnalyticsDataClient 
();

// Runs a simple report.
async function runReport() {
  const [response] = await analyticsDataClient.runReport({
    property: `properties/${propertyId}`,
    dateRanges: [
      {
        startDate: '2020-03-31',
        endDate: 'today',
      },
    ],
    dimensions: [
      {
        name: 'city',
      },
    ],
    metrics: [
      {
        name: 'activeUsers',
      },
    ],
  });

  console.log('Report result:');
  response.rows.forEach(row => {
    console.log(row.dimensionValues[0], row.metricValues[0]);
  });
}

runReport();

Samples

Samples are in the samples/ directory. Each sample's README.md has instructions for running its sample.

Sample	Source Code	Try it
Alpha_analytics_data.create_audience_list	source code
Alpha_analytics_data.create_recurring_audience_list	source code
Alpha_analytics_data.create_report_task	source code
Alpha_analytics_data.get_audience_list	source code
Alpha_analytics_data.get_property_quotas_snapshot	source code
Alpha_analytics_data.get_recurring_audience_list	source code
Alpha_analytics_data.get_report_task	source code
Alpha_analytics_data.list_audience_lists	source code
Alpha_analytics_data.list_recurring_audience_lists	source code
Alpha_analytics_data.list_report_tasks	source code
Alpha_analytics_data.query_audience_list	source code
Alpha_analytics_data.query_report_task	source code
Alpha_analytics_data.run_funnel_report	source code
Alpha_analytics_data.sheet_export_audience_list	source code
Beta_analytics_data.batch_run_pivot_reports	source code
Beta_analytics_data.batch_run_reports	source code
Beta_analytics_data.check_compatibility	source code
Beta_analytics_data.create_audience_export	source code
Beta_analytics_data.get_audience_export	source code
Beta_analytics_data.get_metadata	source code
Beta_analytics_data.list_audience_exports	source code
Beta_analytics_data.query_audience_export	source code
Beta_analytics_data.run_pivot_report	source code
Beta_analytics_data.run_realtime_report	source code
Beta_analytics_data.run_report	source code
Quickstart	source code

The Google Analytics Data Node.js Client API Reference documentation also contains samples.

Supported Node.js Versions

Our client libraries follow the Node.js release schedule . Libraries are compatible with all current active and maintenance versions of Node.js. If you are using an end-of-life version of Node.js, we recommend that you update as soon as possible to an actively supported LTS version.

Google's client libraries support legacy versions of Node.js runtimes on a best-efforts basis with the following warnings:

Legacy versions are not tested in continuous integration.
Some security patches and features cannot be backported.
Dependencies cannot be kept up-to-date.

Client libraries targeting some end-of-life versions of Node.js are available, and can be installed through npm dist-tags . The dist-tags follow the naming convention legacy-(version) . For example, npm install @google-analytics/data@legacy-8 installs client libraries for versions compatible with Node.js 8.

Versioning

This library follows Semantic Versioning .

This library is considered to be in preview. This means it is still a work-in-progress and under active development. Any release is subject to backwards-incompatible changes at any time.

More Information: Google Cloud Platform Launch Stages

Contributing

Contributions welcome! See the Contributing Guide .

Please note that this README.md , the samples/README.md , and a variety of configuration files in this repository (including .nycrc and tsconfig.json ) are generated from a central template. To edit one of these files, make an edit to its templates in directory .

License

Apache Version 2.0

See LICENSE