You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 8 Next »

Overview

Analytics collects usage and behaviour data from user interactions on your CV ecommerce store. With Google Tag Manager, this data can ultimately be used to personalise Google Ads and other digital remarketing, and to generate reports that measure traffic and engagement on your website.

From version 2022.3, the Analytics feature on the CV ecommerce platform is pre-configured to push data defined by either or both Universal Analytics (v3) and the new Google Analytics GA4 (v4). Depending on your marketing and reporting needs, you can also select what data is collected by defining specific event parameters.


Which version?

If your site has never implemented Analytics, you should choose the current GA4 version. If the soon to be deprecated UA version is active and you want to migrate to GA4, select GA4. This option will cater for UA as well as GA4. In your Google account, continue to use UA until 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).


UA to GA4 Migration

  • In GA4, names of some ecommerce events and parameters, and how they are organised, have changed. For future-proofing, use GA4 conventions. We have implemented Google Analytic's dual tagging solution. 

  • With the the new gtag.js snippet, Google will automatically convert GA4 properties for UA ones. 

    While the gtag.js can automatically translate GA4 events sent to a UA property and vice versa, not all events and parameters can be translated so it's important you review the behavior, incompatibilities and trade-offs you may have to make when relying on automatic translation.

    Read: Event Compatibility Reference


  • In your Google account, leave your UA implementation unchanged when you implement GA4. 
  • UA and GA4 implementations will operate independently side by side, doing slightly different things. 
  • Continue to use UA until you are comfortable with GA4 changes and its events are built up enough to yield useful event insights for remarketing and reporting.

   

Read about GA4:


1. Enable Google Analytics version

  1. In the CMS, go to: SettingsSettingsSystemsAnalytics.

  2. With Analytics enabled on your site, click Configure.

  3. In Analytics Feature Settings, toggle ON Enable Analytics.

  4. In Analytics Version, select which version you are configuring: 'UA' or 'GA4'. NOTE - If you are migrating to GA4 or implementing Analytics on your site for the first time, select GA4.      

  5. In Google Tag Manager ID, enter the ID from your Google account. 

  6. When the ID is entered, Analytics functions available are listed. Tick at least one.

    Digital Remarketing -  if using remarketing tools such as Google Ads or dynamic remarketing, visitor and purchaser behaviour events from Analytics can be included to personalise ads shown to users after they leave your site and continue to browse the internet
    Enhanced Ecommerce - data on user interactions with products or their user journeys on your site for use with reporting. For example, interactions with product can include product impressions, product clicks, product detail views, etc. 
    Enhanced Rich Snippet - snippet added to enhance search results visually

  7. Click Save.  

2. Create a template (optional)

This is optional as there is a default template that can be used. It is called CV_OpeningBodyTemplate. This template contains the following: 

replace with new

This tag will output the 'snippet' required by the Google Tag manager.
<!-- Google Tag Manager -->
<noscript><iframe src="//www.googletagmanager.com/ns.html?id={0}" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
<script>(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start': new Date().getTime(),event:'gtm.js'});
var f=d.getElementsByTagName(s)[0], j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';
j.async=true;j.src= '//www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);
})(window,document,'script','dataLayer','{0}');</script>
<!-- End Google Tag Manager -->

If you create your own template:

  • add to it, the tag [TemplateUtil.GoogleTagManagerInitialiser]. If it isn't in the template, the 'snippet' will not be present on the page and the Google Tag Manager will not work.

  • make sure the tag [TemplateUtil.GoogleTagManagerInitialiser] is at the start of the template (i.e. no text can come before it).


3. Set templates

There are two templates that you can set:

  • Global - one for all users.
  • Role-based - one for users in specific roles.

The default template is called CV_OpeningBodyTemplate.


The role-based template will be checked first and used if it exists. If it doesn't exist, the global template will be used.


Global

To use the tag manager for all users, 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

The 'Data Layer Doctor' extension for Chrome may be useful in viewing data objects during testing. It allows you to check the contents of a data layer and verify it against your specifications.

Remarketing in Analytics assists in displaying relevant Google Ads and and personalising these and other remarketing strategies when users have left your site but are still on Google or partner websites. What ads are shown to a user is based on their behaviour on your site 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

