Releasing v20.0.0

Author: benkarl

ChangeLog

@@ -1,3 +1,7 @@
+20.0.0 -- 06/11/2019
+* Updated examples to be Python 3 compatible
+* Removed suds dependency leaving zeep as the only supported SOAP client
+
 19.0.1 -- 05/22/2019
 * Really removed examples for Ad Manager v201808
 

README.md

@@ -9,6 +9,9 @@ and DoubleClick for Publishers. The library provides easy ways to store your
 authentication and create SOAP web service clients. It also contains example
 code to help you get started integrating with our APIs.
 
+**NOTE**: As of v20.0.0 this library is _not_ compatible with Python versions less than Python 3.6.
+Also `suds` is no longer supported in this library, `zeep` is now the only supported SOAP client.
+
 ## Getting started
 1. Download and install the library
 
@@ -112,12 +115,6 @@ can do the following:
 logging.basicConfig(level=logging.INFO, format=googleads.util.LOGGER_FORMAT)
 logging.getLogger('googleads.soap').setLevel(logging.DEBUG)
 ```
-
-If you are using suds, you can achieve the same like this:
-```python
-logging.basicConfig(level=logging.INFO, format=googleads.util.LOGGER_FORMAT)
-logging.getLogger('suds.transport').setLevel(logging.DEBUG)
-```
 If you wish to log to a file, you'll need to attach a log handler to this source
 which is configured to write the output to a file.
 
@@ -138,68 +135,14 @@ class DangerousZeepLogger(zeep.Plugin):
 adwords_client.zeep_client.plugins.append(DangerousZeepLogger())
 ```
 
-When using suds, this library will apply log filters to the `googleads.common`,
-`suds.client`, and `suds.transport` loggers in order to omit sensitive data. If
-you need to see this data in your logs, you can disable the filters with the
-following:
-```python
-logging.getLogger('googleads.common').removeFilter(
-    googleads.util.GetGoogleAdsCommonFilter())
-logging.getLogger('suds.client').removeFilter(
-    googleads.util.GetSudsClientFilter())
-logging.getLogger('suds.mx.core').removeFilter(
-    googleads.util.GetSudsMXCoreFilter())
-logging.getLogger('suds.mx.literal').removeFilter(
-    googleads.util.GetSudsMXLiteralFilter())
-logging.getLogger('suds.transport').removeFilter(
-    googleads.util.GetSudsTransportFilter())
-```
-
-
-## I'm familiar with suds/zeep. Can I use those features in the library?
-Yes, you can. The services returned by the `client.GetService()` functions all
-have a reference to the underlying client stored in the `zeep_client` or `suds_client`
-attributes. You can retrieve the client and use it in familiar ways:
-```python
-client = AdWordsClient.LoadFromStorage()
-campaign_service = client.GetService('CampaignService')
-suds_client = campaign_service.suds_client
-
-campaign = suds_client.factory.create('Campaign')
-# Set any attributes on the campaign object which you need.
-campaign.name = 'My Campaign'
-campaign.status = 'PAUSED'
-
-operation = suds_client.factory.create('CampaignOperation')
-operation.operator = 'ADD'
-operation.operand = campaign
-
-# The service object returned from the client.GetService() call accepts suds
-# objects and will set the SOAP and HTTP headers for you.
-campaign_service.mutate([operation])
-
-# Alternatively, if you wish to set the headers yourself, you can use the
-# suds_client.service directly.
-soap_header = suds_client.factory.create('SoapHeader')
-soap_header.clientCustomerId = client.client_customer_id
-soap_header.developerToken = client.developer_token
-soap_header.userAgent = client.user_agent
-
-suds_client.set_options(
-    soapheaders=soap_header,
-    headers=client.oauth2_client.CreateHttpHeader())
-
-suds_client.service.mutate([operation])
-```
-
 ## How can I configure or disable caching?
 
 By default, clients are cached because reading and digesting the WSDL
 can be expensive. However, the default caching method requires permission to
 access a local file system that may not be available in certain hosting
 environments such as App Engine.
 
-You can pass an implementation of `suds.cache.Cache` or `zeep.cache.Base` to the `AdWordsClient` or
+You can pass an implementation of `zeep.cache.Base` to the `AdWordsClient` or
 `AdManagerClient` initializer to modify the default caching behavior.
 
 For example, configuring a different location and duration of the cache file with zeep
