Overview
Instructions to send "Add to Cart" browse click information using the Javascript Tagging Library.
...
| Code Block | ||
|---|---|---|
| ||
trackBrowseAdd2Cart(categoryid, page, position, productid, title, url, scope, options, callback) |
Parameters
| Parameter | Description | Data Type | Mandatory |
|---|---|---|---|
| categoryid | The ID of the Product Category Page where the product is selected | String | Yes |
| page | The page number | Integer | Yes |
| position | The position of the product selected on Product Category Page. | Integer | No* |
| productId | The product ID of the selected result. | String | No* |
| title | The product or result title | String | Yes |
| url | Destination URL, for example product detail page | String | Yes |
| scope | This parameter is used for separate analytic data between two or more different scenarios | String | No* |
| options | Object that may contain information about filters and other required data | Object | No |
| callback | Function that will be executed after sending data | Function | No |
| *This parameters are not mandatory for the service but necessary for the statistics | |||
Options
The options object should contains additional parameters not passed as parameters but also necessary such as language. Also section, userID and sessionID that must be included if they're available or requiredin function call:
| Code Block | ||
|---|---|---|
| ||
{
lang: LANGUAGUE,
scope: SCOPE,
section: SECTION,
user: USER_ID,
session: SESSION_ID
} |
| Parameter | Description | Data Type | Mandatory |
|---|---|---|---|
| lang | Language identifier (es, en...) | String | No |
| scope | Scope identifier (desktop, mobile, android app, iOS app...) | String | No |
| section | Section value if it is required for the project | String | No |
| user | UserID used for user based services | String* | No |
| session | SessionID used for user based services | String | No |
*UserID should be an UUID identifier.
NOTE: The values for scope and lang will be provided by the Empathy Team.
NOTE: If you are setting up the trackBrowseAdd2Cart function into the product detail page, categoryId and page values will be relative to the product situation into the category grid before being clicked by the user.
The callback function receives an object with the following content. Also options parameters are included:
| Code Block | ||
|---|---|---|
| ||
{
page: page,
productId: productid,
categoryId: categoryid,
position: position,
title:title,
url:url,
scope: scope,
follow: false
} |
NOTE: The values for scope and options parameters will be provided by the Empathy Team.The callback also receives the parameter lang, user, session and the other params sent in options.
NOTE: If you are setting up the trackBrowseAdd2Cart function into the product detail page, categoryId and page values will be relative to the product situation into the category grid before being clicked by the user.
Code samples
Selectors using jQuery (you could use other frameworks to build the selectors)
| Code Block | ||
|---|---|---|
| ||
empathyTAG.trackBrowseAdd2Cart('MyCatID', 1, 3, "My product id", 'My product title', 'http://MY_PRODUCT_URL.com',{lang:'testscopeen',{langscope:'entestscope'},function(){}); |
Related articles
...