search

peaksandpies / universal-analytics

A node module for Google's Universal Analytics and Measurement Protocol
960 stars 146 forks source link

readme

universal-analytics

Setting up a new property in Google Analytics? follow these instructions to get your UA-xxxx code.
https://support.google.com/analytics/answer/9304153#UA

A node module for Google's Universal Analytics tracking via the Measurement Protocol.

This module allows tracking data (or rather, users) from within a Node.js application. Tracking is initiated on the server side and, if required, does not require any more tracking in the browser.

npm version Build Status

Table of Contents

Getting started

universal-analytics is installed and included like any other node module:

$ npm install universal-analytics
var ua = require('universal-analytics');

// Or with ES6 import
import ua from 'universal-analytics'

Initialization expects at least your Google Analytics account ID:

var visitor = ua('UA-XXXX-XX');

This will create a universal-analytics Visitor instance that you can use and keep around to track a specific client (Not to be confused with the Google Analytics User ID, see Setting persistent parameters for more information on that). Since no client ID was specified in the constructor's arguments, a random UUID is generated. In case you have a client ID at hand, you can use that to create the visitor:

var visitor = ua('UA-XXXX-XX', '6a14abda-6b12-4578-bf66-43c754eaeda9');

Starting with Universal Analytics, a UUID v4 is the preferred client ID format. It is therefor necessary to provide a UUID of such type to universal-analytics. However you can force custom client ID, passing strictCidFormat: false in the options:

var visitor = ua('UA-XXXX-XX', 'CUSTOM_CLIENTID_1', { strictCidFormat: false });

If you want to force the HTTP protocol instead of HTTPS, include http: true in the options, by default this module will use https:

var visitor = ua('UA-XXXX-XX', { http: true });

If you want to set User Id you can add it into options:

var visitor = ua('UA-XXXX-XX', { uid: 'as8eknlll'});

see about User Id

Tracking a pageview without much else is now very simple:

visitor.pageview("/").send()

The first argument for the pageview method is the path of the page to be tracked. Simply calling pageview() will not initiate a tracking request. In order to send off tracking to the Google Analytics servers you have two options:

  1. You can append a send() call after pageview(). The tracking request is sent asynchronously. This means you will not receive any confirmation when and if it was successful.
  2. You can provide a callback function to pageview() as an additional, last argument. This callback will be invoked once the tracking request has finished. Any error that occured during the request will be provided to said callback. In that case send() is no longer necessary.

An example of the callback approach:

var visitor = ua('UA-XXXX-XX');
visitor.pageview("/", function (err) {
  // Handle the error if necessary.
  // In case no error is provided you can be sure
  // the request was successfully sent off to Google.
});

Tracking

Pageview tracking

The first argument for the pageview tracking call is the page path. Furthermore, pageview tracking can be improved with the additional parameters to provide the page's hostname and title to Google Analytics. The parameters are provided as arguments after the page path.

visitor.pageview("/", "http://peaksandpies.com", "Welcome").send();

The following snippet is the exact same tracking using a callback. It is always the last argument.

visitor.pageview("/", "http://peaksandpies.com", "Welcome", function (err) {
  // …
});

Depending on how you integrate tracking into your app, you might be more comfortable with providing all the tracking data via a params object to the pageview() method:

visitor.pageview({dp: "/", dt: "Welcome", dh: "http://peaksandpies.com"}).send();

This code has the exact same effect as the one above. dp, dt, and dh (as in 'document path', 'document title' and 'document hostname') are the attribute names used by the Measurement Protocol.

It's mandatory to specify either the page path (dp) or document location (dl). Google Analytics can not track a pageview without a path. To avoid such erroneous requests, universal-analytics will deny pageview() tracking if the required parameters are omitted.

var pagePath = null;

visitor.pageview(pagePath, function (err) {
  // This callback will receive an error
});

The following method signatures are available for the pageview() method of the Visitor instance:

See also: List of acceptable params.

Screenview tracking

Instead of pageviews app will want to track screenviews.

visitor.screenview("Home Screen", "App Name").send()

The following method signatures are available for #screenview:

See also: List of acceptable params.

Event tracking

