Obsługa wersji w interfejsie Search Ads 360 Reporting API

Interfejs Search Ads 360 Reporting API korzysta z wersji semantycznej.

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. W przypadku numeru wersji sufiks wskazuje typ wersji: w przypadku wersji głównych jest to zawsze 0, a w przypadku wersji podrzędnych zawsze większa niż 0.

Wersje główne

Duże wersje wprowadzają zmiany powodujące niezgodność, czyli zmiany, które nie są zgodne z poprzednimi wersjami.

Każda główna wersja ma osobny punkt końcowy, np.:

https://searchads360.googleapis.com/v0

https://searchads360.googleapis.com/v1

Podczas przejścia z jednej wersji głównej na inną może być konieczna zmiana kodu przed przejściem na punkt końcowy nowej wersji głównej.

Jeśli używasz biblioteki klienta, musisz przejść na jej najnowszą wersję. Nowe główne wersje zawierają przewodnik po migracji, który pomoże Ci naprawić wszelkie zmiany powodujące niezgodność w kodzie.

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

W wersjach podrzędnych wprowadzane są 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 używać dotychczasowej biblioteki klienta.

Mniejsze wersje zawierają nowe funkcje lub aktualizacje, które nie mają wpływu na dotychczasowy kod. Jeśli chcesz korzystać z nowych funkcji, musisz zaktualizować 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.