概览

Python 客户端库托管在 GitHub 上,并且该软件包可在 PyPI 上获取。

要求

该库支持 Python 3.9 到 3.14(>=3.9, <3.15;Python 3.14 支持是在 v28.2.0 中添加的)。由于 Python 3.9 和 3.10 在 google-ads v32.0.0 及更高版本中会在导入时发出弃用警告,因此建议使用 Python 3.11 或更高版本。

前提条件

在继续阅读本指南之前,您需要获取 Google Ads 账号的 10 位数客户客户 ID。

运行时和依赖项兼容性

Python 客户端库与 Python Software Foundation 发布的支持的版本部分中的 Python 运行时保持兼容,但状态为“功能”或“预发布”的版本除外。

Google Ads API 团队的目标是,在 Python Software Foundation 发布并正式支持新版 Python 运行时后,尽快采用这些新版本。

达到服务终止 (EOL) 日期的 Python 运行时在 python.org 的不受支持的版本部分中列出的 EOL 日期之后不受支持。我们无法保证与已终止支持的运行时兼容,因为在终止支持日期之后发布的库版本可能会破坏兼容性。

对于依赖项(尤其是 Python 客户端库列为必需项的任何 Google 维护的软件包),Google 会根据 OSS 破坏性变更政策,确保其与 Google 维护且被视为“受支持”的软件包保持兼容性。

如需查看受支持的 Python 运行时和依赖项的完整列表,请参阅依赖项页面。

安装

安装指南概述了安装该库的所有不同方式。将库安装到应用中的最简单(也是推荐)方法是使用 pip:

python -m pip install google-ads

配置

安装库后,您需要为其设置配置。您可以通过多种方式配置该库,具体请参阅配置指南。

身份验证

选择配置方法后,设置身份验证配置。如需查看分步说明,请参阅 Python 客户端库身份验证指南。如需了解更全面的背景信息,请参阅 OAuth 概览。

发出 API 请求

设置好身份验证配置后,您就可以发出 API 请求了。请参阅获取广告系列示例,快速测试该库是否已正确配置,可以发出 API 请求。

如需运行 get_campaigns.py 示例,请先克隆 google-ads-python 代码库。然后,从克隆的代码库的根目录运行以下命令:

python examples/basic_operations/get_campaigns.py -c INSERT_CUSTOMER_ID_HERE

其他资源

在能够发出 API 请求后,请继续了解客户端库的以下用途: