Page History

items added to cart

products

items

An array with items included.

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. 

In GA4, not used.

list page where product was added

list

item_list_name

See: List Names. 

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

GA4 Example

gtag("event", "add_to_cart", {
  currency: "AUD",
  value: 20.00,
  items: [
    {
      item_id: "SKU_12345",
      item_name: "CV Tee",
      currency: "AUD",
      index: 0,
      item_brand: "CV",
      item_category: "Apparel",
      item_category2: "Adult",
      item_category3: "Shirts",
      item_category4: "Crew",
      item_category5: "Short sleeve",
      item_list_name: "Related Products",
      price: 10.00,
      quantity: 2
    }
  ]
});

UA Example

{
	"event": "addToCart",
	"ecommerce": {
		"currencyCode": "AUD",
		"add": {
			"items": [
			{
				"name": "Product Description",
				"id": "ProductCode",
				"category": "/first level/second level/third level",
				"quantity": 2,
				"brand": "brand name",
				"price": "10.00"
			}
			]
		}
	},
	"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

UA

GA4

Notes

event

'removeFromCart'

remove_from_cart

value of order line (product x quantity)

value

currency code for the current account

currencyCode

currency

product(s) removed from cart

products

items

Standard product data is included here (e.g. name, id, category, quantity, price).

GA4 example

 gtag("event", "remove_from_cart", {
  currency: "AUD",
  value: 20.00,
  items: [
    {
      item_id: "SKU_12345",
      item_name: "CV Tee",
      currency: "AUD",
      index: 0,
      item_brand: "CV",
      item_category: "Apparel",
      item_category2: "Adult",
      item_category3: "Shirts",
      item_category4: "Crew",
      item_category5: "Short sleeve",
      item_list_name: "Related Products",
      price: 10.00,
      quantity: 2
    }
  ]
});

UA example

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

Cart Updates will push Add or Remove event depending on product quantity changes:

• Quantity increase triggers an "addToCart" data push

• Quantity decrease triggers a "removeFromCart" data push

The following data is automatically pushed in relation to Promotion Code use: 

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

To push custom data or to override Commerce Vision's out-of-the-box inclusions, consult Commerce Vision. 

Determine the type of custom 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_RoleName for role-specific changes)

Order

Primary Table:

• ProntoSalesOrder

Additional Tables:

• ProntoSalesOrderLine

• Product

SiteTrackerOrderData (or SiteTrackerOrderData_RoleName for 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. This can be used with Google Tag Manager to produce enhanced ecommerce data and reports. These in turn can be used for Google Services such as Google Ads and other digital remarketing tools to deliver more relevant and personalised ads, and produce more insightful reports that detail traffic and engagement patterns on your website.

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. You can populate GA4 events as well a UA ones. These 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. Running both UA and GA4 concurrently? This tag will also tell Google to automatically convert GA4 properties to UA and vice versa. 

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

2. Set templates (optional)

This step is needed only if you do not want to use the default global template use.

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. Used with Tag Manager, 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 that analyse shopper behaviour patterns on your site. 

Enhanced ecommerce data is pushed for nearly every event type on the website. The general event name is ecommerce. How CV data fields match Analytics parameters and values are outlined below. 

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

In GA4, this is the view_item_list event. Data sent includes the items array parameter containing the displayed items. 

View List Parameters

UA

GA4

Notes

Item list type

list

item_list_name

See: List Names

products in the list

products

items

Array with each included item.

Required: yes

Products / Items Parameters

UA Value

GA Value

Notes

See: Products/Items event parameters and values for data sent on each item

Product/item event parameters and values

In GA4, product data are now in 'items'.

Event = items

Parameter

UA

GA4

product description

name 

item_name

product code

id

item_id

product category

category

item_category

GA4: item_category = top level category. Specify up to 5 categories:

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

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

• Only the first 5 category levels

list name

list *

item_list_name

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

See: List Names

*NOTE - Zoned Product Layout must be in use for Enhanced Ecommerce to work with lists.

product's brand

brand

item_brand

product's position / sequence in the list

position

index

Monetary nett price of the item, in units of the specified currency parameterprice

price

price

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

item level currency

currencyCode

currency

In 3-letter ISO 4217 format.

Multiple currencies per event is not supported. Each item should set the same currency.

GA4 - currency can be set at both item and event levels. If set at item level, event-level currency is ignored.

Item level structure: ecommerce.items.currency

Lists are used for product impressions, product clicks and add to cart tracking. The value of item_list_name is the list type viewed by the user.  

Item List Type

List Type Values

Product Detail

Product Details

Product Category

Product List

Search Results

Search Results

Recently Viewed

Items Recently Viewed

Campaign

Campaign - (sent as the Campaign Description, not the Campaign Code)

Alternate products

CrossSell

Accessories / Related products

Upsell

User Favourites

User Favourites

Prior Purchases

Prior Purchases

Product Details

Product Details

Products Viewed in a List GA4 example:

gtag("event", "view_item_list", {
  item_list_name: "Related products",
  items: [
    {
      item_id: "SKU_12345",
      item_name: "Stan and Friends Tee",
      currency: "AUD",
      index: 1,
      item_brand: "CV",
      item_category: "Apparel",
      item_category2: "Adult",
      item_category3: "Shirts",
      item_category4: "Crew",
      item_category5: "Short sleeve",
      item_list_name: "Related Products",
      price: 9.99,
      }
  ]
});   ]
	}
}

UA example:

