Migrate to a New Version

  • Campaign Manager 360 API versions are regularly released, with older versions eventually deprecated and sunset, at which point they return errors.

  • If you are using a deprecated API version, you must migrate to a newer one before its sunset date to avoid service interruption.

  • To migrate, first identify the specific API version you are currently using within your application or client library.

  • After identifying your version, check the Deprecation Schedule to determine its current status.

  • If migration is necessary, upgrade your client library or integration and review release notes for any breaking changes between your old and new versions.

New versions of the Campaign Manager 360 API are released regularly. As new versions are released, earlier versions are deprecated and eventually sunset. When a version is sunset, all requests against that version begin returning errors.

If the version you're using is deprecated, you must upgrade as soon as possible to avoid service interruptions.

Step 1: Determine which version you're using

You can determine which API version you're using with the following instructions. In most cases, you'll be accessing the API using one of our language-specific client libraries or an official integration.

Apps Script new editor

Version information for Apps Script is exposed in the advanced services dialogue:

  1. From the Apps Script editor, click Add a service .
  2. Locate the Campaign Manager 360 API in the list of available services.
  3. The value selected in the version drop-down is the Campaign Manager 360 API version in use.

Apps Script legacy editor

Version information for Apps Script is exposed in the advanced services dialogue:

  1. From the Apps Script editor, navigate to Resources > Advanced Google services.
  2. Locate the Campaign Manager 360 API in the list of available services.
  3. The value selected in the version drop-down is the Campaign Manager 360 API version in use.

C#

Version information for the Google API Client Library for .NET is exposed in the following places:

  1. Included in the NuGet package name and service namespace. 
    Google.Apis.Dfareporting.v3_4
  2. Exposed using a public property of DfareportingService. 
    Console.WriteLine(DfareportingService.Version);

Java

Version information for the Google API Client Library for Java is exposed in the following places:

  1. Specified in the Maven artifactId. 
    <dependency> <groupId>com.google.apis</groupId>
<artifactId>google-api-services-dfareporting</artifactId>
<version>v3.4-rev1-1.21.0</version>
</dependency>
  2. Included in the JAR filename. 
    google-api-services-dfareporting-v3.4-rev1-1.21.0.jar
  3. Exposed using a public property of Dfareporting. 
    System.out.println(Dfareporting.DEFAULT_SERVICE_PATH);

PHP

Version information for the Google API Client Library for PHP is exposed using a public property of Google_Service_Dfareporting: 

$service = new Google_Service_Dfareporting($client) print
$service->version;

Python

The Google API Client Library for Python (v1/v2) is not versioned. The API version to use is specified as an argument to the discovery builder: 

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

Ruby

Google API Client Library for Ruby versions < 0.9 are not versioned. The API version to use is specified as an argument to the service constructor: 

service = Google::APIClient::Service.new("dfareporting", "v3.4", { :application_name => "My application",
:application_version => '1.0.0', :authorization => authorization } )

For Google API Client Library for Ruby versions >= 0.9, version is exposed in the service namespace: 

Google.Apis.DfareportingV3_4

Step 2: Determine the status of your version

Check the deprecation schedule to determine the status of your version. If your version isn't listed, it has been sunset and is no longer supported.

If your version is listed, check the Deprecation Date and Sunset Date columns:

  • If no dates are present, your version is fully supported.
  • If dates are present, your version is deprecated and will be sunset on the date specified.

If your version is deprecated or has been sunset, you need to migrate to a newer version to avoid service interruptions. We recommend migrating to the most recent version shown in the schedule (excluding beta releases) to maximize time between upgrades.

Step 3: Upgrade versions

To migrate to a newer version of the API, you will need to update your integration or obtain an updated build of your preferred client library. Note that while some client libraries may provide a single build that works with any API version, others will have separate builds for each version. The following list provides general upgrade information for the most widely used client libraries and integrations.

Apps Script new editor

Google Apps Script supports all versions of the Campaign Manager 360 API and lets you select the version to use on a script-by-script basis. To change the version used by a particular script:

  1. From the Apps Script editor, click Add a service .
  2. Locate the Campaign Manager 360 API in the list of available services.
  3. Change the Campaign Manager 360 API version using the version drop-down.
  4. Click Add to save your changes.

Apps Script legacy editor

Google Apps Script supports all versions of the Campaign Manager 360 API and lets you select the version to use on a script-by-script basis. To change the version used by a particular script:

  1. From the Apps Script editor, navigate to Resources > Advanced Google services.
  2. Locate the Campaign Manager 360 API in the list of available services.
  3. Change the Campaign Manager 360 API version using the version drop-down.
  4. Click OK to save your changes.

C#

The Google API Client Library for .NET provides separate builds for each version of the Campaign Manager 360 API, distributed through NuGet. Update to a version of the client library that corresponds to the API version you want to use.

For detailed installation instructions or alternative download options, refer to the client library documentation.

Java

The Google API Client Library for Java provides separate builds for each version of the Campaign Manager 360 API, distributed through Maven. Update to a version of the client library that corresponds to the API version you want to use.

For detailed installation instructions or alternative download options, refer to the client library documentation.

PHP

The Google API Client Library for PHP provides separate builds for each version of the Campaign Manager 360 API, distributed through Packagist. Update to a version of the client library that corresponds to the API version you want to use.

For detailed installation instructions or alternative download options, refer to the client library documentation.

Python

Every build of the Google API Client Library for Python (v1/v2) supports all versions of the Campaign Manager 360 API. To migrate to a new version of Campaign Manager 360 API, update the version string being passed as an argument to the discovery builder: 

discovery.build('dfareporting', 'v3.4', http=http)
 For detailed installation instructions or alternative download options, refer to the client library documentation.

Ruby

The Google API Client Library for Ruby v0.8 and lower supports all versions of the Campaign Manager 360 API. To migrate to a new version of Campaign Manager 360 API, update the version string being passed as an argument to the service constructor: 

service = Google::APIClient::Service.new("dfareporting", "v3.4",
    {
      :application_name => "My application",
      :application_version => '1.0.0',
      :authorization => authorization
    }
)
 The Google API Client Library for Ruby v0.9+ provides separate builds for each version of the Campaign Manager 360 API, distributed through RubyGems. Update to a version of the client library that corresponds to the API version you want to use. For detailed installation instructions or alternative download options, refer to the client library documentation.

REST

If you're calling the API directly using HTTPS, update the endpoint for your requests to use the new API version number.

For example, when migrating from v4 to v5, you would change the base URL from: 

https://dfareporting.googleapis.com/dfareporting/v4/...
 to: 
https://dfareporting.googleapis.com/dfareporting/v5/...

Step 4: Address version differences

New API versions are designed to be backward compatible whenever possible. However, some updates may include breaking changes that require you to modify your code. These changes are detailed in the release notes.

When migrating, review the release notes for each version between your current version and the version you're upgrading to. Pay special attention to the following sections:

  • New features: Newly added functionality. These don't require code changes for migration.
  • Sunsets: Functionality removed from the API. Replacement functionality is noted when available.
  • Known issues: Modifications to existing functionality, such as renamed fields or methods, or changed validation logic.

If your application uses functionality listed in the Sunsets or Known issues sections, you'll need to update your code to address these changes.

Stay informed

Regularly monitor the Google Ads developer blog to be the first to hear about API releases, deprecations, and sunsets.