版本控制

语义版本控制

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 调用都会失败。

我们会在版本停用之前在开发者博客上发布公告。查看弃用和停用时间表,了解有效、已弃用和预定停用的日期。