Versions Compared

Key

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

...

Out of the box data

Digital Remarketing

pushed on every page

  • event
    • Name of event
  • ecomm_pagetype
    • other
    • home
    • category
    • product
    • cart
    • purchase
  • ecomm_prodid
    • optional
    • only visible on category, product, cart and purchase page types
  • ecomm_totalvalue
    • optional
    • only visible on product, cart and purchase page types
  • google_conversion_value
    • optional
    • only visible on purchase page type

...

Enhanced ecommerce

Product Impressions

pushed when a product list is displayed

  • event
    • Name of event
    • impressions are pushed via and event as the page could load data after the page has been loaded via infinite scrolling
    • the data is pushed in blocks to try to ensure the data amount pushed is less than the object data limit
  • event_type
    • impression
  • currencyCode
    • the currency code for the account currently being viewed
  • name
    • the product description
  • id
    • the product code
  • category
    • the primary category for the product
  • list
    • the list from which the product resides
      • Product List
      • Search Results
      • Items Recently Viewed
      • Campaign - Campaign Description
      • CrossSell
      • UpSell
      • User Favourites
      • Prior Purchases
      • Product Details (the product detail page displays the list name from which the product was clicked and falls back to this value if navigated directly to a product)
  • brand
    • the product brand
  • position
    • the position in its respective list
  • price
    • the product price
    • only sent through if hide pricing on the role is not enabled
Code Block
languagejs
{
	"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"
		}
		]
	}
}

 

Product Clicks

pushed when clicking on a product link

  • event
    • Name of event
  • list
    • the list from which the product resides
      • Product List
      • Search Results
      • Items Recently Viewed
      • Campaign - Campaign Description
      • CrossSell
      • UpSell
      • User Favourites
      • Prior Purchases
      • Cart Item
  • name
    • the product description
  • id
    • the product code
  • category
    • the primary category for the product
  • brand
    • the product brand
  • price
    • the product price
    • only sent through if hide pricing on the role is not enabled

 

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

 

User Details

Questionnaire (non widget)

Checkout Options

Transactions

Login Success

Logout Success

Add to CartThere is an option to only track logged in users

pushed on every page

Code Block
languagejs
{
	"User_ID": "unique user id"
}

 

Questionnaire

This is only for non widget questionnaires as the URL does not change after the questionnaire is submitted so a virtual URL is pushed.

Widget based questionnaires have a redirect URL after form submission

Code Block
languagejs
{
	"virtualURL": "thank you URL"
}

 

Checkout Options

  • step
    • the step number
  • option
    • Cart
    • Login
    • Address
    • Payment
    • Order Complete

 

Code Block
languagejs
{
	"event": "checkout",
	"event_type": "checkout",
	"ecommerce": {
		"checkout_option": {
			"actionField": {
				"step": 1,
				"option": "Cart"
			}
		}
	}
}

 

Transactions

Pushed on successful submission of an order

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

Login Success

pushed on a successful login

  • widgertName
    • The name of the widget used to login

 

Code Block
languagejs
{
	"event": "login",
	"widgetName": "widget-name"
}

 

Logout Success

pushed on a successful logout

  • widgertName
    • The name of the widget used to logout
Code Block
languagejs
{
	"event": "logout",
	"widgetName": "widget-name"
}

 

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
Code Block
{
	"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

Cart Updated

...