本頁面由 Cloud Translation API 翻譯而成。

設定

您可以透過多種不同的方式設定用戶端。

使用 YAML 檔案進行設定

您可以指定在初始化包含以下內容的用戶端時要使用的 YAML 檔案提出要求所需的必要驗證資訊這個檔案當使用 load_from_storage 方法初始化用戶端時，會存取這個物件。產生這個檔案最簡單的方式 google-ads.yaml 修改並加入您的憑證包括開發人員權杖、更新權杖、用戶端 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，如果您使用其他殼層，可能需要請參閱說明文件，瞭解如何在您使用的殼層

以下提供使用 .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 或 dict，這些名稱都相同設定)：

refresh_token：您的 OAuth 更新憑證。
client_id：您的 OAuth 用戶端 ID。
client_secret：您的 OAuth 用戶端密鑰。
developer_token：用來存取 API 的開發人員權杖。
login_customer_id：請參閱 login-customer-id 說明文件。
linked_customer_id：請參閱 linked-customer-id 說明文件。
json_key_file_path (先前為 path_to_private_key_file)：本機私密金鑰檔案這會用於透過服務進行驗證讓他們使用服務帳戶請參閱 OAuth2 服務帳戶說明文件。
impersonated_email (先前為 delegate_account)：使用的帳戶電子郵件。這會用於透過服務帳戶進行驗證。詳情請見 OAuth2 服務帳戶說明文件。
logging：記錄設定。記錄欄位的說明如下。
http_proxy：請參閱 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：定義不同記錄器類型的字典，包括處理常式和記錄層級