Page History

Set Up Google Tag Manager

1. Create an account

See http://www.google.com/tagmanager/get-started.html on how to setup an account to use with Google Tag manager.

2. Check resource

Check resource rcGoogleTagManagerInitialiser. It should contain something similar to the following:

3. Set the Google Tag Manager ID

Go to the Settings admin page and set the Google Tag Manager ID to what Google has given you (most likely in the format 'GTM-XXXX').

4. Create a template (optional)

This is not necessary as there is a default template that you can use. It is called CV_OpeningBodyTemplate. This template contains the following: 

5. Set templates

There are two templates that you can set:

• Global - one for all users.
• Role-based - one for users in specific roles.

The default template is called CV_OpeningBodyTemplate.

Global

To use the tag manager for all users, go to the default templates admin page. Set the Opening Body Template to the default template or another template you created.

Role-based

To use the tag manager for users in specific roles, go to the role management admin page (see Templates tab). Set the Opening Body Template to the default template or another template you created.

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. 

 Enhanced Ecommerce

Enhanced Ecommerce is additional functionality for Google Analytics. It allows richer data to be gathered beyond 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 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:

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

 Enhanced Ecommerce

Enhanced Ecommerce is additional functionality for Google Analytics. It allows richer data to be gathered beyond 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

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.

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 ) 

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

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.

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

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

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.

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

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 ) 

{
	"User_ID": "unique user id"
}

Anchor
ecomquestion ecomquestion

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

{
	"virtualURL": "thank you URL"
}

Anchor
ecomcheckout ecomcheckout

Checkout Steps & Options

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

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

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

Anchor
ecomtrans ecomtrans

Transactions

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

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

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.

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.

Login Success data is pushed on any successful login.  

• The 'event' always = "login"

• The 'widgetName' = that of the widget used to initiate the login 

Logout Success data is pushed on any successful logout.  

• The 'event' always = "logout"

• The 'widgetName' = that of the widget used to initiate the logout 

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.

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

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

Anchor
ecomlogout ecomlogout

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

Anchor
ecomaddtocart ecomaddtocart

Add to Cart

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

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

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.

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

in quantity. Both actions are sent as 'Remove From Cart' data.

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

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

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.

{
	"event": "validPromoCode",
	"promoCode": "XXXX"
}

{
	"event": "removedPromoCode",
	"promoCode": "XXXX"
}

{
	"virtualURL": "/TrackOrder/ViewOrder/Order Number"
}

Anchor
ecomvieworder ecomvieworder

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.

Anchor
ecomviewtemplate ecomviewtemplate

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.

{
	"virtualURL": "/OrderTemplates/Template Name"
}

Anchor
extend extend

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

   
   

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) 

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

Related help