Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lukeed/ganalytics
A tiny (312B) client-side module for tracking with Google Analytics
https://github.com/lukeed/ganalytics
analytics google-analytics javascript lightweight
Last synced: about 5 hours ago
JSON representation
A tiny (312B) client-side module for tracking with Google Analytics
- Host: GitHub
- URL: https://github.com/lukeed/ganalytics
- Owner: lukeed
- License: mit
- Created: 2017-07-23T04:16:59.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2023-03-16T16:47:09.000Z (over 1 year ago)
- Last Synced: 2024-10-26T15:10:42.702Z (8 days ago)
- Topics: analytics, google-analytics, javascript, lightweight
- Language: JavaScript
- Homepage:
- Size: 37.1 KB
- Stars: 574
- Watchers: 9
- Forks: 28
- Open Issues: 4
-
Metadata Files:
- Readme: readme.md
- License: license
Awesome Lists containing this project
- awesome-list - ganalytics - side module for tracking with Google Analytics | lukeed | 503 | (JavaScript)
README
# ganalytics [](https://travis-ci.org/lukeed/ganalytics)
> A tiny (312B) client-side module for tracking with Google Analytics
This module exposes three module definitions:
* **ES Module**: `dist/ganalytics.mjs`
* **CommonJS**: `dist/ganalytics.js`
* **UMD**: `dist/ganalytics.min.js`
_Please see [Releases](https://github.com/lukeed/ganalytics/releases) for changelog!_
## Install
```
$ npm install --save ganalytics
```
## Usage
```js
const GAnalytics = require('ganalytics');
const ga = new GAnalytics('UA-XXXXXXXX-X', { aid:1 });
// or
const ga = 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, toWait)
#### trackerID
Type: `String`
Your Google Analytics tracker ID; eg `UA-XXXXXXXX-X`
#### options
Type: `Object`
Any common, [general options](https://developers.google.com/analytics/devguides/collection/protocol/v1/parameters#general) that this instance should hold onto.
> **Note:** Any `option` key can be redefined or overwritten within a `send()` call.
#### options.aip
Type: `Integer`
Default: `0`
Anonymize the sender's IP address. See [Anonymize IP](https://developers.google.com/analytics/devguides/collection/protocol/v1/parameters#aip).
#### options.an
Type: `String`
Specifies the application's name. See [Application Name](https://developers.google.com/analytics/devguides/collection/protocol/v1/parameters#an).
#### options.aid
Type: `String`
Specifies the application identifier. See [Application ID](https://developers.google.com/analytics/devguides/collection/protocol/v1/parameters#aid).
#### options.aiid
Type: `String`
Specifies the application installer identifier. See [Application Installer ID](https://developers.google.com/analytics/devguides/collection/protocol/v1/parameters#aiid).
#### options.av
Type: `String`
Specifies the application verison. See [Application Version](https://developers.google.com/analytics/devguides/collection/protocol/v1/parameters#av).
#### options.cid
Type: `String`
Anonymously identify a particular user, device, or browser instance. This should be persisted so that repetitive session use the same identifier. See [Client ID](https://developers.google.com/analytics/devguides/collection/protocol/v1/parameters#cid).
> **Important** This is required when `options.uid` is not defined.
#### options.uid
Type: `String`
An identifier for a known user, if possible. This value should never be persisted. See [User ID](https://developers.google.com/analytics/devguides/collection/protocol/v1/parameters#uid).
> **Important** This is required when `options.cid` is not defined.
#### options.ds
Type: `String`
Indicates the data source type of the hit; eg `web` or `app`. See [Data Source](https://developers.google.com/analytics/devguides/collection/protocol/v1/parameters#ds).
#### toWait
Type: `Boolean`
Default: `false`
When truthy, a `pageview` event **will not** be sent immediately upon initialization.
### 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:
* [Event](https://developers.google.com/analytics/devguides/collection/protocol/v1/parameters#events)
* [Exception](https://developers.google.com/analytics/devguides/collection/protocol/v1/parameters#exception)
* [Item](https://developers.google.com/analytics/devguides/collection/protocol/v1/parameters#ecomm)
* [Pageview](https://developers.google.com/analytics/devguides/collection/protocol/v1/parameters#content)
* [Screenview](https://developers.google.com/analytics/devguides/collection/protocol/v1/parameters#cd)
* [Social](https://developers.google.com/analytics/devguides/collection/protocol/v1/parameters#social)
* [Timing](https://developers.google.com/analytics/devguides/collection/protocol/v1/parameters#timing)
* [Transaction](https://developers.google.com/analytics/devguides/collection/protocol/v1/parameters#ecomm)
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:
```js
ga.send('pageview');
// is the same as:
//=> ga.send('pageview', { dt:document.title, dl:location.href })
```
## License
MIT © [Luke Edwards](https://lukeed.com)