Auf dieser Seite wird davon ausgegangen, dass Sie mit den Entwicklerleitfäden Ressourcenorientiertes Design und Ressourcennamen vertraut sind. Sie wird durch spezifische Implementierungsdetails der Google Ads API ergänzt.
Ressourcenorientiertes Design
Im Allgemeinen folgt die Google Ads API einem ressourcenorientierten Design, das als Sammlungen von individuell adressierbaren Ressourcen (Substantive der API) modelliert ist. Ressourcen werden anhand ihrer Ressourcennamen referenziert und mit nur wenigen Methoden (auch als Verben oder Vorgänge bezeichnet) bearbeitet. Diese Ressourcennamen und Methoden bilden zusammen mit einem bestimmten API-Versionspräfix die URLs der REST-Schnittstelle. Diese Beispiel-URL kann beispielsweise gemäß der folgenden Tabelle in diese einzelnen Komponenten unterteilt werden:
https://googleads.googleapis.com/v25/customers/1234567890:mutate
| API-Versionspräfix | Ressourcenname (relativ) | Methode |
|---|---|---|
https://googleads.googleapis.com/v25
|
customers/1234567890
|
mutate
|
Alle REST-URLs für eine bestimmte Version der API (z.B. v25) haben ein gemeinsames API-Versionspräfix. Der Ressourcenname und die Methode geben zusammen an, welcher API-Dienst aufgerufen wird.
In der Google Ads API werden häufig benutzerdefinierte Methoden verwendet, im Gegensatz zu den meisten
REST APIs, die Standard-REST-Methoden wie list, get,
create, update, und delete verwenden. Beispiele für benutzerdefinierte Methoden in der Google Ads API
sind search, searchStream und mutate.
Auf den folgenden Seiten finden Sie weitere Informationen zu den Ressourcen namen, Dienstmethoden und JSON-Namenskonventionen der Google Ads API. So wird veranschaulicht, wie sie zusammen verwendet werden, um Endpunkte der REST-Schnittstelle zu definieren.
Fehlermanagement
Unter API-Fehler verstehen finden Sie eine Anleitung zum Analysieren und Debuggen von Fehlern.
Discovery-Dokument
Um die Suche nach verfügbaren Methoden in der Google Ads API zu erleichtern und zu automatisieren, können Sie das Discovery-Dokument verwenden, das für jede Version veröffentlicht wird.
Es ist unter
https://googleads.googleapis.com/$discovery/rest?version=<API_VERSION> verfügbar.
Dies ist beispielsweise das
Discovery-Dokument
für die neueste Version der Google Ads API.
Das Discovery-Dokument enthält Informationen zu allen Diensten, Methoden, Ressourcen und Entitäten, die in der Google Ads API verwendet werden, ähnlich wie die Referenzdokumentation, aber in einem maschinenlesbaren, JSON-Format.