Konfiguracja

Zadbaj o dobrą organizację dzięki kolekcji Zapisuj i kategoryzuj treści zgodnie ze swoimi preferencjami.

Biblioteka klienta PHP w interfejsie API Google Ads udostępnia kilka ustawień konfiguracji, których możesz użyć do dostosowania zachowania biblioteki.

Plik konfiguracji

Większość z tych ustawień konfiguracji możesz zapisywać w plikach ini i używać ich do tworzenia instancji klientów, na przykład google_ads_php.ini.

Dane logowania i kreatory klienta udostępniają metody fromFile umożliwiające ładowanie ustawień z takich plików:

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

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

Jeśli nie podasz ścieżki pliku konfiguracji jako argumentu, metody fromFile zostaną wczytane z domyślnej ścieżki pliku konfiguracji, który jest:

  1. Wartość zmiennej środowiskowej o nazwie GOOGLE_ADS_CONFIGURATION_FILE_PATH (jeśli jest ustawiona).
  2. W przeciwnym razie plik google_ads_php.ini w katalogu HOME.
$oAuth2Credential = (new OAuth2TokenBuilder())
    ->fromFile()
    ->build();

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

Konfiguracja dynamiczna

Te ustawienia konfiguracyjne możesz określić dynamicznie podczas tworzenia instancji klientów.

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

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

Zmienne środowiska konfiguracji

Niektóre ustawienia możesz skonfigurować ze zmiennych środowiskowych podczas stymulowania klientów (zobacz pełną listę).

Dane logowania i kreatory klientów udostępniają metody fromEnvironmentVariables służące do wczytywania ustawień ze zmiennych środowiskowych:

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

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

Pola konfiguracji

Ustawienia konfiguracji obsługują kilka pól podzielonych na kategorie.

  1. Pola używane przez OAuth2TokenBuilder:
    • Tryb aplikacji
      • [OAUTH2] clientId: identyfikator klienta OAuth2.
      • [OAUTH2] clientSecret: Twój tajny klucz klienta OAuth2.
      • [OAUTH2] refreshToken: token odświeżania OAuth2.
    • Tryb konta usługi
      • [OAUTH2] jsonKeyFilePath: ścieżka pliku klucza Json.
      • [OAUTH2] scopes: zakresy.
      • [OAUTH2] impersonatedEmail: adres e-mail, pod który chcesz się podszywać.
  2. Pola używane przez GoogleAdsClientBuilder:
    • [GOOGLE_ADS] developerToken: token programisty umożliwiający dostęp do interfejsu API.
    • [GOOGLE_ADS] loginCustomerId: identyfikator klienta logowania.
    • [GOOGLE_ADS] linkedCustomerId: identyfikator połączonego klienta.
    • [LOGGING] logFilePath: ścieżka do logowania.
    • [LOGGING] logLevel: poziom rejestrowania.
    • [CONNECTION] proxy: URL serwera proxy używany do łączenia się z internetem.
    • [CONNECTION] transport: transport.
    • [CONNECTION] grpcChannelIsSecure: określa, czy kanał gRPC jest bezpieczny.
    • [CONNECTION] grpcChannelCredential: dane logowania do kanału gRPC.
    • [CONNECTION] unaryMiddlewares: oprogramowanie pośredniczące.
    • [CONNECTION] streamingMiddlewares: oprogramowanie pośredniczące do strumieniowego przesyłania danych.
    • [CONNECTION] grpcInterceptors: przechwytujące gRPC.

Weryfikacja konfiguracji

Ustawienia konfiguracji są sprawdzane, gdy instancje instancji są generowane w wyniku nieprawidłowego działania. Zasady są następujące:

  1. Pola [OAUTH2] nie mogą być ustawione jednocześnie dla trybu aplikacji i trybu konta usługi.
  2. W trybie konta usługi musisz ustawić [OAUTH2] jsonKeyFilePath i [OAUTH2] scopes.
  3. W trybie aplikacji musisz ustawić [OAUTH2] clientId, [OAUTH2] clientSecret i [OAUTH2] refreshToken.
  4. Pole [GOOGLE_ADS] developerToken musi być zawsze ustawione.
  5. Jeśli jest ustawiony, [GOOGLE_ADS] loginCustomerId i [GOOGLE_ADS] linkedCustomerId muszą być liczbą dodatnią.
  6. Jeśli jest skonfigurowany, [CONNECTION] proxy musi być prawidłowym adresem URL (zobacz filtr FILTER_valIDATE_URL).
  7. Jeśli jest ustawiony, [LOGGING] logLevel musi być poprawnym poziomem rejestrowania PSR wielkimi literami, np. INFO.
  8. Jeśli jest ustawiony, [CONNECTION] transport musi mieć wartość grpc lub rest.
  9. Jeśli zasada [CONNECTION] transport ma wartość grpc, środowisko gRPC musi być obsługiwane przez środowisko (patrz przewodnik transport).
  10. Wartość [CONNECTION] grpcChannelIsSecure musi mieć wartość true, gdy [CONNECTION] transport nie jest ustawiona na grpc.
  11. Pole [CONNECTION] grpcChannelCredential można ustawić tylko wtedy, gdy [CONNECTION] transport ma wartość grpc.
  12. Wartość [CONNECTION] grpcChannelCredential można ustawić tylko wtedy, gdy [CONNECTION] grpcChannelIsSecure ma wartość true.