Назад к новостям для разработчиков

Предстоящее изменение в упразднении версий Marketing API для поддержки автоматического обновления версий

Мы с радостью сообщаем о предстоящем запуске функции автоматического обновления версии MAPI. Это позволит улучшить работу с API в целом, сделать ее более удобной и эффективной. С мая 2024 г. мы включим автоматическое обновление версии для конечных точек Marketing API, не претерпевших изменений в новой версии. Если по сравнению с упраздненной версией в следующей доступной версии конечная точка не изменилась, платформа автоматически обновит вызов до этой версии, чтобы он не завершался ошибкой.

Управление версиями API — это распространенный способ управления изменениями в API. Чаще всего он используется в случае срочных изменений. По мере выпуска новых версий старые упраздняются. Если приложение вызовет упраздненную версию API, оно получит сообщение об ошибке ‘(#2635) You are calling a deprecated version of the Ads API. Please update to the latest version: vXXX’ ((№ 2635) Вы вызываете упраздненную версию Ads API. Обновите его до последней версии: vXXX).

14 мая 2024 г. будет упразднена версия 17.0. Согласно журналу изменений версии 18.0, это затронет следующие конечные точки:

  • POST /act_{ad-account-id}/reachfrequencypredictions;
  • GET /act_{ad-account-id}/reachestimate;
  • GET /act_{ad-account-id}/delivery_estimate;
  • POST /act_{ad-account-id}/adsets;
  • POST /{adset-id};
  • POST /act_{ad-account-id}/saved_audiences;
  • POST /{saved-audience-id};
  • POST /act_{ad-account-id}/credit_cards.

Если ваше приложение вызовет конечную точку POST /{adset-id}, используя версию 17.0 после ее упразднения 14 мая 2024 г., этот запрос API завершится ошибкой, поскольку автоматическое обновление не применяется к конечным точкам, претерпевшим изменения в следующей доступной версии —18.0.

Если ваше приложение вызовет конечную точку GET /{ad-account-id}/insights, используя версию 17.0 после ее упразднения, платформа обновит этот вызов и переведет его на следующую доступную версию — 18.0.

Если ваше приложение уже делает вызовы, используя версию старше 17.0, после ее упразднения ничего не изменится.

Отключить автоматическое обновление можно в разделе "Настройки" > "Настройки версии Ads API" в карточке продукта Marketing API для приложения.

Чтобы убедиться, что вызов был автоматически обновлен, проверьте заголовок ответа API. В нем должна быть подробная информация.

  • Пример заголовка уведомления: ‘X-Ad-Api-Version-Warning:‘ The call has been auto-upgraded to v17.0 as v16.0 has been deprecated’’

Подробнее см. в статье Управление версиями Marketing API.

Проверить, какие конечные точки затронули изменения в каждой конкретной версии, можно в журнале изменений.

Затронутые конечные точки

  • Все конечные точки MAPI

Ссылка на документацию для разработчиков

Ссылка на справочную статью по функции