Python 客户端库配置

安装 Python 客户端库

要在本地环境中安装 Python 客户端库,请执行以下操作:

  1. 解压缩 Python 客户端库 tarball。
  2. 在同一目录中运行以下命令:

    python -m pip install .
    
  3. 按照终端中的提示完成安装。

使用 YAML 文件的配置

您可以指定在初始化客户端时使用的 YAML 文件,该文件包含发出请求所需的必要身份验证信息。在使用 load_from_file 方法初始化客户端时,系统会访问此文件。在创建 YAML 文件时,请按照下方提供的示例指定刷新令牌、客户端 ID 和客户端密钥。

如需指定 search-ads-360.yaml 文件的位置,您可以在调用该方法时将路径作为字符串传递给该方法:

from util_searchads360 import SearchAds360Client
client = SearchAds360Client.load_from_file("path/to/search-ads-360.yaml")

如果您未提供路径,该库会在 $HOME 目录中查找该文件:

from util_searchads360 import SearchAds360Client
client = SearchAds360Client.load_from_file()

配置字段

客户端库配置支持以下字段。

常规字段:

  • refresh_token:您的 OAuth 刷新令牌。
  • client_id:您的 OAuth 客户端 ID。
  • client_secret:您的 OAuth 客户端密钥。
  • login_customer_id:请参阅 login-customer-id 文档

桌面应用流程和网站应用流程支持的按键

如果您使用的是桌面版或网站应用流程,则支持的按键如下:

# Credential for accessing Google's OAuth servers.
# Provided by console.cloud.google.com.
client_id: INSERT_CLIENT_ID_HERE

# Credential for accessing Google's OAuth servers.
# Provided by console.cloud.google.com.
client_secret: INSERT_CLIENT_SECRET_HERE

# Renewable OAuth credential associated with 1 or more Search Ads accounts.
refresh_token: INSERT_REFRESH_TOKEN_HERE

# Required for manager accounts only: Specify the login customer ID used to
# authenticate API calls. This will be the customer ID of the authenticated
# manager account. You can also specify this later in code if your application
# uses multiple manager account + OAuth pairs.
#
# login_customer_id: INSERT_LOGIN_CUSTOMER_ID_HERE