Ta strona zakłada, że znasz przewodniki dla deweloperów dotyczące architektury zorientowanej na zasoby i nazw zasobów. Uzupełnia je o szczegółowe informacje o implementacji interfejsu Google Ads API.
Architektura zorientowana na zasoby
Interfejs Google Ads API jest zasadniczo zgodny z architekturą zorientowaną na zasoby, która jest modelowana jako kolekcje zasobów z indywidualnymi adresami (czyli rzeczowniki interfejsu API). Zasoby są przywoływane za pomocą nazw zasobów i manipulowane za pomocą niewielkiego zestawu metod (znanych też jako czasowniki lub operacje). Te nazwy zasobów i metody w połączeniu z określonym 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/v24/customers/1234567890:mutate
| Prefiks wersji interfejsu API | Nazwa zasobu (względna) | Metoda |
|---|---|---|
https://googleads.googleapis.com/v24
|
customers/1234567890
|
mutate
|
Wszystkie adresy URL REST dla określonej wersji interfejsu API (np. v24) 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 search, searchStream i mutate.
Na kolejnych stronach znajdziesz więcej informacji o nazwach zasobów, metodach usług i konwencjach nazewnictwa JSON w interfejsie Google Ads API. Zobaczysz, jak są one 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żyć dokumentu opisującego opublikowanego dla każdej wersji.
Jest on dostępny pod adresem
https://googleads.googleapis.com/$discovery/rest?version=<API_VERSION>.
Oto na przykład dokument opisujący najnowszą wersję interfejsu Google Ads API.
Dokument opisujący zawiera informacje o wszystkich usługach, metodach, zasobach i encjach używanych w interfejsie Google Ads API, podobnie jak dokumentacja, ale w formacie JSON, który może być odczytywany przez maszyny.