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 |
| Value determined by the page the user is on. |
ecomm_prodid |
| 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.
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 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 |
| 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. |
Product Clicks
pushed when clicking on a product link
- event
- Name of event
- list
- the list from which the product resides
- Product List
- Search Results
- Items Recently Viewed
- Campaign - Campaign Description
- CrossSell
- UpSell
- User Favourites
- Prior Purchases
- Cart Item
- the list from which the product resides
- name
- the product description
- id
- the product code
- category
- the primary category for the product
- brand
- the product brand
- price
- the product price
- only sent through if hide pricing on the role is not enabled
User Details
There is an option to only track logged in users
pushed on every page
{ "User_ID": "unique user id" }
Questionnaire
This is only for non widget questionnaires as the URL does not change after the questionnaire is submitted so a virtual URL is pushed.
Widget based questionnaires have a redirect URL after form submission
{ "virtualURL": "thank you URL" }
Checkout Options
- step
the step number
// Step 1 - going to the cart
// Step 2 - attempting to checkout but need to log in
// Step 3 - going to the delivery options
// Step 4 - going to the payment options
// Step 5 - going to submit the order
- products
- the products in the cart
checkout steps
checkout options
- step
the step number (from the checkout steps above)
- option
- The selected option at this step, for example the freight option selected at option 3 or payment method at option 4
Transactions
Pushed on successful submission of an order
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" }
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" }
Add to Cart
pushed on successful add to cart
- pageType
- The page the product was added from
- Product List
- Search Results
- Product Details
- The page the product was added from
- list
- The list the product was added from
- Product List
- Search Results
- Product Compare
- Items Recently Viewed
- Campaign - Campaign Description
- CrossSell
- UpSell
- User Favourites
- Prior Purchases
- Product Details
- Cart Fast Order
- Quick Order Entry
- The list the product was added from
Remove from Cart
pushed when a product is removed from the cart
Cart Updated
pushed when cart quantities are changed.
Increases trigger and "addToCart" push, while decreases trigger a "removeFromCart" push
Promo Codes
For promo codes we push success and fails when adding promo codes, we also push the removal of a promo code
invalid
{ "event": "invalidPromoCode", "promoCode": "XXXX" }
valid
{ "event": "validPromoCode", "promoCode": "XXXX" }
removed
{ "event": "removedPromoCode", "promoCode": "XXXX" }
View Order
Pushed when an order is viewed on the order tracking page
{ "virtualURL": "/TrackOrder/ViewOrder/Order Number" }
View Template
Pushed when a template is viewed on the order templates page
{ "virtualURL": "/OrderTemplates/Template Name" }
Extending or Overriding pushed data
If you want to push different data you can include this data by adding fields to the JSON field groups
SiteTrackerUserData-append (or SiteTrackerUserData_RoleName-append for role specific changes
- PrimaryTable Name = User
- You can also retrieve data from the users Role or Customer
SiteTrackerProductData-append (or SiteTrackerProductData_RoleName-append for role specific changes
- PrimaryTable Name = Product
SiteTrackerOrderData-append (or SiteTrackerOrderData_RoleName-append for role specific changes
- Primary Table Name = ProntoSalesOrder
- You can also retrieve field data from ProntoSalesOrderLine and Product
Options
- 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
$.cv.css.tracker.track("userDetail", "extend", function(data) { return { EmailAddress: data.EmailAddress }; });
Related articles