npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

ga-service-acct

v2.5.0

Published

Google Analytics REST API via service account

Downloads

93

Readme

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 = "[email protected]";

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