Page History

Before You Begin 

1. CMS Analytics feature enabled in CMS

If Analytics is not enabled, contact Commerce Vision.

2. Templates/Widgets Setup

To track product clicks (select_item event in GA4) for certain List Types check that templates where users can select a product has these setups:

•  

  Product List Grid widget: zoned layouts are enabled for Products and Categories. Affects List Type: Product List 

  (Go to Pages & Templates → Products and check the Product List Grid widget is using a zoned layout.)

  Image Added

•  

  List Type: Items Recently Viewed works with the Recently Viewed widget added on a page or template. 

•  

  List Types: Cross Sell, Upsell works with the CrossSell/Upsell widget added on a page or template, e.g., Product Detail page. 

•  

  List Type: Campaign works with the Campaign Slider widget added on a page or template.

Set CMS Analytics to GA4 

1. Select GA4 version

1. In the CMS, go to: Settings → Feature Management→ System → Analytics.
   
   
2. With Analytics enabled on your site, click Configure.
   
   
3. In Analytics Feature Settings, toggle ON Enable Analytics.
   
   
4. In Analytics Version, select 'GA4'. TIP - GA4 should be selected if you are implementing Tag Manager for the first time.
   
   
5. In Google Tag Manager ID, enter the Tag Manager ID. 
   
   
6. When the ID was entered in step 5, three options appear. 
   Image Added
   
   1. Digital Remarketing -  does not apply to GA4
   2. Enhanced Rich Snippet - this allows you to add a code snippet that enhances search results visually, e.g., include ratings when a product's page is listed. See: Enhanced Rich Snippets
      
      
7. Tick Enhanced Ecommerce so it's on
   
   
8. Click Save.  

Event and Parameter Reference Guide

This section details the data sent for each event.

Anchor
item item

search

This event is triggered when the search results render from any of the following widgets

• Product Search With Category Widget

• Product Search Widget

• Product Search With Preview Widget

• Product Favourites page

• Cart

Item parameters below are included out-of-the-box.

Anchor
item item

view_item

The view_item event triggers when the product details page loads.

Item parameters below are included out-of-the-box.

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

view_item_list 

The view_item_list event is logged when the user has been presented with a list of items from a certain category or search results, e.g., from a search results, a category list or user's favourites. 

Data sent include items, to specify each product with their details. 

view_item_list

Anchor
ecomclicks ecomclicks

select_item

The select_item event signifies an item was selected from a list, i.e., product was clicked. Data is pushed on any click on a product link, e.g., on a search results page or from the user's favourites list. It includes data from the items array with the clicked product as the only product.  

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

select_item

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

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

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

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. 

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.

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

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)

Anchor
ecomclicks ecomclicks

add_to_wishlist

The add_to_wishlist event signifies an item was added to the favourites

select_item

Anchor
ecomcheckout ecomcheckout

begin_checkout

The begin_checkout event is triggered when the "Begin Checkout" button is clicked from the cart.

Anchor
ecomtrans ecomtrans

purchase

The purchase event is triggered when the cart is checked out

Anchor
ecomaddtocart ecomaddtocart

add_to_cart

The add_to_cart event is triggered every time a user successfully adds items to cart. This is recommended for businesses with online sales. 

These parameters are included.

Anchor
ecomaddtocart ecomaddtocart

add_payment_info

The add_payment_info event is triggered every time a user successfully adds payment info during checkout. 

These parameters are included.

Anchor
ecomaddtocart ecomaddtocart

add_shipping_info

The add_shipping_info event is triggered every time a user successfully adds payment info during checkout. 

These parameters are included.

Anchor
ecomremovefromcart ecomremovefromcart

remove_from_cart

The remove_from_cart event is triggered whenever a product is successfully removed from the shopper's cart.

NOTE - This can be a whole line deletion, or a decrease in quantity. Both actions are sent as 'Remove From Cart' data.

Anchor
richsnippets richsnippets

Enhanced Rich Snippets

You can add rich snippets to include key summary details about a website page when it displays in Google search results. An example might be to show ratings for a product's page on your site.   

Learn more: https://developers.google.com/search/blog/2009/05/introducing-rich-snippets

Related Resources

 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