版本控制

语义化版本控制

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

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