Tracking events with universal-analytics works like pageview tracking, only you have to provide different arguments:

visitor.event("Event Category", "Event Action").send()

This is the most straightforward way to track an event. The event attributes label and value are optional and can be provided if necessary:

visitor.event("Event Category", "Event Action", "…and a label", 42).send()

Just like pageview tracking, event tracking supports a callback as the last argument:

visitor.event("Event Category", "Event Action", "…and a label", 42, function (err) {
  // …
})

An additional attribute for events is the path of the page they should be associated with in Google Analytics. You can provide this path via an additional params object:

visitor.event("Event Category", "Event Action", "…and a label", 42, {p: "/contact"}, function (err) {
  // …
})

Notice: The page path attribute for the event is called p which differs from the dp attribute used in the pageview tracking example. universal-analytics is smart enough to use the dp attribute should you provide it instead of p.

In case this argument list is getting a little long, event() also accepts a params object like pageview():

var params = {
  ec: "Event Category",
  ea: "Event Action",
  el: "…and a label",
  ev: 42,
  dp: "/contact"
}

visitor.event(params).send();

The category (ec) and the action (ea) are mandatory. Google Analytics will not track an event without them. To avoid such erroneous requests, universal-analytics will deny event() tracking if either attribute is omitted.

var action = null;

visitor.event("Navigation clicks", action, function (err) {
  // This callback will receive an error
});

The following method signatures are available for #event:

See also: List of acceptable params.

E-commerce tracking

E-commerce tracking in general is a bit more complex. It requires a combination of one call to the transaction() method and one or more calls to the item() method.

visitor
  .transaction("trans-12345", 500)   // Create transaction trans-12345 worth 500 total.
  .item(300, 1, "item-54321")        // Add 1 unit the item item-54321 worth 300.
  .item(200, 2, "item-41325")        // Add 2 units the item item-41325 worth 200.
  .send()

Once again, daisy-chaining simplifies associating the items with the transaction. Officially, nothing but the transaction ID is a requirement for both the transaction and the items. However, providing a minimum set of information (revenue for the transaction, price, quantity and ID for the items) is recommended.

It is also possible to provide the params as an object to both methods:

visitor
  .transaction({ti: "trans-12345", tr: 500, ts: 50, tt: 100, ta: "Partner 13"})
  .item({ip: 300, iq: 1, ic: "item-54321", in: "Item 54321", iv: "Blue"})
  .item({ip: 200, iq: 2, ic: "item-41325", in: "Item 41325", iv: "XXL"})
  .send()

In case an additional item has to be added later on or daisy-chaining is not available for another reason, each item can be given an associated transaction ID via the params object as well:

visitor.item({ip: 100, iq: 1, ic: "item-41325", in: "Item 41325", iv: "XL", ti: "trans-12345"}).send()

The transaction ID (ti) is mandatory for both the transaction and the item. Google Analytics will not track e-commerce data without it. To avoid such erroneous requests, universal-analytics will deny transaction() and item() tracking if it is omitted.

var ti = null;

visitor.transaction(ti, function (err) {
  // This callback will receive an error
});

The following method signatures are available for #transaction:

The following method signatures are available for #item:

See also: List of acceptable params.

Exception tracking

Exception tracking is a way to keep track of any sort of application errors and bugs with Google Analytics. Using it with this module is a way to capture server-side problems.

visitor.exception("StackOverflow Error").send()

As an additional information, the exception can be flagged as fatal if the error was exceptionally bad.

var fatal = true;
visitor.exception("StackOverflow Error", fatal, function () {
  // Finish handling this error
});

The following method signatures are available for #exception:

See also: List of acceptable params.

User timing tracking

Tracking user timings is a way to capture time-based information similar to the page load speed data tracked automatically by Google Analytics. All arguments to this tracking method are optional, but a category, a variable and a time value should be provided. The time value should be provided in milliseconds.

visitor.timing("User interaction", "Time to open login overlay", 12547).send()

The following method signatures are available for #timing:

See also: List of acceptable params.

Transaction tracking

Transactions are the main tracking calls for ecommerce tracking

visitor.transaction("123456", "449.99").send()

