Семантическое версионирование
В Google Ads API используется семантическое управление версиями с номерами основной и промежуточной версий. Версии записываются как MAJOR.MINOR или vMAJOR.MINOR.
Например, v26.0 (или v26) – это основная версия, а v26.1 – промежуточная версия.
Подробную информацию о текущей и предыдущих версиях можно найти в примечаниях к выпуску.
Основные версии
Основные версии содержат критические изменения, несовместимые с предыдущими версиями. Первый выпуск основной версии заканчивается на ноль (vX.0 или vX, где X – номер основной версии).
У каждой основной версии есть отдельный путь к конечной точке REST и gRPC (vX), который не включает суффикс промежуточной версии. В URL ниже X – это номер основной версии (например, v26):
https://googleads.googleapis.com/vX
Если вы переходите со старой основной версии, то при переключении на конечную точку новой основной версии может потребоваться изменить код. Если вы используете наши клиентские библиотеки, перейдите на версию, которая поддерживает новую основную версию. При выпуске основной версии мы предоставляем руководство по обновлению, которое поможет вам устранить критические изменения в коде.
Примеры критических изменений:
- Удаление или переименование сервиса, интерфейса, поля, метода или значения перечисления.
- Изменение типа поля.
- Изменение формата названия ресурса.
- Изменение формата URL в определении HTTP.
- Изменение форматов выходных данных, например значений по умолчанию.
- Изменение причины ошибки, возвращаемой из A в B.
Промежуточные версии
В промежуточных версиях вносятся только обратно совместимые изменения. В промежуточной версии vMAJOR.MINOR имеет номер MINOR больше нуля (например, v26.1).
При выпуске промежуточной версии существующая конечная точка основной версии (https://googleads.googleapis.com/vX) автоматически обновляется. Вам не нужно менять путь к версии в URL конечных точек, а существующий код продолжит работать без сбоев.
В промежуточных версиях добавляются функции или обновления, которые не влияют на существующий код. Чтобы использовать поля или функции из промежуточной версии с клиентской библиотекой, обновите клиентскую библиотеку до выпуска, включающего определения промежуточной версии.
Прекращение поддержки и отключение
Время от времени мы прекращаем поддержку старых версий Google Ads API, а затем отключаем их.
- Поддержка прекращена. Когда выпускается основная версия (например,
v26), все предыдущие основные версии помечаются как устаревшие. Вызовы API к устаревшим версиям будут выполняться до даты прекращения поддержки. Существующие версии клиентских библиотек продолжат поддерживать их, но в последующих версиях клиентских библиотек устаревшие версии API будут удалены, чтобы уменьшить размер пакета. - Отключение. Версия отключается в дату прекращения поддержки, и все вызовы API к ее конечной точке завершаются ошибкой.
Мы заранее публикуем объявления о прекращении поддержки версий в блоге для разработчиков. Ознакомьтесь с графиком прекращения поддержки, чтобы узнать, какие версии активны, какие устарели, а какие скоро перестанут поддерживаться.