版本控制

某些商家资料 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 版功能进行构建之前,请查看其指南和更新日志,了解已知限制。