Projektowanie interfejsu REST

Na tej stronie założono, że znasz przewodniki dla deweloperów Projektowanie zorientowane na zasobyNazwy zasobów. Znajdziesz tu szczegółowe informacje o wdrażaniu interfejsu Google Ads API.

Projektowanie zorientowane na zasoby

Interfejs Google Ads API jest zwykle zaprojektowany w sposób zorientowany na zasoby, które są modelowane jako kolekcje indywidualnie adresowanych zasobów (rzeczowników interfejsu API). Do zasobów odwołuje się za pomocą ich nazw, a manipuluje się nimi za pomocą niewielkiego zestawu metod (nazywanych też czasownikami lub operacjami).

Te nazwy zasobówmetody w połączeniu z określonym prefiksem wersji interfejsu API tworzą adresy URL interfejsu REST. Na przykład adres URL poniżej można podzielić na poszczególne komponenty zgodnie z tabelą:

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

Wszystkie adresy URL REST dla konkretnej wersji interfejsu API (np. v21) 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 w dużym stopniu korzysta z metod niestandardowych, w przeciwieństwie do większości tradycyjnych interfejsów API REST, które używają standardowych metod REST, takich jak list, get, create, updatedelete. Przykłady metod niestandardowych w interfejsie Google Ads API to search, searchStreammutate.

Na kolejnych stronach znajdziesz więcej informacji o nazwach zasobów, metodach usługkonwencjach nazewnictwa JSON w Google Ads API. Wyjaśniamy, jak są one używane razem do definiowania punktów końcowych interfejsu REST.

Dokument opisujący

Aby ułatwić i zautomatyzować wykrywanie dostępnych metod w interfejsie Google Ads API, możesz użyć dokumentu wykrywania opublikowanego dla każdej wersji.

Jest dostępna w https://googleads.googleapis.com/$discovery/rest?version=<API_VERSION>. Na przykład ten dokument to dokument wykrywania najnowszej wersji interfejsu Google Ads API.

Dokument opisujący zawiera informacje o wszystkich usługach, metodach, zasobach i elementach używanych w Google Ads API, takie jak dokumentacja referencyjna, ale w czytelnym dla komputera formacie JSON.