Skip to content
This repository was archived by the owner on Dec 14, 2020. It is now read-only.

literal-io/ganalytics

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

21 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

ganalytics Build Status

A tiny (400B) client-side module for tracking with Google Analytics

This module exposes three module definitions:

  • ES Module: dist/ganalytics.es.js
  • CommonJS: dist/ganalytics.js
  • UMD: dist/ganalytics.min.js

As of v2.0.0, ganalytics makes use of Object.assign, which means that Internet Explorer is not supported by default. However, Babel users may install babel-plugin-transform-object-assign to quickly regain IE compatibility!

Install

$ npm install --save ganalytics

Usage

const GAnalytics = require('ganalytics');

const ga = new GAnalytics('UA-XXXXXXXX-X', { aid:1 });

ga.send('pageview');
ga.send('pageview', { dt:'Foobar', dp:'/foo' });

ga.send('event', { ec:'Video', ea:'Play', el:'Home Hero' });

API

GAnalytics(trackerID, options)

trackerID

Type: String

Your Google Analytics tracker ID; eg UA-XXXXXXXX-X

options.aip

Type: Integer
Default: 0

Anonymize the sender's IP address. See Anonymize IP.

options.an

Type: String

Specifies the application's name. See Application Name.

options.aid

Type: String

Specifies the application identifier. See Application ID.

options.aiid

Type: String

Specifies the application installer identifier. See Application Installer ID.

options.av

Type: String

Specifies the application verison. See Application Version.

options.ds

Type: String

Indicates the data source type of the hit; eg web or app. See Data Source.

ga.send(type, params)

type

Type: String

The type of hit to send. Must be one of these: pageview, screenview, event, transaction, item, social, exception, or timing.

params

Type: Object

The parameters to send based on the type of hit.

Please follow the links for each available parameter set:

For pageview hits only, if no params are provided, then the document.title and location.href values will be auto-filled. This allows you to send valid requests by writing:

ga.send('pageview');
// is the same as:
//=> ga.send('pageview', { dt:document.title, dl:location.href })

License

MIT © Luke Edwards

About

A tiny (400B) client-side module for tracking with Google Analytics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 100.0%