Projektowanie interfejsu REST

Zakładamy, że zna ona sekcje zasobów Projekt i Zasób nazwy przewodników dla programistów oraz uzupełnia je szczegółowymi informacjami o wdrożeniu interfejsu Google Ads API.

Projektowanie nastawione na zasoby

Ogólnie interfejs Google Ads API opiera się na zorientowaniu na zasoby, kolekcje adresowanych indywidualnie zasobów (rzeczowników interfejsu API). Przywoływać zasoby za pomocą nazw i manipulowano przy użyciu zestaw metod (nazywanych też czasownikami lub operacjami).

Połączone nazwy zasobów i metody z określonym prefiksem wersji API obejmują adresy URL interfejsu REST. Na przykład poniższy adres URL można podzielić na poszczególne komponenty zgodnie z tą tabelą:

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). wspólny prefiks wersji interfejsu API. Nazwa zasobu i metoda razem identyfikuje wywoływaną usługę API.

W interfejsie Google Ads API bardzo często stosowane są metody niestandardowe, API typu REST, które wykorzystują standardowe metody REST, takie jak list, get, create, update i delete. Przykłady niestandardowych metod w interfejsie Google Ads API to search, searchStream i mutate.

Na kolejnych stronach znajdziesz więcej informacji o zasobie interfejsu Google Ads API nazwy, metody obsługi oraz Konwencje nazewnictwa JSON przedstawiające sposób ich użycia razem, aby zdefiniować punkty końcowe interfejsu REST.