Updating examples, no longer sending return_money_in_micros in AdWords v201406.

Author: msaniscalchi

ChangeLog

@@ -1,3 +1,8 @@
+2.0.0 - 07/22/2014
+=================
+* AdGroups/Campaigns no longer renamed on remove/delete in examples, obsolete.
+* GoogleAdsValueError now thrown when returnMoneyInMicros is sent with v201406.
+
 1.0.7 - 07/7/2014
 =================
 * Added support for v201406 of the AdWords/DoubleClick Ad Exchange Client

examples/adwords/v201402/basic_operations/delete_ad_group.py

@@ -29,8 +29,6 @@
 __author__ = ('[email protected] (Kevin Winter)'
               'Joseph DiLallo')
 
-from datetime import datetime
-
 from googleads import adwords
 
 
@@ -46,10 +44,6 @@ def main(client, ad_group_id):
       'operator': 'SET',
       'operand': {
           'id': ad_group_id,
-          # We recommend including the original name when renaming before
-          # delete.
-          'name': ('Deleted on %s' %
-                   datetime.today().strftime('%Y%m%d %H:%M:%S.%f')),
           'status': 'DELETED'
       }
   }]

examples/adwords/v201402/basic_operations/delete_campaign.py

@@ -29,8 +29,6 @@
 __author__ = ('[email protected] (Kevin Winter)'
               'Joseph DiLallo')
 
-from datetime import datetime
-
 from googleads import adwords
 
 
@@ -46,10 +44,6 @@ def main(client, campaign_id):
       'operator': 'SET',
       'operand': {
           'id': campaign_id,
-          # We recommend including the original name when renaming before
-          # delete.
-          'name': ('Deleted on %s' %
-                   datetime.today().strftime('%Y%m%d %H:%M:%S.%f')),
           'status': 'DELETED'
       }
   }]

examples/adwords/v201406/basic_operations/remove_ad_group.py

@@ -29,8 +29,6 @@
 __author__ = ('[email protected] (Kevin Winter)'
               'Joseph DiLallo')
 
-from datetime import datetime
-
 from googleads import adwords
 
 
@@ -46,10 +44,6 @@ def main(client, ad_group_id):
       'operator': 'SET',
       'operand': {
           'id': ad_group_id,
-          # We recommend including the original name when renaming before
-          # delete.
-          'name': ('Removed on %s' %
-                   datetime.today().strftime('%Y%m%d %H:%M:%S.%f')),
           'status': 'REMOVED'
       }
   }]

examples/adwords/v201406/basic_operations/remove_campaign.py

@@ -29,8 +29,6 @@
 __author__ = ('[email protected] (Kevin Winter)'
               'Joseph DiLallo')
 
-from datetime import datetime
-
 from googleads import adwords
 
 
@@ -46,10 +44,6 @@ def main(client, campaign_id):
       'operator': 'SET',
       'operand': {
           'id': campaign_id,
-          # We recommend including the original name when renaming before
-          # delete.
-          'name': ('Removed on %s' %
-                   datetime.today().strftime('%Y%m%d %H:%M:%S.%f')),
           'status': 'REMOVED'
       }
   }]

googleads/adwords.py

@@ -116,6 +116,8 @@
 
 # The endpoint used by default when making AdWords API requests.
 _DEFAULT_ENDPOINT = 'https://adwords.google.com'
+# The final version where return_money_in_micros is accepted.
+_FINAL_RETURN_MONEY_IN_MICROS_VERSION = 'v201402'
 
 
 class AdWordsClient(object):
@@ -320,7 +322,20 @@ def SetHeaders(self, suds_client):
         headers=self._adwords_client.oauth2_client.CreateHttpHeader())
 
   def GetReportDownloadHeaders(self, return_money_in_micros=None):
-    """Returns a dictionary of headers for a report download request."""
+    """Returns a dictionary of headers for a report download request.
+
+    Args:
+      return_money_in_micros: A boolean indicating whether money should be
+          represented as micros in reports. If None is supplied the AdWords
+          server will use its default value, which is currently True.
+
+    Returns:
+      A dictionary containing the headers configured for downloading a report.
+
+    Raises:
+      GoogleAdsValueError: if return_money_in_micros used with incompatible
+          version.
+    """
     headers = self._adwords_client.oauth2_client.CreateHttpHeader()
     headers.update({
         'Content-type': self._CONTENT_TYPE,
@@ -329,8 +344,13 @@ def GetReportDownloadHeaders(self, return_money_in_micros=None):
         'User-Agent': ''.join([self._adwords_client.user_agent, self._LIB_SIG,
                                ',gzip'])
     })
-    if return_money_in_micros is not None and self._version != 'v201406':
-      headers.update({'returnMoneyInMicros': str(return_money_in_micros)})
+    if return_money_in_micros is not None:
+      if self._version == _FINAL_RETURN_MONEY_IN_MICROS_VERSION:
+        headers.update({'returnMoneyInMicros': str(return_money_in_micros)})
+      else:
+        raise googleads.errors.GoogleAdsValueError('returnMoneyInMicros isn\'t'
+                                                   'supported in this version.')
+
     return headers
 
 

googleads/common.py

@@ -26,7 +26,7 @@
 import googleads.errors
 import googleads.oauth2
 
-VERSION = '1.0.7'
+VERSION = '2.0.0'
 _COMMON_LIB_SIG = 'googleads/%s' % VERSION
 _PYTHON_VERSION = 'Python/%d.%d' % (sys.version_info[0], sys.version_info[1])
 

tests/adwords_test.py

@@ -35,15 +35,18 @@
 
 PYTHON2 = sys.version_info[0] == 2
 URL_REQUEST_PATH = ('urllib2' if PYTHON2 else 'urllib.request')
