Notwithstanding Precautions, Misadventure

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

    4.0.0 • Public • Published

    Google Cloud Platform logo

    Google Analytics Admin: Node.js Client

    release level npm version

    Admin 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 Admin 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/admin

    Using the client library

    // Imports the Google Analytics Admin API client library
    const analyticsAdmin = require('@google-analytics/admin');
    
    async function main() {
      // Instantiates a client using default credentials.
      // TODO(developer): uncomment and use the following line in order to
      //  manually set the path to the service account JSON file instead of
      //  using the value from the GOOGLE_APPLICATION_CREDENTIALS environment
      //  variable.
      // const analyticsAdminClient = new analyticsAdmin.AnalyticsAdminServiceClient(
      //     {keyFilename: "your_key_json_file_path"});
      const analyticsAdminClient = new analyticsAdmin.AnalyticsAdminServiceClient();
    
      // Calls listAccounts() method of the Google Analytics Admin API and prints
      // the response for each account.
      const [accounts] = await analyticsAdminClient.listAccounts();
    
      console.log('Accounts:');
      accounts.forEach(account => {
        console.log(account);
      });
    }
    
    main(...process.argv.slice(2)).catch(err => {
      console.error(err.message);
      process.exitCode = 1;
    });
    process.on('unhandledRejection', err => {
      console.error(err.message);
      process.exitCode = 1;
    });
    

    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_installed_oauth2 source code Open in Cloud Shell

    The Google Analytics Admin 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/admin@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

    Install

    npm i @google-analytics/admin

    DownloadsWeekly Downloads

    463

    Version

    4.0.0

    License

    Apache-2.0

    Unpacked Size

    4.63 MB

    Total Files

    19

    Last publish

    Collaborators

    • justinbeckwith
    • google-wombot
    • bcoe