Obsługa wersji

Niektóre interfejsy Business Profile API są dostępne w więcej niż 1 wersji i kanale wersji. Wersja to segment adresu URL żądania, który następuje po nazwie hosta, np. v1 lub v1alpha. Na tej stronie wyjaśniamy, jak numerowane są wersje, jak stabilny jest każdy kanał wersji i jak wywołać kanał alfa.

Numerowanie wersji

Każda wersja interfejsu API ma numer wersji głównej i opcjonalny sufiks kanału:

  • Wersja główna (v1, v2, ...): stabilna, ogólnie dostępna wersja. Wersja główna otrzymuje tylko zmiany zgodne wstecznie, takie jak nowe metody, nowe pola lub nowe wartości typu wyliczeniowego. Zmiany, które nie są zgodne wstecznie, są publikowane w nowej wersji głównej.
  • Kanał alfa (v1alpha, v2alpha, …): kanał wersji przedpremierowej wersji głównej. Obejmuje wszystkie funkcje z tej wersji głównej oraz funkcje, które nie są jeszcze ogólnie dostępne.

Kanały wersji

Kanał Stabilność Spis treści
Ogólna dostępność (v1) Stabilny. Zmiany w ramach wersji głównej są zgodne wstecznie. Gdy wersja główna zostanie wycofana, pozostanie dostępna przez co najmniej 12 miesięcy od ogłoszenia wycofania. Daty wycofania i zakończenia obsługi są publikowane na stronie Harmonogram wycofywania. Funkcje ogólnie dostępne.
Alpha (v1alpha) Wersja przedpremierowa, bez gwarancji stabilności i bez określonego okresu ważności. Funkcje w wersji alfa mogą ulec zmianie lub zostać wycofane po upływie co najmniej 30 dni od powiadomienia. Nie używaj funkcji w wersji alfa w integracjach produkcyjnych. Wszystkie funkcje dostępne w v1 oraz funkcje, które nie są jeszcze ogólnodostępne.

Jak funkcje są przenoszone między kanałami

Gdy funkcja przechodzi z v1alpha do v1, pozostaje dostępna w v1alpha.

Przewodniki i strony referencyjne dotyczące funkcji dostępnych tylko w v1alpha są oznaczone jako wersja alfa. Nowe funkcje w wersji alfa i ogólnie dostępne oraz zmiany lub usunięcia funkcji w wersji alfa są ogłaszane w najnowszych aktualizacjach i w historii zmian każdego interfejsu API.

Użyj kanału alfa

Aby wywołać kanał alfa, zastąp v1 ciągiem v1alpha w adresie URL żądania. Przykład:

GET https://mybusinessbusinessinformation.googleapis.com/v1alpha/locations/{locationId}?readMask={readMask}

Oba kanały należą do tego samego interfejsu API, więc mają wspólne:

  • Włączanie interfejsu API w konsoli Google Cloud.
  • Zakresy protokołu OAuth 2.0 i wymagania dotyczące dostępu.
  • Nazwy zasobów, np. locations/{locationId}.
  • Limit. Żądania do v1 i v1alpha są wliczane do tego samego limitu na projekt. Więcej informacji znajdziesz w sekcji Limity.
  • podstawowe firmowe bazy danych, Zmiany wprowadzone w v1alpha są widoczne w v1 i na odwrót.

Biblioteki klienta i publiczny katalog interfejsów API zawierają tylko v1. Aby wywołać v1alpha, wysyłaj żądania REST bezpośrednio.

Sprawdzone metody

  • W przypadku integracji produkcyjnych używaj wersji stabilnej, np. v1.
  • Używaj kanału alfa, takiego jak v1alpha, aby korzystać z nowych funkcji, zanim staną się ogólnie dostępne. Aby podzielić się opinią, zapoznaj się z sekcją Pomoc.
  • Upewnij się, że klient toleruje pola i wartości typu wyliczeniowego, których nie rozpoznaje.
  • Zanim zaczniesz korzystać z funkcji w wersji alfa, zapoznaj się z przewodnikiem i historią zmian, aby poznać znane ograniczenia.