Comparing version 3.1.2 to 3.1.3
@@ -49,2 +49,3 @@ declare module "ganalytics" { | ||
* The application or site owner's known identifier for the user. | ||
* @note This becomes required if `cid` is not defined. | ||
* @see https://developers.google.com/analytics/devguides/collection/protocol/v1/parameters#uid | ||
@@ -56,2 +57,10 @@ * @example 'as8eknlll', 'foobar' | ||
/** | ||
* The application or site owner's generated identifier for the client device. | ||
* @note This becomes required if `uid` is not defined. | ||
* @see https://developers.google.com/analytics/devguides/collection/protocol/v1/parameters#cid | ||
* @example 'as8eknlll', 'foobar' | ||
*/ | ||
cid?: string; | ||
/** | ||
* Control the session duration. The session will begin or end with this hit. | ||
@@ -58,0 +67,0 @@ * @see https://developers.google.com/analytics/devguides/collection/protocol/v1/parameters#sc |
{ | ||
"name": "ganalytics", | ||
"version": "3.1.2", | ||
"version": "3.1.3", | ||
"umd:name": "GAnalytics", | ||
@@ -5,0 +5,0 @@ "repository": "lukeed/ganalytics", |
@@ -46,2 +46,9 @@ # ganalytics [![Build Status](https://travis-ci.org/lukeed/ganalytics.svg?branch=master)](https://travis-ci.org/lukeed/ganalytics) | ||
#### 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 | ||
@@ -73,2 +80,17 @@ Type: `Integer`<br> | ||
#### 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 | ||
@@ -75,0 +97,0 @@ Type: `String` |
Major refactor
Supply chain riskPackage has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.
Found 1 instance in 1 package
27738
573
141
0