Versions Compared

Key

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

Overview


Multiexcerpt
MultiExcerptNameFeature Overview


Excerpt

Google's Tag Manager allows administrators and digital marketers to track user behaviour and improve conversion rates on their websites. To this end, Commerce Vision websites on version 3.87+ now 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

    1. Product Impressions
    2. Product Clicks
    3. User Details
    4. Questionnaires
    5. Checkout Steps & Options
    6. Transactions
    7. Login Success
    8. Logout Success
    9. Add to Cart
    10. Remove from Cart
    11. Cart Updated
    12. Promotion Codes
    13. View Order
    14. View Template 
  3. Extending or Overriding Pushed Data

 


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.

...


Anchor
remarketing
remarketing

...

PropertyValueNotes
event'remarketing' 
ecomm_pagetype

One of the following:

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

Value determined by the page the user is on. 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

...

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

...

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 categoryIncludes 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 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
ecomclicks
b. Product Clicks

...

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
			}
			]
		}
	}
}

 

...



Anchor
ecomuser
ecomuser
c. User Details

...

Code Block
languagejs
titleSample User Detail data
collapsetrue
{
	"User_ID": "unique user id"
}

...

 



Anchor
ecomquestion
ecomquestion
d. Questionnaire

...

Code Block
languagejs
titleSample Questionnaire data
collapsetrue
{
	"virtualURL": "thank you URL"
}

 

 



Anchor
ecomcheckout
ecomcheckout
e. Checkout Steps & Options

...

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

...

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"
			}
		}
	}
}

 

...



Anchor
ecomtrans
ecomtrans
f. Transactions

...

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

...


Anchor
ecomlogout
ecomlogout
h. Logout Success

...

Code Block
languagejs
titleSample Logout Success data
collapsetrue
{
	"event": "logout",
	"widgetName": "widget-name"
}

 


Anchor
ecomaddtocart
ecomaddtocart
i. Add to 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

...

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

...

  • Quantity increase triggers an "addToCart" data push
  • Quantity decrease triggers a "removeFromCart" data push

 


Anchor
ecompromo
ecompromo
l. Promotion Codes

...

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

...


Anchor
ecomvieworder
ecomvieworder
m. View Order

...

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

...


Anchor
ecomviewtemplate
ecomviewtemplate
n. View Template

...

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

...


Anchor
extend
extend
3. Extending or Overriding pushed data

...

  • 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
(Google Tag ID required)


Multiexcerpt
hiddentrue
MultiExcerptNameFeature Title

Google Tag Manager and BPD


Minimum Version Requirements


Multiexcerpt
MultiExcerptNameMinimum Version Requirements

3.87.00


Prerequisites


Multiexcerpt
MultiExcerptNamePre reqs

--


Self Configurable


Multiexcerpt
MultiExcerptNameSelf Configurable

Yes


Business Function


Multiexcerpt
MultiExcerptNameBusiness Function

Marketing


BPD Only?


Multiexcerpt
MultiExcerptNameBPD Only

Yes


B2B/B2C/Both


Multiexcerpt
MultiExcerptNameB2B/B2C/Both

Both


Ballpark Hours From CV (if opting for CV to complete self config component)


Multiexcerpt
MultiExcerptNameBallpark Hours From CV (if opting for CV to complete self config component)

1


Ballpark Hours From CV (in addition to any self config required)


Multiexcerpt
MultiExcerptNameBallpark Hours From CV (in addition to any self config required)

n/a


Third Party Costs


Multiexcerpt
MultiExcerptNameThird Party Costs
n/a


CMS Category


Multiexcerpt
MultiExcerptNameCMS Category

 Feature Management - Analytics


   

       

 

Related

...

help

Content by Label
showLabelsfalse
max10
spacesKB
showSpacefalse
sortmodified
reversetrue
typepage
excludeCurrenttrue
cqllabel in ("how-to","google","analytics","tags","seo") and type = "page" and space = "KB"
labelskb-how-to-article