...
...
...
...
...
...
Table of Contents
Anchor remarketing remarketing
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. |
...
Product code (product pages)
Array of product codes (category, cart, purchase pages)
...
For example:
| ||
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'. |
Code Block | ||||
---|---|---|---|---|
| ||||
{
"event": "remarketing",
"ecomm_pagetype": "home",
"ecomm_prodid": ["ProductCode", "ProductCode"] or "ProductCode",
"ecomm_totalvalue": "99.99",
"google_conversion_value": "99.99"
} |
...
Anchor
ecommerce ecommerce
...
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.
...
Anchor ecomimpressions ecomimpressions
a. Product Impressions
ecomimpressions | |
ecomimpressions |
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 |
...
initial 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 |
...
Google's 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 |
...
Includes all levels of the category structure for the product's primary category. | |
list* | One of the following:
|
...
|
...
| Value determined by the list in which the product is located. *Note - Zoned Product Layout must be used in order for Enhanced eCommerce to work with lists. |
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. |
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
{
"event": "enhancedEcomm",
"event_type": "impression",
"ecommerce": {
"currencyCode": "AUD",
"impressions": [
{
"name": "Product Description",
"id": "ProductCode",
"list": "list name",
"category": "/first level/second level/third level",
"brand": "brand name",
"position": 1,
"price": "99.99"
}
]
}
} |
...
Code Block |
---|
...
|
...
|
...
|
...
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
...
language | js |
---|
...
| |||
{ "event": "enhancedEcomm", "event_type": "impression", "ecommerce": { "currencyCode": "AUD", "detail": { "actionField": { "list": "list name" }, "products": [ { "name": "Product Description", "id": "ProductCode", "category": "/first level/second level/third level", "brand": "brand name", "price": "99.99" } ] } } } |
...
Anchor
...
ecomclicks
ecomclicks |
...
There is an option to only track logged in users
pushed on every page
Code Block | ||
---|---|---|
| ||
{
"User_ID": "unique user id"
} |
...
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
Code Block | ||
---|---|---|
| ||
{
"virtualURL": "thank you URL"
} |
...
- step
- the step number
- option
- Cart
- Login
- Address
- Payment
- Order Complete
Code Block | ||
---|---|---|
| ||
{
"event": "checkoutOption",
"event_type": "checkout",
"ecommerce": {
"checkout_option": {
"actionField": {
"step": 1,
"option": "Cart"
}
}
}
} |
...
Pushed on successful submission of an order
...
language | js |
---|
...
ecomclicks
b. Product Clicks
ecomclicks |
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. *Note - Zoned Product Layout must be used in order for Enhanced eCommerce to work with lists. |
name | The product description | |
id | The product code | |
category | The product's primary category | Includes all levels of the category structure for the product's primary category. |
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. |
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
{ "event": "productClick", "ecommerce": { "click": { "actionField": { "list": "list name" }, "products": [ { "name": "Product Description", "id": "ProductCode", "category": "/first level/second level/third level", "brand": "brand name", "price": "99.99", "position": 1 } |
...
] |
...
} |
...
pushed on a successful login
- widgertName
- The name of the widget used to login
}
} |
Anchor ecomuser ecomuser
c. User Details
ecomuser | |
ecomuser |
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 )
Code Block | ||
---|---|---|
|
...
| |||||
{ " |
...
User_ID": " |
...
unique user id" } |
...
Anchor
...
ecomquestion
ecomquestion |
...
pushed on a successful logout
...
ecomquestion
d. Questionnaire
ecomquestion |
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.)
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
{
" |
...
virtualURL": " |
...
thank you URL" } |
Anchor
...
ecomcheckout
ecomcheckout |
...
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
...
language | js |
---|
ecomcheckout
e. Checkout Steps & Options
ecomcheckout |
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). |
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
{
"event": " |
...
checkout", " |
...
event_type": |
...
"checkout", |
...
" |
...
ecommerce": |
...
{ " |
...
checkout": { "actionField": { "step": 1 }, "products": [ { "name": "Product Description", "id": "ProductCode", "category": "/first level/second level/third level", |
...
" |
...
brand": "brand name",
"price": "99.99"
}
]
}
} |
...
...
pushed when a product is removed from the cart
...
language | js |
---|
...
} |
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. |
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
{ "event": " |
...
checkoutOption", " |
...
event_type": |
...
"checkout", |
...
" |
...
ecommerce": |
...
{ " |
...
checkout_option": { " |
...
actionField": |
...
{
" |
...
step": |
...
4, " |
...
option": " |
...
BPAY" |
...
} |
...
...
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
Code Block | ||
---|---|---|
| ||
{
"event": "invalidPromoCode",
"promoCode": "XXXX"
} |
valid
Code Block | ||
---|---|---|
| ||
{
"event": "validPromoCode",
"promoCode": "XXXX"
} |
removed
Code Block | ||
---|---|---|
| ||
{
"event": "removedPromoCode",
"promoCode": "XXXX"
} |
...
Pushed when an order is viewed on the order tracking page
Code Block | ||
---|---|---|
| ||
{
"virtualURL": "/TrackOrder/ViewOrder/Order Number"
} |
...
Pushed when a template is viewed on the order templates page
Code Block | ||
---|---|---|
| ||
{
"virtualURL": "/OrderTemplates/Template Name"
} |
...
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
Code Block |
---|
$.cv.css.tracker.track("userDetail", "extend", function(data) {
return { EmailAddress: data.EmailAddress };
}); |
...
}
}
} |
Anchor ecomtrans ecomtrans
f. Transactions
ecomtrans | |
ecomtrans |
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 | Includes all levels of the category structure for 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. |
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
{
"event": "enhancedEcomm",
"event_type": "payment",
"ecommerce": {
"purchase": {
"actionField": {
"id": 100000000,
"revenue": 99.99,
"tax": 9.99,
"shipping": 10.00
}
},
"products": [
{
"name": "Product Description",
"id": "ProductCode",
"category": "/first level/second level/third level",
"price": "99.99"
}
]
}
} |
Anchor ecomlogin ecomlogin
g. Login Success
ecomlogin | |
ecomlogin |
Login Success data is pushed on any successful login.
- The 'event' always = "login"
- The 'widgetName' = that of the widget used to initiate the login
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
{
"event": "login",
"widgetName": "widget-name"
} |
Anchor ecomlogout ecomlogout
h. Logout Success
ecomlogout | |
ecomlogout |
Logout Success data is pushed on any successful logout.
- The 'event' always = "logout"
- The 'widgetName' = that of the widget used to initiate the logout
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
{
"event": "logout",
"widgetName": "widget-name"
} |
Anchor ecomaddtocart ecomaddtocart
i. Add to Cart
ecomaddtocart | |
ecomaddtocart |
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 *Note - Zoned Product Layout must be used in order for Enhanced eCommerce to work with lists. |
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
{
"event": "addToCart",
"ecommerce": {
"currencyCode": "AUD",
"add": {
"products": [
{
"name": "Product Description",
"id": "ProductCode",
"category": "/first level/second level/third level",
"quantity": 1,
"brand": "brand name",
"price": "99.99"
}
]
}
},
"pageType": "Product List",
"list": "Product List"
} |
Anchor ecomremovefromcart ecomremovefromcart
j. Remove from Cart
ecomremovefromcart | |
ecomremovefromcart |
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). |
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
{
"event": "removeFromCart",
"ecommerce": {
"currencyCode": "AUD",
"remove": {
"products": [
{
"name": "Product Description",
"id": "ProductCode",
"category": "/first level/second level/third level",
"quantity": 1,
"price": "99.99"
}
]
}
}
} |
Anchor ecomcartupdate ecomcartupdate
k. Cart Updated
ecomcartupdate | |
ecomcartupdate |
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
Anchor ecompromo ecompromo
l. Promotion Codes
ecompromo | |
ecompromo |
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.
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
{
"event": "validPromoCode",
"promoCode": "XXXX"
} |
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
{
"event": "invalidPromoCode",
"promoCode": "XXXX"
} |
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
{
"event": "removedPromoCode",
"promoCode": "XXXX"
} |
Anchor ecomvieworder ecomvieworder
m. View Order
ecomvieworder | |
ecomvieworder |
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.
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
{
"virtualURL": "/TrackOrder/ViewOrder/Order Number"
} |
Anchor ecomviewtemplate ecomviewtemplate
n. View Template
ecomviewtemplate | |
ecomviewtemplate |
View Template data is pushed when a saved template is viewed on the Order Templates page. The template name is sent in this instance.
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
{
"virtualURL": "/OrderTemplates/Template Name"
} |
Anchor extend extend
3. Extending or Overriding pushed data
extend | |
extend |
It is possible to push additional data or to override Commerce Vision's out-of-the-box inclusions. For assistance with this, please contact a Commerce Vision Consultant.
CV internal use:
- Determine the type of additional data required to push:
- User
- Product
- Order
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(or SiteTrackerUserData_RoleNamefor role-specific changes) Product Product SiteTrackerProductData (or SiteTrackerProductData_RoleNamefor role-specific changes) Order Primary Table:
- ProntoSalesOrder
Additional Tables:
- ProntoSalesOrderLine
- Product
SiteTrackerOrderData(or SiteTrackerOrderData_RoleNamefor role-specific changes) Finally, construct the tracking code per the format below.
- First parameter is the data to manipulate (e.g. "userDetail" in sample code)
- Second parameter is the type of manipulation:
- extend
- override
- The third parameter is the function that will perform the manipulation (e.g. "EmailAddress: data.EmailAddress" in sample code)
- The data is the raw data that can be used for manipulation (and includes the additional data from the JSON field groups described above)
Code Block title Sample Data Extension code $.cv.css.tracker.track("userDetail", "extend", function(data) { return { EmailAddress: data.EmailAddress }; });
Possible extension methods:
- userDetail
- pageType (this is for Digital Remarketing)
productImpressions
- productClick
questionnaire
checkout
checkoutOption
transactionProducts
loginSuccess
logoutSuccess
addToCart
removeFromCart
promoCodes
viewOrder
viewTemplate
Additional Information
Multiexcerpt | ||
---|---|---|
| ||
Allows administrators and digital marketers to track user behaviour and improve conversion rates on their websites. |
Multiexcerpt | ||||
---|---|---|---|---|
| ||||
Minimum Version Requirements |
| |||||
---|---|---|---|---|---|---|
Prerequisites |
| |||||
Self Configurable |
| |||||
Business Function |
| |||||
BPD Only? |
| |||||
B2B/B2C/Both |
| |||||
Third Party Costs |
|
Related help
Content by Label | |||
---|---|---|---|
|
...
|
...
|
...
|
...
|
...
|