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 Modified

   Items

•  

  List Type: Items Recently Viewed works with the 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)

4. Enable Favourites for Prior Purchases:

For each shopper and visitor role 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

• 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.       
   In
   
   
5. In Google Tag Manager ID, enter the Container ID from your Google Tag Manager accountTag Manager ID. 
   Example: 
   Image Removed
   When an ID is entered, the functions are displayed. TIP - To capture the basic properties of the shopper journey, tick Digital Remarketing. To include fine-grained properties of a range of shopper journeys, tick Enhanced eCommerce as well.
   Image Removed
   - Digital Remarketing -  use Analytics with Google Tag Manager for remarketing tools such as Google Ads or for dynamic remarketing. In dynamic remarketing,  after they leave your site and continue to browse the internet, shoppers can be shown personalised ads based on products they purchased or viewed.
   - Enhanced Ecommerce - add this option to send fine-grained details about shopper behaviours on your site that goes beyond the transactional  (purchase) journey. As well as remarketing, this data produce more indepth reports on patterns of user activity, e.g., how users interact with specific products, where they go to on your site and where they go next, when they abandon their carts and leave your site.  
   - Enhanced Rich Snippet - add a code snippet that enhances search results visually, e.g., include ratings when a product's page is listed. See: Enhanced Rich Snippets
   
6. Click Save.  

2. Set template (optional)

This step is needed only if you do not want to use the default template supplied by CV ecommerce.

This template contains the code that outputs the Google Tag Manager code snippet onto every page. You can however use a custom template. 

Global or Role-based 

You can select to use a global template that includes all users or role-based ones.

Set Global template

To set a custom global template, go to the default templates admin page. Set the Opening Body Template to the default template or another template you created.

Set Role-based template

To set a role-based template, go to the role management admin page (see Templates tab). Set the Opening Body Template to the default template or another template you created.

Data Layer Testing

Google Tag Manager functions best when deployed alongside a data layer. A data layer is a JavaScript object that passes information from your ecommerce platform to your Tag Manager container. You can then use that information to populate variables and activate triggers in your tag configurations.

Digital Remarketing

Digital remarketing tags your site for online remarketing. Your store or products can be advertised to shoppers after they have left your store. This could be through Google Adwords or ads on Google-partnered sites as the shopper continues their online journey. You can also use dynamic remarketing, when ads are personalised to show products on pages visited by a shopper. By default, data from every page type is sent to Google. Some of these page types contain product value data based on products viewed and/or purchased by specific users.  You can untick any page types to be excluded from remarketing.

The data sent for page type are listed.

Event: remarketing

Property/Variable

Value

Notes

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

Remarketing data sample for a 'purchase' page 

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

See: Remarketing with Google Analytics 

Enhanced Ecommerce

Enhanced Ecommerce sends additional richer data about shoppers to Google Tag Manager. Instead of just basic transactional information, activities such as when shoppers 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 more insightful reports on site engagement, e.g., shopper behaviour patterns or conversion success rates on particular pages, search analytics, etc, as well as the ability to build more granular and complex audience segments for remarketing. 

(Enhanced) ecommerce data is pushed for nearly every event type on the website. How CV data fields match GA4 parameters and values are outlined below. 

Default value labels

• Event Name: enhancedEcomm 
• Cart URL: /cart
• Product Pricing: inc  (Change to exc to exclude tax)

Options

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

In GA4, this is the view_item_list event. Data sent include the items object containing each product listed. 

Event

Value

Notes

item_list_name

List type. See: List Names

items

items < >

items

Products in the list. Array with each included product.

Required: yes

Products / Items Parameters

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

In GA4, product data are now under 'items' (ecommerce.items[ ])

Event

Items

Parameter

Value from CV

item_name

product description

item_id

Product Code

item_category

Product Category

top level/primary category.

You can 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

item_list_name

List type

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

1. 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
      
      
2. Tick Enhanced Ecommerce so it's on
   
   
3. 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.  

select_item

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

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.

Lists are used for product impressions, product clicks and add to cart tracking. The list type is populated in the item_list_name parameter to track the list the user was viewing.  

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 example:

