Projektowanie interfejsu REST

Ta strona zakłada, że znasz już przewodniki dla programistów dotyczące projektowania zorientowanego na zasoby i nazw zasobów, a także uzupełnia je o szczegółowe informacje o implementacji interfejsu Google Ads API.

Projektowanie zorientowane na zasoby

Ogólnie interfejs Google Ads API jest zaprojektowany zgodnie z zasadami architektury zorientowanej na zasoby 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://googleads.googleapis.com/v18/customers/1234567890:mutate
Prefix wersji interfejsu API Nazwa zasobu (względna) Metoda
https://googleads.googleapis.com/v18 customers/1234567890 mutate

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

Interfejs Google Ads 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 list, get, create, updatedelete. Przykłady niestandardowych metod w interfejsie Google Ads API to search, searchStreammutate.

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