Na tej stronie zakładamy, że znasz przewodniki dla programistów dotyczące projektowania zorientowanego na zasoby i nazw zasobów. Uzupełniamy je o szczegóły implementacji interfejsu Google Ads API.
Projektowanie zorientowane na zasoby
Interfejs Google Ads API jest zwykle zaprojektowany zgodnie z zasadami architektury zorientowanej na zasoby, która jest modelowana jako kolekcje indywidualnie adresowalnych zasobów (rzeczowników interfejsu API). Zasoby są przywoływane za pomocą nazw zasobów i modyfikowane przy użyciu niewielkiego zestawu metod (nazywanych też czasownikami lub operacjami). Te nazwy zasobów i metody w połączeniu z konkretnym prefiksem wersji interfejsu API tworzą adresy URL interfejsu REST. Na przykład ten przykładowy adres URL można podzielić na poszczególne komponenty zgodnie z tabelą poniżej:
https://googleads.googleapis.com/v26/customers/1234567890:mutate
| Prefiks wersji interfejsu API | Nazwa zasobu (względna) | Metoda |
|---|---|---|
https://googleads.googleapis.com/v26
|
customers/1234567890
|
mutate
|
Wszystkie adresy URL typu REST dla konkretnej wersji interfejsu API (np. v26) 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 interfejsów API REST, które używają standardowych metod REST, takich jak list, get, create, update i delete. Przykłady metod niestandardowych w interfejsie Google Ads API to m.in. search, searchStream i mutate.
Na kolejnych stronach znajdziesz więcej informacji o nazwach zasobów, metodach usługi i konwencjach nazewnictwa JSON w interfejsie Google Ads API, które pokazują, jak te elementy są używane razem do definiowania punktów końcowych interfejsu REST.
Zarządzanie błędami
Więcej informacji o analizowaniu i debugowaniu błędów znajdziesz w artykule Informacje o błędach interfejsu API.
Dokument opisujący
Aby ułatwić i zautomatyzować wykrywanie dostępnych metod w interfejsie Google Ads API, możesz używać dokumentu opisującego opublikowanego dla każdej wersji.
Można go znaleźć na stronie https://googleads.googleapis.com/$discovery/rest?version=<API_VERSION>.
Na przykład tak wygląda dokument opisujący najnowszą wersję interfejsu Google Ads API.
Dokument opisujący zawiera informacje o wszystkich usługach, metodach, zasobach i elementach używanych w interfejsie Google Ads API, podobnie jak dokumentacja referencyjna, ale w formacie JSON, który jest czytelny dla komputerów.