我们会定期发布 Campaign Manager 360 API 的新版本。随着新版本的不断发布,我们会弃用并最终弃用较旧版本。停用某个版本后,针对该版本的所有请求都会开始返回错误。
如果您使用的 API 版本已废弃,您需要在预定的停用日期之前迁移到较新版本。本指南详细介绍了如何确定您目前使用的 API 版本是否已被弃用,并提供了建议的迁移步骤。
第 1 步:确定您使用的是哪个版本
如果您怀疑自己维护的某款应用可能在使用 Campaign Manager 360 API 的已弃用版本,则应先确定您具体使用的是哪个版本。在大多数情况下,您可以通过我们针对特定语言的客户端库或某个官方集成访问该 API。有关查找这些客户端库和集成所使用的 API 版本的说明,请参阅下文:
Apps 脚本新编辑器
高级服务对话框中会显示 Apps 脚本的版本信息:
- 在 Apps 脚本编辑器中,点击添加服务 。
- 在可用服务列表中找到 Campaign Manager 360 API。
- 您在版本下拉菜单中选择的值是目前正在使用的 Campaign Manager 360 API 版本。
Apps 脚本旧版编辑器
高级服务对话框中会显示 Apps 脚本的版本信息:
- 在 Apps 脚本编辑器中,依次转到资源 > 高级 Google 服务。
- 在可用服务列表中找到 Campaign Manager 360 API。
- 您在版本下拉菜单中选择的值是目前正在使用的 Campaign Manager 360 API 版本。
C#
.NET 版 Google API 客户端库的版本信息会在以下位置显示:
- Nuget 软件包名称和服务命名空间中。
Google.Apis.Dfareporting.v3_4
- 通过
DfareportingService
的公共属性公开。Console.WriteLine(DfareportingService.Version);
Java
Java 版 Google API 客户端库的版本信息会在以下位置显示:
- Maven artifactId 中。
<dependency> <groupId>com.google.apis</groupId> <artifactId>google-api-services-dfareporting</artifactId> <version>v3.4-rev1-1.21.0</version> </dependency>
- 包含在 JAR 文件名中。
google-api-services-dfareporting-v3.4-rev1-1.21.0.jar
- 通过
Dfareporting
的公共属性公开。System.out.println(Dfareporting.DEFAULT_SERVICE_PATH);
PHP
PHP 版 Google API 客户端库的版本信息通过 Google_Service_Dfareporting
的公共属性公开:
$service = new Google_Service_Dfareporting($client) print $service->version;
Python
Python 版 Google API 客户端库没有版本编号。要使用的 API 版本被指定为 Discovery Builder 的参数:
discovery.build('dfareporting', 'v3.4', http=http)
Ruby
Ruby 版本低于 0.9 的 Google API 客户端库没有版本编号。要使用的 API 版本以服务构造函数的参数的形式指定:
service = Google::APIClient::Service.new("dfareporting", "v3.4", { :application_name => "My application", :application_version => '1.0.0', :authorization => authorization } )
如果 Ruby 版本是 0.9 或以上版本,则相应的 Google API 客户端库将在服务命名空间中公开:
Google.Apis.DfareportingV3_4
请记下您目前使用的版本,因为稍后您会用到此信息。
第 2 步:确定版本状态
弃用时间表中列出了目前支持的每个版本的状态。在此列表中找到您的版本并确定其状态,如下所示:
- 如果弃用日期和停用日期列中未列出任何日期,则说明您使用的是完全受支持的版本。
- 如果列出了日期,则说明您使用的版本目前已被弃用,并将于指定日期停用。
- 如果您的版本未列出,则表明该版本已停用,不再受支持。
如果您符合上述第 2 条或第 3 条的要求,则需要迁移到较新版本,以免服务中断。建议您迁移到已弃用时间表表顶部列出的最新版本(不包括 Beta 版)。这样您就可以获得两次升级之间的最长时间。
第 3 步:升级版本
如果您已确定需要迁移,下一步是更新您的集成或获取您首选客户端库的更新 build。请注意,一些客户端库可能只提供一个适用于所有 API 版本的 build,另一些客户端库则会针对每个版本提供单独的 build。以下列表提供了使用最广泛的客户端库和集成的常规升级信息。
Apps 脚本新编辑器
Google Apps 脚本支持 Campaign Manager 360 API 的所有版本,可让您根据脚本选择要使用的版本。如需更改特定脚本使用的版本,请执行以下操作:
- 在 Apps 脚本编辑器中,点击添加服务 。
- 在可用服务列表中找到 Campaign Manager 360 API。
- 您可以通过版本下拉菜单更改正在使用的 Campaign Manager 360 API 版本。
- 点击添加以保存更改。
Apps 脚本旧版编辑器
Google Apps 脚本支持 Campaign Manager 360 API 的所有版本,可让您根据脚本选择要使用的版本。如需更改特定脚本使用的版本,请执行以下操作:
- 在 Apps 脚本编辑器中,依次转到资源 > 高级 Google 服务。
- 在可用服务列表中找到 Campaign Manager 360 API。
- 您可以通过版本下拉菜单更改正在使用的 Campaign Manager 360 API 版本。
- 点击确定以保存更改。
C#
适用于 .NET 的 Google API 客户端库针对 Campaign Manager 360 API 的每个版本分别提供单独的 build,并通过 Nuget 分发。
如需详细了解安装说明或其他下载选项,请参阅客户端库文档。
Java
适用于 Java 的 Google API 客户端库针对 Campaign Manager 360 API 的每个版本分别提供单独的 build,并通过 Maven 分发。
如需详细了解安装说明或其他下载选项,请参阅客户端库文档。
PHP
适用于 PHP 的 Google API 客户端库针对 Campaign Manager 360 API 的每个版本分别提供单独的 build,并通过 Packagist 分发。
如需详细了解安装说明或其他下载选项,请参阅客户端库文档。
Python
适用于 Python 的 Google API 客户端库的每个 build 均支持 Campaign Manager 360 API 的所有版本。只需更新作为 Discovery Builder 的参数传递的版本字符串即可:
discovery.build('dfareporting', 'v3.4', http=http)如需了解详细安装说明或备用下载选项,请参阅客户端库文档。
Ruby
适用于 Ruby v0.8 及更低版本的 Google API 客户端库支持所有版本的 Campaign Manager 360 API。只需更新作为服务构造函数的参数版本字符串即可:
service = Google::APIClient::Service.new("dfareporting", "v3.4", { :application_name => "My application", :application_version => '1.0.0', :authorization => authorization } )适用于 Ruby v0.9 及更高版本的 Google API 客户端库针对 Campaign Manager 360 API 的每个版本分别提供单独的 build,并通过 RubyGems 分发。 如需详细了解安装说明或其他下载选项,请参阅客户端库文档。
第 4 步:解决版本差异问题
我们会努力确保新版本可向后兼容,也就是说,在不同 API 版本之间迁移无需对代码进行更改。如果无法做到这一点,我们会在版本说明中公布需要开发者采取行动的更改(也称为重大更改)。
这时,您应查看我们的版本说明,从您一开始就记下的版本(您在上一部分中已记下的版本)开始,然后一直升级到您要升级到的版本。版本说明的各个部分应作如下解释:
- 新功能 - 新添加的功能。
- 停用 - 已从 API 中移除的功能。如果有替换功能,本部分将会介绍。
- 已知问题 - 不属于添加或移除范畴的更改。例如,本部分可能会介绍已重命名的字段或方法,或涵盖已更改的验证逻辑。
新功能中的功能不需要更改代码,可以暂时忽略。如果您想尝试添加一些功能,请随时返回此部分查看。
另一方面,如果您在停用或已知问题部分发现更改,可能需要采取措施。您应搜索代码,确定您的应用是否使用了任何已移除或已修改的功能。如果是,您需要更新代码来应对这些更改
了解最新信息
如前所述,我们会定期发布 Campaign Manager 360 API 停用版本。我们会在以下渠道发布关于新版本、弃用和停用的最新资讯:
建议您订阅上述一个或多个渠道,及时了解最新的 API 资讯。