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