Search Ads 360 Reporting API 中的版本管理功能

Search Ads 360 Reporting API 使用語意版本管理

主要和次要版本的格式為 vMAJOR_MINOR。舉例來說,v0_0 是第一個主要版本,v0_1 則是第一個次要版本。版本號碼的後置字串會指出版本類型:主要版本一律為零,次要版本則一律大於零。

主要版本

主要版本會推出破壞性變更,也就是無法回溯相容的變更。

每個主要版本都有單獨的端點,例如:

https://searchads360.googleapis.com/v0

https://searchads360.googleapis.com/v1

從一個主要版本升級至另一個版本時,可能需要先變更程式碼,再切換至新的主要版本端點。

如果您使用用戶端程式庫,請升級至最新版本。新的主要版本會提供遷移指南,協助您修正程式碼中的任何破壞性變更。

以下列舉一些重大變更:

  • 移除或重新命名服務、介面、欄位、方法或列舉值。
  • 變更欄位類型。
  • 變更資源名稱格式。
  • 變更 HTTP 定義中的網址格式。
  • 變更輸出格式,例如將 0 變更為 -- 做為預設值。
  • 將傳回的錯誤原因從 A 變更為 B。

子版本

子版本只會推出回溯相容的變更。

當子版本發布時,系統會自動更新已在使用的端點。但這不會導致程式碼中斷。您可以繼續使用現有的用戶端程式庫。

次要版本包含不會影響現有程式碼的新功能或更新。如要使用新功能,您必須將用戶端程式庫升級至最新版本。

日落

當舊版 Search Ads 360 Reporting API 版本的淘汰時間表訂定後,我們會在 searchads-api-announcements Google 群組中發布通知。