Projektowanie interfejsu REST

Zakładamy tutaj, że znasz już przewodniki dla programistów dotyczące projektowania zorientowanego na zasoby i nazw zasobów oraz zostały one uzupełnione o szczegółowe informacje o implementacji interfejsu Search Ads 360 Reporting API.

Projektowanie zorientowane na zasoby

Interfejs Search Ads 360 Reporting API jest zasadniczo ukierunkowany na zasoby, modelowany jako zbiory adresowanych indywidualnie zasobów (rzeczowników interfejsu API). Do zasobów odwołują się nazwy zasobów i są one wykorzystywane 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 tworzą adresy URL interfejsu REST. Na przykład poniższy adres URL można podzielić na poszczególne komponenty, korzystając z tej tabeli:

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

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

Interfejs Search Ads 360 Reporting API intensywnie korzysta z metod niestandardowych w odróżnieniu od większości tradycyjnych interfejsów API REST używających standardowych metod REST, takich jak list czy get. Interfejs Search Ads 360 Reporting API zawiera 2 metody niestandardowe: search i searchStream.

Na kolejnych stronach znajdziesz więcej informacji o nazwach zasobów, metodach usług i konwencjach nazewnictwa JSON stosowanych w interfejsie Search Ads 360 Reporting API oraz o tym, jak są one używane razem do definiowania punktów końcowych interfejsu REST.