Design der REST-Benutzeroberfläche

Auf dieser Seite wird davon ausgegangen, dass Sie mit den Entwicklerleitfäden für ressourcenorientiertes Design und Ressourcennamen vertraut sind. Im Anschluss werden spezifische Implementierungsdetails der Google Ads API erläutert.

Ressourcenorientiertes Design

Im Allgemeinen ist die Google Ads API ein ressourcenorientiertes Design, das als Sammlungen von individuell adressierbaren Ressourcen (den Substantiven der API) modelliert wird. Ressourcen werden mit ihren Ressourcennamen referenziert und mit 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. Beispielsweise kann die URL unten nach der folgenden Tabelle in diese einzelnen Komponenten aufgeschlüsselt werden:

https://googleads.googleapis.com/v17/customers/1234567890:mutate
API-Versionspräfix Ressourcenname (relativ) Methode
https://googleads.googleapis.com/v17 customers/1234567890 mutate

Alle REST-URLs für eine bestimmte API-Version (z.B. v17) verwenden ein gemeinsames API-Versionspräfix. Der Ressourcenname und die Methode geben zusammen an, welcher API-Dienst aufgerufen wird.

Bei der Google Ads API werden im Gegensatz zu den meisten herkömmlichen REST APIs, die Standard-REST-Methoden wie list, get, create, update und delete verwenden, in großem Umfang benutzerdefinierte Methoden eingesetzt. 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 Ressourcennamen, Dienstmethoden und JSON-Namenskonventionen der Google Ads API, um zu veranschaulichen, wie diese zusammen zur Definition von REST-Schnittstellenendpunkten verwendet werden.