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 aus individuell adressierbaren Ressourcen (den Substantiven der API) modelliert wird. 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. Die URL unten kann beispielsweise gemäß der folgenden Tabelle in die einzelnen Komponenten unterteilt werden:
https://googleads.googleapis.com/v21/customers/1234567890:mutate
| Präfix der API-Version | Ressourcenname (relativ) | Methode |
|---|---|---|
https://googleads.googleapis.com/v21
|
customers/1234567890
|
mutate
|
Alle REST-URLs für eine bestimmte Version der API (z.B. v21)
ein gemeinsames API-Versionspräfix haben. Der Ressourcenname und die Methode geben zusammen an, welcher API-Dienst aufgerufen wird.
In der Google Ads API werden häufig benutzerdefinierte Methoden verwendet. Die meisten herkömmlichen REST APIs nutzen dagegen Standard-REST-Methoden wie list, get, create, update und delete. 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.