GTM Integration

Tracking visitor analytics and behavior are essential in order to provide accurate and visitor-specific search and category page results. UNBXD analyzes visitor events, such as product clicks, products added to cart, orders, etc. These events are tracked using browser cookies. With this information, a profile is built for every visitor, based on his/her affinity to different categories, brands, or prices.

This information is then aggregated and analyzed for two purposes:

• Generating reports
• Providing relevant and personalized search & category pages results

When visitors browse through your store, the integrated trackers log everything visitors do – the products they visit, orders, even the various store properties they interact with. We take that information, analyze it, and assemble a detailed profile of the visitor. We know their browsing patterns, preferences and can even determine susceptibility to merchandising campaigns. The trackers are unique tracking codes that must be configured onto the store properties that yield an interaction. We call this interaction as an “event”, for example, click on the “Add to Cart” button.

The visitor profiles help fetch relevant and personalized products as search results. It also helps in generating detailed reports.

📘

NOTE

For Unbxd E-commerce Search to function correctly on your site, Unbxd Analytics must be configured.

Introduction to GTM

Google Tag Manager is a free tool that allows you to manage and deploy marketing tags (snippets of code or tracking pixels) on your website (or mobile app) without having to modify the code.

Here’s a very simple example of how GTM works. Information from one data source (your website) is shared with another data source (Analytics) through Google Tag Manager. GTM becomes very handy when you have lots of tags to manage because all the code is stored in one place.

Basic components of GTM

Following are the basic components within Google Tag Manager:

• Tags – Tags are tracking codes and code fragments that tell GTM what action to take on that page.

For example: Sending searched query to Unbxd analytics.

• Triggers – Triggers specify the conditions under which a Tag should fire.For example: A trigger with a condition to only fire a Tag when a user views URLs
• containing the path /search/.
• Variables – Variables are values used in triggers and tags to filter when a specific tag should fire. GTM provides built-in variables and allows you to create custom user-defined variables. For example: A ‘click’ class variable has a value name (such as a word string) assigned to buttons on the website.
• DataLayer – The dataLayer is a JSON that contains name value pairs of data points you wish to pass from your website into GTM. (And GTM can then, in turn, pass on to any tags that are managed in GTM, including Unbxd tags.)

Requirements for Unbxd tracking through GTM

Unbxd analytics scripts need to be loaded across all the pages. We require a tag which will need to be loaded on all the pages. Below is the required code block for Unbxd analytics script. This should be loaded before other Unbxd tracking scripts and is mandatory to be added on all pages.

// Container ID is present in GTM-XXXX format in GTM Dashboard
// HTML ID can be found in the url. Eg:
// containers/422XXXX/workspaces/20 , 20 is the HTML ID

<script type="text/javascript">
   /* * * CONFIGURATION * * */
   // Replace the value with the Unbxd Site Key and API Key.

   var UnbxdSiteName = "{{UNBXD_SITE_NAME}}";
   var UnbxdApiKey = "{{UNBXD_API_KEY}}";

   /* * * DON'T EDIT BELOW THIS LINE * * */
   (function() {
   var ubx = document.createElement('script');
   ubx.type = 'text/javascript';
   ubx.async = true; ubx.src='//d21gpk1vhmjuf5.cloudfront.net/unbxdAnalytics.js';
   ubx.addEventListener('load', function() {
   window.google_tag_manager[{{Container ID}}].onHtmlSuccess({{HTML ID}}); });
   (document.getElementsByTagName('head')[0] || document.getElementsByTagName('body')[0]).appendChild(ubx);
   })();
</script>

The above JS snippet needs to be added in a tag and also enable Built-In Variables, i.e., Container ID and HTML ID without fail.

• TagName: UnbxdAnalyticsScript
• TagType: Custom HTML Tag
• Trigger: AllPagesPageView

Category Page

A category page event is tracked to understand the browse/category interests of your visitors, as in which all category pages are visited by user. Each browse results page is tracked to enable per category page analytics of the visitor. A typical category page event involves:

UnbxdCategoryPageTrigger

Through GTM to integrate this event we need to follow below approach:

Create Trigger in GTM to catch the CategoryPath on browse results page load.
Trigger Configuration:

• TriggerName: UnbxdCategoryPageTrigger
• Trigger Type: Custom Event
• Event Name: CategoryPage
• TriggerFiresOn: All custom events

