Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Overview


Excerpt
hiddentrue

Google's Tag Manager

...

lets administrators and digital marketers

...

track user behaviour and improve conversion rates on their websites.

...

Commerce Vision websites

...

have tracking functionality enabled out of the box, pushing rich data on nearly every site event.


Google's Tag Manager lets administrators and digital marketers track user behaviour and improve conversion rates on their websites. Commerce Vision websites have tracking functionality enabled out of the box, pushing rich data on nearly every site event.


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

  2. Enhanced eCommerce

  3. Extending or Overriding Pushed Data

 

 



Multiexcerpt
hiddentrue
MultiExcerptNameFeature Overview

Websites have tracking functionality for Google Tag Manager enabled out of the box, pushing rich data on nearly every site event.





Tip

The 'Data Layer Doctor' extension for Chrome may be useful in viewing data objects during testing. It allows you to check the contents of a data layer and verify it against your specifications.



Panel

On this page:

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. 

PropertyValueNotes
event'remarketing'

...


ecomm_pagetype

...

One of the following:

  • home
  • category
  • product
  • cart
  • purchase
  • other

Value determined by the page the user is on.

...

  • Product code (product pages)

  • Array of product codes (category, cart, purchase pages)

...

For example:

  • 'home' = the site's home page
  • 'category' = a category page listing products
  • 'product' = the product detail page
  • 'cart' = the shopping cart
  • 'purchase' = the confirmation screen once an order has successfully been submitted
  • 'other' = any page not covered above (eg. Favourites, Checkout Delivery Address, Dashboard, etc)
ecomm_prodid

One of the following:

  • Product code (product pages)

  • Array of product codes (category, cart, purchase pages)

Optional. Value determined by the page the user is on, and does not apply to page types 'home' or 'other'.
ecomm_totalvalueThe total value of all products and charges (if any)Optional. Only applies to page types 'product', 'cart, and 'purchase'.
google_conversion_valueThe total value of all products and chargesOptional. Only applies to page type 'purchase'.


