Auf dieser Seite wird davon ausgegangen, dass Sie mit den Entwicklerleitfäden Ressourcenorientiertes Design und Ressourcennamen vertraut sind. Sie werden hier durch spezifische Implementierungsdetails der Google Ads API ergänzt.
Ressourcenorientiertes Design
Die Google Ads API folgt im Allgemeinen einem ressourcenorientierten Design, das als Sammlungen von einzeln adressierbaren Ressourcen (den Substantiven der API) modelliert ist. Ressourcen werden mit ihren Ressourcennamen referenziert und mit einer kleinen Gruppe von 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 gemäß der folgenden Tabelle in diese einzelnen Komponenten aufgeteilt werden:
https://googleads.googleapis.com/v26/customers/1234567890:mutate
| Präfix der API-Version | Ressourcenname (relativ) | Methode |
|---|---|---|
https://googleads.googleapis.com/v26
|
customers/1234567890
|
mutate
|
Alle REST-URLs für eine bestimmte Version der API (z.B. v26) 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 im Gegensatz zu den meisten REST APIs, die Standard-REST-Methoden wie list, get, create, update und delete verwenden, häufig benutzerdefinierte Methoden verwendet. Beispiele für benutzerdefinierte Methoden in der Google Ads API sind search, searchStream und mutate.
Auf den folgenden Seiten werden die Ressourcennamen, Dienstmethoden und JSON-Namenskonventionen der Google Ads API genauer beschrieben, um zu veranschaulichen, wie sie zusammen verwendet werden, um REST-Schnittstellenendpunkte zu definieren.
Fehlermanagement
Unter API-Fehler verstehen finden Sie eine Anleitung zum Analysieren und Beheben von Fehlern.
Discovery-Dokument
Um die verfügbaren Methoden in der Google Ads API leichter und automatisch zu finden, können Sie das für jede Version veröffentlichte Discovery-Dokument verwenden.
Sie ist unter https://googleads.googleapis.com/$discovery/rest?version=<API_VERSION> verfügbar.
Dies ist beispielsweise das Discovery-Dokument für die aktuelle 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, jedoch in einem maschinenlesbaren JSON-Format.