Auf dieser Seite wird davon ausgegangen, dass Sie mit den Entwicklerleitfäden für ressourcenorientiertes Design und Ressourcennamen vertraut sind. Außerdem werden diese um spezifische Implementierungsdetails der Search Ads 360 Reporting API ergänzt.
Ressourcenorientiertes Design
Im Allgemeinen folgt die Search Ads 360 Reporting API einem ressourcenorientierten Design, das als Sammlungen individuell adressierbarer Ressourcen, der Substantive der API, modelliert wird. 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 in Kombination mit einem bestimmten API-Versionspräfix die URLs der REST-Schnittstelle. Zum Beispiel kann die URL unten gemäß der folgenden Tabelle in diese einzelnen Komponenten aufgeschlüsselt werden:
https://searchads360.googleapis.com/v0/customers/1234567890/searchAds360:search
| Präfix der API-Version | Ressourcenname (relativ) | Methode |
|---|---|---|
https://searchads360.googleapis.com/v0
|
customers/1234567890
|
search
|
Alle REST-URLs für eine bestimmte Version der API (z.B. v0) verwenden ein gemeinsames API-Versionspräfix. Der Ressourcenname und die Methode geben zusammen, welcher API-Dienst aufgerufen wird.
Im Gegensatz zu den meisten traditionellen REST APIs, die Standard-REST-Methoden wie list und get verwenden, werden in der Search Ads 360 Reporting API intensiv benutzerdefinierte Methoden eingesetzt. Die Search Ads 360 Reporting API enthält zwei benutzerdefinierte Methoden: search und searchStream.
Auf den folgenden Seiten werden die Ressourcennamen, Dienstmethoden und JSON-Namenskonventionen der Search Ads 360 Reporting API ausführlicher beschrieben, um zu veranschaulichen, wie sie zusammen verwendet werden, um Endpunkte der REST-Schnittstelle zu definieren.