Create Variable in GTM, to fetch the query from the dataLayer.
Variable Configuration:

Variable Name: UnbxdCategoryPagePayload

Variable Variable Type: Data Layer Variable

Data Layer Variable Name: CategoryPagePayload

HTML Content:

Create a Javascript tag with the below details.

Tag Configuration:

Tag Name: UnbxdSearchQueryTag

Tag Type: Custom HTML

HTML Content:

// Pass payload to Unbxd.track function
// to call the tracker API
 
<script type="text/javascript">
  var u_payload = {{UnbxdCategoryPagePayload}};
  if (Unbxd && typeof Unbxd.track === 'function'
      && u_payload.hasOwnProperty("page")
      && u_payload.hasOwnProperty("page_type")) {
      Unbxd.track('categoryPage', u_payload);
  } else {
      console.error('ERRNO-002: unbxdAnalytics.js is not loaded or payload incorrect!')
  }
</script>

Pushing the event to the dataLayer on category page load.

Push payload to Datalayer:

// Add payload to Datalayer variable CategoryPagePayload 
// Should be triggered when user lands on category page
// Payload will contain page and page_type

<script​ ​type="​&quot;text/javascript&quot;​">
   window.dataLayer = window.dataLayer || [];
   dataLayer.push(
       {
           'event': 'CategoryPage',
           'CategoryPagePayload':
           {
               'requestId' : '{{unbxd-request-id}}',
               'page': '{{category-path}}',
               'page_type': '{{category-page-type}}'
           }
       }
   );
      }
  });
</script​>

Payload Details

Note for payload page and page_type details:

For example, if user lands on “/bedrooms/beds” page and

1. If parameters for category API look like /category?p=categoryPath:”Bedrooms>Beds”&pagetype=boolean then, page and page_type will look like:

   'SearchQueryPayload':
   
      {
   
          'requestId' : '{{unbxd-request-id}}',
   
          'page': "categoryPath:\"Bedrooms>Beds\"",
   
          'page_type': 'BOOLEAN'
   
      }

Else If parameters for category API look like /category?p=Bedrooms>Beds then, payload will look like:

'SearchQueryPayload':

   {

       'requestId' : '{{unbxd-request-id}}',

       'page': "Bedrooms>Beds",

       'page_type': 'CATEGORY_PATH'

   }

On a category page results load, please pass the categoryPath to the dataLayer as shown above. The event flow will be:

As soon as the CategoryPage event got pushed data layer.

1. This initiates the trigger UnbxdCategorPageTrigger which we created in the step-1.
2. UnbxdCategorPageTrigger executes the tag: UnbxdCategoryPageTag which we created in step-3.
3. Inside UnbxdCategoryPageTag we have added Unbxd analytics category tracker code.
4. Category tracker code get the CategoryPath from variable UnbxdCategoryPagePayload which we created in step-2.
5. Finally categoryPath of the page will be updated in Unbxd analytics database for the particular siteKey.

Product Click Unbxd Tracker

Tracking product clicks of visitors helps our search engine to understand their preferences over other products on the listing page. This information is used to compute popular products and render relevant and personalized results. It needs to be tracked in case of search and navigation pages. It is also integrated if customer is using the recommendation widgets.

Through GTM to integrate this event we need to follow the below approach:

Create a Trigger in GTM to catch the click event.

Trigger Configuration:

• TriggerName: UnbxdProductClickTrigger
• TriggerType: Custom Event
• EventName: ProductClick
• TriggerFiresOn: All Custom Events

Create Variable in GTM, to fetch the product details from the dataLayer. Variable Configuration:

VariableName: UnbxdProductClickPayload

Variable Type: Data Layer Variable

Data Layer Variable Name: ProductClickPayload

3. Create a Javascript tag with the below details.

   Tag Configuration:

   • Tag Name: UnbxdProductClickTag
   • Tag Type: Custom HTML
   • HTML Content:

   // Pass payload to Unbxd.track function
   // to call the tracker API
   
   <script type="text/javascript">
      var u_payload = {{UnbxdProductClickPayload}};
      if (Unbxd && typeof Unbxd.track === 'function'
          && u_payload.hasOwnProperty("pid")
          && u_payload.hasOwnProperty ("prank")){
          Unbxd.track('click', u_payload);
        } else {
          console.error('unbxdAnalytics.js is not loaded or payload incorrect!')
      }
   </script>

   Pushing the event to the Data Layer through the Product Click.