("event": "ecommerce", 
	"view_item_list", {
  	item_list_name: "Related products",
 	 items: [
    {
      item_id: "SKU_12345",
      item_name: "CV Tee",
      currency: "AUD",
      index: 1,
      item_brand: "CV",
      item_category: "Apparel",
      item_category2: "Adult",
      item_category3: "Shirts",
      item_category4: "Crew",
      item_category5: "Short sleeve",
      price: 10.00,
      }
{
      item_id: "SKU_12222",
      item_name: "CV Jacket",
      currency: "AUD",
      index: 2,
      item_brand: "CV",
      item_category: "Apparel",
      item_category2: "Adult",
      item_category3: "Jackets",
      item_category4: "Mens",
      item_category5: "Waterproof",
      price: 70.00,
      }   ]
});   ]
	}
}

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

In GA4, the event is called select_item. Details of a clicked product are from the Product/Item event parameters.  

Event = select_item

Parameter

Value

Notes

item_list_name

List type product was on when selected. See: List Names

Event structure:

• GA4 - ecommerce.items.item_list_name

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

value

Sum of product price x quantity

Structure: ecommerce.value

items

items

* The items array with one single element, representing the selected product.

If multiple elements are provided, only the first element in items will be used.

Item Parameters

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

Select Item example:

("ecommerce", "select_item", {
  	item_list_name: "Related products",
	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
    }
  ]
});

A shopper's data is pushed on every page of the site.  You can select to send only data for logged in shoppers.

• 'User_ID' = the user's unique identifier (database field = user.userid ) 

{
	"User_ID": "user userid"
}

Questionnaire data are 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"
}

In GA4, you need only specify 'Step 1' of checkout. Event name is 'begin_checkout'.  Tick 'Checkout Options' to include other details selected during checkout.

Event

Value

Notes

event

begin_checkout

currency

value

items

items < >

Array that contains each product in the cart.

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

Items parameters

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

 begin_checkout example:

("ecommerce", "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
    }
  ]
});

Tick to include data about the products purchased.

When an order is submitted, the purchase event pushes the transaction details and details of each product. 

In GA4, the purchase event has transaction (payment) +  items purchased. There is no separate payment event.

Event Name

purchase

Parameter

Value

Notes

Event

transaction

transaction_id

sales order number

value

total order value

tax

total tax value

shipping

total shipping value

currency

Event

items < >

Array with each product purchased

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

Purchase example:

"ecommerce", "purchase", "transaction" {
    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
    }]
});

Login Success data are pushed on any successful user login. 

• event = "login"

• method = name of the widget used to initiate the login 

GA4 example:

("ecommerce", "login", {
  method: "widget name"
});

Logout Success data is pushed on any successful user logout.  

• Event = "logout"

• method = 'widgetName' (widget used to initiate the logout) 

{
	"event": "logout",
	"widgetName": "widget name"
}

Add To Cart data are pushed every time a shopper successfully adds a product to their cart. 

Event

add_to_cart

Parameter

Value

 value

value

currency

Currency code of the current event, in 3-letter ISO 4217 format.

items

Items < >

An array with each product included.

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

item_list_name

List type

list type determined by the list type from which product was added . See: List Names. 

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

add_to_cart example

("ecommerce", "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
    }
  ]
});

Remove From Cart data are 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.

Event

remove_from_cart

Property

Value

Notes

value

value

currency

currency code

Event

items <> 

Items event with array for each product(s) removed from cart.

remove_from_cart example

 ("ecommerce", "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
    }
  ]
});

Cart Updates will push add_to_cart or remove_from_cart event event depending on product quantity changes:

• Quantity increase triggers an "add_to_cart" data push

• Quantity decrease triggers a "remove_from_cart" data push

Promotion Code use automatically pushes event type and promotion code name: 

• successful promo code add - 'validPromoCode'

• failure of promo code add - 'invalidPromoCode'

• removal of promo code 'removedPromoCode'

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

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

View Order data is pushed when an order is viewed on the Order History / tracking page. The sales order number is sent.

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

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

To push custom data or to override 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:

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