Code Block
languagejs
titleSample Remarketing data
{
    "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

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.

PropertyValueNotes
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'

...


currencyCodeThe currency code for the current account

...


nameThe product description

...


idThe product code

...


categoryThe product's primary category

...

Includes all levels of the category structure for the product's primary category.
list*

One of the following:

  • Product List
  • Search Results
  • Items Recently Viewed
  • Campaign - (sent as the Campaign Description, not the Campaign Code)
  • CrossSell - (Alternate products)
  • UpSell

...

  • - (Accessories / Related products)
  • User Favourites
  • Prior Purchases
  • Product Details - (This value

...

  • only applies where the user has navigated directly to a product via link or similar. Otherwise, the list from which the product was accessed will be used for product detail impressions.)

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.

brandThe product's brand

...


positionThe product's position / sequence in its list

...


priceThe product price (nett price for 1)If 'hide pricing' is enabled at Role level, this data is not pushed.


Code Block
languagejs
titleSample Product Impression data
collapsetrue
{
	"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

...

language

...

js

...

title

...

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
  • 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

 

...

languagejs

...

Sample Product Detail Impression data
collapsetrue
{
	"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

...

There is an option to only track logged in users

pushed on every page

Code Block
languagejs
{
	"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
languagejs
{
	"virtualURL": "thank you URL"
}

 

...

  • step
    • the step number
  • option
    • Cart
    • Login
    • Address
    • Payment
    • Order Complete

 

Code Block
languagejs
{
	"event": "checkoutOption",
	"event_type": "checkout",
	"ecommerce": {
		"checkout_option": {
			"actionField": {
				"step": 1,
				"option": "Cart"
			}
		}
	}
}

 

...

Pushed on successful submission of an order

...

languagejs

...

ecomclicks
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.

PropertyValueNotes
event

'productClick'


list*

One of the following:

  • Product List
  • Search Results
  • Items Recently Viewed
  • Campaign - (sent as the Campaign Description, not the Campaign Code)
  • CrossSell - (Alternate products)
  • UpSell - (Accessories / Related products)
  • User Favourites
  • Prior Purchases
  • Cart Item

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.

nameThe product description
idThe product code
categoryThe product's primary categoryIncludes all levels of the category structure for the product's primary category.
brandThe product's brand
positionThe product's position / sequence in its list
priceThe product price (nett price for 1)If 'hide pricing' is enabled at Role level, this data is not pushed.


Code Block
languagejs
titleSample Product Click data
collapsetrue
{
	"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

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
languagejs

...

titleSample User Detail data
collapsetrue
{
	"

...

User_ID": "

...

unique user id"
}

...



Anchor

...

ecomquestion

...

pushed on a successful logout

...

ecomquestion
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.)

Code Block
languagejs
titleSample Questionnaire data
collapsetrue
{
	"

...

virtualURL": "

...

thank you URL"
}

 



Anchor

...

ecomcheckout

...

pushed on successful add to cart

  • pageType
    • The page the product was added from
      • Product List
      • Search Results
      • Product Details
  • 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

...

languagejs

ecomcheckout
e. Checkout Steps & Options

Steps - pushed as the user progresses through the various steps of the checkout process.

PropertyValueNotes
event'checkout'
event_type'checkout'
step

The checkout step number:

  • 1 - going to cart
  • 2 - attempting checkout, but login required
  • 3 - selecting delivery option
  • 4 - selecting payment option
  • 5 - submitting the order


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).

productsThe products in the cartStandard product data will be pushed for each product in the cart (e.g. name, id, category, brand, price).


Code Block
languagejs
titleSample Checkout Steps data
collapsetrue
{
	"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

...

languagejs

...


}


Options - pushed whenever the Checkout Step value (detailed above) is either 3 or 4. 

PropertyValueNotes
event'checkoutOption'
event_type'checkout'
step3 or 4Value determined by the step number in 'Checkout Steps' data above.
optionThe option selected at this stepFor example - 'pickup' at Step 3 or 'BPAY' at Step 4.


Code Block
languagejs
titleSample Checkout Option data
collapsetrue
{
	"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
languagejs
{
	"event": "invalidPromoCode",
	"promoCode": "XXXX"
}

valid

Code Block
languagejs
{
	"event": "validPromoCode",
	"promoCode": "XXXX"
}

removed

Code Block
languagejs
{
	"event": "removedPromoCode",
	"promoCode": "XXXX"
}

 

...

Pushed when an order is viewed on the order tracking page

Code Block
languagejs
{
	"virtualURL": "/TrackOrder/ViewOrder/Order Number"
}

 

...

Pushed when a template is viewed on the order templates page

Code Block
languagejs
{
	"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

  1. First param is the data to manipulate
  2. Second param is the type of manipulation
    1. extend
    2. override
  3. The third param is the function that will perform the manipulation
    1. The data is the raw data that can be used for manipulation (and includes the additional data from the JSON field groups described above)
    2. 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

Product Transaction data is pushed on successful submission of an order. 

PropertyValueNotes
event'enhancedEcomm'
event type'payment'
nameThe product descriptionRepeated for each product in the transaction.
idThe product codeRepeated for each product in the transaction.
categoryThe product's primary category

Includes all levels of the category structure for the product's primary category.

Repeated for each product in the transaction.

priceThe product price (nett price for 1)Repeated for each product in the transaction.


Code Block
languagejs
titleSample Transaction data
collapsetrue
{
	"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

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
languagejs
titleSample Login Success data
collapsetrue
{
	"event": "login",
	"widgetName": "widget-name"
}


Anchor
ecomlogout
ecomlogout
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 
Code Block
languagejs
titleSample Logout Success data
collapsetrue
{
	"event": "logout",
	"widgetName": "widget-name"
}


Anchor
ecomaddtocart
ecomaddtocart
i. Add to Cart

Add To Cart data is pushed every time a user successfully adds a product to their cart. 

PropertyValueNotes
event'addToCart'
currencyCode The currency code for the current account
productsThe product(s) added to the cartStandard product data is included here (e.g. name, id, category, quantity, brand, price)
pageType

One of the following:

  • Product List
  • Search Results
  • Product Details
Value determined by the page on which the product was added.
list*

One of the following:

  • Product List
  • Search Results
  • Product Compare
  • Items Recently Viewed
  • Campaign - (sent as the Campaign Description, not the Campaign Code)
  • CrossSell - (Alternate products)
  • UpSell - (Accessories / Related products)
  • User Favourites
  • Prior Purchases
  • Product Details
  • Cart Fast Order
  • Quick Order Entry

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
languagejs
titleSample Add To Cart data
collapsetrue
{
	"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

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.

PropertyValueNotes
event'removeFromCart'
currencyCodeThe currency code for the current account
productsThe product(s) removed from cartStandard product data is included here (e.g. name, id, category, quantity, price).


Code Block
languagejs
titleSample Remove From Cart data
collapsetrue
 {
	"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

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

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
languagejs
titleSample Valid Promo Code data
collapsetrue
{
	"event": "validPromoCode",
	"promoCode": "XXXX"
}


Code Block
languagejs
titleSample Invalid Promo Code data
collapsetrue
{
	"event": "invalidPromoCode",
	"promoCode": "XXXX"
}


Code Block
languagejs
titleSample Removed Promo Code data
collapsetrue
{
	"event": "removedPromoCode",
	"promoCode": "XXXX"
}


Anchor
ecomvieworder
ecomvieworder
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.

Code Block
languagejs
titleSample View Order data
collapsetrue
{
	"virtualURL": "/TrackOrder/ViewOrder/Order Number"
}


Anchor
ecomviewtemplate
ecomviewtemplate
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.

Code Block
languagejs
titleSample View Template data
collapsetrue
{
	"virtualURL": "/OrderTemplates/Template Name"
}


Anchor
extend
extend
3. Extending or Overriding pushed data

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:

  1. Determine the type of additional data required to push:
    • User
    • Product
    • Order
       
  2. Include the new data by adding the field to the relevant JSON field group. 

    Data TypeDictionary TableJSON Field Group
    User

    Primary Table:

    • User

    Additional Tables:

    • Role
    • Customer
    SiteTrackerUserData(or SiteTrackerUserData_RoleNamefor role-specific changes)
    ProductProductSiteTrackerProductData (or SiteTrackerProductData_RoleNamefor role-specific changes)
    Order

    Primary Table:

    • ProntoSalesOrder

    Additional Tables:

    • ProntoSalesOrderLine
    • Product
    SiteTrackerOrderData(or SiteTrackerOrderData_RoleNamefor role-specific changes)


  3. 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
    titleSample 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
MultiExcerptNameAdditional Info
Allows administrators and digital marketers to track user behaviour and improve conversion rates on their websites.


Multiexcerpt
hiddentrue
MultiExcerptNameFeature Title

Google Tag Manager and BPD


Minimum Version Requirements


Multiexcerpt
MultiExcerptNameMinimum Version Requirements

3.87.00


Prerequisites


Multiexcerpt
MultiExcerptNamePre reqs

Google Tag ID required.


Self Configurable


Multiexcerpt
MultiExcerptNameSelf Configurable

Yes


Business Function


Multiexcerpt
MultiExcerptNameBusiness Function

Data Analytics


BPD Only?


Multiexcerpt
MultiExcerptNameBPD Only

Yes


B2B/B2C/Both


Multiexcerpt
MultiExcerptNameB2B/B2C/Both

Both


Third Party Costs


Multiexcerpt
MultiExcerptNameThird Party Costs
n/a


  

Related help

Content by Label
showLabelsfalse
max

...

10
spacesKB
showSpacefalse
sortmodified
reversetrue

...

type

...

page

...

excludeCurrenttrue
cql

...

label in ("how-to","google","analytics","tags","seo") and type = "page" and space = "KB"
labelskb-how-to-article