Projektowanie interfejsu REST

Ta strona zakłada, że znasz już poradniki dla programistów dotyczące projektowania zorientowanego na zasoby i nazw zasobów, a także uzupełnia je o szczegółowe informacje o wdrażaniu 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). Zasoby są odwoływane za pomocą nazwy zasobu i modyfikowane za pomocą niewielkiego zestawu metod (zwanych też czasownikami lub operacjami).

Te nazwy zasobówmetod, w połączeniu z określonym preiksem wersji interfejsu API, tworzą 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.