Shopping.com Widget Instructions

The Shopping.com Widget provides publishers with a pre-formatted shopping content module requiring little to no technical expertise.  Simply follow the steps outlined below, and shopping content will be automatically included in your page.

If you want to be paid for your referral leads, you will need to apply and be approved for API access to get your own apiKey and trackingId.  Otherwise, feel free to use the demo credentials provided in the code below.  For demo credentials for other countries, please look here.

 

1. Paste the following code in your web page source code at the location you would like the module added (Click 'view plain'.)

view plain
  1. <div>    
  2.   <div id="sdcWidgetContent"></div>    
  3.   <a href="http://www.shopping.com">    
  4.     <img style="border: none; margin: 0px; padding: 0px; height: 1px; width: 1px;" src="http://stat.dealtime.com/pixel/noscript?PV_EvnTyp=APPV&APPV_LI_LNKINID=7000610&APPV_PRTID=2002&APPV_BrnID=14305" alt="Shopping.com"/>    
  5.   </a>    
  6. </div>    
  7.   
  8. <script id="sdcWidgetGenerator" src="http://img.shopping.com/sc/pac/sdc_widget_v2.0_proxy.js"> </script>    
  9. <script>    
  10. <!--    
  11. var sdcwidget = new ShopWidget();    
  12. var sdcrequest = sdcwidget.requestParameters;    
  13.   
  14. // Widget Parameters
  15. // height and width can be absolute numbers or percentages (e.g. "540" or "80%")
  16. sdcwidget.height = "540";    
  17. sdcwidget.width = "700";    
  18. // designId options are "gallery", "listinglike" or "textlike"
  19. sdcwidget.designId = "gallery";    
  20.   
  21. // Request Parameters  
  22. sdcrequest.apiKey = "78b0db8a-0ee1-4939-a2f9-d3cd95ec0fcc";    
  23. sdcrequest.trackingId = "7000610";    
  24. sdcrequest.keyword = ["womens jeans", "sony lcd tv"];    
  25. //sdcrequest.categoryId = ["31515","7185","96602"];    
  26. //sdcrequest.attributeValue = ["ap_gender_age_women||ap_types_pants||jeans",,"brand_nike"];    
  27. //sdcrequest.productId = ["37716504","40940647"];    
  28. //sdcrequest.offerId = [""];    
  29.   
  30. sdcwidget.render();    
  31. //-->    
  32. </script>    

 

2. Update the widget parameters

To configure the widget, you will first need to choose a design and dimensions.  Currently, 3 designs are available:

designId: 'gallery'    suggested minimum height: 350    suggested minimum width: 640


designId: 'textlike'    suggested minimum height: 520    suggested minimum widght: 700

 

designId: 'listinglike'    suggested minimum height: 560    suggested minimum widght: 550

 

3. Update the request parameters

Shopping.com Widgets are not currently context sensitive (i.e. they don't automatically detect the content of your page), which  means you will need to define the search parameters manually.  You can either provide a static set of search parameters, or dynamically update these values based on user interactions (e.g. set the widget keyword to a keyword entered into your own sites search box by the user.) 

All searches require a valid trackingId and apiKey.  Additionally, you must provide at least one search parameter, the options being keyword, categoryId, productId, or offerId. A fifth search parameter, 'attributeValue' may be combined with categoryId and/or keyword, but cannot be used on it's own.

Except for categoryId, you can provide multiple values for any of the search parameters in a single request, separated by double pipes ('||').  This allows you to show results for multiple products, offers, or keywords in the same result.  You can also provide multiple sets of values for any search parameter, which will cause the widget to rotate through those sets randomly for each new page view. 

See below for a few examples of different request configurations.

 

1. Show results for a single keyword

  1. sdcrequest.keyword = ["womens jeans"];  

 

2. Show results for a single category

  1. sdcrequest.categoryId = ["7185"];  

 

3. Show results for a single keyword, category, attribute value combination

  1. sdcrequest.keyword = ["sony"];  
  2. sdcrequest.categoryId = ["7185"];  
  3. sdcrequest.attributeValue = ["ultra_compact"];  

 

4. Show results for a single product

  1. sdcrequest.productId = ["40940647"];  

 

5. Show results for a single offer

  1. sdcrequest.offerId = ["q_DA7Cut6RIpD486c4U2OQ=="];  

 

6. Show results for a single keyword and category, with multiple attribute values

  1. sdcrequest.keyword = ["red"];  
  2. sdcrequest.categoryId = ["31515"];  
  3. sdcrequest.attributeValue = ["ap_gender_age_women||dresses"];  

 

7. Show results for multiple products in the same response

  1. sdcrequest.productId = ["40940647||40741277"];  

 

8. Show results for multiple offers in the same response

  1. sdcrequest.offerId = ["q_DA7Cut6RIpD486c4U2OQ==||78MFZvt8rlWDaXIR0doseg=="];  

 

9. Rotate through results for multiple keywords

  1. sdcrequest.keyword = ["digital cameras", "lcd tvs"];  

 

10. Rotate through results for multiple keyword, category and attributeValue combinations

  1. // The same set will be selected from keyword, categoryId, and attributeValue
  2. // when rotating, ensuring parameter combinations make sense.  In this example,
  3. // there are three distinct sets:
  4. // (keyword="red", categoryId="31515", attributeValue=ap_gender_age_women||dresses)
  5. // (keyword="", categoryId="96602, attributeValue="brand_nike")
  6. // (keyword="grey aviator", categoryId="22686", attributeValue="")

  8. sdcrequest.keyword = ["red", ,"grey aviator"];  
  9. sdcrequest.categoryId = ["31515", "96602","22686"];  
  10. sdcrequest.attributeValue = ["ap_gender_age_women||dresses", "brand_nike"];  

 

11. Rotate through results for multiple sets of products

  1. sdcrequest.productId = ["40940647||40741277", "28328722||84828538"];  

 

version 19 as of 7/1/09 1:56 pm by Ryan

Comments

Please sign in to post a comment.