Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 2 Current »

Overview

Instructions to send to Empathy clicks on any product in the product category page using the Javascript Tagging Library.

Step-by-step guide

Clicks in any product of the product category page should be sent to Empathy using the function trackBrowseProduct.

trackBrowseProduct

trackBrowseProduct(categoryid, page, position, productid, title, url, scope, options, callback)


Parameters

ParameterDescriptionData TypeMandatory
categoryidThe ID of the Product Category Page where the product is selectedStringYes
pageThe page numberInteger

Yes

positionThe position of the product selected on Product Category Page.IntegerNo*
productidThe product ID of the selected product.StringNo*
titleThe product selected titleString

Yes

urlDestination URL, for example product detail pageStringYes
scopeThis parameter is used for separate analytic data between two or more different scenariosStringNo*
optionsObject that may contain information about filters and other required dataObjectNo
callbackFunction that will be executed after sending dataFunctionNo

*This parameters are not mandatory for the service but necessary for the statistics


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 required:

{
    lang: LANGUAGUE,
	section: SECTION,
	user: USER_ID,
	session: SESSION_ID
}


The callback function receives an object with the following content:

{
    page: page,
	productId: productid,
	categoryId: categoryid,
	position: position,
	title:title,
    url:url,
    scope: scope,
    follow: false
}

The callback also receives the parameter lang, user, session and the other params sent in options.

NOTE: The values for scope and options parameters will be provided by the EmpathyBroker Team.

Code samples

<a href="http://MY_PRODUCT_URL.com" title="My product title" prodID="My product ID" class="myLink">My Test Link</a>
/**
* 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 prodID = this.prodID;
   empathyTAG.trackBrowseProduct("My_category_ID", 1, 3, this.prodID, this.title, this.href, , {lang:'en'}, function(){
   		//Add your code here
   		document.location.href = myURL;
   });
});


  • No labels