Design der REST-Benutzeroberfläche

Auf dieser Seite wird davon ausgegangen, dass Sie mit den Entwicklerhandbüchern zum ressourcenorientierten Design und zu Ressourcennamen vertraut sind. Sie werden um spezifische Implementierungsdetails der Search Ads 360 Reporting API ergänzt.

Ressourcenorientiertes Design

Die Search Ads 360 Reporting API folgt im Allgemeinen einem ressourcenorientierten Design, das als Sammlungen von 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 in Kombination mit einem bestimmten API-Versionspräfix bilden die URLs der REST-Schnittstelle. Die folgende URL kann beispielsweise gemäß der folgenden Tabelle in die einzelnen Komponenten unterteilt 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) ein gemeinsames API-Versionpräfix haben. Der Ressourcenname und die Methode geben zusammen an, welcher API-Dienst aufgerufen wird.

Die Search Ads 360 Reporting API verwendet häufig benutzerdefinierte Methoden, im Gegensatz zu den meisten traditionellen REST APIs, die Standard-REST-Methoden wie list und get verwenden. Die Search Ads 360 Reporting API enthält zwei benutzerdefinierte Methoden: search und searchStream.

Auf den folgenden Seiten finden Sie weitere Informationen zu den Ressourcennamen, Dienstmethoden und JSON-Namenskonventionen der Reporting API von Search Ads 360. Außerdem wird erläutert, wie sie zusammen verwendet werden, um REST-Interface-Endpunkte zu definieren.