このページは Cloud Translation API によって翻訳されました。

設定

Google Ads API PHP クライアントライブラリには、ユーザーが設定できるライブラリの動作をカスタマイズできます。

構成ファイル

このような構成設定のほとんどは、GKE クラスタ、 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 メソッドは、次のデフォルト構成ファイルのパスから読み込まれます。

環境変数の値が設定されている場合は GOOGLE_ADS_CONFIGURATION_FILE_PATH。
それ以外の場合は、HOME ディレクトリの google_ads_php.ini ファイル。

$oAuth2Credential = (new OAuth2TokenBuilder())
    ->fromFile()
    ->build();

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

動的構成

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

$oAuth2Credential = (new OAuth2TokenBuilder())
    ->withClientId('INSERT_CLIENT_ID')
    // ...
    ->build();

$googleAdsClient = (new GoogleAdsClientBuilder())
    ->withOAuth2Credential($oAuth2Credential)
    ->withDeveloperToken('INSERT_DEVELOPER_TOKEN_HERE')
    // ...
    ->build();

構成の環境変数

環境変数から構成設定の一部は、クライアントをインスタンス化（ list）。

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

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

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

構成フィールド

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

OAuth2TokenBuilder で使用されるフィールド: <ph type="x-smartling-placeholder">
- アプリモード <ph type="x-smartling-placeholder">
  - [OAUTH2] clientId: OAuth2 クライアント ID。
  - [OAUTH2] clientSecret: OAuth2 クライアントシークレット。
  - [OAUTH2] refreshToken: OAuth2 更新トークン。
- サービスアカウントモード <ph type="x-smartling-placeholder">
  - [OAUTH2] jsonKeyFilePath: JSON キーファイルのパス。
  - [OAUTH2] scopes: スコープ。
  - [OAUTH2] impersonatedEmail: 権限を借用するメール。
GoogleAdsClientBuilder で使用されるフィールド: <ph type="x-smartling-placeholder">
- [GOOGLE_ADS] developerToken: API にアクセスするための開発者トークン。
- [GOOGLE_ADS] loginCustomerId: 承認済み ID の ID customer から受け取ります。
- [GOOGLE_ADS] linkedCustomerId: リンクされたお客様 ID。
- [LOGGING] logFilePath: ロギングのファイルパス。
- [LOGGING] logLevel: ロギングレベル。
- [CONNECTION] proxy: インターネット接続に使用されるプロキシサーバーの URL。
- [CONNECTION] transport: トランスポート。
- [CONNECTION] grpcChannelIsSecure: gRPC チャネルが安全かどうかできません。
- [CONNECTION] grpcChannelCredential: gRPC チャネルの認証情報。
- [CONNECTION] unaryMiddlewares: 単項ミドルウェア。
- [CONNECTION] streamingMiddlewares: ストリーミングミドルウェア。
- [CONNECTION] grpcInterceptors: gRPC インターセプタ。
[GAPIC] useGapicV2Source: GAPIC v2 ソースを使用するかどうかコードを使用する必要があります。

構成の検証

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

[OAUTH2] フィールドは、アプリケーションモードと Service の両方に設定しないでください [アカウントモード] を同時に有効にできます。
使用するときは、[OAUTH2] jsonKeyFilePath と [OAUTH2] scopes を設定する必要があります。 [サービスアカウントモード] を選択します。
[OAUTH2] clientId、[OAUTH2] clientSecret、[OAUTH2] refreshToken は、アプリケーションモードの使用時に設定してください。
[GOOGLE_ADS] developerToken は常に設定する必要があります。
設定した場合、[GOOGLE_ADS] loginCustomerId と [GOOGLE_ADS] linkedCustomerId は正の数でなければなりません。
設定する場合は、[CONNECTION] proxy を有効な URL にする必要があります（フィルタを参照）。 FILTER_VALIDATE_URL）。
設定する場合、[LOGGING] logLevel は有効な PSR ログにする必要があります。レベルすべて大文字にします（例: INFO）。
設定する場合、[CONNECTION] transport は grpc または rest にする必要があります。
[CONNECTION] transport が grpc に設定されている場合、gRPC トランスポートを環境でサポートされている必要があります（ガイドのトランスポートをご覧ください）。
[CONNECTION] transport が grpc に設定されていない場合は、[CONNECTION] grpcChannelIsSecure を true にする必要があります。
[CONNECTION] grpcChannelCredential は、[CONNECTION] transport が grpc に設定されている場合にのみ設定できます。
[CONNECTION] grpcChannelCredential は、[CONNECTION] grpcChannelIsSecure が true の場合にのみ設定できます。