版本管理

部分商家檔案 API 有多個版本和發布管道。版本是要求網址中主機名稱後面的區段,例如 v1 或 v1alpha。本頁說明版本編號方式、各發布管道的穩定性,以及如何呼叫 Alpha 版管道。

版本編號

每個 API 版本都有主要版本號碼和選用的管道後置字串:

  • 主要版本 (v1、v2 等):穩定、正式發布的版本。主要版本只會收到回溯相容的變更,例如新方法、新欄位或新列舉值。不具回溯相容性的變更會在新主要版本中發布。
  • Alpha 管道 (v1alpha、v2alpha、...):主要版本的預先發布管道。包含該主要版本的所有功能,以及尚未正式發布的功能。

發布管道

頻道 穩定性 目錄
正式發布 (v1) 穩定。主要版本內的變更可回溯相容。主要版本淘汰後,仍可使用至少 12 個月。淘汰和停用日期會發布在「淘汰時程」頁面。 正式發布功能。
Alpha (v1alpha) 預先發布版,不保證穩定性,也沒有明確的使用期限。Alpha 版功能可能有所異動或停用,屆時我們會提前至少 30 天通知。請勿在正式環境整合中使用 Alpha 版功能。 v1 的所有功能,以及尚未正式發布的功能。

功能在不同版本間的轉移方式

當功能從 v1alpha 升級至 v1 時,仍可在 v1alpha 中使用。

如果功能僅適用於 v1alpha,相關指南和參考頁面會標示為 Alpha 版。新的 Alpha 版和正式發布功能,以及 Alpha 版功能的變更或移除,都會在最新更新和各 API 的變更記錄中公告。

使用 Alpha 版

如要呼叫 Alpha 版管道,請將要求網址中的 v1 替換為 v1alpha。例如:

GET https://mybusinessbusinessinformation.googleapis.com/v1alpha/locations/{locationId}?readMask={readMask}

這兩個管道屬於同一個 API,因此共用下列項目:

  • 在 Google Cloud 控制台啟用 API。
  • OAuth 2.0 範圍和存取權規定。
  • 資源名稱,例如 locations/{locationId}。
  • 配額。對 v1 和 v1alpha 的要求會計入相同的每項專案配額。詳情請參閱「配額限制」。
  • 基礎業務資料。透過 v1alpha 所做的變更會顯示在 v1 中,反之亦然。

用戶端程式庫和公開 API 目錄僅包含 v1。如要呼叫 v1alpha,請直接傳送 REST 要求。

最佳做法

  • 如要整合至正式環境,請使用穩定版,例如 v1。
  • 使用 Alpha 版管道 (例如 v1alpha),在功能正式發布前搶先體驗。如要提供意見,請參閱「支援」。
  • 讓用戶端容許無法辨識的欄位和列舉值。
  • 在 Alpha 版功能上建構前,請先查看指南和變更記錄,瞭解已知限制。