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