Page History

Overview

Multiexcerpt

MultiExcerptName	Feature 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.

Property	Value	Notes
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_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

language	js
title	Sample Remarketing data

{
    "event": "remarketing",
	"ecomm_pagetype": "home",
	"ecomm_prodid": ["ProductCode", "ProductCode"] or "ProductCode",
	"ecomm_totalvalue": "99.99",
	"google_conversion_value": "99.99"
}

...

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

language	js
title	Sample Product Impression data
collapse	true

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

...

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

language	js
title	Sample Product Click data
collapse	true

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

...

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

language	js
title	Sample Checkout Steps data
collapse	true

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

...

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

language	js
title	Sample Checkout Option data
collapse	true

{
	"event": "checkoutOption",
	"event_type": "checkout",
	"ecommerce": {
		"checkout_option": {
			"actionField": {
				"step": 4,
				"option": "BPAY"
			}
		}
	}
}

...

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

language	js
title	Sample Transaction data
collapse	true

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

...

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

language	js
title	Sample Add To Cart data
collapse	true

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

...

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

language	js
title	Sample Remove From Cart data
collapse	true

 {
	"event": "removeFromCart",
	"ecommerce": {
		"currencyCode": "AUD",
		"remove": {
			"products": [
			{
				"name": "Product Description",
				"id": "ProductCode",
				"category": "/first level/second level/third level",
				"quantity": 1,
				"price": "99.99"
			}
			]
		}
	}
}

...

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-append (or SiteTrackerUserData_RoleName-append for role-specific changes)

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 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 }; });

...

userDetail
pageType (this is for Digital Remarketing)
productImpressions
productClick
questionnaire
checkout
checkoutOption
transactionProducts
loginSuccess
logoutSuccess
addToCart
removeFromCart
promoCodes
viewOrder
viewTemplate

...

Additional Information

...

Multiexcerpt

contentbylabel

MultiExcerptName

showLabelsfalsemax5spacesKBsortmodifiedshowSpacefalse

Additional Info

Please be advised that the creation of the XML product feed is classed as a minor project by Commerce Vision, and therefore attracts an implementation fee.

Multiexcerpt

hidden	true
MultiExcerptName	Feature Title

Google Shopping - Product Feeds

Minimum Version Requirements:

Multiexcerpt

MultiExcerptName	Minimum Version Requirements

**.**.**

BPD Only:

Multiexcerpt

MultiExcerptName	BPD Only

Yes

Business Function:

Multiexcerpt

MultiExcerptName	Business Function

Marketing

CMS Category:

Multiexcerpt

MultiExcerptName	CMS Category

B2B/B2C/Both:

Multiexcerpt

MultiExcerptName	B2B/B2C/Both

Both

Self Configurable:

Multiexcerpt

MultiExcerptName	Self Configurable

Yes

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

Multiexcerpt

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

Contact CV Support

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

Multiexcerpt

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

Contact CV Support

Third Party Costs:

Multiexcerpt

MultiExcerptName	Third Party Costs

You pay-per-click with an associated Google AdWords account

Prerequisites:

Multiexcerpt

MultiExcerptName	Pre reqs

This feature requires a Shopping campaign in Google AdWords linked to your Merchant Center account

Space shortcuts

Page tree

Versions Compared

Old Version 46

New Version 47

Key

Overview

Table of Contents

Digital Remarketing

Enhanced eCommerce

Extending or Overriding Pushed Data

Additional Information

Related articles