Im Folgenden wird davon ausgegangen, dass Sie mit den Entwicklerleitfäden für ressourcenorientierte Designs und Ressourcennamen vertraut sind. Außerdem werden sie mit spezifischen Implementierungsdetails der Google Ads API ergänzt.
Ressourcenorientiertes Design
Die Google Ads API ist im Allgemeinen ressourcenorientiert konzipiert und als Sammlungen individueller Ressourcen (die Substantive der API) modelliert. Ressourcen werden anhand ihrer 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. Beispielsweise kann die URL unten entsprechend der folgenden Tabelle in diese einzelnen Komponenten aufgeschlüsselt werden:
https://googleads.googleapis.com/v16/customers/1234567890:mutate
| Präfix der API-Version | Ressourcenname (relativ) | Methode |
|---|---|---|
https://googleads.googleapis.com/v16
|
customers/1234567890
|
mutate
|
Alle REST-URLs für eine bestimmte Version der API (z.B. v16) haben ein gemeinsames API-Versionspräfix. Der Ressourcenname und die Methode geben zusammen, welcher API-Dienst aufgerufen wird.
Im Gegensatz zu den meisten herkömmlichen REST APIs, die Standard-REST-Methoden wie list, get, create, update und delete nutzen, werden in der Google Ads API intensiv benutzerdefinierte Methoden eingesetzt. Beispiele für benutzerdefinierte Methoden in der Google Ads API sind search, searchStream und mutate.
Auf den folgenden Seiten erhalten Sie detaillierte Informationen zu den Ressourcennamen, Dienstmethoden und JSON-Namenskonventionen der Google Ads API, um zu veranschaulichen, wie sie zusammen zur Definition von REST-Schnittstellenendpunkten verwendet werden.