Obsługa wersji w interfejsie Search Ads 360 Reporting API

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

Istnieją wersje główne i podrzędne w formacie vMAJOR_MINOR. Na przykład v0_0 to pierwsza wersja główna, a v0_1 – pierwsza wersja podrzędna. Sufiks numeru wersji wskazuje typ wersji: w przypadku wersji głównych ma on zawsze wartość 0, a w przypadku wersji podrzędnych – zawsze jest większy niż 0.

Wersje główne

Główne wersje wprowadzają zmiany powodujące niezgodność, czyli takie, które nie są 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

Uaktualnienie z jednej wersji głównej na drugą może wymagać zmiany kodu przed przejściem na nowy punkt końcowy wersji głównej.

Jeśli używasz biblioteki klienta, musisz uaktualnić pakiet do najnowszej wersji. Główne wersje zawierają przewodnik po migracji, który pomaga skorygować zmiany powodujące niezgodność kodu.

Przykłady zmian powodujących niezgodność:

  • usunięcie lub zmiana nazwy usługi, interfejsu, pola, metody lub wartości wyliczenia.
  • zmiana typu pola,
  • Zmiana formatu nazwy zasobu.
  • zmiana formatu adresu URL w definicji HTTP,
  • zmiana formatów wyjściowych, np. zmiana wartości domyślnej 0 na --;
  • Zmiana przyczyny błędu zwróconego z A na B.

Wersje podrzędne

Wersje podrzędne wprowadzają tylko zmiany zgodne wstecznie.

Po opublikowaniu wersji podrzędnej punkt końcowy, który jest już używany, jest automatycznie aktualizowany. Nie powoduje to uszkodzenia kodu. Nadal możesz używać istniejącej biblioteki klienta.

Mniejsze wersje zawierają nowe funkcje lub aktualizacje, które nie mają wpływu na obecny kod. Jeśli chcesz korzystać z nowych funkcji, musisz uaktualnić bibliotekę klienta do najnowszej wersji.

Zachody słońca

Przy planowaniu wycofania starszej wersji interfejsu Search Ads 360 Reporting API publikujemy powiadomienie w grupie dyskusyjnej Google searchads-api-announcements.