This guide details the data sent for various events, which can then be used with Tag Manager's Remarketing and Enhanced eCommerce functions.
Table of Contents
1. Digital Remarketing
Remarketing is the practice of advertising to past visitors of your website. If users leave your site without making a purchase, remarketing can help you reconnect by displaying relevant ads during their subsequent web browsing or searching.
BPD Remarketing data is pushed on every page of the website. Properties and their possible values are detailed below.
Property | Value | Notes |
---|---|---|
event | 'remarketing' | |
ecomm_pagetype | One of the following:
| Value determined by the page the user is on. |
ecomm_prodid | One of the following:
| Optional. Value determined by the page the user is on, and does not apply to page types 'home' or 'other'. |
ecomm_totalvalue | The total value of all products and charges (if any) | Optional. Only applies to page types 'product', 'cart, and 'purchase'. |
google_conversion_value | The total value of all products and charges | Optional. Only applies to page type 'purchase'. |
{ "event": "remarketing", "ecomm_pagetype": "home", "ecomm_prodid": ["ProductCode", "ProductCode"] or "ProductCode", "ecomm_totalvalue": "99.99", "google_conversion_value": "99.99" }
2. Enhanced eCommerce
Enhanced eCommerce is additional functionality for Google Analytics which allows richer data to be gathered, over and above the standard eCommerce transactional information gathered at the Order Confirmation step. Enhanced eCommerce data provides a more nuanced view of user behaviour, such as content engagement, product views, and cart actions.
BPD Enhanced eCommerce data is pushed for nearly every event type on the website. The data objects are outlined below, including properties and their possible values.
a. Product Impressions
Product Impression data is pushed when a product list is displayed. For example, a page of search results, products in a category, or a user's favourites.
Property | Value | Notes |
---|---|---|
event | 'enhancedEcomm' | Due to infinite scrolling, some pages may load additional data after the inital page load. For this reason, impressions are pushed via an event. Infinite scrolling creates a new event, and therefore a new data push. This also ensures that data is pushed in blocks, so as not to exceed the object data limit. |
event_type | 'impression' | |
currencyCode | The currency code for the current account | |
name | The product description | |
id | The product code | |
category | The product's primary category | |
list | One of the following:
| Value determined by the list in which the product is located. |
brand | The product's brand | |
position | The product's position / sequence in its list | |
price | The product price (nett price for 1) | If 'hide pricing' is enabled at Role level, this data is not pushed. |
b. Product Clicks
Product Click data is pushed on any click of a product link. For example, a product on a page of search results, or a product on the user's favourites list.
Property | Value | Notes |
---|---|---|
event | 'productClick' | |
list | One of the following:
| Value determined by the list in which the product is located. |
name | The product description | |
id | The product code | |
category | The product's primary category | |
brand | The product's brand | |
price | The product price (nett price for 1) | If 'hide pricing' is enabled at Role level, this data is not pushed. |
position | The product's position / sequence in its list |
c. User Details
User Detail data is pushed on every page of the site. There is the option to push data for logged in users only.
- 'User_ID' = the user's unique identifier (database field = user.userid )
{ "User_ID": "unique user id" }
d. Questionnaire
Questionnaire data is only pushed for non-widget-based questionnaires.
Since the URL does not change post submission, a virtual URL is pushed. (In contrast, widget-based questionnaires have a URL redirect post submission.)
{ "virtualURL": "thank you URL" }
e. Checkout Steps & Options
Steps - pushed as the user progresses through the various steps of the checkout process.
Property | Value | Notes |
---|---|---|
event | 'checkout' | |
event_type | 'checkout' | |
step | The checkout step number:
| Steps 3 & 4 will trigger additional 'Product Option' data to be pushed, in the form of the option selected at this step. For example, the freight option selected at Step 3 or the payment method selected at Step 4 (sample provided below). |
products | The products in the cart | Standard product data will be pushed for each product in the cart (e.g. name, id, category, brand, price). |
Options - pushed whenever the Checkout Step value (detailed above) is either 3 or 4.
Property | Value | Notes |
---|---|---|
event | 'checkoutOption' | |
event_type | 'checkout' | |
step | 3 or 4 | Value determined by the step number in 'Checkout Steps' data above. |
option | The option selected at this step | For example - 'pickup' at Step 3 or 'BPAY' at Step 4. |
f. Transactions
Product Transaction data is pushed on successful submission of an order.
Property | Value | Notes |
---|---|---|
event | 'enhancedEcomm' | |
event type | 'payment' | |
name | The product description | Repeated for each product in the transaction. |
id | The product code | Repeated for each product in the transaction. |
category | The product's primary category | Repeated for each product in the transaction. |
price | The product price (nett price for 1) | Repeated for each product in the transaction. |
g. Login Success
Login Success data is pushed on any successful login.
- The 'event' always = "login"
- The 'widgetName' = that of the widget used to initiate the login
{ "event": "login", "widgetName": "widget-name" }
h. Logout Success
Logout Success data is pushed on any successful logout.
- The 'event' always = "logout"
- The 'widgetName' = that of the widget used to initiate the logout
{ "event": "logout", "widgetName": "widget-name" }
i. Add to Cart
Add To Cart data is pushed every time a user successfully adds a product to their cart.
Property | Value | Notes |
---|---|---|
event | 'addToCart' | |
currencyCode | The currency code for the current account | |
products | The product(s) added to the cart | Standard product data is included here (e.g. name, id, category, quantity, brand, price) |
pageType | One of the following:
| Value determined by the page on which the product was added. |
list | One of the following:
| Value determined by the list from which the product was added |
j. Remove from Cart
Remove From Cart data is pushed whenever a product is successfully removed from the user's cart.
NOTE - This can be a whole line deletion, or a decrease in quantity. Both actions are sent as 'Remove From Cart' data.
Property | Value | Notes |
---|---|---|
event | 'removeFromCart' | |
currencyCode | The currency code for the current account | |
products | The product(s) removed from cart | Standard product data is included here (e.g. name, id, category, quantity, price). |
k. Cart Updated
Cart Updates will push the relevant Add or Remove data when product quantities are changed:
- Quantity increase triggers an "addToCart" data push
- Quantity decrease triggers a "removeFromCart" data push
l. Promotion Codes
The following data is automatically pushed in relation to Promotion Codes:
- success adding a promo code ('validPromoCode')
- failure adding a promo code ('invalidPromoCode')
- removal of a promo code ('removedPromoCode')
The event type and the promotion code is the only data sent in these instances.
{ "event": "validPromoCode", "promoCode": "XXXX" }
{ "event": "invalidPromoCode", "promoCode": "XXXX" }
{ "event": "removedPromoCode", "promoCode": "XXXX" }
m. View Order
View Order data is pushed when an order is viewed on the Order History / tracking page. The relevant sales order number is sent in this instance.
{ "virtualURL": "/TrackOrder/ViewOrder/Order Number" }
n. View Template
View Template data is pushed when a saved template is viewed on the Order Templates page. The template name is sent in this instance.
{ "virtualURL": "/OrderTemplates/Template Name" }
3. Extending or Overriding pushed data
It is possible to push additional data or to override Commerce Vision's out-of-the-box inclusions.
- First, determine the type of data you wish to push:
- User
- Product
- Order
- Identify the field name for the new data you require. This can be found in the relevant Dictionary table.
- In the CMS, navigate to Settings --> Dictionary.
- Enter the table in the 'TableName' field and click 'Define'.
Locate the required data field in the list.
For very large tables such as 'Customer', the Search function may be handy. With the table defined, enter a keyword in the 'Search For' box, select the 'Contains' option, and click 'Search' (not Enter key).
Next, include the new data by adding the field to the relevant JSON field group.
Data Type Dictionary Table JSON Field Group User Primary Table:
- User
Additional Tables:
- Role
- Customer
SiteTrackerUserData-append (or SiteTrackerUserData_RoleName-append for role-specific changes) Product Product SiteTrackerProductData-append (or SiteTrackerProductData_RoleName-append for role-specific changes) Order Primary Table:
- ProntoSalesOrder
Additional Tables:
- ProntoSalesOrderLine
- Product
SiteTrackerOrderData-append (or SiteTrackerOrderData_RoleName-append for role-specific changes) Finally, construct the tracking code using the format below.
Sample Data Extension code$.cv.css.tracker.track("userDetail", "extend", function(data) { return { EmailAddress: data.EmailAddress }; });
Insert diagram/screenshot here & clarify with AT.
- First param is the data to manipulate
- Second param is the type of manipulation
- extend
- override
- The third param is the function that will perform the manipulation
- The data is the raw data that can be used for manipulation (and includes the additional data from the JSON field groups described above)
- return an object with the properties and data to use
Extension methods
- userDetail
- pageType (this is for Digital Remarketing)
productImpressions
- productClick
questionnaire
checkout
checkoutOption
transactionProducts
loginSuccess
logoutSuccess
addToCart
removeFromCart
promoCodes
viewOrder
viewTemplate
Related articles