gb-tracker-client - npm Package Compare versions

Comparing version 5.0.0-beta.1637173331 to 5.0.0-beta.1637175371

package.json

 {
   "name": "gb-tracker-client",
-  "version": "5.0.0-beta.1637173331",
+  "version": "5.0.0-beta.1637175371",
   "description": "GroupBy client-side event tracker",
@@ -5,0 +5,0 @@ "main": "index.js",

README.md

@@ -69,2 +69,38 @@ # GroupBy Tracker Client
 
+## Shopper tracking
+
+The first party cookie `gbi_visitorId` is set with an empiry time of 1 year that is extended each time the shopper visits again. This is used to anonymously track the shopper.
+
+### 5.0.0 changes
+
+**IMPORTANT**
+
+As of version 5.0.0, the way shopper tracking works has changed. It includes cross-domain support, but tracking only works on domains whose apex domain's TLD is not a second-level domain. Examples:
+
+- `.com` -  You can use version 5.0.0. Shoppers will be tracked. If the cross-domain rules are met (see below), they will be tracked across your domains.
+- `.co.uk` - You cannot use version 5.0.0. If you do, shoppers will not be tracked at all because the cookie-setting code will fail silently. You must wait for a version to be published after 5.0.0. The new version will include instructions for re-enabling shopper tracking.
+
+### Cross-domain rules
+
+For shoppers to be tracked across your domains, in additional to the rule that the TLD must not be a second-level domain (see above), the domains must share the same apex domain. Examples:
+  
+- `a.example.com` and `b.example.com`
+- `a.example.com` and `example.com`
+- `example.com` and `a.example.com`
+
+### Upgrading from versions 3 or 4 and visitor ID re-use
+
+You should not upgrade from 3 or 4 to 5 if your apex domain's TLD is a second-level domain (see above).
+
+If you upgrade from 3 or 4 to 5, the visitor ID values generated by version 3 or 4 of the tracker client will be re-used. Whichever domain the shopper visits next once you start using version 5, the visitor ID generated for that domain will be re-used as the visitor ID for the apex domain, thereafter shared between each of your domains.
+
+For example, if a shopper performed the following events, the visitor ID `abc` would be re-used:
+
+- Visits `www.example.com`, at which point version 3 or 4 sets the visitor ID to `abc`.
+- Performs a search.
+- Views a product and adds it to their cart (where they're brought to `checkout.example.com`), at which point version 3 or 4 sets the visitor ID to `bcd`.
+- Decides not to follow through with purchasing the product.
+- Waits a while, but less than a year, during which time you upgrade to version 5.
+- Visits the site again, clicks their cart (at which point version 5 replaces the visitor ID `bcd` with `abc`), and completes the purchase.
+
 ## More Usage Details
@@ -71,0 +107,0 @@

version.d.ts

@@ -1,1 +0,1 @@
-export declare const version = "5.0.0-beta.1637173331";
+export declare const version = "5.0.0-beta.1637175371";

version.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.version = void 0;
-exports.version = "5.0.0-beta.1637173331";
+exports.version = "5.0.0-beta.1637175371";

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

353269

increased by0.67%

Number of lines in readme file

110

increased by48.65%

No dependency changes