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 des fichiers ini et les utiliser lors de l'instanciation de 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 d'accès au fichier de configuration n'est fourni en tant qu'argument, les méthodes fromFile se chargent à partir du chemin d'accès du fichier de configuration par défaut, qui est le suivant:

  1. Valeur de la variable d'environnement nommée GOOGLE_ADS_CONFIGURATION_FILE_PATH, si elle est définie.
  2. Sinon, il s'agit du 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 lorsque vous instanciez des clients.

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

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

Variables d'environnement de configuration

Vous pouvez définir certains paramètres de configuration à partir de variables d'environnement lors de l'instanciation de clients (voir 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 acceptent plusieurs champs organisés en catégories.

  1. Champs utilisés par OAuth2TokenBuilder :
    • Mode Application
      • [OAUTH2] clientId: votre ID client OAuth2.
      • [OAUTH2] clientSecret: votre code secret de client OAuth2.
      • [OAUTH2] refreshToken: votre jeton d'actualisation OAuth2.
    • Mode Compte de service
      • [OAUTH2] jsonKeyFilePath: chemin d'accès au fichier de clé JSON.
      • [OAUTH2] scopes: champs d'application.
      • [OAUTH2] impersonatedEmail: adresse e-mail dont l'identité doit être empruntée.
  2. Champs utilisés par GoogleAdsClientBuilder :
    • [GOOGLE_ADS] developerToken: votre jeton de développeur pour accéder à l'API.
    • [GOOGLE_ADS] loginCustomerId: ID du client autorisé à utiliser dans la requête.
    • [GOOGLE_ADS] linkedCustomerId: numéro client associé.
    • [LOGGING] logFilePath: chemin d'accès au fichier de journalisation
    • [LOGGING] logLevel: niveau de journalisation
    • [CONNECTION] proxy: URL du serveur proxy utilisée 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: middleware unaire.
    • [CONNECTION] streamingMiddlewares: middleware de streaming
    • [CONNECTION] grpcInterceptors: intercepteurs gRPC
  3. [GAPIC] useGapicV2Source: indique s'il faut utiliser le code source GAPIC v2 lors de la création de clients de service.

Validation de la configuration

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

  1. Les champs [OAUTH2] ne doivent pas être définis en même temps 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 lors de l'utilisation du mode Application.
  4. [GOOGLE_ADS] developerToken doit toujours être défini.
  5. Si ces valeurs sont définies, [GOOGLE_ADS] loginCustomerId et [GOOGLE_ADS] linkedCustomerId doivent être des nombres positifs.
  6. Si ce champ est défini, [CONNECTION] proxy doit être une URL valide (voir le filtre FILTER_VALIDATE_URL).
  7. Si cette valeur est définie, [LOGGING] logLevel doit être un niveau de journalisation PSR valide en majuscules, par exemple INFO.
  8. S'il est défini, [CONNECTION] transport doit être grpc ou rest.
  9. Si [CONNECTION] transport est défini sur grpc, le transport gRPC doit être compatible avec l'environnement (voir le guide transport).
  10. [CONNECTION] grpcChannelIsSecure doit être défini sur true lorsque [CONNECTION] transport n'est pas défini sur grpc.
  11. [CONNECTION] grpcChannelCredential ne peut être défini que lorsque [CONNECTION] transport est défini sur grpc.
  12. [CONNECTION] grpcChannelCredential ne peut être défini que lorsque [CONNECTION] grpcChannelIsSecure est défini sur true.