Google Tag Manager and BPD

Table of Contents

1. Digital Remarketing

2. Enhanced eCommerce

   1. Product Impressions
   2. Product Clicks
   3. User Details
   4. Questionnaires
   5. Checkout Steps & Options
   6. Transactions
   7. Login Success
   8. Logout Success
   9. Add to Cart
   10. Remove from Cart
   11. Cart Updated
   12. View Order
   13. View Template 

3. Extending or Overriding Pushed Data

1. Digital Remarketing

Remarketing is the practice of advertising to past visitors of your website. If users leave your site without making a purchase, remarketing can help you reconnect by displaying relevant ads during their subsequent web browsing or searching. 

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

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

 2. Enhanced eCommerce

Enhanced eCommerce is additional functionality for Google Analytics which allows richer data to be gathered, over and above the standard eCommerce transactional information gathered 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. 

BPD Enhanced eCommerce data is pushed for nearly every event type on the website. The data objects are outlined below, including properties and their possible values. 

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

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

b. Product Clicks

Product Click data is pushed on any click of a product link. For example, a product on a page of search results, a product on a category page, or from the user's favourites list.

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

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

{
	"User_ID": "unique user id"
}

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

{
	"virtualURL": "thank you URL"
}

e. Checkout Steps & Options

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

Checkout Options

Checkout Option data is pushed whenever the Checkout Step value is 3 or 4. 

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

f. Transactions

Product Transaction data is pushed on successful submission of an order. 

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

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

{
	"event": "login",
	"widgetName": "widget-name"
}

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

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

i. Add to Cart

pushed on successful add to cart

• pageType
  • The page the product was added from
    • Product List
    • Search Results
    • Product Details
• list
  • The list the product was added from
    • Product List
    • Search Results
    • Product Compare
    • Items Recently Viewed
    • Campaign - Campaign Description
    • CrossSell
    • UpSell
    • User Favourites
    • Prior Purchases
    • Product Details
    • Cart Fast Order
    • Quick Order Entry

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

j. Remove from Cart

pushed when a product is removed from the cart

 {
	"event": "removeFromCart",
	"ecommerce": {
		"currencyCode": "AUD",
		"remove": {
			"products": [
			{
				"name": "Product Description",
				"id": "ProductCode",
				"category": "/first level/second level/third level",
				"quantity": 1,
				"price": "99.99"
			}
			]
		}
	}
}

k. Cart Updated

pushed when cart quantities are changed.

Increases trigger and "addToCart" push, while decreases trigger a "removeFromCart" push

Promo Codes

For promo codes we push success and fails when adding promo codes, we also push the removal of a promo code

invalid

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

valid

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

removed

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

l. View Order

Pushed when an order is viewed on the order tracking page

{
	"virtualURL": "/TrackOrder/ViewOrder/Order Number"
}

m. View Template

Pushed when a template is viewed on the order templates page

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

3. Extending or Overriding pushed data

If you want to push different data you can include this data by adding fields to the JSON field groups

SiteTrackerUserData-append (or SiteTrackerUserData_RoleName-append for role specific changes

• PrimaryTable Name = User
• You can also retrieve data from the users Role or Customer

SiteTrackerProductData-append (or SiteTrackerProductData_RoleName-append for role specific changes

• PrimaryTable Name = Product

SiteTrackerOrderData-append (or SiteTrackerOrderData_RoleName-append for role specific changes

• Primary Table Name = ProntoSalesOrder
• You can also retrieve field data from ProntoSalesOrderLine and Product

Options

1. First param is the data to manipulate
2. Second param is the type of manipulation
   1. extend
   2. override
3. The third param is the function that will perform the manipulation
   1. The data is the raw data that can be used for manipulation (and includes the additional data from the JSON field groups described above)
   2. return an object with the properties and data to use

Extension methods

• userDetail
• pageType (this is for Digital Remarketing)

• productImpressions

• productClick

• questionnaire

• checkout

• checkoutOption

• transactionProducts

• loginSuccess

• logoutSuccess

• addToCart

• removeFromCart

• promoCodes

• viewOrder

• viewTemplate

$.cv.css.tracker.track("userDetail", "extend", function(data) {
	return { EmailAddress: data.EmailAddress };
});

Related articles

• Page:
  Change Placeholder Images