Sign Up for Free

RunKit +

Try any Node.js package right in your browser

This is a playground to test code. It runs a full Node.js environment and already has all of npm’s 400,000 packages pre-installed, including ga-service-acct with all npm packages installed. Try it out:

var gaServiceAcct = require("ga-service-acct")

This service is provided by RunKit and is not affiliated with npm, Inc or the package authors.

ga-service-acct v2.5.0

Google Analytics REST API via service account

Google Analytics REST API via service accounts

This library provides tools to use the Google Analytics REST API (GET only).

Use of the REST API requires authentication, and this module provides an implementation of Google's oAuth instructions for 'service accounts' (instead of using the Google api for Node library).

There are two additional steps you need to setup to use this code:

1. Convert secret key

After creating the service email, you will download a .p12 key file that needs to be converted to a .pem file using:

openssl pkcs12 -in privatekey.p12 -nodes -nocerts > privatekey.pem

openssl will ask for the private key, which Google has probably told you is 'notasecret'

The code relies upon Json Web tokens and uses the contents of the .pem file to sign the request object which is sent to Google for an access token.

2. Provide service user access

Use the online GA Admin tools "User Management" module to give your service user read access to your GA data (you will need yourself to have management rights to make this change).

Example of usage

var fs = require('fs');
var Report = require('ga-service-cert');

var SERVICE_EMAIL = "123456789-2eqk45me6ts7jn3kf0vfr@developer.gserviceaccount.com";

var query = {
    'ids': 'ga:123456',             // Update ids with your own view information
    'start-date': '2015-02-24',
    'end-date': '2015-03-10',
    'metrics': 'ga:users'
};

var private_key = fs.readFileSync(__dirname+'/privatekey.pem', "utf8");

var report = new Report(private_key, SERVICE_EMAIL, true);

report.on('ready', function() {

    report.get(query, function(err, data) {
        if (err) throw err
        console.log(data);          // e.g. [ [ '5140' ] ]
    });

    // Alternative version using a Promise
    report.get(query)
        .then( data => console.log(data) ) // e.g. [ [ '5140' ] ]
        .catch( err => console.error(err) );
});

report.on('auth_error', function(err) {
    console.log(".test: auth_error", err);
    router.get('/*', (req, res) => res.status(500).send("Unable to connect to Google"));
});

Management data

From version version 0.4, the code implements the simplest management API call (more to follow once I find a use case).

report.getManagement(null, function(err, data) {
    if (err) throw err
    console.log(data.kind);         // e.g. 'analytics#accounts'
});

Change log

  • 2.4.0 - .get can also return a Promise
  • 2.3.0 - Replaced babel polyfill with runtime
  • 2.2.1 - Removed private data from tests
  • 2.2.0 - Added tests (unusable without my private key)
  • 2.1.1 - Removed console statements from production code
  • 2.1.0 - Code improvements
  • 2.0.0 - Switch to ES6 Promises (with Babel polyfill for Node 0.10) from async
  • 1.2.0 - Switched to ES6 for development; shipping with transpiled file
  • 1.0.0 - Breaking change: constructor bow takes the key, rather than filename (to work better with e.g. system variables)
  • 0.4.1 - updated jwt to 5.0 and fixed bug in iat time
  • 0.4.0 - Added management data method

ToDo

  • Factor out token acquisition into separate module

Metadata

RunKit is a free, in-browser JavaScript dev environment for prototyping Node.js code, with every npm package installed. Sign up to share your code.
Sign Up for Free