Page History

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 

Ecommerce

Ecommerce sends data collected from triggered events about user activities important for ecommerce stores, e.g., when users add items to cart, when they remove items, when they abandon their carts and leave without purchasing, when they begin checkout, etc. This data can be used to produce insightful reports on site engagement and user behaviours. Data can be collected and sent for nearly every user event type from your store. Most events and their parameters included here are from Google recommended events. 

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. 

Ecommerce Settings

General Settings

Triggered Events

Reference Guide

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

Event Name

view_item_list

Parameter

Value

Notes

item_list_name

list type

For list type names, see: List Names

Ignored if set at the item-level.

Event

items [ ]

An array with each product in the list.

Required: yes

See: items event and variables/values for product data sent.

items exists an array [ ] that sends data on one or more specific products and its details. It is included in events where users view or select specific products. Item parameters below are included out-of-the-box.

Name

items

Parameter

CV Value

Notes

item_name

product description

Product description. One of item_id or item_name is required.

item_id

product code

Product code. One of item_id or item_name is required.

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

item_list_name

list type

List type of list product was in. See: List Names

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

If set, event-level item_list_name is ignored.
If not set, event-level item_list_name is used, if present.

item_brand

brand

Product's brand. NOTE - Currently not standard inclusion from CV ecommerce platform. Must be custom added. 

index

numerical value

position of item presented in list (if applicable)

price

Monetary nett price of the product, in  the specified currency.

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

currency

currency of site in 3-letter ISO 4217 format

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

For GA4, currency can be set at both item and event levels. When item level currency has been set, any event-level setting is ignored.

Item level structure: event.items.currency

Event level structure: event.currency

item_list_name is a parameter that displays the list type name relevant to an event that involves a product list, e.g., view_item_list, item, select_item etc. List types included and values sent are listed below.  

List Type Name

Value

Product Detail

Product Details

Product Category

Product List

Search Results

Search Results

Recently Viewed

Items Recently Viewed

Campaign

Campaign - {0}

Alternate products

Cross Sell

Related products

Upsell

Cart Fast Order Entry

Cart Fast Order

Product Compare

Product Compare

User Favourites

User Favourites

Prior Purchases

Prior Purchases

Cart Lines

Cart Item

item_list_name example:

dataLayer.push({ ecommerce: null });  // Clear the previous ecommerce object.
dataLayer.push({
  event: "view_item_list",
  ecommerce: {
  	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,       }]
  }
});

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.  

Event Name

select_item

Variable

Value

Notes

item_list_name

list type

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

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

value

Monetary value of product price x quantity

items [array]

selected product details

The items array with the selected product. See: Items object for product data values. 

If multiple products are provided, only the first product will be used. 

Select Item example:

dataLayer.push({ ecommerce: null });  // Clear the previous ecommerce object.
dataLayer.push({
  event: "select_item",
  ecommerce: {  
	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
   }
    ]
  }
});

User_ID feature allows you to send user identifier data (userid) so that you so that you can connect a user with their behavior across different sessions and on various devices and platforms. User ID is pushed on every page of the site.  You can select to send only data for logged in users.

This includes the user's unique identifier (CV database field = user.userid ) Learn more: User-ID feature

dataLayer.push({
  'user_id': 'USER_ID'
});

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

dataLayer.push({
  "virtualURL": "thank you URL"
});

NOTE - In GA4, you need only specify begin_checkout. This is effectively equivalent to UA's sending a checkout_progress event with checkout_step set to 1 ('Step 1' of checkout).

Event: begin_checkout  Tick 'Checkout Options' to include other details selected during checkout.

Event Name

begin_checkout

currency

currency of site in 3-letter ISO 4217 format

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

For GA4, currency can be set at both item and event levels. When item level currency has been set, any event-level setting is ignored.

value

Total cost of products in cart

items

items [ ]

Array contains each product in the cart.

• Standard product data (e.g. name, id, category, brand, price) are included for each product. See: items event for product data values. 

 begin_checkout example:

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