+CURRENT_VERSION = sorted(googleads.adwords._SERVICE_MAP.keys())[-1]
 
 
 class AdWordsHeaderHandlerTest(unittest.TestCase):
   """Tests for the googleads.adwords._AdWordsHeaderHandler class."""
 
   def setUp(self):
     self.adwords_client = mock.Mock()
+    self.header_handler_v201402 = googleads.adwords._AdWordsHeaderHandler(
+        self.adwords_client, 'v201402')
     self.header_handler = googleads.adwords._AdWordsHeaderHandler(
-        self.adwords_client, 'v12345')
+        self.adwords_client, CURRENT_VERSION)
 
   def testSetHeaders(self):
     suds_client = mock.Mock()
@@ -65,7 +68,8 @@ def testSetHeaders(self):
 
     # Check that the SOAP header has the correct values.
     suds_client.factory.create.assert_called_once_with(
-        '{https://adwords.google.com/api/adwords/cm/v12345}SoapHeader')
+        '{https://adwords.google.com/api/adwords/cm/%s}SoapHeader' %
+        CURRENT_VERSION)
     soap_header = suds_client.factory.create.return_value
     self.assertEqual(ccid, soap_header.clientCustomerId)
     self.assertEqual(dev_token, soap_header.developerToken)
@@ -79,7 +83,7 @@ def testSetHeaders(self):
     suds_client.set_options.assert_any_call(
         soapheaders=soap_header, headers=oauth_header)
 
-  def testGetReportDownloadHeaders(self):
+  def testGetReportDownloadHeaders_v201402(self):
     ccid = 'client customer id'
     dev_token = 'developer token'
     user_agent = 'user agent!'
@@ -103,14 +107,15 @@ def testGetReportDownloadHeaders(self):
     # Check that returnMoneyInMicros works when set to true.
     expected_return_value['returnMoneyInMicros'] = 'True'
     self.assertEqual(expected_return_value,
-                     self.header_handler.GetReportDownloadHeaders(True))
+                     self.header_handler_v201402.GetReportDownloadHeaders(True))
 
     # Check that returnMoneyInMicros works when set to false.
     expected_return_value['returnMoneyInMicros'] = 'False'
     self.adwords_client.oauth2_client.CreateHttpHeader.return_value = dict(
         oauth_header)
     self.assertEqual(expected_return_value,
-                     self.header_handler.GetReportDownloadHeaders(False))
+                     self.header_handler_v201402.GetReportDownloadHeaders(False)
+                    )
 
     # Default returnMoneyInMicros value is not included in the headers.
     del expected_return_value['returnMoneyInMicros']
@@ -119,6 +124,40 @@ def testGetReportDownloadHeaders(self):
     self.assertEqual(expected_return_value,
                      self.header_handler.GetReportDownloadHeaders())
 
+  def testGetReportDownloadHeaders_v201406(self):
+    ccid = 'client customer id'
+    dev_token = 'developer token'
+    user_agent = 'user agent!'
+    oauth_header = {'Authorization': 'header'}
+    self.adwords_client.client_customer_id = ccid
+    self.adwords_client.developer_token = dev_token
+    self.adwords_client.user_agent = user_agent
+    self.adwords_client.oauth2_client.CreateHttpHeader.return_value = dict(
+        oauth_header)
+    expected_return_value = {
+        'Content-type': 'application/x-www-form-urlencoded',
+        'developerToken': dev_token,
+        'clientCustomerId': ccid,
+        'Authorization': 'header',
+        'User-Agent': ''.join([
+            user_agent, googleads.adwords._AdWordsHeaderHandler._LIB_SIG,
+            ',gzip'])
+    }
+
+    # Check that returnMoneyInMicros fails when set to true.
+    self.assertRaises(googleads.errors.GoogleAdsValueError,
+                      self.header_handler.GetReportDownloadHeaders, True)
+
+    # Check that returnMoneyInMicros fails when set to false.
+    self.assertRaises(googleads.errors.GoogleAdsValueError,
+                      self.header_handler.GetReportDownloadHeaders, False)
+
+    # Check that it works when returnMoneyInMicros not set.
+    self.adwords_client.oauth2_client.CreateHttpHeader.return_value = dict(
+        oauth_header)
+    self.assertEqual(expected_return_value,
+                     self.header_handler.GetReportDownloadHeaders())
+
 
 class AdWordsClientTest(unittest.TestCase):
   """Tests for the googleads.adwords.AdWordsClient class."""
@@ -144,7 +183,7 @@ def testLoadFromStorage(self):
                             googleads.adwords.AdWordsClient)
 
   def testGetService_success(self):
-    version = googleads.adwords._SERVICE_MAP.keys()[0]
+    version = CURRENT_VERSION
     service = googleads.adwords._SERVICE_MAP[version].keys()[0]
     namespace = googleads.adwords._SERVICE_MAP[version][service]
 
@@ -172,7 +211,7 @@ def testGetService_success(self):
       self.assertIsInstance(suds_service, googleads.common.SudsServiceProxy)
 
   def testGetService_badService(self):
-    version = googleads.adwords._SERVICE_MAP.keys()[0]
+    version = CURRENT_VERSION
     self.assertRaises(
         googleads.errors.GoogleAdsValueError, self.adwords_client.GetService,
         'GYIVyievfyiovslf', version)
@@ -195,7 +234,7 @@ class ReportDownloaderTest(unittest.TestCase):
   """Tests for the googleads.adwords.ReportDownloader class."""
 
   def setUp(self):
-    self.version = googleads.adwords._SERVICE_MAP.keys()[-1]
+    self.version = CURRENT_VERSION
     self.marshaller = mock.Mock()
     self.header_handler = mock.Mock()
     self.adwords_client = mock.Mock()