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