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 tym adresie URL X to numer wersji głównej (na przykład v26):
https://googleads.googleapis.com/vX
Jeśli uaktualniasz starszą wersję główną, po przejściu 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;
- Zmiana przyczyny błędu 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. Nie musisz zmieniać ścieżki wersji w adresach URL punktów końcowych, a istniejący kod będzie nadal działać bez zakłóceń.
Wersje podrzędne dodają funkcje lub aktualizacje, które nie mają wpływu 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
Co jakiś czas starsze wersje interfejsu Google Ads API są wycofywane, a następnie wyłączane:
- Wycofana: gdy zostanie wydana wersja główna (np.
v26), wszystkie wcześniejsze wersje główne zostaną oznaczone jako wycofane. Wywołania interfejsu API do wycofanych wersji będą nadal działać do daty ich wycofania, a istniejące wersje bibliotek klienta będą je nadal obsługiwać, chociaż kolejne wersje bibliotek klienta będą pomijać wycofane wersje interfejsu API, aby zmniejszyć rozmiar pakietu. - Wycofanie: wersja jest wyłączana w dniu wycofania, a wszystkie wywołania interfejsu API do jej punktu końcowego kończą się niepowodzeniem.
Ogłoszenia o wycofaniu wersji publikujemy na blogu dla deweloperów z wyprzedzeniem. Sprawdź harmonogram wycofywania i wyłączania, aby poznać daty aktywacji, wycofania i zaplanowanego wyłączenia.