Configurazione

La libreria client PHP dell'API Google Ads fornisce diverse impostazioni di configurazione che puoi per personalizzare il comportamento della raccolta.

File di configurazione

Puoi memorizzare la maggior parte di queste impostazioni ini e utilizzarli per creare un'istanza per i clienti, ad esempio google_ads_php.ini.

Sia le credenziali che i client builder forniscono fromFile metodi per il caricamento impostazioni da questi file:

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

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

Se non è stato fornito alcun percorso del file di configurazione come argomento, fromFile vengono caricati dal percorso del file di configurazione predefinito, che è:

  1. Il valore della variabile di ambiente denominata GOOGLE_ADS_CONFIGURATION_FILE_PATH se impostato.
  2. In caso contrario, il file google_ads_php.ini nella directory HOME.
$oAuth2Credential = (new OAuth2TokenBuilder())
    ->fromFile()
    ->build();

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

Configurazione dinamica

Puoi impostare queste impostazioni di configurazione in modo dinamico quando crei l'istanza dei client.

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

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

Variabili di ambiente di configurazione

Puoi definire alcune impostazioni di configurazione dalle variabili di ambiente quando creare un'istanza per i clienti (consulta le istruzioni elenco).

Entrambi gli strumenti per la creazione di credenziali e client forniscono fromEnvironmentVariables per caricare le impostazioni dalle variabili di ambiente:

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

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

Campi di configurazione

Le impostazioni di configurazione supportano diversi campi organizzati in categorie.

  1. Campi utilizzati da OAuth2TokenBuilder:
    • Modalità applicazione
      • [OAUTH2] clientId: il tuo ID client OAuth2.
      • [OAUTH2] clientSecret: il tuo client secret OAuth2.
      • [OAUTH2] refreshToken: il tuo token di aggiornamento OAuth2.
    • Modalità account di servizio
      • [OAUTH2] jsonKeyFilePath: il percorso del file della chiave JSON.
      • [OAUTH2] scopes: gli ambiti.
      • [OAUTH2] impersonatedEmail: l'email di cui vuoi rubare l'identità.
  2. Campi utilizzati da GoogleAdsClientBuilder:
    • [GOOGLE_ADS] developerToken: il tuo token sviluppatore per accedere all'API.
    • [GOOGLE_ADS] loginCustomerId: l'ID del certificato da usare nella richiesta.
    • [GOOGLE_ADS] linkedCustomerId: l'ID cliente collegato.
    • [LOGGING] logFilePath: il percorso del file per il logging.
    • [LOGGING] logLevel: il livello di logging.
    • [CONNECTION] proxy: l'URL del server proxy utilizzato per la connettività a internet.
    • [CONNECTION] transport: il trasporto.
    • [CONNECTION] grpcChannelIsSecure: se il canale gRPC è sicuro o .
    • [CONNECTION] grpcChannelCredential: le credenziali del canale gRPC.
    • [CONNECTION] unaryMiddlewares: i middleware unari.
    • [CONNECTION] streamingMiddlewares: i middleware per lo streaming.
    • [CONNECTION] grpcInterceptors: gli intercetti gRPC.
  3. [GAPIC] useGapicV2Source: se utilizzare l'origine GAPIC v2 codice durante la creazione dei client di servizio.

Convalida della configurazione

Le impostazioni di configurazione vengono controllate durante la creazione di istanze di client ed eccezioni vengono generate se non valide. Ecco le regole:

  1. I campi [OAUTH2] non devono essere impostati sia per la modalità di applicazione che per il servizio modalità account.
  2. È necessario impostare [OAUTH2] jsonKeyFilePath e [OAUTH2] scopes quando utilizzi la modalità Account di servizio.
  3. [OAUTH2] clientId, [OAUTH2] clientSecret e [OAUTH2] refreshToken devono quando si utilizza la Modalità applicazione.
  4. [GOOGLE_ADS] developerToken deve essere sempre impostato.
  5. Se impostato, [GOOGLE_ADS] loginCustomerId e [GOOGLE_ADS] linkedCustomerId devono essere numeri positivi.
  6. Se impostato, [CONNECTION] proxy deve essere un URL valido (vedi il filtro FILTER_VALIDATE_URL).
  7. Se impostato, [LOGGING] logLevel deve essere un log PSR valido livello in maiuscole, ad esempio INFO.
  8. Se impostato, [CONNECTION] transport deve essere grpc o rest.
  9. Se [CONNECTION] transport è impostato su grpc, il trasporto gRPC deve essere supportate dall'ambiente (consulta la guida ai trasporti).
  10. [CONNECTION] grpcChannelIsSecure deve essere true quando [CONNECTION] transport non è impostato su grpc.
  11. [CONNECTION] grpcChannelCredential può essere impostato solo quando il criterio [CONNECTION] transport è impostato su grpc.
  12. [CONNECTION] grpcChannelCredential può essere impostato solo quando il valore di [CONNECTION] grpcChannelIsSecure è true.