When an order is submitted, the purchase event sends the transaction details and details of each product. Untick to exclude product data.

The purchase event has two events: transaction (monetary and payment details) +  items (array with the purchased products). There is no separate payment event.

Event Name

purchase

Variable

Value

Event

transaction

transaction_id

sales order number

generated from your system

value

total order value

tax

total tax value

will depend on whether inc or exc tax has been set

shipping

total shipping value

currency

currency of site in 3-letter ISO 4217 format

For GA4, currency can be set at both item and event levels. When item level currency has been set, any event-level setting is ignored.

Event

items [ ]

Array with each product purchased. See: items event for product data variables/values. 

Purchase example:

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

The login event is sent when a user successfully logs in. 

Optional

login example:

("login", {
  method: "login"
});

Logout Success data is pushed on any successful user logout.  

• Event = "logout"

• method = widget used to initiate the logout 

("logout", {
  method: "widget name"
});

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

Learn more: add_to_cart 

These parameters are included in the default template.

Event

add_to_cart

Parameter

Value

 value

value

 monetary value of the event* value is typically required for meaningful reporting. If you mark the event as a conversion then it's recommended you set value.

* currency is required if you set value.

currency

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

Array

Items [ ]

An array with each product and standard product data (e.g. name, id, category, quantity, brand, price) included. See: items for product data values. 

Product data can also include the item_list_name parameter to provide information on the list type from which the product was added.

*NOTE - Zoned Product Layout must be used in order to collect data from lists. See: List Names. 

add_to_cart example

dataLayer.push({ ecommerce: null });  // Clear the previous ecommerce object.
dataLayer.push({
  event: "add_to_cart",
  ecommerce: {
  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 }
    ]
  }
});

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.

Event

remove_from_cart

Parameter

Value

Notes

value

value

value of order line (product x quantity)

currency

currency code

currency code for the current account

array

items [ ] 

An array containing each product removed with its details (e.g. name, id, category, quantity, brand, price)  included. See: items event for product data values. 

remove_from_cart example

dataLayer.push({ ecommerce: null });  // Clear the previous ecommerce object.
dataLayer.push({
  event: "remove_from_cart",
  ecommerce: {
  currency: "AUD",
  value: 10.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: 1
    }
    ]
  }
});

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 events automatically sends the promotion code name when the event is triggered: 

• successful promo code add - 'validPromoCode'

• failure of promo code add - 'invalidPromoCode'

• removal of promo code -  'removedPromoCode'

dataLayer.push({
  event: "validPromoCode",
  	promoCode: "TWOFORONE"
})

dataLayer.push({
  event: "removedPromoCode",
  	promoCode: "TWOFORONE"
})

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. 

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:

Before You Begin 

1. Google Tag Manager and GA4 accounts

You will need to get your site's Container ID from Google Tag Manager. Before you start, your Tag Manager and GA4 accounts should be ready to go. Learn more at Google: Set up GA4; Google Tag Manager with GA4

2. CMS Analytics feature enabled in CMS

If Analytics is not enabled, contact Commerce Vision.

3. Templates/Widgets Setup

To trigger the product click (select_item) event in GA4, check these setups:

•  

  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)

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 CMS Analytics for GA4 

1. Select GA4 version

Image Removed

Image Removed

2. Set template (optional)

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

The template contains the code that outputs the Google Tag Manager code snippet onto every page. You can however use a custom template, e.g., if you want to customise the data collected. 

Global or Role-based 

You can select to use it globally for all users or have specific 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.

Remarketing

The 'remarketing' option enables an event that sends certain data from every page accessed. The data can also be used for remarketing or dynamic remarketing when the user leaves your site and continues browsing.

Page Type

By default, data from every page type is sent. Some of these page types contain product value data based on products viewed and/or purchased by specific users. Below is a list of named page types and data sent for each one.  

The data sent for page type are listed. 

Event: remarketing

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

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