概览

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

要求

该库需要 Python 3.8 或更高版本。

前提条件

在安装该库之前,您需要准备好开发者令牌和客户端客户 ID。如需了解如何获取这些工具,请参阅前提条件部分。请注意,您将在后续步骤中生成其他所需的 OAuth2 令牌。

运行时和依赖项兼容性

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

采用新版 Python 运行时时,我们力求在该运行时发布后的下一季度末发布与其兼容的 Python 客户端库新版本。例如,如果新运行时在 10 月发布,则在次年 3 月底之前,我们会发布兼容版本的 Python 客户端库。

python.org不受支持的版本部分中,已达到服务终止 (EOL) 日期的 Python 运行时将不再受支持。

在某个不受支持的 Python 运行时达到 EOL 后,我们可能会发布与其不兼容的 Python 客户端库版本。

对于依赖项(特别是 Python 客户端库列为必需的任何 Google 维护的软件包),我们将与 Google 维护的软件包保持兼容性,并根据 Google 的 OSS 破坏性更改政策将其视为“受支持”。

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

安装

按照安装文档中的说明从 PyPi 安装该库,然后返回此页面。

配置

安装该库后,您需要为其设置配置。您可以通过多种方式配置该库,具体方法请参阅我们的配置文档。

身份验证

选择配置类型后,您可以继续生成向 API 发出请求所需的其余 OAuth2 令牌。支持多种 OAuth2 流程,如下所述。如需详细了解这两种流程之间的区别,并帮助您确定哪种流程最适合您的应用,请参阅我们的 OAuth 文档。

发出 API 请求

将 OAuth2 令牌纳入配置后,您就可以发出 API 请求了。如需了解一种简单的方法来测试库是否已正确配置为发出 API 请求,请参阅获取广告系列示例。

如需运行 get_campaigns.py 示例,请在本地安装的 googleads-python 客户端库的根目录中运行以下命令:

$ python examples/basic_operations/get_campaigns.py -c \
  INSERT_YOUR_CUSTOMER_ID_HERE

其他资源

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