此页面由 Cloud Translation API 翻译。

配置

您可以通过多种不同的方式配置客户端。

使用 YAML 文件的配置

您可以指定在初始化包含以下内容的客户端时使用的 YAML 文件发出请求所需的必要身份验证信息。此文件为在使用 load_from_storage 方法初始化客户端时访问。生成此文件的最简单方法是将 google-ads.yaml 从 GitHub 代码库中获取示例并对其进行修改，使其包含您的凭据，包括您的开发者令牌、刷新令牌、客户端 ID 和客户端密钥。

如果您未提供路径，该库将在您的 $HOME 目录中查找文件：

from google.ads.googleads.client import GoogleAdsClient
client = GoogleAdsClient.load_from_storage()

如需指定 google-ads.yaml 文件的位置，您可以将以下代码传递给在调用该方法时，以字符串形式指定路径的路径：

from google.ads.googleads.client import GoogleAdsClient
client = GoogleAdsClient.load_from_storage("path/to/google-ads.yaml")

您还可以通过定义特定环境变量来指定路径：

import os

os.environ["GOOGLE_ADS_CONFIGURATION_FILE_PATH"] = "path/to/google-ads.yaml"
from google.ads.googleads.client import GoogleAdsClient
client = GoogleAdsClient.load_from_storage()

如果同时提供这两个值，则系统会向该方法传递路径以及上述环境变量存在时，库会优先考虑路径传递给该方法。

使用环境变量进行配置

您可以将所有客户端配置存储为环境变量，在使用客户端的 load_from_env 方法时读取。环境变量的名称应与 google-ads.yaml 中定义的变量的名称相同但应全部大写，并以 GOOGLE_ADS_ 为前缀命名空间。例如，client_id 应存储为 GOOGLE_ADS_CLIENT_ID。

环境变量通常在 bash 配置文件中定义，例如指定为位于 $HOME 目录中的 .bashrc 或 .bash_profile 文件。他们也可以使用命令行进行定义请注意，这些说明假设您使用的是 bash；如果您使用的是其他 shell，则可能需要参阅有关如何在的 Shell 环境。

以下是使用 .bashrc 定义环境变量的一些基本步骤查看文件：

# Append the line "export GOOGLE_ADS_CLIENT_ID=1234567890" to
# the bottom of your .bashrc file.
$ echo "export GOOGLE_ADS_CLIENT_ID=1234567890" >> ~/.bashrc
# Update your bash environment to use the most recently updated
# version of your .bashrc file.
$ src ~/.bashrc

您也可以直接在终端实例中设置环境变量：

$ export GOOGLE_ADS_CLIENT_ID=1234567890
$ echo $GOOGLE_ADS_CLIENT_ID
1234567890

load_from_env 方法会从 environ 加载配置数据属性。os例如： os.environ["GOOGLE_ADS_CLIENT_ID"]

以下示例展示了如何使用配置初始化客户端实例来自环境变量：

from google.ads.googleads.client import GoogleAdsClient
client = GoogleAdsClient.load_from_env()

为了通过环境变量配置 logging，配置值必须是与 google-ads.yaml示例配置文件

以下示例展示了如何使用 .bashrc 文件进行设置：

export GOOGLE_ADS_LOGGING='{
  "version": 1,
  "disable_existing_loggers": false,
  "formatters": {
    "default_fmt": {
      "format": "[%(asctime)s - %(levelname)s] %(message).5000s",
      "datefmt": "%Y-%m-%d %H:%M:%S"
    }
  },
  "handlers": {
    "default_handler": {
      "class": "logging.StreamHandler",
      "formatter": "default_fmt"
    }
  },
  "loggers": {
    "": {
      "handlers": ["default_handler"],
      "level": "INFO"
    }
  }
}'

使用 YAML 字符串的配置

如果您已将 YAML 文件读取到内存中，可以直接将其提供给初始化模式。为此，只需使用 load_from_string 方法即可。

from google.ads.googleads.client import GoogleAdsClient

with open("/path/to/yaml", "rb") as handle:
    yaml = handle.read()

client = GoogleAdsClient.load_from_string(yaml)

使用 `dict` 的配置

您可以将 dict 直接传递给 load_from_dict 方法。例如：

from google.ads.googleads.client import GoogleAdsClient

credentials = {
    "developer_token": "abcdef123456",
    "refresh_token": "1//0abcdefghijklABCDEF",
    "client_id": "123456-abcdef.apps.googleusercontent.com",
    "client_secret": "aBcDeFgHiJkL"}

client = GoogleAdsClient.load_from_dict(credentials)

配置字段

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

常规字段（无论您是使用 YAML 还是字典，这些名称都相同配置）：

refresh_token：您的 OAuth 刷新令牌。
client_id：您的 OAuth 客户端 ID。
client_secret：您的 OAuth 客户端密钥。
developer_token：用于访问 API 的开发者令牌。
login_customer_id：请参阅 login-customer-id 文档。
linked_customer_id：请参阅已关联的客户 ID 文档。
json_key_file_path（以前称为 path_to_private_key_file）：本地私钥文件用于在使用服务进行身份验证时。请参阅 OAuth2 服务账号文档。
impersonated_email（以前称为 delegate_account）：使用的账号电子邮件地址代理这用于使用服务账号进行身份验证。请参阅 OAuth2 服务账号文档。
logging：日志记录配置。日志记录字段如下所述。
http_proxy：请参阅代理文档。
use_proto_plus：是否使用 proto-plus 消息。请参阅 Protobuf 消息文档。

将常规字段指定为环境变量：

GOOGLE_ADS_CONFIGURATION_FILE_PATH
GOOGLE_ADS_REFRESH_TOKEN
GOOGLE_ADS_CLIENT_ID
GOOGLE_ADS_CLIENT_SECRET
GOOGLE_ADS_DEVELOPER_TOKEN
GOOGLE_ADS_LOGIN_CUSTOMER_ID
GOOGLE_ADS_LINKED_CUSTOMER_ID
GOOGLE_ADS_JSON_KEY_FILE_PATH（以前称为 GOOGLE_ADS_PATH_TO_PRIVATE_KEY_FILE）
GOOGLE_ADS_IMPERSONATED_EMAIL（以前称为 GOOGLE_ADS_DELEGATE_ACCOUNT）
GOOGLE_ADS_LOGGING
GOOGLE_ADS_HTTP_PROXY
GOOGLE_ADS_USE_PROTO_PLUS

日志记录字段，即 logging 配置下的字段字段直接派生自 logging.config 内置模块因为该库会传递 logging 命名空间下的所有字段直接传递到 logging.config.dictConfig 方法。如需了解完整的详细信息，请参阅日志记录指南。

version：表示架构版本的整数值。
disable_existing_loggers：是否在应停用。
formatters：定义不同种类的格式设置工具的字典。
handlers：用于定义不同处理程序的字典，用于控制以及应使用哪些格式化程序。
loggers：定义不同类型的日志记录器的字典，其中包括处理程序和日志级别