Projektowanie interfejsu REST

Na tej stronie zakładamy, że znasz już przewodniki dla programistów dotyczące projektowania zorientowanego na zasoby i nazwisk zasobów, a także uzupełniające je szczegółowe informacje o wdrożeniu interfejsu Search Ads 360 Reporting API.

.

Projektowanie zorientowane na zasoby

Ogólnie rzecz biorąc, interfejs Search Ads 360 Reporting API jest oparty na zasobach i modelowany jako zbiory zasobów (rzeczownik interfejsu API). Odwoływanie się do zasobów odbywa się za pomocą ich nazw i manipulacja przy użyciu niewielkiego zestawu metod (nazywanych też czasownikami lub operacjami).

Te nazwy zasobów i metody w połączeniu z określonym prefiksem wersji interfejsu API składają się na adresy URL interfejsu REST. Na przykład adres URL poniżej można podzielić na te elementy zgodnie z tabelą:

https://searchads360.googleapis.com/v0/customers/1234567890/searchAds360:search
Prefix wersji interfejsu API Nazwa zasobu (względna) Metoda
https://searchads360.googleapis.com/v0 customers/1234567890 search

Wszystkie adresy URL REST dla konkretnej wersji interfejsu API (np. v0) mają wspólny prefiks wersji interfejsu API. Nazwa zasobu i metoda razem określają, która usługa interfejsu API jest wywoływana.

Interfejs Search Ads 360 Reporting API intensywnie korzysta z metod niestandardowych, w przeciwieństwie do większości tradycyjnych interfejsów API REST, które korzystają ze standardowych metod REST, takich jak listget. Interfejs Search Ads 360 Reporting API zawiera 2 metody niestandardowe: searchsearchStream.

Na kolejnych stronach znajdziesz więcej informacji o nazwach zasobów, metodach usługikonwencjach nazewnictwa plików JSON interfejsu Search Ads 360 Reporting API, które są używane razem do definiowania punktów końcowych interfejsu REST.