Управление версиями в API отчетов Search Ads 360

API отчетов Search Ads 360 использует семантическое управление версиями .

Существуют основные и второстепенные версии, отформатированные как v MAJOR _ MINOR . Например, v0_0 — это первая основная версия, а v0_1 первая дополнительная версия. Суффикс номера версии указывает тип версии: для основных версий он всегда равен нулю, а для второстепенных версий всегда больше нуля.

Основные версии

Основные выпуски содержат критические изменения, то есть изменения, не имеющие обратной совместимости.

Каждая основная версия имеет отдельную конечную точку, например:

https://searchads360.googleapis.com/v0

https://searchads360.googleapis.com/v1

При обновлении с одной основной версии на другую вам может потребоваться изменить код перед переключением на новую конечную точку основной версии.

Если вы используете клиентскую библиотеку , вам необходимо обновить ее до последней версии. Новые основные версии содержат руководство по миграции, которое поможет вам исправить любые критические изменения в вашем коде.

Примеры критических изменений включают в себя:

  • Удаление или переименование службы, интерфейса, поля, метода или значения перечисления.
  • Изменение типа поля.
  • Изменение формата имени ресурса.
  • Изменение формата URL-адреса в определении HTTP.
  • Изменение форматов вывода, например изменение 0 на -- в качестве значения по умолчанию.
  • Изменение причины ошибки, возвращенной с A на B.

Второстепенные версии

Второстепенные версии вносят только обратно совместимые изменения.

При выпуске дополнительной версии уже используемая конечная точка автоматически обновляется. Это не приведет к поломке вашего кода. Вы можете продолжать использовать существующую клиентскую библиотеку.

Второстепенные версии включают новые функции или обновления, которые не влияют на существующий код. Если вы хотите использовать новые функции, вам необходимо обновить клиентскую библиотеку до последней версии.

Закаты

Когда срок действия старой версии Search Ads 360 Reporting API истекает, мы публикуем уведомление в группе Google searchads-api-announcements .