Overview

  • The Python client library is available on GitHub and PyPI, requiring Python 3.8 or later.

  • Before installation, you need a developer token and client customer ID.

  • The library maintains compatibility with supported Python runtimes and Google-maintained dependencies.

  • After installation, configure the library and generate OAuth2 tokens for authentication.

  • You can test your setup by making an API request, like the get_campaigns.py example.

The Python client library is hosted on GitHub, and the package is available on PyPI.

Requirements

The library supports Python 3.9 through 3.14 (>=3.9, <3.15; Python 3.14 support was added in v28.2.0). Because Python 3.9 and 3.10 emit a deprecation warning on import in google-ads v32.0.0 and later, using Python 3.11 or later is recommended.

Prerequisites

Before proceeding with this guide, you need the 10-digit client customer ID of your Google Ads account.

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".

The Google Ads API team aims to adopt new versions of the Python runtime as soon as they are released and officially supported by the Python Software Foundation.

Python runtimes that have reached end of life (EOL) are not supported past the EOL date in the Unsupported Versions section of python.org. Compatibility with EOL runtimes cannot be guaranteed, as releases of the library following an EOL date may break compatibility.

For dependencies (specifically, any Google-maintained packages that are listed as required by the Python client library), compatibility is maintained 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

The installation guide outlines all of the different ways to install the library. The simplest (and recommended) way to install the library into your application is with pip:

python -m pip install google-ads

Configuration

After installing the library, you need to set up a configuration for it. There are multiple ways to configure the library, which are described in the configuration guide.

Authentication

Once you've chosen a configuration approach, set up your authentication configuration. For step-by-step instructions, see the Python client library authentication guide. For more general background, see the OAuth overview.

Make an API request

Once you've set up your authentication configuration, you're ready to make an API request. Refer to the get campaigns example for a quick way to test that the library is properly configured to make API requests.

To run the get_campaigns.py sample, first clone the google-ads-python repository. Then, from the root directory of the cloned repository, run the following command:

python examples/basic_operations/get_campaigns.py -c INSERT_CUSTOMER_ID_HERE

Additional resources

After you're able to make an API request, proceed to these uses of the client library: