Commiting latest changes.

Author: jdilallo

ChangeLog

@@ -0,0 +1,3 @@
+1.0.0 - 03/05/2014
+==================
+Initial version of the googleads Python library.

LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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.

README.md

@@ -0,0 +1,111 @@
+#The googleads Python client library
+
+
+This client library simplifies accessing Google's SOAP Ads APIs - AdWords,
+DoubleClick Ad Exchange SOAP, DoubleClick for Advertisers, 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.
+
+
+##How do I get started?
+####Installing the library
+Install or update the library from PyPI. If you're using pip, this is as easy
+as:
+
+`$ pip install [--upgrade] googleads`
+
+If you don't want to install directly from PyPI, you can download the library
+as a tarball and then install it manually. The download can be found here:
+https://pypi.python.org/pypi/googleads
+Navigate to the directory that contains your downloaded unzipped client
+library and run the "setup.py" script to install the "googleads"
+module.
+
+`$ python setup.py build install`
+
+You can find code examples in the git repo and in the library's releases within
+the examples folder.
+
+####Where can I find the pydocs?
+Our pydocs are hosted at: http://googleads.github.io/googleads-python-lib
+
+####Caching authentication information
+It is possible to cache your API authentication information. The library
+includes a sample file showing how to do this named `googleads.yaml`. Fill
+in the fields for the API you plan to use. The library's `LoadFromStorage`
+methods default to looking for a file with this name in your home directory,
+but you can pass in a path to any file with the correct yaml contents.
+
+##Where do I submit bug reports and/or feature requests?
+
+Use the issue tracker at:
+  https://github.com/googleads/googleads-python-lib/issues
+
+Make sure to subscribe to our Google Plus page for API change announcements and
+other news:
+
+  https://plus.google.com/+GoogleAdsDevelopers
+
+##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:
+```python
+logging.basicConfig(level=logging.INFO)
+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.
+
+##I'm familiar with suds. Can I use suds features with this library?
+Yes, you can. The services returned by the `client.GetService()` functions all
+have a reference to the underlying suds client stored in the `suds_client`
+attribute. 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])
+```
+
+
+##External Dependencies:
+
+
+    - oauthlib             -- http://pypi.python.org/pypi/oauthlib/
+    - suds-jurko           -- http://pypi.python.org/pypi/suds-jurko/
+    - pytz                 -- https://pypi.python.org/pypi/pytz
+    - pyYAML               -- http://pypi.python.org/pypi/pyYAML/
+    - mock                 -- http://pypi.python.org/pypi/mock
+                              (only needed to run unit tests)
+    - pyfakefs             -- https://pypi.python.org/pypi/pyfakefs
+                              (only needed to run unit tests)
+
+
+##Authors:
+    jdilallo@google.com (Joseph DiLallo)

examples/adwords/authentication/create_adwords_client_without_yaml.py

@@ -0,0 +1,56 @@
+#!/usr/bin/python
+#
+# Copyright 2014 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 without using yaml-cached credentials.
+
+While our LoadFromStorage method provides a useful shortcut to instantiate a
+client if you regularly use just one set of credentials, production applications
+may need to swap out users. This example shows you how to create an OAuth 2.0
+client and an AdWordsClient without relying on a yaml file.
+"""
+
+__author__ = 'Joseph DiLallo'
+
+from googleads import adwords
+from googleads import oauth2
+
+# OAuth 2.0 credential information. In a real application, you'd probably be
+# pulling these values from a credential storage.
+CLIENT_ID = 'INSERT_CLIENT_ID_HERE'
+CLIENT_SECRET = 'INSERT_CLIENT_SECRET_HERE'
+REFRESH_TOKEN = 'INSERT_REFRESH_TOKEN_HERE'
+
+# AdWords API information.
+DEVELOPER_TOKEN = 'INSERT_DEVELOPER_TOKEN_HERE'
+USER_AGENT = 'INSERT_USER_AGENT_HERE'
+CLIENT_CUSTOMER_ID = 'INSERT_CLIENT_CUSTOMER_ID_HERE'
+
+
+def main(client_id, client_secret, refresh_token, developer_token, user_agent,
+         client_customer_id):
+  oauth2_client = oauth2.GoogleRefreshTokenClient(
+      client_id, client_secret, refresh_token)
+
+  adwords_client = adwords.AdWordsClient(
+      developer_token, oauth2_client, user_agent, client_customer_id)
+
+  customer = adwords_client.GetService('CustomerService').get()
+  print 'You are logged in as customer: %s' % customer['customerId']
+
+
+if __name__ == '__main__':
+  main(CLIENT_ID, CLIENT_SECRET, REFRESH_TOKEN, DEVELOPER_TOKEN, USER_AGENT,
+       CLIENT_CUSTOMER_ID)