@@ -210,14 +153,6 @@ adwords_client = adwords.AdWordsClient(
   client_customer_id=client_customer_id, cache=doc_cache)
 ```
 
-And with suds:
-```python
-doc_cache = suds.cache.DocumentCache(location=cache_path, days=2)
-adwords_client = adwords.AdWordsClient(
-  developer_token, oauth2_client, user_agent,
-  client_customer_id=client_customer_id, cache=doc_cache)
-```
-
 You can also disable caching in similar fashion with zeep
 ```python
 adwords_client = adwords.AdWordsClient(
@@ -226,26 +161,16 @@ adwords_client = adwords.AdWordsClient(
   cache=googleads.common.ZeepServiceProxy.NO_CACHE)
 ```
 
-And with suds:
-```python
-adwords_client = adwords.AdWordsClient(
-  developer_token, oauth2_client, user_agent,
-  client_customer_id=client_customer_id, cache=suds.cache.NoCache())
-```
-
-
 ## Requirements
 
 ### Python Versions
 
-This library supports both Python 2 and 3. To use this library, you will need to
-have Python 2.7.9 (or higher) or Python 3.4 (or higher) installed.
+This library only supports Python 3.6+.
 
 ### External Dependencies:
 
     - httplib2             -- https://pypi.python.org/pypi/httplib2/
     - oauth2client         -- https://pypi.python.org/pypi/oauth2client/
-    - suds-jurko           -- https://pypi.python.org/pypi/suds-jurko/
     - pysocks              -- https://pypi.python.org/pypi/PySocks/
     - pytz                 -- https://pypi.python.org/pypi/pytz
     - pyYAML               -- https://pypi.python.org/pypi/pyYAML/

examples/ad_manager/authentication/create_ad_manager_client_with_access_token.py

@@ -61,8 +61,8 @@ def main(access_token, token_expiry, application_name):
 
   networks = ad_manager_client.GetService('NetworkService').getAllNetworks()
   for network in networks:
-    print ('Network with network code "%s" and display name "%s" was found.'
-           % (network['networkCode'], network['displayName']))
+    print('Network with network code "%s" and display name "%s" was found.'
+          % (network['networkCode'], network['displayName']))
 
 
 if __name__ == '__main__':

examples/ad_manager/authentication/create_ad_manager_client_with_refresh_token.py

@@ -45,8 +45,8 @@ def main(client_id, client_secret, refresh_token, application_name):
 
   networks = ad_manager_client.GetService('NetworkService').getAllNetworks()
   for network in networks:
-    print ('Network with network code "%s" and display name "%s" was found.'
-           % (network['networkCode'], network['displayName']))
+    print('Network with network code "%s" and display name "%s" was found.'
+          % (network['networkCode'], network['displayName']))
 
 
 if __name__ == '__main__':

examples/ad_manager/authentication/create_ad_manager_client_with_service_account.py

@@ -37,8 +37,8 @@ def main(key_file, application_name):
 
   networks = ad_manager_client.GetService('NetworkService').getAllNetworks()
   for network in networks:
-    print ('Network with network code "%s" and display name "%s" was found.'
-           % (network['networkCode'], network['displayName']))
+    print('Network with network code "%s" and display name "%s" was found.'
+          % (network['networkCode'], network['displayName']))
 
 
 if __name__ == '__main__':

examples/ad_manager/authentication/generate_refresh_token.py

@@ -95,19 +95,19 @@ def main(client_id, client_secret, scopes):
 
   auth_url, _ = flow.authorization_url(prompt='consent')
 
-  print ('Log into the Google Account you use to access your Ad Manager account'
-         'and go to the following URL: \n%s\n' % (auth_url))
-  print 'After approving the token enter the verification code (if specified).'
+  print('Log into the Google Account you use to access your Ad Manager account'
+        'and go to the following URL: \n%s\n' % (auth_url))
+  print('After approving the token enter the verification code (if specified).')
   code = raw_input('Code: ').strip()
 
   try:
     flow.fetch_token(code=code)
   except InvalidGrantError as ex:
-    print 'Authentication has failed: %s' % ex
+    print('Authentication has failed: %s' % ex)
     sys.exit(1)
 
-  print 'Access token: %s' % flow.credentials.token
-  print 'Refresh token: %s' % flow.credentials.refresh_token
+  print('Access token: %s' % flow.credentials.token)
+  print('Refresh token: %s' % flow.credentials.refresh_token)
 
 
 if __name__ == '__main__':

examples/ad_manager/v201811/activity_group_service/create_activity_groups.py

@@ -62,8 +62,8 @@ def main(client, advertiser_company_id):
 
   # Display results.
   for activity_group in activity_groups:
-    print ('Activity group with ID "%s" and name "%s" was created.'
-           % (activity_group['id'], activity_group['name']))
+    print('Activity group with ID "%s" and name "%s" was created.'
+          % (activity_group['id'], activity_group['name']))
 
 if __name__ == '__main__':
   # Initialize client object.

examples/ad_manager/v201811/activity_group_service/get_active_activity_groups.py

@@ -43,7 +43,7 @@ def main(client):
     else:
       break
 
-  print '\nNumber of results found: %s' % response['totalResultSetSize']
+  print('\nNumber of results found: %s' % response['totalResultSetSize'])
 
 
 if __name__ == '__main__':

examples/ad_manager/v201811/activity_group_service/get_all_activity_groups.py

@@ -42,7 +42,7 @@ def main(client):
     else:
       break
 
-  print '\nNumber of results found: %s' % response['totalResultSetSize']
+  print('\nNumber of results found: %s' % response['totalResultSetSize'])
 
 
 if __name__ == '__main__':

examples/ad_manager/v201811/activity_group_service/update_activity_groups.py

@@ -42,7 +42,7 @@ def main(client, activity_group_id, advertiser_company_id):
   # Create statement object to select a single activity groups by ID.
   statement = (ad_manager.StatementBuilder(version='v201811')
                .Where('id = :activityGroupId')
-               .WithBindVariable('activityGroupId', long(activity_group_id))
+               .WithBindVariable('activityGroupId', int(activity_group_id))
                .Limit(1))
 
   # Get activity groups by statement.
@@ -58,10 +58,10 @@ def main(client, activity_group_id, advertiser_company_id):
         updated_activity_groups)
 
     for activity_group in activity_groups:
-      print (('Activity group with ID "%s" and name "%s" was updated.')
-             % (activity_group['id'], activity_group['name']))
+      print(('Activity group with ID "%s" and name "%s" was updated.')
+            % (activity_group['id'], activity_group['name']))
   else:
-    print 'No activity groups found to update.'
+    print('No activity groups found to update.')
 
 
 if __name__ == '__main__':