Advanced tracking code settings

This article describes the parameters you can find in tracking codes. You may use this information for editing existing tracking codes, especially if your integration was built before the introduction of the tracking code creator in the Synerise Platform.

If you need to create a new tracking code and then manually edit its settings, create it as described in Getting started and then return to this article.

Tracking code in Single Page Applications

If your website is a Single Page Application (SPA), the tracking code must be modified. The modification changes the mechanism of sending page visit events and retrieving dynamic content.

1. Add the highlighted parameters to the tracking code:

       function onSyneriseLoad() {
           SR.init({
               'trackerKey':'XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX',
               'customPageVisit': true,
               'dynamicContent': {
                   'virtualPage': true
               }
           });
       }

   Result:
   The additional initialization parameters disable page visit events and dynamic content retrieval.

2. Re-enable page visit tracking and dynamic content retrieval by implementing the following methods in the page:

   SR.event.pageVisit()
       .then(function () {
           SR.dynamicContent.get();
   })

   Important:

   Page visits and dynamic content retrieval must be implemented according to the following rules:

   • og:tags must be loaded first, regardless of the method that is used to load them
   • page visits and dynamic content must be requested whenever the page is loaded, reloaded, and when the view changes
   Tip: You can use Google Tag Manager to implement the methods. To do so, trigger SR.event.pageVisit(); and SR.dynamicContent.get(); methods on events that indicate a page or DOM being loaded. SR.init is only called when DOM is loaded.

Tracking script variants (no custom domain)

Synerise offers several variants of our Javascript SDK that you can use depending on the required features.

Fewer features usually result in smaller page size and shorter load times.

Additional tracking configuration parameters

The only required parameter during the initialization of the tracking code is the trackerKey parameter.
By using the additional parameters described below, you can modify the configuration of the tracking code.

Google dataLayer

If you use Google Analytics 4 e-commerce, you can send data to it when using Synerise event tracking.

If your tracking code was created without the generator, add the dataLayer and gaVersion properties to SR.init():

SR.init({
    "trackerKey":"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
    "dataLayer": dataLayer,
    "gaVersion": "CHOOSE_VERSION"
});

The gaVersion parameter is used to set the Google Analytics implementation. You can only choose one implementation for use with Synerise tracking.

• To send events to Google Analytics 4 Tag Manager implementation, set the value to GA_4
• To send events to Google Analytics 4 gtag.js implementation, set the value to GA_4_TAG

When you send events to Google Data Layer, some parameters are saved in Synerise under different names:

Subdomains

If you have several subdomains with different tracking codes, they generate cookies with their own domains.

If you want the sub-domains to create cookies for another domain instead, declare the domain in the subdomains’ tracking codes.

Example: If your site is docs.example.com, it would generate cookies with the docs.example.com domain. To generate cookies with the root domain, the tracking code needs the following parameter:

SR.init({
    'trackerKey':'XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX',
    'domain':'.example.com'
});

Automatic tracking of page visits

You can turn off the automatic collection of page visit events with the customPageVisit parameter.
In this case, events should be sent manually using the SDK methods.

SR.init({
    'trackerKey':'XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX',
    'customPageVisit':true
});

Synerise webpush worker scope

If you use Synerise webpush and need to set a custom service worker scope (registration path), you can enter that path as a parameter.

SR.init({
    'trackerKey':'XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX',
    'webpush':{
        'service_worker_scope':'/pl/'
    }
});

Disabling modules

Additionally, if you need to disable some Synerise modules on a specific sub-page or domain, you can do it by specifying the parameters as below:

SR.init({
    'trackerKey':'XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX',
    'disableWebPush':true,
    'disableDynamicContent':true,
});

Customizing metadata

You can add <meta> tags (for example, OG tags) to the website or modify existing ones. The new values are added to page.visit events. They can also be used with other features based on metadata, such as communication, recommendations, personalization, and so on.

To do it, add a customizeMetadata function to SR.init().

Example:

SR.init({
    'trackerKey': 'XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX',
    'customizeMetadata': function (metadata) {
        metadata.size = 8;
        metadata.isExample = true;
        metadata['og:title'] = 'Sneakers';
        metadata['product:retailer_part_no'] = '1a4d3380-04d1';
        return metadata;
    }
});

Usage:

• If the name of the meta key doesn’t contain special characters, use the metadata.keyName = 'keyValue' syntax.
• If the name of the meta key contains special characters, use the metadata['key_name'] = 'keyValue' syntax.
• Up to 20 meta parameters can be returned.
• The following value types are allowed:
  • string
  • number
  • boolean
  • array

Cookie expiration

By default, the _snrs_p, _snrs_uuid, and _snrs_puuid cookies expire after 400 days. You can change this by using the cookieExpiration parameter. The value is the number of days after which the cookies expire.

The following example sets cookie expiration time to 60 days:

SR.init({ 
    "trackerKey": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "cookieExpiration": 60
});

Nonce for Content Security Policies

Nonce (number used once) is a content attribute which can be used by Content Security Policies (CSPs) to determine if an element should be allowed. If a script doesn’t have a nonce value that matches the one expected by the CSP, the script can’t execute.

You can add the nonce to the Synerise SDK initialization script:

SR.init({
  trackerKey: "VALUE",
  nonce: "VALUE"
});

The tracking code and any scripts that the SDK adds to the page (for example, in Dynamic Content) will have the nonce value that you add to SR.init

For more details on nonce and implementing it, see MDN Web Docs.