Upgrade to the latest version

Periodically, you might want to upgrade from an older major version of the 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 always upgrade to the newest version.

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:

  1. Your endpoint will change when you change major versions. Update your client libraries to use the newest endpoint.
  2. Go through the release notes to see changes that were introduced in each release.
  3. Check out the tables below for specific areas to focus on for the version you're upgrading to.

For a comprehensive overview of changes based on a diff between the protos from the two versions, look at the diff table.

v15 to v16

Changes to services and their components
AccountLink The data_partner and google_ads links in linked_account have been removed. Use ProductLinkService and ProductLinkInvitationService instead.
CampaignLifecycleGoal When updating an existing CampaignLifecycleGoal previously, you would issue a create operation with specific requirements. Now you can issue an update operation as with other resource types instead.
Error reporting Two cases where the generic ContextError.OPERATION_NOT_PERMITTED_FOR_CONTEXT error was returned now result in more specific error messages:
  • CampaignError.CANNOT_LINK_TO_COMPARISON_SHOPPING_SERVICE_ACCOUNT
  • CampaignError.CANNOT_TARGET_NETWORK_FOR_COMPARISON_SHOPPING_SERVICE_LINKED_ACCOUNTS
AudienceInsightsAttributeMetadata The score field has been removed.
KeywordMatchTypeRecommendation If the keyword match type is unset, the API now returns UNSPECIFIED instead of UNKNOWN for the recommended_match_type field.

v14 to v15

Changes to services and their components
AssetGroupListingGroupFilter The vertical enum field has been renamed to feed_type.
MediaFileService The service has been removed since it's no longer needed. See the ImageAdInfo change below.
ImageAdInfo The media_file field has been replaced with image_asset.
MerchantCenterLinkService The service has been replaced with ProductLinkInvitationService and ProductLinkService.
Campaign.ShoppingSetting The sales_country field has been removed. The information is now returned in the feed_label field.
ProductBiddingCategoryConstant Replaced with ProductCategoryConstant. Multiple fields have been renamed accordingly, see the next three changes below.
ListingDimensionInfo Replaced the product_bidding_category field with product_category.
ListingGroupFilterDimension Replaced the product_bidding_category field with product_category.
shopping_performance_view report The following segment fields:
  • product_bidding_category_level1
  • product_bidding_category_level2
  • product_bidding_category_level3
  • product_bidding_category_level4
  • product_bidding_category_level5
have been replaced with:
  • product_category_level1
  • product_category_level2
  • product_category_level3
  • product_category_level4
  • product_category_level5
Campaign.shopping_setting Removed support for creating Search campaigns with this field.
CampaignCriterion.listing_scope Removed support for creating Search campaigns with this field.
sk_ad_network_conversions report The metrics.sk_ad_network_conversions has been replaced with metrics.sk_ad_network_installs.
OfflineConversionClientSummary Moved the offline_conversion_client_summaries field from Customer to a top-level resource that you can query separately.

Change your query from:

SELECT customer.offline_conversion_client_summaries
FROM customer
to:
SELECT
  offline_conversion_upload_client_summary.client,
  offline_conversion_upload_client_summary.status,
  offline_conversion_upload_client_summary.total_event_count,
  offline_conversion_upload_client_summary.successful_event_count,
  offline_conversion_upload_client_summary.last_upload_date_time,
  ...
FROM offline_conversion_upload_client_summary

Use the query builder to explore the list of available fields for selection and filtering.

OfflineConversionUploadAlert Renamed to OfflineConversionAlert.
OfflineConversionUploadError Renamed to OfflineConversionError.
AdNetworkType The enums YOUTUBE_SEARCH and YOUTUBE_WATCH have been merged into a single enum: YOUTUBE.