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:請參閱登入客戶 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