The following method signatures are available for #transaction:

See also: List of acceptable params.

Transaction item tracking

Transaction consist of one or more items.

visitor.item(449.99, 1, "ID54321", "T-Shirt", {ti: "123456"}).send()

The following method signatures are available for #item:

See also: List of acceptable params.

Daisy-chaining tracking calls

We have seen basic daisy-chaining above when calling send() right after pageview() and event():

visitor.pageview("/").send()

Every call of a tracking method returns a visitor instance you can re-use:

visitor.pageview("/").pageview("/contact").send()

Granted, the chance of this example actually happening in practice might be rather low.

However, universal-analytics is smart when it comes to daisy-chaining certain calls. In many cases, a pageview() call is instantly followed by an event() call to track some additional information about the current page. universal-analytics makes creating the connection between the two easy:

visitor.pageview("/landing-page-1").event("Testing", "Button color", "Blue").send()

This is the same as two distinct tracking calls.

visitor.pageview("/landing-page-1").send()
visitor.event("Testing", "Button color", "Blue", {p: "/landing-page-1"}).send()

Daisy-chaining is context-aware and in this case placing the event() call right after the pageview() call results in the event being associated with the page path tracking in the pageview() call. Even though the attributes (dp and p) are different internally.

It also works when using a callback since the this inside the callback will be the universal-analytics Visitor instance:

visitor.pageview("/landing-page-1", function (err) {
  if (!err) {
    this.event("Testing", "Button color", "Blue").send()
  }
});

More generally, the daisy-chaining context keeps all parameters from the previous call around. This means in a situation where similar tracking calls are necessary tracking is simplified:

visitor
  .event({ec: "Mail Server", ea: "New Team Member Notification sent"})
  .event({ea: "Invitation sent"})
  .send();

In this example the event category ("Mail Server") is not repeated in the second tracking call.

Setting persistent parameters

Some parameters should be in every tracking call, such as a user ID or custom dimensions that never or hardly change. For such situations a #set(key, value) method is available

  visitor.set("uid", "123456789");

The uid parameter will be part of every tracking request of that visitor from now on.

For custom dimensions, you will not pass dimension# rather cd#:

 visitor.set("cd[1-20]", "123456789"); // [1-20] will be the dimension number

Filter application tracking data

Set a persistent parameter for Data Source to app in order to mark tracking data as Application.

 visitor.set("ds", "app"); // Allows filtering by the 'Application?' field in GA

Then create a new view in Google Analytics of type 'Application'. You will then need to filter the data for that view by creating a new filter that either includes or excludes Application? Yes (depending on if you want to show(includes) or hide(excludes) application analytics in a given view).

Google Analytics Setup

Session-based identification

In order to make session-based apps easier to work with, universal-analytics also provides a middleware that works in an Expressjs-style fashion. It will try to detect a client ID based on the _ga cookie used by the analytics.js client-side tracking. Additionally it will store the detected client ID in the current session to recognize the visitor later.

var ua = require("universal-analytics");
var express = require("express");

var app = express()

express.use(ua.middleware("UA-XXXX-Y", {cookieName: '_ga'}));

The middleware will attach the universal analytics visitor instance to every request with the default name of req.visitor. The name of the instance on the req object can be overridden to avoid name conflicts by passing in instanceName on the options object:

express.use(ua.middleware("UA-XXXX-Y", {instanceName: 'uaVisitor'}));

Additionally, the module also exposes a createFromSession method to create a visitor instance simply based on a session, which is helpful when working with Socket.io, etc. where the middleware is not used.

var visitor = ua.createFromSession(socket.handshake.session);

Debug mode

universal-analytics is using the debug library. It can be instructed to output information during tracking by setting the DEBUG environment variable:

DEBUG=universal-analytics

Request Options

Due to the removal of the request package, request options are no longer available as of 0.5.

Shortcuts

The tracking methods have shortcuts:

Tests

The tests are written with mocha using should and Sinon.JS.

Run them by executing the following commands in the universal-analytics directory:

$ npm install
$ make test

License

(The MIT License)

Copyright (c) 2017 Peaks & Pies GmbH <hello@peaksandpies.com>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.