daaru00 / nwjs-analytics

Node-Webkit Google Analytics integration

nwjs-analytics

Node-Webkit Google Analytics integration

Simple integration of Google Analytics Application (named Analytics for Mobile Apps) into Node-Webkit application

Installation

include analytics.js in your index.html file

<script src="analytics.js"></script>

Setup

Set your tracking ID, application name and application version in analytics.js file

var analytics = {
    trackID: 'UA-XXXXXX-X', //tracking id
    appName: 'appname',  //application name
    appVersion: '1.0.0',
    ...

If you are using a User-ID traking set userID

var analytics = {
    ...
    userID: 'john-smith',
    ...

or at runtime process

analytics.userID = 'john-smith';

otherwise will be generate a random client id

If you want to change clientID you can use this:

var analytics = {
    ...
    clientID: 'mac-01',
    ...

or at runtime process

analytics.clientID = 'mac01';

Usage

Screen View

analytics.screenView('login');

Event

analytics.event('category', 'action', 'label', 'value');

Exception

analytics.event('NotFoundError', 0); //second parameters is fatal flag

Timing

var startTime = new Date().getTime();
...
var endTime = new Date().getTime();
var timeSpent = endTime - startTime;
analytics.timing('category', 'variable', timeSpent, 'label');

Ecommerce

Currency setup

var analytics = {
    ...
    currency: "USD",
    ...

or at runtime process

analytics.currency = "USD";

To send ecommerce data

var order_id = "O145KL";
var total = 15.20;
var item = [
    {id: 40,name: "item1", price: 15.00, qty: 1},
    {id: 12,name: "item2", price: 0.20, qty: 1}
]
ecommerce.transactionID = "O145KL"; //optional, if is not set a random id will be generate
ecommerce.transaction(total, items)

Custom API

Check Working with the Measurement Protocol page

var data = {
    't' : 'event',
	'ec' : 'category',
	'ea' : 'action'
}
analytics.custom(data);

Extra

Debug Mode

You can set debug property true in analytics.js file to check hit parsing

var analytics = {
    ...
	debug: true,   
	...

output example

{
  "hitParsingResult": [ {
    "valid": true,
    "parserMessage": [ ],
    "hit": "/debug/collect?v=1\u0026tid=UA-XXXXXX-X\u0026cid=M1RWD\u0026an=application\u0026av=1.0.0\u0026t=screenview\u0026cd=login"
  } ],
  "parserMessage": [ {
    "messageType": "INFO",
    "description": "Found 1 hit in the request."
  } ]
}

Note: data will be not collect in debug mode

Performance Tracking

You can set performanceTracking property true in analytics.js file to automatically send load page timing

var analytics = {
    ...
	performanceTracking: true,   
	...

enabled by default

Error Tracking

You can set errorTracking property true in analytics.js file to automatically send exception

var analytics = {
    ...
	errorTracking: true,   
	...

enabled by default

AngularJS ui-router integration

App.run(['$rootScope', function($rootScope) {
    $rootScope.$on('$stateChangeSuccess', function(event, toState, toParams, fromState, fromParams){
        analytics.screenView(toState.name);
    })
}]);

AngularJS ngRoute integration

App.config(['$routeProvider', function($routeProvider) {
    $routeProvider
        .when('/', {
            title: "Dashboard", //set view title
            templateUrl: './views/dashboard.html',
            controller: 'dashboardCtrl'
        })
}]);
App.run(['$rootScope', function($rootScope, $route) {
    $rootScope.$on('$routeChangeSuccess', function() {
        if($route.current.title) analytics.screenView($route.current.title); //screenView value is Dashboard
    });
}]);

Useful Links

Google Analytics Collect API: Working with the Measurement Protocol

Hit builder and testing tool: Hit Builder

License

MIT

nwjs-analytics's Issues

Add Dimensions to screen tracking

Hi, first of all, thanks for this amazing library.

In the Analytics Android SDK i can add custom dimensions for screenViews. Can you extend the library for that?

Tracker tracker = getDefaultTracker();
tracker.setScreenName("MyAwesomeScreen");
tracker.send(new HitBuilders.ScreenViewBuilder()
    .setCustomDimension(1, "Dimension1Value")
    .build());

Could you tell my how do i have to name the params if i do it as a custom event?

Thanks, Philip

Behaviour -> Events -> Screens shows no screen names

The section of Google Analytics found at 'Behaviour -> Events -> Screens' shows nothing under the 'Screen Name' column.

I'm using both the analytics.screenView and the analytics.event methods. So I need to work out how to tell Analytics which events are associated with which screen. Ideally, it would be great if any events sent were associated with the most recently sent screen view.

It looks like I'm essentially having the same problems as the following URL, but I'm not sure how to apply the suggested fix using your library.

https://stackoverflow.com/questions/30414559/google-analytics-screenname-for-events

Hope you can help!

Many thanks.