語意化版本
Google Ads API 採用語意版本管理,並提供主要和次要版本號碼。版本會寫成 MAJOR.MINOR 或 vMAJOR.MINOR。舉例來說,v25.0 (或 v25) 是主要版本,而 v25.1 是子版本。
如要瞭解目前和過往版本詳情,請參閱「版本資訊」。
主要版本
主要版本會導入破壞性變更,且無法回溯相容。主要版本的初始發布版本會以零結尾 (vX.0 或 vX,其中 X 是主要版本號碼)。
每個主要版本都有個別的 REST 和 gRPC 端點路徑 (vX),不含子版本後置字元。在下列網址中,X 是主要版本號碼 (例如 v25):
https://googleads.googleapis.com/vX
如果您是從舊版主要版本升級,切換至新版主要版本端點時,程式碼可能需要變更。如果您使用我們的用戶端程式庫,請升級至支援新主要版本的用戶端程式庫版本。發布主要版本時,我們會提供升級指南,協助您解決程式碼中的任何重大變更。
重大變更的例子包括:
- 移除或重新命名服務、介面、欄位、方法或列舉值。
- 變更欄位類型。
- 變更資源名稱格式。
- 變更 HTTP 定義中的網址格式。
- 變更輸出格式,例如變更預設值。
- 將從 A 傳回的錯誤原因變更為 B。
子版本
次要版本只會推出回溯相容的變更。如果是子版本,vMAJOR.MINOR 的 MINOR 數字必須大於零 (例如 v25.1)。
發布子版本時,現有主要版本端點 (https://googleads.googleapis.com/vX) 會自動就地更新。您不必變更端點網址中的版本路徑,現有程式碼也能繼續運作,不會中斷。
次要版本會新增功能或更新,但不會影響現有程式碼。如要透過用戶端程式庫使用子版本中的欄位或功能,請將用戶端程式庫升級至包含子版本定義的版本。
淘汰與停用
舊版 Google Ads API 會定期淘汰,並在之後停止支援:
- 已淘汰:發布主要版本 (例如
v25) 時,所有先前的主要版本都會標示為已淘汰。在淘汰日期前,對已淘汰版本的 API 呼叫仍會成功,現有的用戶端程式庫版本也會繼續支援這些呼叫,但後續的用戶端程式庫版本會省略已淘汰的 API 版本,以縮減套件大小。 - 淘汰:版本會在淘汰日期停用,且所有對其端點的 API 呼叫都會失敗。
我們會在開發人員網誌提前發布版本淘汰公告。請查看淘汰與停用時間表,瞭解目前、已淘汰和預計停用日期。