返回開發人員最新消息

推廣 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 的版本執行呼叫,則在版本停用當天應不會有任何變更。

如要停止使用版本自動升級功能,請前往「推廣 API 應用程式產品」卡片下的「設定」>「廣告 API 版本設定」停用此功能。

如要確認呼叫是否已自動升級,請查看 API 回應標題以了解詳情。

  • 通知標題範例:「X-Ad-Api-Version-Warning:由於 v16.0 已停用,呼叫已自動升級,改為向 v17.0 執行」

如要進一步了解相關行為,請參閱推廣 API 版本控制

如要查看在各版本中受影響的端點,請參閱變更記錄

受影響的端點

  • 所有推廣 API 端點

開發人員文件連結

功能幫助文章連結