Sample Remarketing data
{
    "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 additional functionality for Google Analytics. It allows richer data to be gathered beyond the standard ecommerce transactional information at the Order Confirmation step. Enhanced ecommerce data provides a richer view of user behaviour, such as content engagement, product views, and cart actions. 


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 Impressions

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


Include or exclude sales tax from price displayed

Detail Impression Use from List



Default: OFF

Debug To Console



Default: ON

User



Default: ON

Only Track Logged In User



Default: OFF

Questionaire



Default: ON

Questionaire Url

/{0}/Thank-you/



Checkout Options



Default: ON

 Checkout Options




Event Name

checkout



Checkout Option Event Name

checkoutOption



Login Success



default: ON

(login success) Event Name

login



Logout Success



default: ON

(logout success) Event Name

logout



Remove from Cart



default: ON

(remove from cart) Event Name

removeFromCart



Cart Updated



default: ON

(cart updated) Event Name

cartUpdated



Apply Promo Code Success



default: ON

(Apply Promo Code Success) Event Name

validPromoCode



Apply Promo Code Fail



default: ON

(Apply Promo Code Fail) Event Name

invalidPromoCode



Remove Promo Code



default: ON

(Remove Promo Code) Event Name

removedPromoCode



Order Tracking



default: ON

Event Name

/TrackOrder/ViewOrder/{0}



Template View




(Template View) Event Name

/OrderTemplates/{0}



Product Impressions

  • Recently Viewed
  • Campaigns
  • Cross Sell/Upsell

Default: ON

Product Clicked




productClick

Add to Cart



Default: ON

(Add to Cart) Event Name

addToCart

Banner Clicked



Default: OFF





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


Sample Product Impression data
{
	"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"
		}
		]
	}
}
Sample Product Detail Impression data
{
	"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 Clicks

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

-

Event type is 'click.ationField' no longer used for this event in GA4. 

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_category, item_category2

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

Sample Product Click data
{
	"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 Details

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 ) 

Sample User Detail data
{
	"User_ID": "unique user id"
}


Questionnaire

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

Sample Questionnaire data
{
	"virtualURL": "thank you URL"
}


Checkout Steps & Options

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

Sample Checkout Steps data
{
	"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.

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


Transactions

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.

Sample Transaction data
{
	"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

Login Success data is pushed on any successful login.  

  • The 'event' always = "login"

  • The 'widgetName' = that of the widget used to initiate the login 

Sample Login Success data
{
	"event": "login",
	"widgetName": "widget-name"
}


Logout Success

Logout Success data is pushed on any successful logout.  

  • The 'event' always = "logout"

  • The 'widgetName' = that of the widget used to initiate the logout 

Sample Logout Success data
{
	"event": "logout",
	"widgetName": "widget-name"
}


Add to Cart

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.

Sample Add To Cart data
{
	"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

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

Sample Remove From Cart data
 {
	"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 Updated

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


Promotion Codes

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.

Sample Valid Promo Code data
{
	"event": "validPromoCode",
	"promoCode": "XXXX"
}
Sample Removed Promo Code data
{
	"event": "removedPromoCode",
	"promoCode": "XXXX"
}

View Order

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.

Sample View Order data
{
	"virtualURL": "/TrackOrder/ViewOrder/Order Number"
}


View Template

View Template data is pushed when a saved template is viewed on the Order Templates page. The template name is sent in this instance.

Sample View Template data
{
	"virtualURL": "/OrderTemplates/Template Name"
}


Extending or Overriding Pushed Data

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. 


CV internal use:

  1. Determine the type of additional data required to push:

    • User

    • Product

    • Order


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

  3. Finally, construct the tracking code per the format below.

    • First parameter is the data to manipulate (e.g. "userDetail" in sample code)

    • Second parameter is the type of manipulation:

      • extend

      • override

    • The third parameter is the function that will perform the manipulation (e.g. "EmailAddress: data.EmailAddress" in sample code)

      • The data is the raw data that can be used for manipulation (and includes the additional data from the JSON field groups described above) 

        Sample Data Extension 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

Related help

  • No labels