// Add payload to Datalayer variable ProductClickPayload
// Should be triggered on product click

<script type="text/javascript">
   window.dataLayer = window.dataLayer || [];
   dataLayer.push(
     {
      'event': 'ProductClick',
      'ProductClickPayload':
       {
         'requestId': 'REQUEST ID',
         'pid': 'PRODUCT ID',
         'variantId': 'VARIANT ID OF SELECTED VARIANT',
         'prank': 'RANK',
         'query': 'SEARCH QUERY'
       }
     });
</script>

Payload Details:

Browse Impressions

A browse impression event is fired when a category results loads for the first time, and whenever results change on applying pagination, autoscroll, sort, and filters. For each of these actions, unique Ids of the products visible on the category page should be sent as payload.

Through GTM to integrate this event we need to follow the below approach:

1. Create a Trigger in GTM to catch the browse impression

Trigger Configuration:

• TriggerName: ​ UnbxdBrowseImpressionTrigger
• TriggerType: ​ Custom Event​
• EventName: BrowseImpression
• TriggerFiresOn: All Custom Events

2. Create Variable in GTM to fetch the list of product Ids from the dataLayer.

Variable Configuration:

• VariableName: UnbxdBrowseImpressionPayload
• Variable Type: Data Layer Variable
• Data Layer Variable Name: BrowseImpressionPayload

3. Create a javascript tag with the below details.

Tag Configuration:

• Tag Name: UnbxdBrowseImpressionTag
• Tag Type: Custom HTML
• HTML Content:
• Tag Configuration:
• HTML Content:

// Pass payload to Unbxd.track() function
// to call the tracker API
 
<script type="text/javascript">
  var u_payload = {{UnbxdBrowseImpressionPayload}};
  if (Unbxd && typeof Unbxd.track === 'function'
       && u_payload.hasOwnProperty("page")
       && u_payload.hasOwnProperty("page_type")) {
           Unbxd.track('browse_impression', u_payload);
   } else {
  console.error('ERRNO-003: unbxdAnalytics.js is not loaded or payload incorrect!')
}
</script>

4. Pushing event to the dataLayer when the category results loads.

// Add payload to Datalayer variable BrowseImpressionPayload 
// Should be triggered on category page load
// Payload will contain page and page_type instead of query
 
<script type="text/javascript">
  window.dataLayer = window.dataLayer || [];
  dataLayer.push(
    {
     'event': 'BrowseImpression',
     'BrowseImpressionPayload':
      { 
        'requestId' : '{{unbxd-request-id}}',
        'pids_list': [LIST OF UNIQUE ID OF PRODUCTS],
        'page': '{{category-path}}',
        'page_type': '{{category-page-type}}'
      }
    });
</script>

Payload Details – Category Page Impression

Events Flow will be:

1. As soon as the ‘ProductClick’ event got pushed to the dataLayer.
2. This initiates the trigger UnbxdProductClickTrigger which we created in the step-1.
3. UnbxdProductClickTrigger executes the tag UnbxdProductClickTag: ​which we created in step-3.
4. Inside UnbxdProductClickTrigger we have added an Unbxd analytics browse impression tag.
5. Browse tracker code gets the data from variable UnbxdProductClickPayload ​which we created in step-2.
6. Finally, UnbxdProductClickTrigger event data will be updated in the Unbxd analytics database for the particular siteKey.

Product Page View

Product Page View indicates the total number of visits that has been made to the product details page (PDP) by the visitor irrespective of the source (search result page, category page, search engine, email, marketing campaigns, etc). This can be tracked by passing the product ID in the payload.

To integrate this event through GTM, we need to follow the below approach:

1. Create a Trigger in GTM to catch the product view.
   Trigger Configuration:

• TriggerName: UnbxdProductViewTrigger
• TriggerType: Custom Event
• EventName: ProductView
• TriggerFiresOn: All Custom Events.

2. Create a Variable in GTM to fetch the product ID from the dataLayer.

Variable Configuration:

• VariableName: UnbxdProductViewPayload
• Variable Type: Data Layer Variable
• Data Layer Variable Name: ProductViewPayload

