Конфигурация

Клиентская библиотека 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 загружаются из пути к файлу конфигурации по умолчанию:

1. Значение переменной среды с именем GOOGLE_ADS_CONFIGURATION_FILE_PATH , если она установлена.
2. В противном случае файл google_ads_php.ini находится в вашем HOME каталоге.

$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();

Поля конфигурации

Параметры конфигурации поддерживают несколько полей, организованных по категориям.

1. Поля, используемые OAuth2TokenBuilder :
   • Режим приложения
     • [OAUTH2] clientId : ваш идентификатор клиента OAuth2.
     • [OAUTH2] clientSecret : секрет вашего клиента OAuth2.
     • [OAUTH2] refreshToken : ваш токен обновления OAuth2.
   • Режим сервисной учетной записи
     • [OAUTH2] jsonKeyFilePath : путь к файлу ключа Json.
     • [OAUTH2] scopes : Области.
     • [OAUTH2] impersonatedEmail : адрес электронной почты для олицетворения.
2. Поля, используемые GoogleAdsClientBuilder :
   • [GOOGLE_ADS] developerToken : ваш токен разработчика для доступа к API.
   • [GOOGLE_ADS] loginCustomerId : идентификатор клиента для входа.
   • [GOOGLE_ADS] linkedCustomerId : связанный идентификатор клиента.
   • [LOGGING] logFilePath : путь к файлу для ведения журнала.
   • [LOGGING] logLevel : уровень ведения журнала.
   • [CONNECTION] proxy : URL-адрес прокси-сервера, используемый для подключения к Интернету.
   • [CONNECTION] transport : Транспорт.
   • [CONNECTION] grpcChannelIsSecure : защищен ли канал gRPC.
   • [CONNECTION] grpcChannelCredential : учетные данные канала gRPC.
   • [CONNECTION] unaryMiddlewares : Унарные промежуточные программы.
   • [CONNECTION] streamingMiddlewares : ПО промежуточного слоя потоковой передачи.
   • [CONNECTION] grpcInterceptors : перехватчики gRPC.

Проверка конфигурации

Параметры конфигурации проверяются при создании экземпляров клиентов, и если они недействительны, выдаются исключения. Вот правила:

1. [OAUTH2] не должны быть установлены одновременно для режима приложения и режима учетной записи службы.
2. [OAUTH2] jsonKeyFilePath и [OAUTH2] scopes должны быть установлены при использовании режима учетной записи службы.
3. [OAUTH2] clientId , [OAUTH2] clientSecret и [OAUTH2] refreshToken должны быть установлены при использовании режима приложения.
4. Всегда должен быть установлен [GOOGLE_ADS] developerToken .
5. Если установлено, [GOOGLE_ADS] loginCustomerId и [GOOGLE_ADS] linkedCustomerId должны быть положительными числами.
6. Если установлено, [CONNECTION] proxy должен быть действительным URL-адресом (см. фильтр FILTER_VALIDATE_URL ).
7. Если установлено, [LOGGING] logLevel должен быть допустимым уровнем журнала PSR с заглавными буквами, например INFO .
8. Если установлено, [CONNECTION] transport должен быть либо grpc , либо rest .
9. Если для [CONNECTION] transport установлено значение grpc , транспорт gRPC должен поддерживаться средой (см. руководство по транспорту ).
10. [CONNECTION] grpcChannelIsSecure должно иметь значение true , если для [CONNECTION] transport не установлено значение grpc .
11. [CONNECTION] grpcChannelCredential можно установить, только если для [CONNECTION] transport установлено значение grpc .
12. [CONNECTION] grpcChannelCredential можно установить, только если [CONNECTION] grpcChannelIsSecure имеет значение true .