迁移到新版本

我们会定期发布 Campaign Manager 360 API 的新版本。随着新版本的不断发布，我们会弃用并最终停用较旧的版本。 停用某个版本后，针对该版本的所有请求都会开始返回错误。

如果您使用的是已弃用的版本，则必须尽快升级，以免服务中断。

第 1 步：确定您正在使用的版本

您可以按照以下说明确定自己使用的 API 版本。在大多数情况下，您都是通过我们适用于某种语言的客户端库或某种官方集成来使用该 API 的。

Apps 脚本新版编辑器

您可以在高级服务对话框中找到 Apps 脚本所用的版本信息：

  1. 在 Apps 脚本编辑器中，点击添加服务 。
  2. 在可用服务列表中找到 Campaign Manager 360 API。
  3. 版本下拉菜单中选定的值即为目前正在使用中的 Campaign Manager 360 API 版本。

Apps 脚本旧版编辑器

您可以在高级服务对话框中找到 Apps 脚本所用的版本信息：

  1. 在 Apps 脚本编辑器中，依次转到资源 > 高级 Google 服务。
  2. 在可用服务列表中找到 Campaign Manager 360 API。
  3. 版本下拉菜单中选定的值即为目前正在使用中的 Campaign Manager 360 API 版本。

C#

您可以在以下位置找到适用于 .NET 的 Google API 客户端库的版本信息：

  1. NuGet 软件包名称和服务命名空间中。 
    Google.Apis.Dfareporting.v3_4
  2. 通过 DfareportingService 的公共属性加以公开。 
    Console.WriteLine(DfareportingService.Version);

Java

您可以在以下位置找到适用于 Java 的 Google API 客户端库的版本信息：

  1. 在 Maven artifactId 中指定。 
    <dependency> <groupId>com.google.apis</groupId>
<artifactId>google-api-services-dfareporting</artifactId>
<version>v3.4-rev1-1.21.0</version>
</dependency>
  2. JAR 文件名中。 
    google-api-services-dfareporting-v3.4-rev1-1.21.0.jar
  3. 通过 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 客户端库 (v1/v2) 没有版本号。要使用的 API 版本作为 discovery 类的构建函数的一个参数加以指定： 

discovery.build('dfareporting', 'v3.4', http=http)

Ruby

如果 Ruby 版本低于 0.9，则相应的 Google API 客户端库没有版本号。要使用的 API 版本作为 Service 类的构造函数的一个参数加以指定： 

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 步：确定您所用版本的状态

查看弃用时间表，确定您的版本状态。如果您的版本未列在其中，则说明该版本已被停用，且不再受支持。

如果您的版本列在其中，请查看弃用日期和停用日期列：

  • 如果未列出任何日期，则说明您使用的是完全受支持的版本。
  • 如果这些列中列出了日期，则说明您使用的版本已被弃用，并将于指定日期停用。

如果您的版本已被弃用或已停用，您需要迁移到较新的版本，以免服务中断。我们建议您迁移到时间表中显示的最新版本（Beta 版除外），以最大限度延长升级间隔时间。

第 3 步：升级版本

如需迁移到较新版本的 API，您需要更新集成，或获取首选客户端库的新 build。请注意，有些客户端库可能只提供一个适用于所有 API 版本的 build，有些则针对每个 API 版本分别提供单独的 build。以下列表中提供了使用最广泛的客户端库和集成的常规升级信息。

Apps 脚本新版编辑器

Google Apps 脚本支持 Campaign Manager 360 API 的所有版本，可让您根据脚本选择要使用的版本。如需更改特定脚本使用的版本，请执行以下操作：

  1. 在 Apps 脚本编辑器中，点击添加服务 。
  2. 在可用服务列表中找到 Campaign Manager 360 API。
  3. 使用版本下拉菜单更改 Campaign Manager 360 API 版本。
  4. 点击添加以保存更改。

Apps 脚本旧版编辑器

Google Apps 脚本支持 Campaign Manager 360 API 的所有版本，可让您根据脚本选择要使用的版本。如需更改特定脚本使用的版本，请执行以下操作：

  1. 在 Apps 脚本编辑器中，依次转到资源 > 高级 Google 服务。
  2. 在可用服务列表中找到 Campaign Manager 360 API。
  3. 使用版本下拉菜单更改 Campaign Manager 360 API 版本。
  4. 点击确定以保存更改。

C#

适用于 .NET 的 Google API 客户端库针对 Campaign Manager 360 API 的每个版本分别提供单独的 build，并通过 NuGet 分发。更新为与您要使用的 API 版本相对应的客户端库版本。

有关详细的安装说明或其他下载方法，请参阅客户端库文档。

Java

适用于 Java 的 Google API 客户端库针对 Campaign Manager 360 API 的每个版本分别提供单独的 build，并通过 Maven 分发。更新为与您要使用的 API 版本相对应的客户端库版本。

有关详细的安装说明或其他下载方法，请参阅客户端库文档。

PHP

适用于 PHP 的 Google API 客户端库针对 Campaign Manager 360 API 的每个版本分别提供单独的 build，并通过 Packagist 分发。更新为与您要使用的 API 版本对应的客户端库版本。

有关详细的安装说明或其他下载方法，请参阅客户端库文档。

Python

适用于 Python (v1/v2) 的 Google API 客户端库的每个 build 均支持 Campaign Manager 360 API 的所有版本。如需迁移到新版 Campaign Manager 360 API，请更新作为 Discovery 类的构建函数的一个参数传递的版本字符串： 

discovery.build('dfareporting', 'v3.4', http=http)
 有关详细的安装说明或其他下载方法，请参阅客户端库文档。

Ruby

适用于 Ruby v0.8 及更低版本的 Google API 客户端库支持 Campaign Manager 360 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 分发。更新为与您要使用的 API 版本对应的客户端库版本。 有关详细的安装说明或其他下载方法，请参阅客户端库文档。

REST

如果您直接使用 HTTPS 调用 API，请更新请求的端点以使用新的 API 版本号。

例如，在从 v4 迁移到 v5 时，您需要将基本网址从以下网址更改为：

https://dfareporting.googleapis.com/dfareporting/v4/...
 更改为： 
https://dfareporting.googleapis.com/dfareporting/v5/...

第 4 步：解决版本差异问题

新版 API 旨在尽可能实现向后兼容。 不过，某些更新可能包含重大更改，需要您修改代码。版本说明中详细介绍了这些变更。

迁移时，请查看当前版本与要升级到的版本之间的每个版本的版本说明。请特别注意以下部分：

  • 新功能：新添加的功能。这些更改无需更改代码即可迁移。
  • 停用：已从该 API 中移除的功能。如果存在替代功能，我们会注明。
  • 已知问题：对现有功能的修改，例如字段或方法重命名，或验证逻辑发生变化。

如果您的应用使用了停用或已知问题部分中列出的功能，您需要更新代码以应对这些变化。

随时掌握最新信息

请定期关注 Google Ads 开发者博客，以便第一时间了解 API 发布、弃用和停用信息。