AdWords v201607 Sunset.

Author: msaniscalchi

ChangeLog

@@ -1,7 +1,17 @@
-5.6.0 -- 06/01/17:
+6.0.0 -- 6/27/17:
+* Removed support for AdWords v201607.
+* Improved logging support. Can now specify logging configuration from the
+  configuration file.
+* Added new GoogleAccessTokenClient, a non-refreshable client that only requires
+  the access token.
+* Resolved issues:
+- Issue 84: https://github.com/googleads/googleads-python-lib/issues/84
+- Issue 171: https://github.com/googleads/googleads-python-lib/issues/171
+
+5.6.0 -- 6/01/17:
 * Added support for AdWords v201705.
 
-5.5.0 -- 05/23/17:
+5.5.0 -- 5/23/17:
 * Added more expressive python utility to build DFP PQL statements.
 * Support building DFP SOAP entities with native python date/datetime objects.
 * Added support and examples for DFP v201705.

README.md

@@ -101,8 +101,12 @@ for API change announcements and other news.
 
 
 ## How do I log SOAP interactions?
-The library uses Python's built in logging framework. If you wish to log your
-SOAP interactions to stdout, you can do the following:
+The library uses Python's built in logging framework. You can specify your
+configuration via the configuration file; see [googleads.yaml](https://github.com/googleads/googleads-python-lib/blob/master/googleads.yaml)
+for an example.
+
+Alternatively, you can manually specify your logging configuration. For example,
+if you want to log your SOAP interactions to stdout, you can do the following:
 ```python
 logging.basicConfig(level=logging.INFO, format=googleads.util.LOGGER_FORMAT)
 logging.getLogger('suds.transport').setLevel(logging.DEBUG)
@@ -121,6 +125,10 @@ 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())
 ```

examples/adwords/adwords_appengine_demo/ChangeLog

@@ -1,6 +1,10 @@
-1.0.1 - 1/5/2015
-- Updated dependencies listed in README, for the changes introduced in googleads
-  3.0.0.
+1.0.2 -- 6/21/16:
+- Fixed issue #171:
+  https://github.com/googleads/googleads-python-lib/issues/171
+
+1.0.1 -- 1/5/15:
+- Updated dependencies listed in README, for the changes introduced in
+  googleads 3.0.0.
 
 1.0.0:
-- Initial release of the demo.
+- Initial release of the demo.

examples/adwords/adwords_appengine_demo/README.md

@@ -36,19 +36,19 @@ prepared your OAuth2 Credentials via the Google Developers Console.
 1. Install Python v2.7, which you can get
    [here](https://www.python.org/downloads).
 
-2. Install [pip](http://pip.readthedocs.org/en/latest/installing.html),
+1. Install [pip](http://pip.readthedocs.org/en/latest/installing.html),
    if you have not done so already.
 
-3. If you don't have one already,
+1. If you don't have one already,
    [sign up for a Google Account](https://www.google.com/accounts/NewAccount).
    This account will be used to access your AdWords credentials used in making
    API requests.
 
-4. Download the latest version of the
+1. Download the latest version of the
    [App Engine SDK](https://developers.google.com/appengine/downloads) and
    unpack its content. This demo should be compatible with  v1.9.11+.
 
-5. Install googleads with the following command:
+1. Install googleads with the following command:
 
    `$ pip install googleads`
 
@@ -57,36 +57,42 @@ prepared your OAuth2 Credentials via the Google Developers Console.
    should also have installed the dependencies referred to in the following
    steps.
 
-6. Copy the httplib2 package from your Python installation's dist-packages
+1. Copy the httplib2 package from your Python installation's dist-packages
    directory into this project.
 
-7. Copy the oauth2client package from your Python installation's dist-packages
+1. Copy the oauth2client package from your Python installation's dist-packages
    directory into this project.
 
-8. Copy the pytz package from your Python installation's dist-packages
+1. Copy the pyasn1 package from your Python installation's dist-packages
    directory into this project.
 
-9. Copy socks.py from the PySocks tarball found in your Python installation's
+1. Copy socks.py from the PySocks tarball found in your Python installation's
    dist-packages directory into this project.
 
-10. Copy the suds package from your Python installation's dist-packages
+1. Copy the rsa package from your Python installation's dist-packages
+   into this project.
+
+1. Copy the suds package from your Python installation's dist-packages
+   into this project.
+
+1. Copy xmltodict.py from your Python installation's dist-packages directory
    directory into this project.
 
-11. Create an App Engine application in the
+1. Create an App Engine application in the
    [Google App Engine Console](https://appengine.google.com/).
 
-12. Go to this project's app.yaml, and enter in your application name for the
+1. Go to this project's app.yaml, and enter in your application name for the
    "application" field.
 
-13. You can now deploy this project by running the following command:
+1. You can now deploy this project by running the following command:
 
     `python $APPENGINE_SDK_DIR/appcfg --oauth2 update .`
 
-14. When you go to your App for the first time, you will need to log in and
+1. When you go to your App for the first time, you will need to log in and
     provide OAuth2 and AdWords API credentials. You can use credentials
     generated via the generate_refresh_token.py example.
 
-15. With all information entered, you can now use the UI to view and modify
+1. With all information entered, you can now use the UI to view and modify
     your account details.
 
 

examples/adwords/adwords_appengine_demo/app.yaml

@@ -13,3 +13,7 @@ handlers:
   script: demo.main.app
   login: required
   secure: always
+
+libraries:
+- name: ssl
+  version: latest

examples/adwords/adwords_appengine_demo/handlers/api_handler.py

@@ -19,12 +19,11 @@
 import time
 
 
-from suds.cache import NoCache
-
 from demo import VERSION
 from googleads.adwords import AdWordsClient
 from googleads.errors import GoogleAdsError
 from googleads.oauth2 import GoogleRefreshTokenClient
+from suds.cache import NoCache
 
 
 class APIHandler(object):
@@ -48,7 +47,7 @@ def __init__(self, client_id, client_secret, refresh_token,
                                            refresh_token)
     self.client = AdWordsClient(dev_token, credentials, self._USER_AGENT,
                                 client_customer_id=manager_account_id,
-                                cache=NoCache)
+                                cache=NoCache())
 
   def AddAdGroup(self, client_customer_id, campaign_id, name, status):
     """Create a new ad group.

examples/adwords/adwords_appengine_demo/handlers/ndb_handler.py

@@ -43,22 +43,22 @@ def InitUser():
 
 
 def UpdateUserCredentials(client_id, client_secret, refresh_token,
-                          manager_account_id, developer_token):
+                          adwords_manager_cid, developer_token):
   """Update the credentials associated with application user.
 
   Args:
     client_id: str Client Id retrieved from the developer's console.
     client_secret: str Client Secret retrieved from the developer's console.
     refresh_token: str Refresh token generated with the above client id/secret.
-    manager_account_id: str Customer Id for the AdWords manager account.
+    adwords_manager_cid: str Customer Id for the AdWords manager account.
     developer_token: str Developer Token for the AdWords account.
   """
   app_user = AppUser.query(AppUser.user == users.get_current_user()).fetch()[0]
 
   app_user.client_id = client_id
   app_user.client_secret = client_secret
   app_user.refresh_token = refresh_token
-  app_user.manager_account_id = manager_account_id
+  app_user.adwords_manager_cid = adwords_manager_cid
   app_user.developer_token = developer_token
 
   app_user.put()

examples/adwords/adwords_appengine_demo/templates/show_credentials.html

@@ -24,8 +24,8 @@
       </tr>
       <tr>
         <th><label for="adwords_manager_cid">AdWords Manager Account Id: </label></th>
-        <td><input type="text" name="manager_account_id" size="35"
-                   value="{{ manager_account_id }}"/></td>
+        <td><input type="text" name="adwords_manager_cid" size="35"
+                   value="{{ adwords_manager_cid }}"/></td>
       </tr>
       <tr>
       <th><label for="dev_token">Developer Token: </label></th>
@@ -39,4 +39,4 @@
       </tr>
     </table>
   </form>
-{% endblock %}
+{% endblock %}

examples/adwords/adwords_appengine_demo/views/update_credentials_view.py

@@ -41,7 +41,7 @@ def post(self):
       UpdateUserCredentials(self.request.get('client_id'),
                             self.request.get('client_secret'),
                             self.request.get('refresh_token'),
-                            self.request.get('manager_account_id'),
+                            self.request.get('adwords_manager_cid'),
                             self.request.get('dev_token'))
       self.redirect('/showCredentials')
     except Exception, e:

examples/adwords/authentication/create_adwords_client_with_access_token.py

@@ -0,0 +1,86 @@
+#!/usr/bin/env python
+#
+# Copyright 2017 Google Inc. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+"""Initializes an AdWordsClient using GoogleAccessTokenClient.
+
+Note that unlike clients initialized with GoogleRefreshTokenClient, those
+initialized with GoogleAccessTokenClient can't refresh.
+"""
+
+import argparse
+import datetime
+from googleads import adwords
+from googleads import oauth2
+import httplib2
+from oauth2client import client
+
+
+GOOGLE_OAUTH2_ENDPOINT = 'https://accounts.google.com/o/oauth2/token'
+
+# OAuth2 credential information.
+DEFAULT_CLIENT_ID = 'INSERT_CLIENT_ID_HERE'
+DEFAULT_CLIENT_SECRET = 'INSERT_CLIENT_SECRET_HERE'
+DEFAULT_REFRESH_TOKEN = 'INSERT_REFRESH_TOKEN_HERE'
+
+# AdWords API information.
+DEFAULT_CLIENT_CUSTOMER_ID = 'INSERT_CLIENT_CUSTOMER_ID_HERE'
+DEFAULT_DEVELOPER_TOKEN = 'INSERT_DEVELOPER_TOKEN_HERE'
+USER_AGENT = 'INSERT_USER_AGENT_HERE'
+
+
+parser = argparse.ArgumentParser(
+    description=('Creates an AdWordsClient using a GoogleAccessToken with an '
+                 'access token generated with the given credentials.'))
+parser.add_argument('--client_id', default=DEFAULT_CLIENT_ID,
+                    help='Client Id retrieved from the Developer\'s Console.')
+parser.add_argument('--client_secret', default=DEFAULT_CLIENT_SECRET,
+                    help='Client Secret retrieved from the Developer\'s '
+                    'Console.')
+parser.add_argument('--refresh_token', default=DEFAULT_REFRESH_TOKEN,
+                    help='The refresh token used to generate an access token.')
+parser.add_argument('--client_customer_id', default=DEFAULT_CLIENT_CUSTOMER_ID,
+                    help='The client customer ID for your AdWords account.')
+parser.add_argument('--developer_token', default=DEFAULT_DEVELOPER_TOKEN,
+                    help='The refresh token used to generate an access token.')
+
+
+def main(access_token, token_expiry, client_customer_id, developer_token,
+         user_agent):
+  oauth2_client = oauth2.GoogleAccessTokenClient(access_token, token_expiry)
+
+  adwords_client = adwords.AdWordsClient(
+      developer_token, oauth2_client, user_agent,
+      client_customer_id=client_customer_id)
+
+  customer = adwords_client.GetService('CustomerService').getCustomers()[0]
+  print 'You are logged in as customer: %s' % customer['customerId']
+
+
+if __name__ == '__main__':
+  args = parser.parse_args()
+
+  # Retrieve a new access token for use in this example. In a production
+  # application, you may use a credential store to share access tokens for a
+  # given user across applications.
+  oauth2credentials = client.OAuth2Credentials(
+      None, args.client_id, args.client_secret, args.refresh_token,
+      datetime.datetime(1980, 1, 1, 12), GOOGLE_OAUTH2_ENDPOINT,
+      USER_AGENT)
+
+  oauth2credentials.refresh(httplib2.Http())
+
+  main(oauth2credentials.access_token, oauth2credentials.token_expiry,
+       args.client_customer_id, args.developer_token, USER_AGENT)