Resonance® Implementation Instructions

For Home Depot Canada

© 2004-2017 Certona Corporation

 Resonance® Implementation Instructions

Table of Contents
About Certona ............................................................................................... 1
About This Document ..................................................................................... 2
Tagging Instructions ........................................................................................ 4
Pages with Certona Recommendations .............................................................. 7
Further Assistance ....................................................................................... 13

Certona Corporation i Copyright 2004-2017

 Resonance® Implementation Instructions

About Certona

Certona Corporation is the creator of Resonance®, a real-time personalization and revenue

optimization platform for multi-channel retailers. Resonance automates a company's ability to
provide relevant, individualized content and experience in real time that calls visitors to an online
sales or other marketing-related action. For more information, visit www.certona.com.

Copyright 2004-2017 Certona Corporation

Certona and Resonance are registered trademarks belonging to Certona Corporation, registered
U.S. Patent and Trademark Office. All other trademarks are the property of their respective
owners. All rights reserved.

Certona Corporation 1 Copyright 2004-2017

 Resonance® Implementation Instructions

About This Document

Purpose
This document contains instructions on how to properly configure your web site to allow the
Certona Resonance® recommendation engine to collect data elements that will be used to create
personalized recommendations.

Audience
This document is intended for web site administrators and technical personnel.

Customer
This document was prepared for Home Depot Canada by Certona Implementation.

Document History

Version # Creation/ Created/Revised By Description

Revision Date

1.0 03.11.2016 Asha John Original Document

 Added 5 more new schemes and
1.1 04.18.2016 Asha John example webservice calls for each of
them.
 Added data object for Product
Comparision page.
1.2 09.07.2016 Asha John  Modified the WS call for Cart1_rr to
include the query parameter for
pageID

1.3 09.21.2016 Asha John  Included recExposed function to

update hosted tag with new recite
values for cart1_rr

1.4 11.29.2016 Asha John  Modified the WS call for Cart1_rr to

remove the query parameter for
pageID
 Modified the recExposed function to
include pageid as an argument

Certona Corporation 2 Copyright 2004-2017

 Resonance® Implementation Instructions

1.5 12.22.2016 Matineh Modified by adding product2_rr to the

Moghaddam list of schemes

1.6 01.24.2017 Tim Imasa  Created a new location (404Error)

 Added new containers –
catlanding1_rr & error1_rr

1.7 04.10.2017 Paul Hutchins  Updates, adding Search Terms to

itemid parameter on Search and
No Search pages, and adding the
CIP parameter.

Certona Corporation 3 Copyright 2004-2017

 Resonance® Implementation Instructions

Tagging Instructions
The Resonance JavaScript is hosted by Certona and included on pages by adding the following
script block. The script can be placed in the head, footer or body of a page.

<script type="text/javascript"
src="//edge1.certona.net/cd/becdd454/homedepot.ca/scripts/resonance.js"></script>

