Page History

2. Set templates (optional)

You can select to include all users or a subgroup based on Role by setting relevant templates:

• Set global - one template for all users
• Set role-based - template for users in a specific role.

Set Global

To set the global template, 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 uses Analytics with Google's digital marketing and remarketing solutions, e.g., Google Ads etc by personalising ads shown to past visitors of your website who are still on Google or partner websites. What ads are shown to a user is based on their past behaviour matching a behavioral profile. When there is a match, the user is added to that user segment. Segment rules set up personalise what kind of ads are displayed. For example, you might create a segment of 'website visitors' - users who leave your site without making a purchase. You could have rules that show them ads of products they clicked on or added to cart, when they continue to browse and search the internet. Remarketing in a targeted way like this may help bring them back to your site and make a purchase.

See: Remarketing with Google Analytics 

Remarketing data from every page of the website are pushed to Google. What data (property + its value) is sent with each page type are listed. 

Property

Value

Notes

event

'remarketing'

ecomm_pagetype

• other

• home

• category

• product

• cart

• purchase

Value determined by the page the user is on. For example:

• 'other' = any other page not specifically listed (eg. Favourites, Checkout Delivery Address, Dashboard, etc).

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

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

check

{
    "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 extra functionality you can add to Google Analytics. It allows the gathering of richer data about buyers and visitors on your website. Instead of just the standard ecommerce transactional information at the Order Confirmation step, activities such as when they add items to cart, when they remove items, when they abandon their carts and leave without purchasing, where they begin checkout, etc, are also collected. This data can be used to produce reports of shopper behaviour patterns for analysis. 

Enhanced ecommerce data is pushed for nearly every event type on the website. The data objects, including properties and their possible values, are outlined below. 

Product Impression data is pushed whenever a product list is displayed, e.g., a page of search results, products in a category, or a user's favourites.

Property

UA Value

GA Value

Notes

Data Layer Name

dataLayer

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

Cart Url

/cart

Product Pricing

inc or ex

Detail Impression Use from List

Debug To Console

User

Only Track Logged In User

Questionaire

Questionaire Url

/{0}/Thank-you/

Checkout Options

 Checkout Options

Event Name

checkout

Checkout Option Event Name

checkoutOption

Login Success

(login success) Event Name

login

Logout Success

(logout success) Event Name

logout

Remove from Cart

(remove from cart) Event Name

removeFromCart

Cart Updated

(cart updated) Event Name

cartUpdated

Apply Promo Code Success

(Apply Promo Code Success) Event Name

validPromoCode

Apply Promo Code Fail

(Apply Promo Code Fail) Event Name

invalidPromoCode

Remove Promo Code

(Remove Promo Code) Event Name

removedPromoCode

Order Tracking

Event Name

/TrackOrder/ViewOrder/{0}

Template View

(Template View) Event Name

/OrderTemplates/{0}

Product Impressions

• Recently Viewed
• Campaigns
• Cross Sell/Upsell

Product Clicked

(Product Clicked) Event Name

Add to Cart

(Add to Cart) Event Name

Banner Clicked

Event_type

Impressions

Items

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.

currency

currency

ecommerce.currencyCode

currency

ecommerce.items.currency

Add in code snippet if required.

List Types

List types being used for product impressions, product clicks and add to cart tracking

Product Detail

Product Details

Product Category

Product List

Search Results

Search Results

Recently Viewed

Items Recently Viewed

Campaign

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

Cart Lines

Cart Item

{
	"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": [
			{
				"item_name": "Product Description",
				"item_id": "ProductCode",
				"item_category": "/first level/second level/third level",
				"brand": "brand name",
				"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

UA Value

GA4 Value

Notes

event

productClick

productClick

event type

event_type

-

Where product is located when clicked

list*

ecommerce.click.actionField.list

item_list_name

ecommerce.items.item_list_name

Value determined by the list in which the product is located:

• 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

*Note - Zoned Product Layout must be used in order for Enhanced eCommerce to work with lists.

product description

name

ecommerce.click.products.name

item_name

ecommerce.items.item_name

Product code

id

ecommerce.click.products.id

item_id

ecommerce.items.item_id

product category

category -  primary category

ecommerce.click.products.category

'item_category' - primary category

ecommerce.items.item_category

Specify up to 5 levels. E.g., 'item_category3': specifies to the third category level

item_category3

item_category4, item_category5

All levels of the category structure can be shown. 'category' by itself = product's primary category.

In UA, when setting the items[].category parameter, you use / as a delimiter to specify up to five levels of hierarchy.

In GA4, you use enumerated category parameters to specify up to five levels of hierarchy.

The behavior for category translation is as follows:

• For GA4 events translated to UA, enumerated categories will be combined into a single category parameter, with each category delimited by /.
• For UA events translated to GA4, the value of the category parameter will be split to populate the corresponding GA4 enumerated categories.
• If you intend to send GA4 events to UA, it's recommended that you do not use the / character in category values, since this will be interpreted as a category delimiter when translating to UA.
• Only the first 5 category levels will be used, regardless of how many are defined.

Product's brand

brand

ecommerce.click.products.brand

item_brand

ecommerce.items.index

Product's position / sequence in its list

position

ecommerce.click.products.position

index

ecommerce.items.index

Product price

(nett price for 1)

price

ecommerce.click.products.price

price

ecommerce.items.price

If 'hide pricing' is enabled at Role level, this data is not pushed.

Currency

-

currency

ecommerce.items.currency

Total 

-

ecommerce.value

Sum of product price x quantity

{
	"event": "productClick",
	"ecommerce": {
			"items": [
			{
				"item_name": "Product Description",
				"item_id": "Product Code",
				"item_category": "Product Category",
				"item_brand": "Brand Name",
				"price": "99.99",
				"index": 1
			}
			]
		}
	}
}

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

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

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

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

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

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

Measure a purchase by sending a purchase event with one or more items defined with the relevant fields.

Property

Value

Notes

event

'purchase'

item_name

The product description

Repeated for each product in the transaction.

item_id

The product code

Repeated for each product in the transaction.

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

{
	"event": "payment",
		"ecommerce": {
		"purchase": {
			"actionField": {
				"id": 100000000,
				"revenue": 99.99,
				"tax": 9.99,
				"shipping": 10.00
			}
		},
		"products": [
		{
			"item_name": "Product Description",
			"item_id": "ProductCode",
			"item_category": "/first level/second level/third level",
			"price": "99.99"
		}
		]
	}
}

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

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

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

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

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

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

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

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.

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

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

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. 

Determine the type of additional data required to push:

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

Finally, construct the tracking code per the format below.

The third parameter is the function that will perform the manipulation (e.g. "EmailAddress: data.EmailAddress" in sample 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

Analytics collects usage and behaviour data from user interactions on your CV ecommerce store. Used with Google Tag Manager, your Google Ads and other digital remarketing tools can deliver more relevant and personalised ads, and reports that measure traffic and engagement on your website can be created.

From version 2022.3, GA4 is available for selection. It is pre-configured to push unified data for both Universal Analytics (v3) and GA4 (v4).  The latest version supports Analytics' latest capabilities for tracking and managing content through Google Services. In the CMS, you can select what optional data are collected to suit your marketing and reporting needs. Learn more: Google Analytics

Which version in the CMS?

• If your site has never implemented Analytics, choose the GA4 version.
• If your site is using UA (v3), you can choose UA or GA4. Selecting GA4 will still mean your UA implementation also receives data.  
• If you choose UA, you want to start thinking of migrating to GA4 as UA will be deprecated by Google on the 1st July 2023. Remember, by selecting GA4, you can start to implement GA4 while continuing to use UA. 

Migration Plan 

• The GA4 solution has adopted Google's dual tagging, so both UA and GA4 requirements can be handled at the same time.
• In your Google account, leave your UA implementation unchanged while you implement GA4. UA and GA4 will operate independently side by side, doing slightly different things. 
• Continue to use UA until you are comfortable that your GA4 data has built enough of a historical record to be useful (or until UA is deprecated by Google on the 1st July 2023). This time should also be used to understand UA → GA4 changes. 

The CV Platform and GA4

GA4 Google Tag Manager snippet must be added. This tag will also tell Google to automatically convert GA4 properties to UA, for those running both versions concurrently. 

Prerequisites 

1. Set up Google account and get ID and Google Tag Manager snippet

NOTE - This guide only documents the steps that are required to obtain credentials and the Google Tag Manager code snippet. Learn more at Google: Set up GA4  

Image Removed

Image Removed

To retrieve the generated tag js script for your account, click View Tag Instructions. 
Image Removed

Image Removed

Copy the tag. It will have your Measurement ID added to it.

Use the Search tool to find: rcGoogleTagManagerInitialiserHead
Image Removed

In Resource Value, add the Google Tag Manager snippet you copied. It will look like this except the {0} placeholders will have your data stream's Measurement ID.

<!-- Google tag (gtag.js) -->
<script async src="https://www.googletagmanager.com/gtag/js?id={0}"></script>
<script>
  window.dataLayer = window.dataLayer || [];
  function gtag(){dataLayer.push(arguments);}
  gtag('js', new Date());
  gtag('config', '{0}');
</script>

:
Image Removed

2. Check templates/widgets are set up for capturing the Product Click event

To capture products clicked by users for GA4, in the CMS, make sure the following are in place:

•  Product List Grid widget: zoned layouts are enabled for Products and Categories.
  (Pages & Templates → Products → Product List Grid widget)
  Image Removed
•  Items Recently Viewed widget is added to Home Page
  (Pages & Templates → Home Page → Items Recently Viewed widget)
•  CrossSell/Upsell widgets: are added to Product Detail
  (Pages & Templates → Products → Product Detail page → CrossSell/Upsell widget)
•  Campaign Slider: is added to Home Page
  (Pages & Templates → Home Page → Campaign Slider widget)

3. Enable Favourites for Prior Purchases:

For each role your customers use and you want tracked:

Go to Ecommerce → Users → Roles.
Image Removed

Find and tick Enable Customer Favourites.
Image Removed

Configure GA4 Analytics 

1. Select GA4 version

Image Removed

Image Removed

item_category: "Apparel",
item_category2: "Adult",
item_category3: "Shirts",
item_category4: "Crew",
item_category5: "Short sleeve

view_item_list

select_item

item_category: "Apparel",
item_category2: "Adult",
item_category3: "Shirts",
item_category4: "Crew",
item_category5: "Short sleeve

select_item

 Content by Label
showLabels
false
max
5
spaces
KB
showSpace
false
sort
modified
reverse
true
type
page
excludeCurrent
true
cql
label in ("google","analytics") and type = "page" and space = "KB"
labels
Google Analytics