page
The digitalData.page object contains variables that describe the loaded page: URL, GET parameters, page template type, breadcrumbs, etc.
Page contents
Introduction
The digitalData.page object must be declared and filled in the source code of each page of the site.
We do not recommend filling the object asynchronously after loading the page. This can significantly reduce the systems performance.
Example:
window.digitalData = {
...,
page: {
type: 'listing',
category: 'Category Listing',
breadcrumb: ['Women', 'Shoewear', 'Boots'],
url: 'http://website.com/women/boots?sortBy=price#black',
hash: '#black',
path: '/women/dresses/mini/',
queryString: '?sortBy=price',
referrer: 'https://referrer.com/',
title: 'Buy boots online - website.com'
},
...
}
page.type
page.type - a reserved variable that contains a description of the page type. A variable can take the following values:
- “home” - when loading the main page
- “listing” - when loading a catalog page with a list of products. This can be a page with new items, and with goods of a certain brand or category.
If you use spreading catalog pages where there are no products, and there are only banners and links leading to subsections - use
page.type: “content” - “product” - when loading a page with a detailed description of a product
- “search” - when loading the search results page
- “cart” - when loading a page containing the contents of the shopping cart
- “checkout” - when loading one of the checkout step pages
- “confirmation” - when loading the “Thank you for your purchase” page
- “content” - for all the other pages
Do not use any other values, for example: “brandPage”, “navigation”, “main”, etc. This can lead to incorrect integration work.
page.category
page.category contains the name of the page template. For the same page.type value, there may be several page.category values. For example, for page.type: “listing”, page.category can take the following values:
- Brand Listing - list of products of the same brand
- Category Listing - list of products of the same category or subcategory
- New Arrivals Listing - list of new products
- Sales Listing - list of products on sale
- Trend Listing - list of trending products
The values of the variables
page.categoryandpage.typeare convenient for use in Google Analytics content groups
page.breadcrumb
page.breadcrumb contains the path to the current page in the site structure. The variable is an array where element 0 is the highest level of the category, and the last element of the array is the lowest (the name of the current page).
On many sites, the array will be equivalent to the breadcrumb navigation element, excluding the first link to the “Main” page.
The variable page.breadcrumb does not need to be filled on pages with page.type: “home”, “cart”, “checkout”, “confirmation”
page.url
page.url contains the full url of the page.
SDK creates and fills this variable automatically. Please do not try to reinitialize this variable.
page.hash
page.hash contains the part of the url beginning from the # character. For example, for the URL http://website.com/wommen/dresses/mini/?sortBy=price#black page.hash is set to “#black”.
SDK creates and fills this variable automatically. Please do not try to reinitialize this variable.
page.path
page.path contains the url part between the first and last slash after the domain. For example, for the URL http://website.com/wommen/dresses/mini/?sortBy=price#black page.path takes the value of “/women/dresses/mini/”.
SDK creates and fills this variable automatically. Please do not try to reinitialize this variable.
page.queryString
page.queryString contains the url part with GET parameters. For example, for the URL http://website.com/wommen/dresses/mini/?sortBy=price#black page.queryString takes the value of “?SortBy=price”.
SDK creates and fills this variable automatically. Please do not try to reinitialize this variable.
page.referrer
page.referrer contains the url of the page from which the link or redirect to the current page occurred.
Please note that this isn’t always the case, for example when redirecting to a site through a search engine results page, the user is usually put through an intermediate page which will not contain data about the users search queries(for privacy reasons), therefore the value of the page.referrer variable may not be equal to the page that the user actually used to visit the site.
The value corresponds to the content of the global js-variable document.referrer.
SDK creates and fills this variable automatically. Please do not try to reinitialize this variable.
page.title
page.title contains the value of the meta tag
SDK creates and fills this variable automatically. Please do not try to reinitialize this variable.