Have ideas to improve npm?Join in the discussion! »

    @google-analytics/data
    TypeScript icon, indicating that this package has built-in type declarations

    2.4.2 • Public • Published

    Google Cloud Platform logo

    Google Analytics Data: Node.js Client

    release level npm version codecov

    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

    Before you begin

    1. Select or create a Cloud Platform project.
    2. Enable the Google Analytics Data API.
    3. Set up authentication with a service account 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
    Quickstart source code Open in Cloud Shell
    Quickstart_json_credentials source code Open in Cloud Shell
    Quickstart_oauth2 source code Open in Cloud Shell
    Realtime source code Open in Cloud Shell

    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.

    Client libraries targeting some end-of-life versions of Node.js are available, and can be installed via npm dist-tags. The dist-tags follow the naming convention legacy-(version).

    Legacy Node.js versions are supported as a best effort:

    • Legacy versions will not be tested in continuous integration.
    • Some security patches may not be able to be backported.
    • Dependencies will not be kept up-to-date, and features will not be backported.

    Legacy tags available

    • legacy-8: install client libraries from this dist-tag for versions compatible with Node.js 8.

    Versioning

    This library follows Semantic Versioning.

    This library is considered to be in beta. This means it is expected to be mostly stable while we work toward a general availability release; however, complete stability is not guaranteed. We will address issues and requests against beta libraries with a high priority.

    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 template in this directory.

    License

    Apache Version 2.0

    See LICENSE

    Install

    npm i @google-analytics/data

    DownloadsWeekly Downloads

    1,193

    Version

    2.4.2

    License

    Apache-2.0

    Unpacked Size

    3.47 MB

    Total Files

    28

    Last publish

    Collaborators

    • avatar
    • avatar
    • avatar