Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Overview

Implementing Google Analytics allows your business to collect usage and behaviour data for your CV ecommerce store.

 

The current version of Google Analytics (Universal Analytics (UA)) will be available until deprecated by Google on the 1st July 2023. After that, UA reports will not be generated.It then generates reports that measure traffic and engagement across your website. The integration of Google Analytics to the CV ecommerce platform is pre-configured to collect data needed for specific user actions (events). You can select what to include and exclude to suit your business needs.

 

From version 2022.3 onwards, you can set , the most recent Analytics version - GA4, is availabe for your CV ecommerce site to use the new GA4 version. New site implementation of Google Analytics should select this version. UA will continue to be supported until the deprecation date.Analytics should select this version. If you're on the old version - Universal Analytics (UA), you can still use it until it is deprecated by Google (1st July 2023). UA reports will not be generated after this date. 

  

Read about the changeGA4:




1. Enable Google Analytics version

  1. In the CMS, go to: SettingsSettingsSystemsAnalytics.

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

  3. In Analytics Feature Settings, toggle ON Enable Analytics.
    In Analytics Version, select 'UA' or 'GA4'.  
    In Google Tag Manager ID, enter the ID from your Google account. 
  4. When the ID is entered, check one or more areas of your site to use with Analytics.
     
  5. Click Save. The Google Analytics settings will be displayed for configuring. 

2. Configure Google Analytics Settings

  1. toggle ON Enable Analytics.

  2. In Analytics Version, select 'UA' or 'GA4'.  

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

  4. Once you enter When the Tag Manager ID , you can select to include:is entered, the Analytics functions available are listed. Tick at least one.

    Digital Remarketing - contact with   configure relevant ads to display to past visitors of or buyers on your site as they continue to browse the internet
    Enhanced eCommerce - measurement of receive reports that measure user interactions with products on your site, including. Include: product impressions, product clicks, viewing product detailsdetail views, etc
    Enhanced Rich Snippet - visual enhancement of enhance search results
    As each option is selected, its relevant fields are displayed below. 
  5. Click Save or Save & Exit.
3
  1. visually

  2. Click Save.  

2. Create a template (optional)

This is not necessary optional as there is a default template that you can usebe used. It is called CV_OpeningBodyTemplate. This template contains the following: 


Code Block
titleThis 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 -->


Note

If you create your own template:

  • The template does NOT have to contain the tag [TemplateUtil.GoogleTagManagerInitialiser]. If it is not in the template, the 'snippet' will not be present on the page and the Google Tag Manager will not work.

  • If the tag [TemplateUtil.GoogleTagManagerInitialiser] is in the template, it must be at the start of the template (i.e. no text can come before it).

4


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.


Info

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


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.


Anchor
remarketing
remarketing

Digital Remarketing

Tip

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 advertises to user types on your website based on their behavior on your site. When users fit the behavioral profile for an user type, e.g., purchaser, they are added to that audience and can see ads related to that behavior. You can create events to capture user behaviours If . For example, if users leave your site without making a purchase, remarketing can help you reconnect by displaying relevant ads as they continue to browse or search the internet.

See: Remarketing on Google site of your website: past visitors and purchasers.  


Remarketing data is pushed on every page of the website. Properties and their possible values are detailed below. 

Property

Value

Notes

event

'remarketing'


ecomm_pagetype

One of the following:

  • other
  • home

  • category

  • product

  • cart

  • purchase

Value determined by the page the user is on. For example:

  • 'other' = any page not covered above (eg. Favourites, Checkout Delivery Address, Dashboard, etc). This is the default option.
  • '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'.


Code Block
languagejs
titleSample Remarketing data
{
    "event": "remarketing",
	"ecomm_pagetype": "home",
	"ecomm_prodid": ["ProductCode", "ProductCode"] or "ProductCode",
	"ecomm_totalvalue": "99.99",
	"google_conversion_value": "99.99"
}


Anchor
ecommerce
ecommerce

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 more nuanced 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. 


Anchor
ecomimpressions
ecomimpressions
Product Impressions

Product Impression data is pushed when a product list is displayed. For example, a page of search results, products in a category, or a user's favourites.

Property

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.

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

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.


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



Code Block
languagejs
titleSample Product Impression data
collapsetrue
{
	"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"
		}
		]
	}
}


Code Block
languagejs
titleSample Product Detail Impression data
collapsetrue
{
	"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"
			}
			]
		}
	}
}


Anchor
ecomclicks
ecomclicks
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

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.


Code Block
languagejs
titleSample Product Click data
collapsetrue
{
	"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
			}
			]
		}
	}
}


Anchor
ecomuser
ecomuser
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 ) 

Code Block
languagejs
titleSample User Detail data
collapsetrue
{
	"User_ID": "unique user id"
}


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

Code Block
languagejs
titleSample Questionnaire data
collapsetrue
{
	"virtualURL": "thank you URL"
}


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


Code Block
languagejs
titleSample Checkout Steps data
collapsetrue
{
	"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.


Code Block
languagejs
titleSample Checkout Option data
collapsetrue
{
	"event": "checkoutOption",
	"event_type": "checkout",
	"ecommerce": {
		"checkout_option": {
			"actionField": {
				"step": 4,
				"option": "BPAY"
			}
		}
	}
}


Anchor
ecomtrans
ecomtrans
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.


Code Block
languagejs
titleSample Transaction data
collapsetrue
{
	"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"
		}
		]
	}
}


Anchor
ecomlogin
ecomlogin
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 

Code Block
languagejs
titleSample Login Success data
collapsetrue
{
	"event": "login",
	"widgetName": "widget-name"
}


Anchor
ecomlogout
ecomlogout
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 

Code Block
languagejs
titleSample Logout Success data
collapsetrue
{
	"event": "logout",
	"widgetName": "widget-name"
}


Anchor
ecomaddtocart
ecomaddtocart
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.


Code Block
languagejs
titleSample Add To Cart data
collapsetrue
{
	"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"
}


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


Code Block
languagejs
titleSample Remove From Cart data
collapsetrue
 {
	"event": "removeFromCart",
	"ecommerce": {
		"currencyCode": "AUD",
		"remove": {
			"products": [
			{
				"name": "Product Description",
				"id": "ProductCode",
				"category": "/first level/second level/third level",
				"quantity": 1,
				"price": "99.99"
			}
			]
		}
	}
}


Anchor
ecomcartupdate
ecomcartupdate
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


Anchor
ecompromo
ecompromo
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.

Code Block
languagejs
titleSample Valid Promo Code data
collapsetrue
{
	"event": "validPromoCode",
	"promoCode": "XXXX"
}


Code Block
languagejs
titleSample Removed Promo Code data
collapsetrue
{
	"event": "removedPromoCode",
	"promoCode": "XXXX"
}


Anchor
ecomvieworder
ecomvieworder
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.

Code Block
languagejs
titleSample View Order data
collapsetrue
{
	"virtualURL": "/TrackOrder/ViewOrder/Order Number"
}


Anchor
ecomviewtemplate
ecomviewtemplate
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.

Code Block
languagejs
titleSample View Template data
collapsetrue
{
	"virtualURL": "/OrderTemplates/Template Name"
}


Anchor
extend
extend
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) 

        Code Block
        titleSample 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

Content by Label
showLabelsfalse
max5
spacesKB
showSpacefalse
sortmodified
reversetrue
typepage
excludeCurrenttrue
cqllabel in ("google","analytics") and type = "page" and space = "KB"
labelsGoogle Analytics