3. Create a Javascript tag with the below details
   Tag Configuration:

• Tag Name: UnbxdProductViewTag
• Tag Type: Custom HTML
• HTML Content:

// Pass payload to Unbxd.track function
// to call the tracker API

<script type="text/javascript">
   var u_payload = {{UnbxdProductViewPayload}};
   if (Unbxd && typeof Unbxd.track === 'function'
       && u_payload.hasOwnProperty("pid")){
       Unbxd.track('product_view', u_payload);
     } else {
       console.error('unbxdAnalytics.js is not loaded or payload incorrect!')
   }
</script>

Pushing the event to the dataLayer through a product view.

// Add payload to Datalayer variable ProductViewPayload
// Should be triggered when a user lands on product page

<script type="text/javascript">
   window.dataLayer = window.dataLayer || [];
   dataLayer.push(
     {
      'event': 'ProductView',
      'ProductViewPayload':
       {
         'requestId': 'REQUEST ID',
         'pid': 'PRODUCT ID',
         'variantId': 'VARIANT ID OF SELECTED VARIANT'
       }
     });
</script>

Payload Details

Events Flow will be:

1. As soon as the ‘Productview` event got pushed to the dataLayer.
2. This initiates the trigger UnbxdProductViewTrigger which we created in the step-1.
3. UnbxdProductViewTrigger executes the tag UnbxdProductViewTag: which we created in step-3.
4. Inside UnbxdProductViewTrigger we have added an Unbxd analytics product view tag.
5. Product view tracker code gets the data from the variable UnbxdProductViewPayload which we created in step-2.
6. Finally, UnbxdProductViewTrigger event data will be updated in the Unbxd analytics database for the particular siteKey.

Facets Unbxd Tracker

A Facet event tracks the guided navigation on the Product Listing Page. The event query will list the specific filters the shopper has selected to narrow down the results on the search results page.

To track the facets a shopper has chosen on the Search page through GTM, we need to follow the below approach:

Create a Trigger in GTM to catch the product view.
Trigger Configuration:

• TriggerName: UnbxdFacetTrigger
• TriggerType: Custom Event
• EventName: UnbxdFacet
• TriggerFiresOn: All Custom Events

Create Variable in GTM to fetch the selected facet from the dataLayer.
Variable Configuration:

• VariableName: UnbxdFacetPayload
• Variable Type: Data Layer Variable
• Data Layer Variable Name: FacetPayload

Create a javascript tag with the below details.
Tag Configuration:

• Tag Name: UnbxdFacetTag
• Tag Type: Custom HTML
• HTML Content:

// Pass payload to Unbxd.track function
// to call the tracker API

<script type="text/javascript">
   var u_payload = {{UnbxdFacetPayload}};
   if (Unbxd && typeof Unbxd.track === 'function'
       && u_payload.hasOwnProperty("query")
       && u_payload.hasOwnProperty("facets")) {
       Unbxd.track('facets',u_payload);
   } else {
       console.error('unbxdAnalytics.js is not loaded or payload incorrect!')
   }
</script>

Please note that in case of search listing page, the Unbxd.track function will have arguments as “query” and “facets” and in case of category listing page, it will be “page”, “pagetype” and “facets”.

Pushing event to the dataLayer when the facet is selected.

// Add payload to Datalayer variable FacetPayload
// Should be triggered on search page
// when a user selects a facet

<script  type="text/javascript">
   window.dataLayer = window.dataLayer || [];
   dataLayer.push(
     {
      'event': 'UnbxdFacet',
      'FacetPayload':
       {
           'requestId': 'REQUEST ID',
           'facets': {"facet_name": ["facet_value", "facet_value"],
                      "facet_name": ["facet_value"]},
           'query': 'QUERY VALUE'
       }
     });
</script>

Payload Details

Events Flow will be:

1. As soon as the “UnbxdFacet” event got pushed to the dataLayer.
2. This initiates the trigger UnbxdFacetTrigger which we created in the step-1.
3. UnbxdFacetTrigger executes the tag UnbxdFacetTag: which we created in step-3.
4. Inside UnbxdFacetTrigger we have added an Unbxd analytics facet tag.
5. Facet tracker code gets the data from the variable UnbxdFacetPayload which we created in step-2.
6. Finally, “facet” event data will be updated in the Unbxd analytics database for the particular siteKey.