Configuration

La bibliothèque cliente PHP de l'API Google Ads fournit plusieurs paramètres de configuration que vous pouvez utiliser pour personnaliser le comportement de la bibliothèque.

Fichier de configuration

Vous pouvez stocker la plupart de ces paramètres de configuration dans Vous pouvez stocker la plupart de ces paramètres de configuration dans ini fichiers et les utiliser lors de l'instanciation des clients, par exemple, google_ads_php.ini.

Les compilateurs d'identifiants et de clients fournissent tous deux des méthodes fromFile pour charger les paramètres à partir de ces fichiers :

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

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

Si aucun chemin de configuration n'est fourni en tant qu'argument, les méthodes fromFile chargent le chemin de configuration par défaut, qui est le suivant :

  1. La valeur de la variable d'environnement nommée GOOGLE_ADS_CONFIGURATION_FILE_PATH si elle est définie.
  2. Sinon, le fichier google_ads_php.ini dans votre répertoire HOME.
$oAuth2Credential = (new OAuth2TokenBuilder())
    ->fromFile()
    ->build();

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

Configuration dynamique

Vous pouvez définir ces paramètres de configuration de manière dynamique lors de l'instanciation des clients.

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

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

Variables d'environnement de configuration

Vous pouvez définir certains paramètres de configuration à partir de variables d'environnement lors de l' instanciation des clients (consultez la liste exhaustive).

Les compilateurs d'identifiants et de clients fournissent tous deux des méthodes fromEnvironmentVariables pour charger les paramètres à partir de variables d'environnement :

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

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

Champs de configuration

Les paramètres de configuration sont compatibles avec plusieurs champs organisés en catégories.

  1. Champs utilisés par OAuth2TokenBuilder :
    • Mode de l'application
      • [OAUTH2] clientId : votre ID client OAuth2.
      • [OAUTH2] clientSecret : votre clé secrète client OAuth2.
      • [OAUTH2] refreshToken : votre jeton d'actualisation OAuth2.
    • Mode Compte de service
      • [OAUTH2] jsonKeyFilePath : chemin d'accès à la clé JSON.
      • [OAUTH2] scopes : les autorisations.
      • [OAUTH2] impersonatedEmail : l'adresse e-mail à usurper.
  2. Champs utilisés par GoogleAdsClientBuilder :
    • [GOOGLE_ADS] loginCustomerId : ID du client autorisé à utiliser dans la requête.
    • [GOOGLE_ADS] linkedCustomerId : ID client associé.
    • [LOGGING] logFilePath : chemin d'accès à la journalisation.
    • [LOGGING] logLevel : niveau de journalisation.
    • [CONNECTION] proxy : URL du serveur proxy utilisé pour la connectivité Internet.
    • [CONNECTION] transport : transport.
    • [CONNECTION] grpcChannelIsSecure: indique si le canal gRPC est sécurisé ou non.
    • [CONNECTION] grpcChannelCredential : identifiants du canal gRPC.
    • [CONNECTION] unaryMiddlewares : middlewares unaires.
    • [CONNECTION] streamingMiddlewares : middlewares de streaming.
    • [CONNECTION] grpcInterceptors : intercepteurs gRPC.

Validation de la configuration

Les paramètres de configuration sont vérifiés lors de l'instanciation des clients, et des exceptions sont générées lorsqu'ils ne sont pas valides. Voici les règles :

  1. Les champs [OAUTH2] ne doivent pas être définis simultanément pour le mode Application et le mode Compte de service.
  2. [OAUTH2] jsonKeyFilePath et [OAUTH2] scopes doivent être définis lorsque vous utilisez le mode Compte de service.
  3. [OAUTH2] clientId, [OAUTH2] clientSecret et [OAUTH2] refreshToken doivent être définis lorsque vous utilisez le mode Application.
  4. S'ils sont définis, [GOOGLE_ADS] loginCustomerId et [GOOGLE_ADS] linkedCustomerId doivent être des nombres positifs.
  5. S'il est défini, [CONNECTION] proxy doit être une URL valide (voir le filtre FILTER_VALIDATE_URL).
  6. S'il est défini, [LOGGING] logLevel doit être un niveau de journalisation PSR valide en majuscules, tel que INFO.
  7. S'il est défini, [CONNECTION] transport doit être grpc ou rest.
  8. Si [CONNECTION] transport est défini sur grpc, le transport gRPC doit être compatible avec l'environnement (voir le guide de transport).
  9. [CONNECTION] grpcChannelIsSecure doit être true lorsque [CONNECTION] transport n'est pas défini sur grpc.
  10. [CONNECTION] grpcChannelCredential ne peut être défini que lorsque [CONNECTION] transport est défini sur grpc.
  11. [CONNECTION] grpcChannelCredential ne peut être défini que lorsque [CONNECTION] grpcChannelIsSecure est true.