Data layer

pageType: ‘page_type_name’ (string) – required – the Page Type has to be specified on all pages. 

Please take note of the required Page Type naming convention:

• ‘homepage‘ – on the homepage
• ‘detail‘ – on the product detail page
• ‘category‘ – on the product list (category) page
• ‘basket‘ – on the page of basket and through the checkout process all the way to the order confirmation page
• ‘error‘ – on the error “404 page not found” page
• ‘search‘ – on the page with search results
• ‘other‘ – on other pages (contacts, blog, terms and conditions etc.)

currency: ‘eur’ (string) – required – currency as specified by ISO 4217 Currency Codes

impressedProducts: ‘locationID’ [product ids] (object) – optional – an object with locations containing IDs of their displayed products. Useful, if we want to prevent showing a product already displayed by the e-shop. Remember to keep the product IDs in the same format as in the product feed.

pageType: ‘homepage’ (string) – povinné

pageType: ‘detail’  (string) – required

itemID  (string) – required – id of the currently displayed product. Needs to be identical with the id in the product feed.

categoryID  (string) – optional – id of the category of the currently displayed product

hierarchy  (string) – optional – tree structure of the categories of the currently displayed product. IDs of categories should be divided with colons and without spaces.

pageType: ‘category’  (string) – required 

hierarchy  (string) – required– hierarchy of the currently displayed category. IDs of categories should be divided with colons and without spaces.

categoryID  (string) – optional– id of the currently displayed category

[filterParameters] (string or array) – optional – Those are the currently selected filters. If only one item is selected, the value is a string, if more than one is selected, return an array of strings. These parameters are especially important in stores that do not use traditional tree hierarchy, and use only parametrical filtering (e.g. very common in e-shops with clothing).
Important: the naming convention here has to be the same as in the product feed (e.g. if the product feed has “brand”: “adidas”, the data layer has to have the same “brand”: “adidas” when the filter is applied).

Empty basket confirmation – required

When visitor clears basket (deletes items or makes purchase), set the following values in the next pageview:

1. set basketTotal to zero (basketTotal:0)
2. remove basketItems

Example: There are two products “Red t-shirt with a short sleeve” with id ‘333’ and also “Black outdoor shoes” with id ‘546’.

Note: if there is a discount included in the process, this price in the data layer is after the discount with VAT.

pageType: ‘basket’ (string) – required

basketItems (object) – required – contains products placed in the basket. If the basket is emptied, reset the whole basketItems.

quantity (number) – required – amount of that particular product in the basket

price (number) – required – price of the particular product, with VAT

basketTotal (number) – required – total price of the products in the basket. Insert on each page, even the transaction confirmation page. If the basket is emptied, reset also basketTotal. Include VAT.

basketID (string) – optional – persistent basket ID to be referred to (e.g. in the e-mails). If we insert it into a URL parameter, server will be able to recollect this particular basket’s contents.

Following values need to be present on all pages regardless of pagetype. This allows Persoo to react to current basket contents.

Empty basket confirmation – required

When visitor clears basket (deletes items or makes purchase), set the following values in the next pageview:

1. set basketTotal to zero (basketTotal:0)
2. remove basketItems

Example: There are two products “Red t-shirt with a short sleeve” with id ‘333’ and also “Black outdoor shoes” with id ‘546’.

Note: if there is a discount included in the process, this price in the data layer is after the discount.

Important! We need the variables basketItems and basketTotal on every page (if there is something in the basket).

basketItems (object) – required – contains products placed in the basket. Insert on all pages. If the basket is emptied, reset the whole basketItems.

quantity (number) – required – amount of that particular product in the basket

price (number) – required – price of the particular product, with VAT

basketTotal (number) – required – total price of the products in the basket. Insert on each page, even the transaction confirmation page. If the basket is emptied, reset also basketTotal. This is with VAT.

basketID (string) – optional – persistent basket ID to be referred to (e.g. in the e-mails). If we insert it into a URL parameter, server will be able to recollect this particular basket’s contents.

Example: The visitor finished the order, and has the transaction ID = “transNo123” on the confirmation page.

pageType (string) – required 

basketItems (object) – required – see above section “Basket status” (Note: the following page after this confirmation will have the basket reset).

quantity (number) – required – see above section “Basket status”

price (number) – required – see above section “Basket status”

basketTotal (number) – required – see above section “Basket status”. Must be filled with the whole order value. (Note: the following page after this confirmation will have the basket reset).

transaction (object) – required – contains info about the currently sent order.

id (string) – required – unique order ID

revenue (number) – required – total value of the order with VAT ( or the same number that is sent to Google Analytics).

Empty basket after transaction confirmation – required

During the next pageview, coming after confirmation page pageview, empty basket in data layer:

1. set basketTotal to zero (basketTotal:0)
2. remove basketItems

The user’s id (usually email) needs to be sent to the data layer with each log-in, order finish, newsletter subscription etc.

pageType: ‘error’ (string)

pageType: ‘search’ (string)

query (string) – searched query

results (string) – number of results