版本管理

語意版本管理

Google Ads API 採用語意版本管理,包含主要和次要版本號碼。版本會寫成 MAJOR.MINOR 或 vMAJOR.MINOR。舉例來說,v26.0 (或 v26) 是主要版本,而 v26.1 是子版本。

如要瞭解目前和過往版本的詳細資訊,請參閱版本資訊。

主要版本

主要發布版本會導入破壞性、回溯不相容的變更。主要版本的初始版本結尾為零 (vX.0 或 vX,其中 X 是主要版本號碼)。

每個主要版本都有獨立的 REST 和 gRPC 端點路徑 (vX),不含子版本後置字串。在下列網址中,X 是主要版本號碼 (例如 v26):

https://googleads.googleapis.com/vX

如果您是從舊的主要版本升級,切換至新的主要版本端點時,可能需要變更程式碼。如果您使用我們的用戶端程式庫,請升級至支援新主要版本的用戶端程式庫版本。主要版本發布時,我們會提供升級指南,協助您解決程式碼中的破壞性變更。

破壞性變更的例子包括:

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

子版本

子版本只會導入回溯相容的變更。如果是子版本,vMAJOR.MINOR 的 MINOR 數字會大於零 (例如 v26.1)。

子版本發布時,現有的主要版本端點 (https://googleads.googleapis.com/vX) 會自動就地更新。您不需要變更端點網址中的版本路徑,現有程式碼也會繼續運作,不會中斷。

子版本會新增功能或更新,不會影響現有程式碼。如要透過用戶端程式庫使用子版本的欄位或功能,請將用戶端程式庫升級至包含子版本定義的版本。

淘汰與停用

Google Ads API 舊版本會定期淘汰,並在之後停用:

  • 已淘汰:主要版本 (例如 v26) 發布後,所有先前的主要版本都會標示為已淘汰。在停用日期前,對已淘汰版本的 API 呼叫仍會成功,現有的用戶端程式庫版本也會繼續支援這些版本,但後續的用戶端程式庫版本會省略已淘汰的 API 版本,以縮減套件大小。
  • 停用:版本會在停用日期停用,所有對其端點的 API 呼叫都會失敗。

我們會在版本淘汰前,於開發人員網誌發布公告。請查看淘汰和停用時間表,瞭解有效、已淘汰和預定停用的日期。