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
メソッドは、デフォルトの構成ファイルのパスから読み込まれます。
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();
構成環境変数
一部の構成設定は、クライアントをインスタンス化する際に環境変数から設定できます(詳細なリストをご覧ください)。
認証情報とクライアント ビルダーには、環境変数から設定を読み込む fromEnvironmentVariables
メソッドが用意されています。
$oAuth2Credential = (new OAuth2TokenBuilder())
// ...
->fromEnvironmentVariables()
->build();
$googleAdsClient = (new GoogleAdsClientBuilder())
->withOAuth2Credential($oAuth2Credential)
// ...
->fromEnvironmentVariables()
->build();
設定に関する項目
この構成設定では、カテゴリ別に整理された複数のフィールドがサポートされています。
OAuth2TokenBuilder
で使用されるフィールド:- アプリケーション モード
[OAUTH2] clientId
: OAuth2 クライアント ID。[OAUTH2] clientSecret
: OAuth2 クライアント シークレット。[OAUTH2] refreshToken
: OAuth2 更新トークン。
- サービス アカウント モード
[OAUTH2] jsonKeyFilePath
: JSON キーファイル パス。[OAUTH2] scopes
: スコープ。[OAUTH2] impersonatedEmail
: 権限を借用するメールアドレス。
- アプリケーション モード
GoogleAdsClientBuilder
で使用されるフィールド:[GOOGLE_ADS] developerToken
: API にアクセスするための開発者トークン。[GOOGLE_ADS] loginCustomerId
: ログイン顧客 ID。[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 インターセプト。
構成の検証
構成設定はクライアントをインスタンス化する際にチェックされ、無効な場合は例外がスローされます。ルールは次のとおりです。
[OAUTH2]
フィールドは、アプリケーション モードとサービス アカウント モードの両方に同時に設定しないでください。- サービス アカウント モードを使用する場合は、
[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
の場合にのみ設定できます。