返回开发者新闻

市场营销 API 版本停用迎来更改:将启用版本自动升级功能

2024年4月16日发布者:Mengxuan Zhang

为提高市场营销 API 的流畅度和效率,增强此 API 的整体体验,我们很高兴宣布即将推出市场营销 API 版本自动升级功能。自 2024 年 5 月起,我们将为在两个版本之间不受影响的市场营销 API 端点启用自动版本升级功能。这意味着,在要停用的版本与下一个可用版本之间,如果某个端点不受影响,该开放平台会自动升级调用,改为对下一个可用版本执行调用,而不是直接给出结果,表示请求失败。

API 版本管理是处理 API 更改的一种常用方法,最常用于推出重大更改。随着新版本的发布,旧版本将停用。在某个 API 版本停用期间,如果应用调用该已停用的 API 版本后,会收到错误消息“(#2635) 您正在调用一个已停用的广告 API 版本。请更新至最新版本:vXXX”。

2024 年 5 月 14 日,v17.0 将停用。根据 v18.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

如果您的应用在 2024 年 5 月 14 日 v17.0 停用后向 v17.0 执行 POST /{adset-id} 调用,此 API 请求将失败,因为自动升级功能不适用于受下一个可用版本 v18.0 影响的端点。

如果在 v17.0 停用后,应用向 v17.0 执行 GET /{ad-account-id}/insights 调用,该开放平台会升级调用,改为对下一个可用版本 v18.0 执行调用。

如果您的应用已经向高于 v17.0 的版本执行调用,在 v17.0 停用当天应该不会发生任何更改。

如要禁用版本自动升级功能,请前往“市场营销 API 应用产品”卡片下的“设置”>“广告 API 版本设置”,禁用此功能。

如要确认该开放平台是否已自动升级相关调用,请查看 API 响应标头,了解详情。

  • 通知标头示例:“X-广告-API-版本-警告:由于 v16.0 已停用,系统已自动升级调用,改为向 v17.0 执行调用”

如要详细了解相关行为,请参阅市场营销 API 版本管理

如要查看在各个版本中受影响的端点,请参阅更新日志

受影响的端点

  • 所有市场营销 API 端点

开发者文档链接

功能帮助文章链接