Add affiliate headers to the Shopping API back-end

Author: timotheus

Changes

@@ -1,6 +1,7 @@
 Changes for ebaysdk
 
 0.1.11
+- Add affiliate headers to the Shopping API back-end
 - https://github.com/timotheus/ebaysdk-python/issues/40
   fix datatype issue with error codes from the shopping API
 

ebay.yaml

@@ -27,3 +27,8 @@ svcs.ebay.com:
 open.api.ebay.com:
     appid: ENTER_YOUR_APPID_HERE
     version: 671
+
+    # Optional affiliate tracking
+    # http://developer.ebay.com/DevZone/shopping/docs/Concepts/ShoppingAPI_FormatOverview.html#StandardURLParameters
+    trackingid: ENTER_YOUR_TRACKINGID_HERE
+    trackingpartnercode: ENTER_YOUR_PARTNERCODE_HERE 

ebaysdk/__init__.py

@@ -461,7 +461,7 @@ def __init__(self, **kwargs):
         config_file   -- YAML defaults (default: ebay.yaml)
         debug         -- debugging enabled (default: False)
         warnings      -- warnings enabled (default: True)
-        errors      -- errors enabled (default: True)
+        errors        -- errors enabled (default: True)
         uri           -- API endpoint uri (default: /shopping)
         appid         -- eBay application id
         siteid        -- eBay country site id (default: 0 (US))
@@ -471,8 +471,14 @@ def __init__(self, **kwargs):
         proxy_port    -- proxy port number
         timeout       -- HTTP request timeout (default: 20)
         parallel      -- ebaysdk parallel object
-        response_encoding -- API encoding (default: XML)
-        request_encoding  -- API encoding (default: XML)
+        trackingid    -- ID to identify you to your tracking partner
+        trackingpartnercode -- third party who is your tracking partner
+        response_encoding   -- API encoding (default: XML)
+        request_encoding    -- API encoding (default: XML)
+
+        More affiliate tracking info:
+        http://developer.ebay.com/DevZone/shopping/docs/Concepts/ShoppingAPI_FormatOverview.html#StandardURLParameters
+
         """
         ebaybase.__init__(self, method='POST', **kwargs)
 
@@ -500,12 +506,14 @@ def __init__(self, **kwargs):
         self.set_config('proxy_port', None)
         self.set_config('appid', None)
         self.set_config('version', '799')
+        self.set_config('trackingid', None)
+        self.set_config('trackingpartnercode', None)
 
         if self.api_config['https'] and self.debug:
             print("HTTPS is not supported on the Shopping API.")
 
     def _build_request_headers(self):
-        return {
+        headers = {
             "X-EBAY-API-VERSION": self.api_config.get('version', ''),
             "X-EBAY-API-APP-ID":  self.api_config.get('appid', ''),
             "X-EBAY-API-SITEID":  self.api_config.get('siteid', ''),
@@ -514,6 +522,18 @@ def _build_request_headers(self):
             "Content-Type": "text/xml"
         }
 
+        if self.api_config.get('trackingid', None):
+            headers.update({
+                "X-EBAY-API-TRACKING-ID": self.api_config.get('trackingid', '')
+            })
+
+        if self.api_config.get('trackingpartnercode', None):
+            headers.update({
+                "X-EBAY-API-TRACKING-PARTNER-CODE": self.api_config.get('trackingpartnercode', '')
+            })
+
+        return headers
+
     def _build_request_xml(self):
         xml = "<?xml version='1.0' encoding='utf-8'?>"
         xml += "<" + self.verb + "Request xmlns=\"urn:ebay:apis:eBLBaseComponents\">"

samples/shopping.py

@@ -130,7 +130,20 @@ def categoryInfo(opts):
     api = shopping(debug=opts.debug, appid=opts.appid, config_file=opts.yaml,
                    warnings=True)
 
-    api.execute('getCategoryInfo', {"CategoryID": 3410})
+    api.execute('GetCategoryInfo', {"CategoryID": 3410})
+
+    dump(api, full=False)
+
+def with_affiliate_info(opts):
+    api = shopping(debug=opts.debug, appid=opts.appid, config_file=opts.yaml,
+                   warnings=True, trackingid=1234, trackingpartnercode=9)
+
+    mySearch = {    
+        "MaxKeywords": 10,
+        "QueryKeywords": 'shirt',
+    }
+
+    api.execute('FindPopularSearches', mySearch)
 
     dump(api, full=False)
 
@@ -139,3 +152,4 @@ def categoryInfo(opts):
     run(opts)
     popularSearches(opts)
     categoryInfo(opts)
+    with_affiliate_info(opts)