Periodically, you will upgrade from an older major version of Google Ads API to a newer major version. It could be because a version is sunsetting, or it could be because you want to use a new feature. We recommend that you upgrade to the newest version when going through the migration process.
Check out our deprecation schedule to plan your upgrades. See our versioning guide to learn how versioning works.
Here's a checklist to help you get started with the process of upgrading:
- Your endpoint will change when you change major versions. Update your client libraries to use the newest endpoint.
- Go through the release notes to see changes that were introduced in each release.
- Check out the tables below for specific areas to focus on for the version you're upgrading to.
Migrating from v5 to v6
| Changes to Services and their Components | |
|---|---|
ReachPlanService |
The field ReachForecast.forecasted_product_allocations
has been replaced with ReachForecast.planned_product_reach_forecasts. |
| Criteria display names | The display names for the following types of criteria were updated. You
shouldn't be using display names to logically act on criteria (preferring IDs
instead), but if you are, make sure to check your logic if you use any of the
following criteria
types:
|
| Media upload | A new error type was added to disambiguate types of media that cannot be
uploaded through the Google Ads API. This is not a new error condition, but rather a
new error message to assist in debugging in these cases. If you get a
CANNOT_UPLOAD_MEDIA_TYPE_THROUGH_API error, then you must upload
that bundle through the UI instead. |
Invoice |
The invoice_level_adjustments_micros field has been replaced
with a suite of new fields that provide a more detailed breakdown. See the
Invoice documentation for full
details. |
ChangeStatus |
The change_status resource now requires that you specify a
LIMIT clause and a filter on the
last_change_date_time field when searching. The limit must be at
most 10,000. |
KeywordPlanIdeaService |
The language parameter for the
GenerateKeywordIdeas method has been changed from required to
optional. This may alter how you have to specify it in your client library; for
example, it may change from a positional argument to a keyword argument. |
The remainder of the fields not converted in v5 now use field
presence such as optional string and optional
double instead of wrapper types such as StringValue and
DoubleValue.
For the fields mentioned here, update your code to remove wrapper types. |
ResourcesShow me the fields
ServicesShow me the fields
|
Migrating from v4 to v5
| Changes to Services and their Components | |
|---|---|
| Multiple Services |
Added the feature to return metrics for entities that are not formally
supported in the API such as Discovery campaigns. These entities will have type
Renamed the following errors:
|
AccountLinkService |
Replaced AccountLinkOperation.create with AccountLinkService.CreateAccountLink.
|
AdGroupBidModifierService |
Updated AdGroupBidModifier.criterion
to be required on creation.
|
BatchJobService |
Removed BatchJobOperation.remove as jobs in a PENDING
state will automatically be removed after 1 day.
|
CampaignBidModifierService |
Updated CampaignBidModifier.criterion
to be required on creation.
|
ExtensionFeedItemService |
Renamed the following errors:
|
Extension Setting ServicesAdGroupExtensionSettingServiceCampaignExtensionSettingServiceCustomerExtensionSettingService
|
Renamed the following error:
|
Metrics |
Renamed the following metrics:
|
OfflineUserDataJobService |
Renamed the following errors:
|
UserListService |
Renamed the following error:
|
Approximately half of our resources now use field
presence such as optional string and optional
double instead of such as StringValue and
DoubleValue. The rest of the resources will change to field
presence in a future release.
For the fields mentioned here, update your code to remove wrapper types. |
CommonShow me the fields
ResourcesShow me the fields
ServicesShow me the fields
|
Migrating from v3 to v4
| Changes to Services and their Components | |
|---|---|
AdGroupAdAssetView |
Changed the format of AdGroupAdAssetView.resource_name
fromcustomers/{id}/adGroupAdAssets/{id}
tocustomers/{id}/adGroupAdAssetViews/{id}.
|
AdGroupCriterionError |
The following errors were moved to CriterionError:
|
CriterionError |
Renamed error enum values from CriterionError:
|
| KeywordPlanKeywordService |
Removed Removed |
| KeywordPlanNegativeKeywordService |
Removed Removed |
| MutateJobService | Renamed MutateJobService to BatchJobService. This service is
not yet available for general use, but you can start coding against the
service.
|