Wersjonowanie semantyczne
Interfejs Google Ads API korzysta z semantycznej obsługi wersji, która obejmuje numer wersji głównej i wersji podrzędnej. Wersje są zapisywane jako MAJOR.MINOR lub vMAJOR.MINOR.
Na przykład v25.0 (lub v25) to wersja główna, a v25.1 to wersja podrzędna.
Szczegółowe informacje o bieżących i poprzednich wersjach znajdziesz w informacjach o wersji.
Wersje główne
Wersje główne 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 (np. v25):
https://googleads.googleapis.com/vX
Jeśli uaktualniasz starszą wersję główną, po przejściu na nowy punkt końcowy wersji głównej Twój kod może wymagać zmian. Jeśli używasz naszych bibliotek klienta, uaktualnij je do wersji, która obsługuje nową wersję główną. Gdy wydamy główną wersję, udostępnimy przewodnik po uaktualnieniu, który pomoże Ci rozwiązać wszelkie problemy ze zmianami powodującymi przerwanie działania kodu.
Przykłady zmian powodujących niezgodność:
- Usuwanie lub zmienianie nazwy usługi, interfejsu, pola, metody lub wartości wyliczeniowej.
- 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 zwracanej z A na B.
Wersje podrzędne
Wersje podrzędne wprowadzają tylko zmiany zgodne wstecznie. W przypadku wersji podrzędnej numer vMAJOR.MINOR ma wartość MINOR większą od zera (np. v25.1).
Gdy zostanie opublikowana wersja podrzędna, istniejący punkt końcowy wersji głównej (https://googleads.googleapis.com/vX) zostanie automatycznie zaktualizowany w miejscu. Nie musisz zmieniać ścieżki wersji w adresach URL punktów końcowych, a dotychczasowy kod nadal działa bez zakłóceń.
Wersje pomocnicze 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 za pomocą biblioteki klienta, uaktualnij bibliotekę klienta do wersji, która zawiera definicje wersji podrzędnej.
Wycofanie i zakończenie
Okresowo wycofujemy starsze wersje interfejsu Google Ads API, a następnie je zamykamy:
- Wycofane: gdy zostanie wydana wersja główna (np.
v25), wszystkie wcześniejsze wersje główne zostaną oznaczone jako wycofane. Wywołania interfejsu API w przypadku wycofanych wersji będą nadal działać do daty ich wycofania, a istniejące wersje biblioteki klienta będą je nadal obsługiwać. Jednak kolejne wersje biblioteki klienta nie będą zawierać wycofanych wersji 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 z wyprzedzeniem na blogu dla programistów. Sprawdź harmonogram wycofywania, aby poznać daty aktywacji, wycofania i zaplanowanego wyłączenia.