Wersjonowanie semantyczne
Interfejs Google Ads API korzysta z semantycznej obsługi wersji z numerem wersji głównej i wersji podrzędnej. Wersje są zapisywane jako MAJOR.MINOR lub vMAJOR.MINOR.
Na przykład v26.0 (lub v26) to wersja główna, a v26.1 to wersja podrzędna.
Szczegółowe informacje o bieżącej i poprzednich wersjach znajdziesz w informacjach o wersji.
Wersje główne
Główne wersje do publikacji wprowadzają zmiany powodujące niezgodność wsteczną. Pierwsza wersja główna kończy się zerem (vX.0 lub vX, gdzie X to numer wersji głównej).
Każda wersja główna ma osobną ścieżkę punktu końcowego REST i gRPC (vX), która nie zawiera sufiksu wersji podrzędnej. W adresie URL poniżej X to numer wersji głównej (na przykład v26):
https://googleads.googleapis.com/vX
Jeśli przechodzisz ze starszej wersji głównej, po przełączeniu się na nowy punkt końcowy wersji głównej może być konieczne wprowadzenie zmian w kodzie. Jeśli używasz naszych bibliotek klienta, uaktualnij je do wersji, która obsługuje nową wersję główną. Gdy wydajemy wersję główną, udostępniamy przewodnik po uaktualnieniu, który pomoże Ci rozwiązać wszelkie problemy z kodem.
Przykłady zmian powodujących niezgodność:
- usunięcie lub zmiana nazwy usługi, interfejsu, pola, metody lub wartości typu wyliczeniowego;
- zmiana typu pola,
- zmiana formatu nazwy zasobu,
- zmiana formatu adresu URL w definicji HTTP;
- zmiana formatów wyjściowych, np. zmiana wartości domyślnych;
- Zmienianie przyczyny błędu zwracanego z A na B.
Wersje podrzędne
Wersje podrzędne wprowadzają tylko zmiany zgodne wstecznie. W przypadku wersji podrzędnej vMAJOR.MINOR ma liczbę MINOR większą od zera (np. v26.1).
Gdy zostanie wydana wersja podrzędna, istniejący punkt końcowy wersji głównej (https://googleads.googleapis.com/vX) zostanie automatycznie zaktualizowany. Wszystkie wywołania interfejsu API dotyczące konkretnej wersji głównej zawsze trafiają do najnowszej odpowiadającej jej wersji podrzędnej, a interfejs Google Ads API nie obsługuje wywoływania konkretnych wersji podrzędnych.
Nie musisz zmieniać ścieżki wersji w adresach URL punktów końcowych, a dotychczasowy kod będzie nadal działać bez zakłóceń. Okres ważności wersji podrzędnych nie jest śledzony oddzielnie. Zamiast tego wersje podrzędne mają tę samą datę wycofania co odpowiadająca im wersja główna.
Wersje podrzędne dodają funkcje lub aktualizacje, które nie wpływają na istniejący kod. Aby używać pól lub funkcji z wersji podrzędnej z biblioteką klienta, uaktualnij bibliotekę klienta do wersji, która zawiera definicje wersji podrzędnej.
Wycofanie i zakończenie obsługi
Interfejs Google Ads API obsługuje wiele aktywnych wersji głównych jednocześnie. Co jakiś czas starsze wersje są wycofywane, a później wyłączane:
- Wycofana: wersja jest uznawana za wycofaną tylko wtedy, gdy jest wyraźnie oznaczona jako wycofana. Wywołania interfejsu API do wycofanych wersji będą działać do daty wycofania.
- Wycofanie: wersja jest wyłączana w dniu wycofania, a wszystkie wywołania interfejsu API do jej punktu końcowego kończą się niepowodzeniem.
Przed wycofaniem wersji publikujemy ogłoszenia na blogu dla deweloperów. Sprawdź harmonogram wycofywania i wyłączania, aby poznać daty aktywacji, wycofania i zaplanowanego wyłączenia.