Overview
Instructions to send clicks information using the Javascript Tagging Library.
Step-by-step guide
Click events should be triggered when any result is selected by the user in the search results page. At this moment, the function trackClick should be executed.
trackClick
| Code Block |
|---|
|
trackClick(terms, page, position, productId, title, url, options, callback) |
Parameters
| Parameter | Description | Data Type | Mandatory |
|---|
| terms | The query typed by the user | String | Yes |
| page | The page number where user clicks | Integer | Yes |
| position | The position in SERP of the product selected. | 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 |
| 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 in function call:
...
| Code Block |
|---|
|
{
page: page,
productId: productid,
position: position,
title: title,
url: url,
follow: false
} |
Code samples
| Code Block |
|---|
|
<a href="http://MY_PRODUCT_URL.com" title="My product title" class="myLink" prodID="prod_id">My Test Link</a> |
...
| Code Block |
|---|
|
/**
* 1 -> Capture click on the desired product
* 2 -> Avoid default action (redirect to destination url)
* 3 -> Execute trackClick function with the desired callback (including url redirection)
*/
jQuery('a#myLink').click(function(){
event.preventDefault();
var myURL = this.href;
var title = this.title;
var productId = this.prodID;
var options = {
lang: LANGUAGUE,
scope: SCOPE,
section: SECTION,
user: USER_ID,
session: SESSION_ID
};
empathyTAG.trackClick('test',1,3, this.prodID, this.href, options, function(){
//Add your code here
document.location.href = myURL;
});
}); |
Related articles
| Filter by label (Content by label) |
|---|
| cql | label = "empathy-tag-api-javascript" and space = currentSpace ( ) |
|---|
|