設定

Google Ads API PHP クライアント ライブラリには、ライブラリの動作をカスタマイズするための構成設定がいくつか用意されています。

構成ファイル

これらの構成設定のほとんどは INI 構成ファイルに保存し、クライアントのインスタンス化時に使用できます（例: google_ads_php.ini）。

認証情報ビルダーとクライアント ビルダーはどちらも、このようなファイルから設定を読み込む fromFile メソッドを提供します。

$oAuth2Credential = (new OAuth2TokenBuilder())
    ->fromFile('/path/to/google_ads_php.ini')
    ->build();

$googleAdsClient = (new GoogleAdsClientBuilder())
    ->fromFile('/path/to/google_ads_php.ini')
    ->withOAuth2Credential($oAuth2Credential)
    ->build();

引数として構成パスが指定されていない場合、fromFile メソッドはデフォルトの構成パスから読み込みます。デフォルトの構成パスは次のとおりです。

  1. GOOGLE_ADS_CONFIGURATION_FILE_PATH という名前の環境変数の値（設定されている場合）。
  2. それ以外の場合は、HOME ディレクトリの google_ads_php.ini ファイル。
$oAuth2Credential = (new OAuth2TokenBuilder())
    ->fromFile()
    ->build();

$googleAdsClient = (new GoogleAdsClientBuilder())
    ->fromFile()
    ->withOAuth2Credential($oAuth2Credential)
    ->build();

動的構成

これらの構成設定は、クライアントのインスタンス化時に動的に設定できます。

$oAuth2Credential = (new OAuth2TokenBuilder())
    ->withClientId('INSERT_CLIENT_ID_HERE')
    ->withClientSecret('INSERT_CLIENT_SECRET_HERE')
    ->withRefreshToken('INSERT_REFRESH_TOKEN_HERE')
    ->build();

$googleAdsClient = (new GoogleAdsClientBuilder())
    ->withOAuth2Credential($oAuth2Credential)
    ->build();

構成環境変数

クライアントをインスタンス化するときに、環境変数から一部の構成設定を設定できます（標準の環境変数をご覧ください）。

認証情報ビルダーとクライアント ビルダーはどちらも、環境変数から設定を読み込む fromEnvironmentVariables メソッドを提供します。

$oAuth2Credential = (new OAuth2TokenBuilder())
    // ...
    ->fromEnvironmentVariables()
    ->build();

$googleAdsClient = (new GoogleAdsClientBuilder())
    ->withOAuth2Credential($oAuth2Credential)
    // ...
    ->fromEnvironmentVariables()
    ->build();

構成フィールド

構成設定では、カテゴリ別に整理されたいくつかのフィールドがサポートされています。

  1. OAuth2TokenBuilder で使用されるフィールド:
    • アプリケーション モード:
      • [OAUTH2] clientId: OAuth2 クライアント ID。
      • [OAUTH2] clientSecret: OAuth2 クライアント シークレット。
      • [OAUTH2] refreshToken: OAuth2 更新トークン。
    • サービス アカウント モード:
      • [OAUTH2] jsonKeyFilePath: JSON キーパス。
      • [OAUTH2] scopes: OAuth2 スコープ（v32.1.0 以降ではデフォルトで https://www.googleapis.com/auth/adwords。v32.1.0 より前のバージョン、またはカスタム スコープを使用する場合は必須。fromEnvironmentVariables() によって環境変数から読み取られない）。
      • [OAUTH2] impersonatedEmail: Google Workspace のドメイン全体の委任を使用するときに権限を借用するメールアドレス（省略可）。
    • アプリケーションのデフォルト認証情報モード:
      • アプリケーション モード フィールドとサービス アカウント モード フィールドのどちらも設定されていない場合、OAuth2TokenBuilder は自動的にアプリケーションのデフォルト認証情報（ADC）にフォールバックします。
  2. GoogleAdsClientBuilder で使用されるフィールド:
    • [GOOGLE_ADS] loginCustomerId: リクエストで使用する承認済みのお客様の ID。
    • [GOOGLE_ADS] linkedCustomerId: リンクされたお客様 ID。
    • [GOOGLE_ADS] endpoint: 代替の Google Ads API サーバー エンドポイント（省略可）。
    • [LOGGING] logFilePath: ロギング出力のパス。
    • [LOGGING] logLevel: ロギングレベル。
    • [CONNECTION] proxy: インターネット接続に使用されるプロキシ サーバーの URL。
    • [CONNECTION] transport: ネットワーク トランスポート（grpc または rest）。
    • [CONNECTION] grpcChannelIsSecure: gRPC チャネルが安全かどうか。
    • [CONNECTION] grpcChannelCredential: gRPC チャネルの認証情報。
    • [CONNECTION] unaryMiddlewares: 単項ミドルウェア。
    • [CONNECTION] streamingMiddlewares: ストリーミング ミドルウェア。
    • [CONNECTION] grpcInterceptors: gRPC インターセプタ。

構成の検証

構成設定は、クライアントのインスタンス化時にチェックされ、無効な場合は例外がスローされます。検証ルールは次のとおりです。

  1. [OAUTH2] フィールドは、アプリケーション モードとサービス アカウント モードの両方に同時に設定しないでください。
  2. サービス アカウント モードを使用する場合は、[OAUTH2] jsonKeyFilePath を設定する必要があります（v32.1.0 より前のバージョンでは、[OAUTH2] scopes も設定する必要があります。v32.1.0 以降では、scopes のデフォルトは https://www.googleapis.com/auth/adwords です）。
  3. アプリケーション モードを使用する場合は、[OAUTH2] clientId、[OAUTH2] clientSecret、[OAUTH2] refreshToken を設定する必要があります。
  4. 設定する場合は、[GOOGLE_ADS] loginCustomerId と [GOOGLE_ADS] linkedCustomerId を正の数にする必要があります。
  5. 設定する場合、[CONNECTION] proxy は有効な URL である必要があります（FILTER_VALIDATE_URL フィルタをご覧ください）。
  6. 設定する場合、[LOGGING] logLevel は有効な PSR ログレベル（INFO など）を大文字で指定する必要があります。
  7. 設定する場合、[CONNECTION] transport は grpc または rest のいずれかにする必要があります。
  8. [CONNECTION] transport が grpc に設定されている場合、gRPC トランスポートは環境でサポートされている必要があります（トランスポート ガイドをご覧ください）。
  9. [CONNECTION] transport が grpc に設定されていない場合、[CONNECTION] grpcChannelIsSecure は true にする必要があります（REST 接続には常に HTTPS が必要です）。
  10. [CONNECTION] grpcChannelCredential は、[CONNECTION] transport が grpc に設定されている場合にのみ設定できます。
  11. [CONNECTION] grpcChannelCredential は、[CONNECTION] grpcChannelIsSecure が true の場合にのみ設定できます。