Некоторые версии Business Profile API доступны в нескольких версиях и каналах обновления. Версия – это сегмент URL запроса, который следует за именем хоста, например v1 или v1alpha. На этой странице объясняется, как нумеруются версии, насколько стабилен каждый канал обновления и как вызвать альфа-канал.
Нумерация версий
У каждой версии API есть номер основной версии и необязательный суффикс канала:
- Основная версия (
v1,v2и т. д.) – стабильная общедоступная версия. В основные версии вносятся только обратно совместимые изменения, например новые методы, поля или значения перечислений. Изменения, несовместимые с предыдущими версиями, выпускаются в новой основной версии. - Альфа-канал (
v1alpha,v2alphaи т. д.) – канал предварительного выпуска основной версии. Она включает все функции основной версии, а также функции, которые ещё не стали общедоступными.
Каналы обновления
| Канал | Стабильность | Содержание |
|---|---|---|
Общая доступность (v1) |
Стабильная. Изменения в рамках одной основной версии обратно совместимы. После объявления о прекращении поддержки основной версии она остается доступной в течение как минимум 12 месяцев. Даты прекращения поддержки и удаления публикуются на странице График прекращения поддержки. | Общедоступные функции. |
Альфа-версия (v1alpha) |
Предварительный выпуск, стабильность и срок действия которого не гарантируются. Альфа-функции могут быть изменены или отключены с уведомлением не менее чем за 30 дней. Не используйте альфа-функции в рабочих интеграциях. | Все функции из v1, а также функции, которые ещё не стали общедоступными. |
Как функции перемещаются между каналами
Когда функция переходит из v1alpha в v1, она остается доступной в v1alpha.
Руководства и справочные страницы для функций, доступных только в v1alpha, помечены как альфа-версии. О новых альфа-функциях и функциях с общей доступностью, а также об изменениях или удалении альфа-функций сообщается в последних обновлениях и в истории изменений для каждого API.
Как использовать альфа-канал
Чтобы вызвать альфа-канал, замените v1 на v1alpha в URL запроса. Пример:
GET https://mybusinessbusinessinformation.googleapis.com/v1alpha/locations/{locationId}?readMask={readMask}
Оба канала относятся к одному API, поэтому у них общие:
- Включение API в консоли Google Cloud.
- Области действия OAuth 2.0 и требования к доступу.
- Названия ресурсов, например
locations/{locationId}. - Квота. Запросы к
v1иv1alphaучитываются в одной квоте для проекта. Подробнее о лимитах на квоты… - исходные коммерческие данные; Изменения, внесенные в
v1alpha, видны вv1, и наоборот.
Клиентские библиотеки и каталог общедоступных API включают только v1. Чтобы вызвать v1alpha, отправьте REST-запросы напрямую.
Рекомендации
- Для рабочих интеграций используйте стабильную версию, например
v1. - Используйте альфа-версию, например
v1alpha, чтобы попробовать новые функции до того, как они станут общедоступными. Чтобы отправить отзыв, перейдите в раздел Поддержка. - Настройте клиент так, чтобы он игнорировал поля и значения перечислений, которые не распознает.
- Прежде чем использовать альфа-функцию, ознакомьтесь с руководством по ней и историей изменений, чтобы узнать об известных ограничениях.