Obsługa wersji w interfejsie Search Ads 360 Reporting API

Interfejs Search Ads 360 Reporting API korzysta z obsługi wersji semantycznej.

Istnieją główne i podrzędne wersje w formacie vMAJOR_MINOR Na przykład v0_0 to pierwszą wersję główną i v0_1 pierwszą wersję podrzędną. Sufiks elementu numer wersji wskazuje typ wersji: dla wersji głównych jest to zawsze zero, a w przypadku wersji podrzędnych jest zawsze większa niż zero.

Wersje główne

Duże wersje wprowadzają zmiany powodujące niezgodność, czyli takie, które nie zgodne wstecznie.

Każda wersja główna ma oddzielny punkt końcowy, na przykład:

https://searchads360.googleapis.com/v0

https://searchads360.googleapis.com/v1

Przy przechodzeniu z jednej wersji głównej na inną może być konieczna zmiana przed przełączeniem się na nowy punkt końcowy wersji głównej.

Jeśli korzystasz z biblioteki klienta, musisz uaktualnić aplikację do najnowszej wersji. Nowe główne wersje zapewniają przewodnik po migracji, który pomoże Ci naprawić zmiany powodujące niezgodność w kodzie.

Przykłady zmian powodujących niezgodność:

  • usunięcie lub zmiana nazwy usługi, interfejsu, pola, metody bądź wartości wyliczeniowej;
  • Zmiana typu pola.
  • Zmiana formatu nazwy zasobu.
  • Zmiana formatu adresu URL w definicji HTTP.
  • zmiana formatu wyjściowego, np. zmiana 0 na -- jako wartości domyślnej;
  • Zmiana przyczyny błędu zwróconej z A na B.

Wersje podrzędne

Wersje podrzędne wprowadzają tylko zmiany zgodne wstecznie.

Po opublikowaniu wersji podrzędnej, używany już punkt końcowy automatycznie zaktualizowane. Nie spowoduje to uszkodzenia kodu. Możesz kontynuować do korzystania z istniejącej biblioteki klienta.

Wersje podrzędne zawierają nowe funkcje lub aktualizacje, które nie mają wpływu na istniejące w kodzie. Jeśli chcesz korzystać z nowych funkcji, musisz uaktualnić bibliotekę klienta do najnowszej wersji wersji.

Zachody słońca

Planowane wycofanie starszej wersji interfejsu Search Ads 360 Reporting API opublikuje powiadomienie w grupie dyskusyjnej Google searchads-api-announcements.