Versions Compared

Key

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

Describe when someone would need this information. For example "when connecting to wi-fi for the first time".

Step-by-step guide

 

Out of the box data

Digital Remarketing

pushed on every page

...

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

  3. Extending or Overriding Pushed Data

 

Anchor
remarketing
remarketing
Digital Remarketing

Remarketing is the act 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
eventremarketing 
ecomm_pagetype
  • other
  • home
  • category
  • product
  • cart
  • purchase
Value determined by the page the user is on.
ecomm_prodid

...

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

Anchor
ecomimpressions
ecomimpressions
Product Impressions

pushed when a product list is displayed

...

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

 

Anchor
ecomclicks
ecomclicks
Product Clicks

pushed when clicking on a product link

...

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

 

Anchor
ecomuser
ecomuser
User Details

There is an option to only track logged in users

...

Code Block
languagejs
{
	"User_ID": "unique user id"
}

 

Anchor
ecomquestion
ecomquestion
Questionnaire

This is only for non widget questionnaires as the URL does not change after the questionnaire is submitted so a virtual URL is pushed.

...

Code Block
languagejs
{
	"virtualURL": "thank you URL"
}

 

Anchor
ecomcheckout
ecomcheckout
Checkout Options

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

 

Anchor
ecomtrans
ecomtrans
Transactions

Pushed on successful submission of an order

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

pushed on a successful login

...

Code Block
languagejs
{
	"event": "login",
	"widgetName": "widget-name"
}

 

Anchor
ecomlogout
ecomlogout
Logout Success

pushed on a successful logout

...

Code Block
languagejs
{
	"event": "logout",
	"widgetName": "widget-name"
}

 

Anchor
ecomaddtocart
ecomaddtocart
Add to Cart

pushed on successful add to cart

...

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

pushed when a product is removed from the cart

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

pushed when cart quantities are changed.

...

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

 

Anchor
ecomvieworder
ecomvieworder
View Order

Pushed when an order is viewed on the order tracking page

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

 

Anchor
ecomviewtemplate
ecomviewtemplate
View Template

Pushed when a template is viewed on the order templates page

Code Block
languagejs
{
	"virtualURL": "/OrderTemplates/Template Name"
}

 

Anchor
extend
extend
Extending or Overriding pushed data

...

Code Block
$.cv.css.tracker.track("userDetail", "extend", function(data) {
	return { EmailAddress: data.EmailAddress };
});
Info

Content by Label
showLabelsfalse
max5
spacesKB
sortmodified
showSpacefalse
reversetrue
typepage
labelskb-how-to-article