The Python client library is hosted on GitHub, and the package is available on PyPI.
Requirements
The library requires Python 3.8 or later.
Prerequisites
Before installing the library, you will need a developer token and client customer ID. Instructions on how to obtain them are outlined in the prerequisites section. Note that you will generate the other required OAuth2 tokens in later steps.
Runtime and dependency compatibility
The Python client library maintains compatibility with the Python runtimes in the Supported Versions section published by the Python Software Foundation, except for versions with a status of "feature" or "prerelease".
When adopting new versions of the Python runtime, we aim to release a new version of the Python client library that is compatible with the latest runtime by the end of the quarter following its release. For example, if a new runtime is released in October, a compatible version of the Python client library will be available by the end of March in the following year.
Python runtimes that have reached End of Life (EOL) are not supported past the End of Life date in the Unsupported Versions section of python.org.
We may release a version of the Python client library that is incompatible with unsupported Python runtimes at any point after they reach EOL.
For dependencies, (specifically, any Google-maintained packages that are listed as required by the Python client library), we will maintain compatibility with packages that are Google-maintained, and considered "supported" according to Google's OSS Breaking Change Policy.
For a complete list of supported Python runtimes and dependencies, see the Dependencies page.
Installation
Follow the instructions in our installation documentation to install the library from PyPi and return to this page.
Configuration
Once you have installed the library you will need to set up a configuration for it. There are multiple ways to configure the library, which are described in our configuration documentation.
Authentication
Once you've chosen a configuration type you can proceed with generating the remaining OAuth2 tokens needed to make requests to the API. There are multiple supported OAuth2 flows, which are documented in the list below. For details on the differences between the flows and help deciding which is best for your application, see our OAuth documentation.
Making an API request
Once you've incorporated your OAuth2 tokens into your configuration, you're ready to make an API request. Refer to the get campaigns example for a simple way to test that the library is properly configured to make API requests.
To run the get_campaigns.py sample, in the root directory of your locally
installed googleads-python client library, run the following command:
$ python examples/basic_operations/get_campaigns.py -c \
INSERT_YOUR_CUSTOMER_ID_HERE
Additional resources
After you're able to make an API request, proceed to these uses of the client library: