Projektowanie interfejsu REST

Na tej stronie zakładamy, że znacie przewodniki dla programistów po projektowaniu zorientowanym na zasoby oraz nazwach zasobów, a także uzupełnia je informacjami o konkretnej implementacji interfejsu Google Ads API.

.

Projektowanie nastawione na zasoby

Ogólnie interfejs Google Ads API opiera się na zorientowaniu na zasoby, który jest modelowany jako zbiory indywidualnie adresowanych zasobów (rzeczowników 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 poniższy adres URL można podzielić na poszczególne komponenty według tabeli:

https://googleads.googleapis.com/v17/customers/1234567890:mutate
Prefiks wersji interfejsu API Nazwa zasobu (względna) Metoda
https://googleads.googleapis.com/v17 customers/1234567890 mutate

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

W przeciwieństwie do większości tradycyjnych interfejsów API typu REST, które korzystają ze standardowych metod REST, takich jak list, get, create, update i delete, interfejs Google Ads API często używa metod niestandardowych. Przykładami niestandardowych metod w interfejsie Google Ads API są search, searchStream i mutate.

Na kolejnych stronach znajdziesz więcej informacji o nazwach zasobów, metodach usług i konwencjach nazewnictwa danych JSON interfejsu Google Ads API, które obrazują sposób ich wspólnego używania do definiowania punktów końcowych interfejsu REST.