Die PHP-Clientbibliothek der Google Ads API bietet mehrere Konfigurationseinstellungen, mit denen sich das Verhalten der Bibliothek anpassen lässt.
Konfigurationsdatei
Die meisten dieser Konfigurationseinstellungen können Sie in ini
-Dateien speichern und bei der Instanziierung von Clients verwenden, z. B. google_ads_php.ini
.
Die Anmeldedaten- und Client-Builder bieten jeweils fromFile
-Methoden zum Laden von Einstellungen aus solchen Dateien:
$oAuth2Credential = (new OAuth2TokenBuilder())
->fromFile('/path/to/google_ads_php.ini')
->build();
$googleAdsClient = (new GoogleAdsClientBuilder())
->fromFile('/path/to/google_ads_php.ini')
->withOAuth2Credential($oAuth2Credential)
->build();
Wenn kein Konfigurationsdateipfad als Argument angegeben ist, werden die Methoden fromFile
aus dem Standardpfad der Konfigurationsdatei geladen:
- Der Wert der Umgebungsvariablen mit dem Namen
GOOGLE_ADS_CONFIGURATION_FILE_PATH
, falls festgelegt. - Andernfalls befindet sich die Datei
google_ads_php.ini
im VerzeichnisHOME
.
$oAuth2Credential = (new OAuth2TokenBuilder())
->fromFile()
->build();
$googleAdsClient = (new GoogleAdsClientBuilder())
->fromFile()
->withOAuth2Credential($oAuth2Credential)
->build();
Dynamische Konfiguration
Sie können diese Konfigurationseinstellungen bei der Instanziierung von Clients dynamisch festlegen.
$oAuth2Credential = (new OAuth2TokenBuilder())
->withClientId('INSERT_CLIENT_ID')
// ...
->build();
$googleAdsClient = (new GoogleAdsClientBuilder())
->withOAuth2Credential($oAuth2Credential)
->withDeveloperToken('INSERT_DEVELOPER_TOKEN_HERE')
// ...
->build();
Umgebungsvariablen für die Konfiguration
Sie können einige Konfigurationseinstellungen aus Umgebungsvariablen festlegen, wenn Sie Clients instanziieren (siehe vollständige Liste).
Die Anmeldedaten- und Client-Builder bieten beide fromEnvironmentVariables
-Methoden zum Laden von Einstellungen aus Umgebungsvariablen:
$oAuth2Credential = (new OAuth2TokenBuilder())
// ...
->fromEnvironmentVariables()
->build();
$googleAdsClient = (new GoogleAdsClientBuilder())
->withOAuth2Credential($oAuth2Credential)
// ...
->fromEnvironmentVariables()
->build();
Felder für die Konfiguration
In den Konfigurationseinstellungen sind mehrere Felder unterstützt, die in Kategorien unterteilt sind.
- Von
OAuth2TokenBuilder
verwendete Felder:- Anwendungsmodus
[OAUTH2] clientId
: Ihre OAuth2-Client-ID.[OAUTH2] clientSecret
: Ihr OAuth2-Clientschlüssel.[OAUTH2] refreshToken
: Ihr OAuth2-Aktualisierungstoken.
- Dienstkontomodus
[OAUTH2] jsonKeyFilePath
: Der Pfad der JSON-Schlüsseldatei.[OAUTH2] scopes
: die Bereiche.[OAUTH2] impersonatedEmail
: Die E-Mail-Adresse, die angenommen werden soll.
- Anwendungsmodus
- Von
GoogleAdsClientBuilder
verwendete Felder:[GOOGLE_ADS] developerToken
: Ihr Entwicklertoken für den Zugriff auf die API.[GOOGLE_ADS] loginCustomerId
: Die Kundennummer für die Anmeldung.[GOOGLE_ADS] linkedCustomerId
: Die verknüpfte Kundennummer.[LOGGING] logFilePath
: Der Dateipfad für das Logging.[LOGGING] logLevel
: Die Logging-Ebene.[CONNECTION] proxy
: Die für die Internetverbindung verwendete Proxy-Server-URL.[CONNECTION] transport
: Der Transport.[CONNECTION] grpcChannelIsSecure
: gibt an, ob der gRPC-Kanal sicher ist oder nicht.[CONNECTION] grpcChannelCredential
: Die Anmeldedaten für den gRPC-Kanal.[CONNECTION] unaryMiddlewares
: Die unären Middleware.[CONNECTION] streamingMiddlewares
: Die Streaming-Middleware.[CONNECTION] grpcInterceptors
: der gRPC-Abfanger.
Konfigurationsprüfung
Die Konfigurationseinstellungen werden geprüft, wenn Instanzen instanziiert werden, und Ausnahmen, wenn sie ungültig sind. Dies sind die Regeln:
[OAUTH2]
-Felder dürfen nicht gleichzeitig für den Anwendungsmodus und den Dienstkontomodus festgelegt werden.[OAUTH2] jsonKeyFilePath
und[OAUTH2] scopes
müssen bei Verwendung des Dienstkontomodus festgelegt werden.[OAUTH2] clientId
,[OAUTH2] clientSecret
und[OAUTH2] refreshToken
müssen im Anwendungsmodus festgelegt werden.[GOOGLE_ADS] developerToken
muss immer festgelegt werden.- Wenn festgelegt, müssen
[GOOGLE_ADS] loginCustomerId
und[GOOGLE_ADS] linkedCustomerId
positive Zahlen sein. - Wenn festgelegt, muss
[CONNECTION] proxy
eine gültige URL sein (siehe Filter FILTER_CANCELATE_URL). - Wenn festgelegt, muss
[LOGGING] logLevel
eine gültige PSR-Logebene in Großbuchstaben sein, z. B.INFO
. - Wenn festgelegt, muss
[CONNECTION] transport
entwedergrpc
oderrest
sein. - Wenn
[CONNECTION] transport
aufgrpc
gesetzt ist, muss der gRPC-Transport von der Umgebung unterstützt werden (siehe Transport). [CONNECTION] grpcChannelIsSecure
musstrue
sein, wenn[CONNECTION] transport
nicht aufgrpc
festgelegt ist.[CONNECTION] grpcChannelCredential
kann nur festgelegt werden, wenn[CONNECTION] transport
aufgrpc
gesetzt ist.[CONNECTION] grpcChannelCredential
kann nur festgelegt werden, wenn[CONNECTION] grpcChannelIsSecure
den Werttrue
hat.