{
	"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 Detail Impression Data:

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

Product Click data is pushed on any click of a product link, e.g., a product on a page of search results or on the user's favourites list.

In GA4, the event is called select_item.

Parameters

UA

GA4

Notes

event

productClick

select_item

event

click

-

event type

click.actionField

-

List type product was located on when selected

list *

item_list_name

Where product was clicked. See: List Names

Event structure:

• GA4 - ecommerce.items.item_list_name
• UA - ecommerce.click.actionField.list

* NOTE - Zoned Product Layout must be in use for Enhanced Ecommerce to work with lists.

products/items

products

items

* The items array is expected to have a single element, representing the selected item. If multiple elements are provided, only the first element in items will be used.

Item Parameters

UA

GA4

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' - top level category

ecommerce.items.item_category

Specify up to 5 levels:

E.g.,

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

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.

• Only the first 5 category levels will be used, regardless of how many are defined.

product's brand

brand

item_brand

Event structure:

GA4 - ecommerce.items.brand

UA - ecommerce.click.products.brand

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

In 3-letter ISO 4217 format.

Multiple currencies per event is not supported. Each item should set the same currency.

GA4 - currency can be set at both item and event levels. If set at item level, event-level currency is ignored.

Item level structure: ecommerce.items.currency

Total amount

-

value

Sum of product price x quantity

Structure: ecommerce.value

Product Click/Select Item - GA4 example:

gtag("event", "select_item", {
  item_list_name: "Related products",
  items: [
    {
      item_id: "SKU_12345",
      item_name: "CV Tee",
      currency: "AUD",
      index: 0,
      item_brand: "CV",
      item_category: "Apparel",
      item_category2: "Adult",
      item_category3: "Shirts",
      item_category4: "Crew",
      item_category5: "Short sleeve",
      item_list_name: "Related Products",
      price: 10.00,
      quantity: 1
    }
  ]
});

UA example: 

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

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.

Checkout Event

UA

GA4

Notes

event 

'checkout'

begin_checkout

event type

'checkout'

Event structure

"ecommerce":

{ "checkout":

{ "actionField":

{ "step": 1

Not required in GA4.

In UA:

The checkout step numbers are:

• 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 in the cart

products

items

Includes products in the cart.

• Standard product data will be pushed for each product in the cart (e.g. name, id, category, brand, price).

GA example:

gtag("event", "begin_checkout", {
  currency: "AUD",
  value: 20.00,
  items: [
    {
      item_id: "SKU_12345",
      item_name: "CV Tee",
      currency: "AUD",
      index: 0,
      item_brand: "CV",
      item_category: "Apparel",
      item_category2: "Adult",
      item_category3: "Shirts",
      item_category4: "Crew",
      item_category5: "Short sleeve",
      item_list_name: "Related Products",
      price: 10.00,
      quantity: 2
    }
  ]
});

UA example:

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

check for GA4

Options - pushed whenever the Checkout Step value (detailed above) is either 3 or 4. 

Parameter Options

UA

GA4

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.

UA example:

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

When an order is submitted, Transaction and Product/Items data are pushed. 

The purchase event consists of the transaction (payment) and the items purchased. 

Property

UA

GA4

Notes

event name

purchase

purchase

 sales order number

id

transaction_id

order value

revenue

value

total value of order

tax amount

tax

tax

shipping amount

shipping

shipping

Property

UA

GA4

Notes

event name

purchase

purchase

product description 

name

item_name

Repeated for each product in the transaction.

product code

id

item_id

Repeated for each product in the transaction.

product's primary category

category

item_category

Includes all levels of the category structure for the product's primary category.

Repeated for each product in the transaction.

product price (nett for 1)

price

price

Repeated for each product in the transaction.

GA4 example:

gtag("event", "purchase", {
    transaction_id: "100000000",
    value: 25.99,
    tax: 4.90,
    shipping: 5.99,
    currency: "AUD",
    items: [
     {
      item_id: "SKU_12345",
      item_name: "CV Tee",
      currency: "AUD",
      index: 0,
      item_brand: "CV",
      item_category: "Apparel",
      item_category2: "Adult",
      item_category3: "Shirts",
      item_category4: "Crew",
      item_category5: "Short sleeve",
      item_list_name: "Related Products",
      price: 10.00,
      quantity: 1
    },
    {
      item_id: "SKU_12346",
      item_name: "CV Grey Women's Tee",
      currency: "AUD",
      index: 1,
      item_brand: "CV",
      item_category: "Apparel",
      item_category2: "Adult",
      item_category3: "Shirts",
      item_category4: "Crew",
      item_category5: "Short sleeve",
      item_list_name: "Related Products",
      price: 10.00,
      quantity: 1
    }]
});

UA example:

{
	"event": "payment",
		"ecommerce": {
		"purchase": {
			"actionField": {
				"id": 100000000,
				"revenue": 25.99,
				"tax": 4.90,
				"shipping": 5.99
			}
		},
		"products": [
		{
			"name": "CV tee",
			"id": "SKU_12345",
			"category": "/first level/second level/third level",
			"price": "10.00"
		}
	
		{
			"name": "CV Grey Women's Tee",
			"id": "SKU_12346",
			"category": "/first level/second level/third level",
			"price": "10.00"
		}
		]  
}

Login Success data is pushed on any successful user login. 

• The 'event' always = "login"

• The 'widgetName'/'method' = name of the widget used to initiate the login 

GA4 example:

gtag("event", "login", {
  method: "widget-name"
});

UA example:

{
	"event": "login",
	"widgetName": "widget-name"
}

Logout Success data is pushed on any successful user 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. 

Event

UA

GA4

Notes

event name

'addToCart'

add_to_cart

Parameters

monetary value of the event

value

value

currency of event

currencyCode

currency

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