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, które są formatowane jako 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 zawsze wartość ta wynosi 0, a w wersjach podrzędnych zawsze jest większa niż 0.

Wersje główne

Większe wersje wprowadzają zmiany powodujące niezgodność, czyli zmiany, 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

Podczas uaktualniania z jednej wersji głównej do innej może być konieczna zmiana kodu przed przełączeniem na nowy punkt końcowy wersji głównej.

Jeśli używasz biblioteki klienta, musisz zaktualizować ją do najnowszej wersji. W nowych głównych wersjach znajdziesz przewodnik po migracji, który pomoże Ci usunąć w kodzie zmiany powodujące niezgodność.

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 z 0 na --.
  • Zmiana zwracanego powodu błędu z A na B.

Wersje podrzędne

Wersje podrzędne wprowadzają tylko zmiany zgodne wstecznie.

Gdy zostanie wydana nowa wersja podrzędna, punkt końcowy, który jest już używany, zostanie automatycznie zaktualizowany. Nie spowoduje to uszkodzenia kodu. Możesz nadal korzystać z dotychczasowej biblioteki klienta.

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

Zachody słońca

Gdy starsza wersja Search Ads 360 Reporting API zostanie wycofana, opublikujemy o tym powiadomienie w grupie searchads-api-announcements w Google.