概览

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

要求

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

前提条件

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

运行时和依赖项兼容性

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

在采用新版 Python 运行时时,我们力求在发布后一个季度结束前发布与最新运行时兼容的新版 Python 客户端库。例如,如果 10 月份发布了新的运行时,那么到次年 3 月底,就会提供兼容的 Python 客户端库版本。

达到生命周期结束 (EOL) 的 Python 运行时在 python.org不受支持的版本部分中列出的生命周期结束日期之后不受支持。

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

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

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

安装

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

配置

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

身份验证

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

发出 API 请求

将 OAuth2 令牌纳入配置后,您就可以发出 API 请求了。如需了解如何简单地测试库是否已正确配置以发出 API 请求,请参阅 get campaigns 示例。

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

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

其他资源

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