Place the Certona JavaScript on the below mentioned pages of the site. If you are using a tag
manager, please follow the tag manager’s instructions.

 
Home page (https://www.homedepot.ca/en/home.html)

<script type="text/javascript">
var certona = {
"pagetype" : "HOME",
"customerid" : "CUSTOMER IDENTIFIER”(If user not logged in, do not pass any value)
};
</script>

Category Landing page (https://www.homedepot.ca/en/home/categories/kitchen.html)

Place the following Certona Javascript on the category pages. The category value on the page
should match the categoryid in the data feed.

<script type="text/javascript">
var certona = {
"pagetype" : "CATEGORYLANDING",
"categoryid" : "CATEGORYID",
"customerid" : "CUSTOMER IDENTIFIER”(If user not logged in, do not pass any value)
};
</script>

Category page
(https://www.homedepot.ca/en/home/categories/kitchen/kitchen-cabinets.html?NAVID=CLP_RE_FC_D
ecor_Cabinets-en )

Place the following Certona Javascript on the category pages. The category value on the page
should match the categoryid in the data feed.

<script type="text/javascript">
var certona = {
"pagetype" : "CATEGORY",
"categoryid" : "CATEGORYID",
"customerid" : "CUSTOMER IDENTIFIER”(If user not logged in, do not pass any value)
};
</script>

Certona Corporation 4 Copyright 2004-2017

 Resonance® Implementation Instructions

Product page (https://www.homedepot.ca/en/home/p.25mm‐goblet‐knob.1000789107.html) 

The product ID on the page should match the product ID in the data feed.

<script type="text/javascript">
var certona = {
"pagetype" : "PRODUCT",
"itemid" : "PRODUCTID",
"customerid" : "CUSTOMER IDENTIFIER”(If user not logged in, do not pass any value)
};
</script>

Search page (https://www.homedepot.ca/en/home/search.products.html#!q=impact%20wrench) 

<script type="text/javascript">
var certona = {
"pagetype" : "SEARCH",
"customerid" : "CUSTOMER IDENTIFIER”(If user not logged in, do not pass any value)
};
</script>

No Search page
(https://www.homedepot.ca/en/home/search.products.html#!p=0&q=certonaimplementationtest%3Arel
evance) 

<script type="text/javascript">
var certona = {
"pagetype" : "NOSEARCH",
"customerid" : "CUSTOMER IDENTIFIER”(If user not logged in, do not pass any value)
};
</script>

Ideas & How-tos page (https://www.homedepot.ca/en/home/ideas‐how‐to/buying‐guides/appliances.html)

<script type="text/javascript">
var certona = {
"pagetype" : "IDEAS",
"customerid" : "CUSTOMER IDENTIFIER”(If user not logged in, do not pass any value)
};
</script>

Certona Corporation 5 Copyright 2004-2017

 Resonance® Implementation Instructions

Product compare
(https://www.homedepot.ca/en/home/products-compare.1000769080.1000722654.1000814478.html)

<script type="text/javascript">
var certona = {
"pagetype" : "COMPARE",
"itemid" : "SEMICOLON DELIMITED LIST OF PRODUCT IDS",
"customerid" : "CUSTOMER IDENTIFIER”(If user not logged in, do not pass any value)
};
</script>

Account page (https://www.homedepot.ca/en/home/account.html)

<script type="text/javascript">
var certona = {
"pagetype" : "ACCOUNT",
"customerid" : "CUSTOMER IDENTIFIER”(If user not logged in, do not pass any value))
};
</script>

Shopping Cart page (https://www.homedepot.ca/en/home/cart.html) 

 
<script type="text/javascript">
var certona = {
"pagetype" : "CART",
"itemid" : "SEMICOLON DELIMITED LIST OF PRODUCT IDS",
"customerid" : "CUSTOMER IDENTIFIER"(If user not logged in, do not pass any value)
};
</script>

Purchase Confirmation Page

<script type="text/javascript">
var certona = {
"pagetype" : "PURCHASE",
"itemid" : "SEMICOLON DELIMITED LIST OF PRODUCT IDS",
"qty" : "SEMICOLON DELIMITED LIST OF QUANTITIES",
"price" : "SEMICOLON DELIMITED LIST OF EXTENDED PRICES",
"total" : "ORDER SUBTOTAL",
"transactionid" : "UNIQUE TRANSACTION ID",
"customerid" : "CUSTOMER IDENTIFIER”(If user not logged in, do not pass any value)
};
</script>

404 Error page

<script type="text/javascript">
var certona = {
"pagetype" : "404ERROR",
"customerid" : "CUSTOMER IDENTIFIER”(If user not logged in, do not pass any value)
};
</script>

Certona Corporation 6 Copyright 2004-2017

 Resonance® Implementation Instructions

Pages with Certona Recommendations

Certona requires that the following JavaScript is set on pages where Certona recommendations are
displayed. The pageid is a unique identifer for the recommendations returned on a web service
request by Resonance. It is returned within the XML response and is used for recommendation
performance tracking.

<script type="text/javascript">
var certona = {
"pageid" : "PAGE IDENTIFIER FROM RECOMMENDATION REQUEST",
"recitems" : "SEMICOLON DELIMITED LIST OF RECOMMENDATION PRODUCT IDS"
};
</script>

For example: If there are recommendations on the product page then add pageid and recitems
variable to the Certona object

<script type="text/javascript">
var certona = {
"pagetype" : "PRODUCT",
"itemid" : "PRODUCT IDENTIFIER",
"customerid" : "CUSTOMER IDENTIFIER",
"pageid" : "PAGE IDENTIFIER FROM RECOMMENDATION RESPONSE"
"recitems" : "SEMICOLON DELIMITED LIST OF RECOMMENDATION PRODUCT IDS"
};
</script>

Note : The recitems value will be a semi-colon delimited string with each value being a pipe
separated value (productid|schemeid).
For example:
Product1_rr recommendations are 111,222,333
Product2_rr recommendations are aaa,bbb,ccc
Recitems should be set to:
"111|product1_rr;222|product1_rr;333|product1_rr;aaa|product2_rr;bbb|product2_rr;
ccc|product2_rr"

Certona Corporation 7 Copyright 2004-2017

 Resonance® Implementation Instructions

Web Service recommendation request code

HomeDepotCA will make web service requests to Certona and display recommendations on
designated pages. Recommendation requests consist of a base URL followed by query string
parameters.

Query parameters are:

 appid (required) - Use HomeDepotCA01 on all web service calls.
 trackingid (required) - This is read from the RES_TRACKINGID cookie written by the Resonance
JavaScript tag.
Note: The value of this parameter can be blank (for example, for a first time visitor with no
cookie), but the parameter is required.
 scheme (required) – Certona-provided unique scheme identifier.
 itemid – Item identifier(s) or Search Term(s). This is the product being viewed on a product
page, and a semicolon-delimited list of products in the cart on the shopping bag page. This
can also be single search term, or semicolon-delimited list of individual search terms on the
Search or No Search page.
 categoryid – Category identifier.
 cip (optional) – IP address of the visitor. e.g., &cip=209.118.149.82

 exitemid (optional) – Item identifier(s) for products that should be excluded from
recommendations.
Note: Values in the itemid parameter are automatically excluded and do not have to be
repeated in the exitemid parameter.

Pages with Certona Recommendations

 product1_rr
 product2_rr
 cart1_rr (Add to cart)
 search1_rr
 nosearch1_rr
 home1_rr
 Category1_rr
 catlanding1_rr
 error1_rr

Certona Corporation 8 Copyright 2004-2017

 Resonance® Implementation Instructions

Example: Web Service call on Product page

Product page

http://www.res‐x.com/ws/r2/resonance.aspx?appid=HomeDepotCA01&trackingid=35855169994052&sessi
onid=48483828385&scheme=product1_rr&itemid=228268&cip=209.118.149.82&output=json
Where itemid equals the product ID of the item the visitor is viewing.

Cart Add page (Add to cart)

http://www.res‐x.com/ws/r2/resonance.aspx?appid=HomeDepotCA01&trackingid=358551689794052&sch
eme=cart1_rr&itemid=228268;227957&cip=209.118.149.82&output=json 
where itemid equals the product ID(s) of the item(s) in the visitor’s shopping cart. Multiple items
are semicolon-delimited.

When the user clicks on “Addtocart” button and the above webservice call is fired to get the
cart1_rr recommendations, also call the function recsExposed() passing in the below argument as
parameter of the function call.

Note: The pageid parameter should be included only if you are making multiple WS requests on
the page. The &pageid value should be the same pageid value returned in the first WS response.

<script type="text/javascript">

recsExposed(pageid,recitems) ; (recitems will be a string)

</script>   

The recitems will be a semi-colon delimited string with each value being a pipe separated value
(productid|schemeid). For example:

Recitems should be set to:

"111|cart1_rr;222|cart1_rr;333|cart1_rr;aaa|cart1_rr;bbb

Search page

http://www.res‐x.com/ws/r2/resonance.aspx?appid=HomeDepotCA01&trackingid=35855169994052&sche
me=search1_rr&number=10&itemid=washing;machine;parts&cip=209.118.149.82&output=json 

No Search page

http://www.res‐x.com/ws/r2/resonance.aspx?appid=HomeDepotCA01&trackingid=35855169994052&sche
me=nosearch1_rr&number=10&itemid=washing;machine;parts&cip=209.118.149.82&output=json 

Certona Corporation 9 Copyright 2004-2017

 Resonance® Implementation Instructions

Home page

http://www.res‐x.com/ws/r2/resonance.aspx?appid=HomeDepotCA01&trackingid=35855169994052&sche
me=home1_rr&number=10&cip=209.118.149.82&output=json 

Category page

http://www.res‐x.com/ws/r2/resonance.aspx?appid=HomeDepotCA01&trackingid=35855169994052&sche
me=category1_rr&number=6&categoryid=categoryid&cip=209.118.149.82&output=json 
The category value should match the categoryid in the data feed.
Category landing page

http://www.res‐x.com/ws/r2/resonance.aspx?appid=HomeDepotCA01&trackingid=358551689794052&sch
eme=catlanding1_rr&itemid=228268;227957&cip=209.118.149.82&output=json 

404 error page

http://www.res‐x.com/ws/r2/resonance.aspx?appid=HomeDepotCA01&trackingid=358551689794052&sch
eme=error1_rr&itemid=228268;227957&cip=209.118.149.82&output=json 

Certona Corporation 10 Copyright 2004-2017

 Resonance® Implementation Instructions

Response
The recommendation response will be a JSON object with the following format:
{ "resonance":{
"schemes":[
{
"scheme":"product1_rr",
"explanation":"YOU MAY ALSO LIKE",
"items":[
{"ID":"1000653667"},
{"ID":"1000653668"},
{"ID":"1000653669"}
]
}
],
"pageid":"res150601111234279857287779"
}
}

pageid
There is an element in the response called pageid, used to track the recommendation performance.
The value should be read from the response and written to the page using the resx.pageid variable.
This variable is required to track the recommendation performance.

Certona Corporation 11 Copyright 2004-2017

 Resonance® Implementation Instructions

Displaying Recommendations

For reporting purposes and accuracy, Certona recommendation link URLs should contain a query
string parameter value pair of "rrec=true". If the Certona JSON response includes the item URL in
the response, Certona will append the parameter to the end of the item destination URL. For
example:

{
"id": "1000653669"
"detailURL": "http://www.domain.com/product/1000653669.html?rrec=true"
}

This query string parameter value pair should carry over to the destination URL.

If the response does not contain this URL value and this is looked up via internal API or service,
when the callback processes the response and retrieves the URL link for display, "rrec=true" should
be added to all href links for clicking through to the Certona recommended Product Detail Page.

Certona Corporation 12 Copyright 2004-2017

 Resonance® Implementation Instructions

Further Assistance
Certona is here to ensure that you have a speedy and successful implementation experience.

If you have any questions, please contact your Certona Account Representative.
www.certona.com
858-369-3888

Certona Corporation 13 Copyright 2004-2017