Upgrading to the newest version

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:

  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.

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:
  • CARRIER
  • MOBILE_DEVICE
  • OPERATING_SYSTEM_VERSION
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.

Resources

Show me the fields
  • v6/resources/campaign_label.proto campaign
  • v6/resources/campaign_label.proto label
  • v6/resources/search_term_view.proto search_term
  • v6/resources/search_term_view.proto ad_group
  • v6/resources/payments_account.proto payments_account_id
  • v6/resources/payments_account.proto name
  • v6/resources/payments_account.proto currency_code
  • v6/resources/payments_account.proto payments_profile_id
  • v6/resources/payments_account.proto secondary_payments_profile_id
  • v6/resources/payments_account.proto paying_manager_customer
  • v6/resources/extension_feed_item.proto id
  • v6/resources/extension_feed_item.proto start_date_time
  • v6/resources/extension_feed_item.proto end_date_time
  • v6/resources/extension_feed_item.proto targeted_geo_target_constant
  • v6/resources/extension_feed_item.proto targeted_campaign
  • v6/resources/extension_feed_item.proto targeted_ad_group
  • v6/resources/recommendation.proto campaign_budget
  • v6/resources/recommendation.proto campaign
  • v6/resources/recommendation.proto ad_group
  • v6/resources/recommendation.proto dismissed
  • v6/resources/recommendation.proto impressions
  • v6/resources/recommendation.proto clicks
  • v6/resources/recommendation.proto cost_micros
  • v6/resources/recommendation.proto conversions
  • v6/resources/recommendation.proto video_views
  • v6/resources/recommendation.proto current_budget_amount_micros
  • v6/resources/recommendation.proto recommended_budget_amount_micros
  • v6/resources/recommendation.proto budget_amount_micros
  • v6/resources/recommendation.proto recommended_cpc_bid_micros
  • v6/resources/recommendation.proto creation_date
  • v6/resources/recommendation.proto auto_apply_date
  • v6/resources/recommendation.proto recommended_target_cpa_micros
  • v6/resources/recommendation.proto target_cpa_micros
  • v6/resources/recommendation.proto required_campaign_budget_amount_micros
  • v6/resources/recommendation.proto recommended_budget_amount_micros
  • v6/resources/recommendation.proto recommended_budget_amount_micros
  • v6/resources/recommendation.proto excess_campaign_budget
  • v6/resources/third_party_app_analytics_link.proto shareable_link_id
  • v6/resources/user_list.proto id
  • v6/resources/user_list.proto read_only
  • v6/resources/user_list.proto name
  • v6/resources/user_list.proto description
  • v6/resources/user_list.proto integration_code

Services

Show me the fields
  • v6/services/recommendation_service.proto new_budget_amount_micros
  • v6/services/recommendation_service.proto ad_group
  • v6/services/recommendation_service.proto cpc_bid_micros
  • v6/services/recommendation_service.proto target_cpa_micros
  • v6/services/recommendation_service.proto new_campaign_budget_amount_micros
  • v6/services/recommendation_service.proto budget_micros_to_move
  • v6/services/keyword_plan_idea_service.proto language
  • v6/services/keyword_plan_idea_service.proto google.protobuf.StringValue
  • v6/services/keyword_plan_idea_service.proto url
  • v6/services/keyword_plan_idea_service.proto google.protobuf.StringValue
  • v6/services/keyword_plan_idea_service.proto google.protobuf.StringValue
  • v6/services/keyword_plan_idea_service.proto site
  • v6/services/keyword_plan_idea_service.proto url
  • v6/services/keyword_plan_idea_service.proto text
  • v6/services/offline_user_data_job_service.proto enable_partial_failure
  • v6/services/keyword_plan_service.proto keyword_plan_campaign
  • v6/services/keyword_plan_service.proto keyword_plan_ad_group
  • v6/services/keyword_plan_service.proto keyword_plan_ad_group_keyword
  • v6/services/keyword_plan_service.proto keyword_plan_campaign
  • v6/services/keyword_plan_service.proto max_cpc_bid_micros
  • v6/services/keyword_plan_service.proto impressions
  • v6/services/keyword_plan_service.proto ctr
  • v6/services/keyword_plan_service.proto average_cpc
  • v6/services/keyword_plan_service.proto clicks
  • v6/services/keyword_plan_service.proto cost_micros
  • v6/services/keyword_plan_service.proto search_query
  • v6/services/reach_plan_service.proto id
  • v6/services/reach_plan_service.proto name
  • v6/services/reach_plan_service.proto parent_country_id
  • v6/services/reach_plan_service.proto plannable_location_id
  • v6/services/reach_plan_service.proto plannable_product_code
  • v6/services/reach_plan_service.proto plannable_location_id
  • v6/services/reach_plan_service.proto currency_code
  • v6/services/reach_plan_service.proto budget_micros
  • v6/services/reach_plan_service.proto is_skippable
  • v6/services/reach_plan_service.proto starts_with_sound
  • v6/services/reach_plan_service.proto top_content_only
  • v6/services/reach_plan_service.proto has_guaranteed_price
  • v6/services/reach_plan_service.proto plannable_product_code
  • v6/services/reach_plan_service.proto budget_micros
  • v6/services/reach_plan_service.proto currency_code
  • v6/services/reach_plan_service.proto cookie_frequency_cap
  • v6/services/reach_plan_service.proto min_effective_frequency
  • v6/services/reach_plan_service.proto impressions
  • v6/services/reach_plan_service.proto plannable_location_id
  • v6/services/reach_plan_service.proto duration_in_days
  • v6/services/reach_plan_service.proto plannable_product_code
  • v6/services/reach_plan_service.proto budget_micros
  • v6/services/reach_plan_service.proto cost_micros
  • v6/services/reach_plan_service.proto on_target_reach
  • v6/services/reach_plan_service.proto total_reach
  • v6/services/reach_plan_service.proto on_target_impressions
  • v6/services/reach_plan_service.proto total_impressions
  • v6/services/reach_plan_service.proto youtube_audience_size
  • v6/services/reach_plan_service.proto census_audience_size
  • v6/services/user_data_service.proto upload_date_time
  • v6/services/user_data_service.proto received_operations_count

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 UNKNOWN returned in enum types. These are the fields that are affected:

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 Services
AdGroupExtensionSettingService
CampaignExtensionSettingService
CustomerExtensionSettingService

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.

Common

Show me the fields
  • v5/common/frequency_cap.proto cap
  • v5/common/frequency_cap.proto time_length
  • v5/common/explorer_auto_optimizer_setting.proto opt_in
  • v5/common/tag_snippet.proto global_site_tag
  • v5/common/tag_snippet.proto event_snippet
  • v5/common/bidding.proto commission_rate_micros
  • v5/common/bidding.proto enhanced_cpc_enabled
  • v5/common/bidding.proto target_roas
  • v5/common/bidding.proto target_cpa_micros
  • v5/common/bidding.proto cpc_bid_floor_micros
  • v5/common/bidding.proto location_fraction_micros
  • v5/common/bidding.proto target_roas
  • v5/common/bidding.proto cpc_bid_floor_micros
  • v5/common/bidding.proto target_spend_micros
  • v5/common/bidding.proto enhanced_cpc_enabled
  • v5/common/policy.proto policy_name
  • v5/common/policy.proto violating_text
  • v5/common/policy.proto google.protobuf.StringValue
  • v5/common/policy.proto topic
  • v5/common/policy.proto language_code
  • v5/common/policy.proto google.protobuf.StringValue
  • v5/common/policy.proto google.protobuf.StringValue
  • v5/common/policy.proto google.protobuf.StringValue
  • v5/common/policy.proto expanded_url
  • v5/common/policy.proto last_checked_date_time
  • v5/common/policy.proto http_error_code
  • v5/common/policy.proto total_targeted_countries
  • v5/common/policy.proto country_criterion
  • v5/common/ad_type_infos.proto headline
  • v5/common/ad_type_infos.proto description1
  • v5/common/ad_type_infos.proto description2
  • v5/common/ad_type_infos.proto headline_part1
  • v5/common/ad_type_infos.proto headline_part2
  • v5/common/ad_type_infos.proto headline_part3
  • v5/common/ad_type_infos.proto description
  • v5/common/ad_type_infos.proto description2
  • v5/common/ad_type_infos.proto path1
  • v5/common/ad_type_infos.proto path2
  • v5/common/ad_type_infos.proto country_code
  • v5/common/ad_type_infos.proto phone_number
  • v5/common/ad_type_infos.proto business_name
  • v5/common/ad_type_infos.proto headline1
  • v5/common/ad_type_infos.proto headline2
  • v5/common/ad_type_infos.proto description1
  • v5/common/ad_type_infos.proto description2
  • v5/common/ad_type_infos.proto call_tracked
  • v5/common/ad_type_infos.proto disable_call_conversion
  • v5/common/ad_type_infos.proto phone_number_verification_url
  • v5/common/ad_type_infos.proto conversion_action
  • v5/common/ad_type_infos.proto description
  • v5/common/ad_type_infos.proto description2
  • v5/common/ad_type_infos.proto headline
  • v5/common/ad_type_infos.proto header_image
  • v5/common/ad_type_infos.proto marketing_image
  • v5/common/ad_type_infos.proto marketing_image_headline
  • v5/common/ad_type_infos.proto marketing_image_description
  • v5/common/ad_type_infos.proto headline
  • v5/common/ad_type_infos.proto description
  • v5/common/ad_type_infos.proto business_name
  • v5/common/ad_type_infos.proto logo_image
  • v5/common/ad_type_infos.proto text
  • v5/common/ad_type_infos.proto text_color
  • v5/common/ad_type_infos.proto url_collection_id
  • v5/common/ad_type_infos.proto product_image
  • v5/common/ad_type_infos.proto description
  • v5/common/ad_type_infos.proto product_video
  • v5/common/ad_type_infos.proto pixel_width
  • v5/common/ad_type_infos.proto pixel_height
  • v5/common/ad_type_infos.proto image_url
  • v5/common/ad_type_infos.proto preview_pixel_width
  • v5/common/ad_type_infos.proto preview_pixel_height
  • v5/common/ad_type_infos.proto preview_image_url
  • v5/common/ad_type_infos.proto name
  • v5/common/ad_type_infos.proto media_file
  • v5/common/ad_type_infos.proto ad_id_to_copy_image_from
  • v5/common/ad_type_infos.proto companion_banner
  • v5/common/ad_type_infos.proto companion_banner
  • v5/common/ad_type_infos.proto action_button_label
  • v5/common/ad_type_infos.proto action_headline
  • v5/common/ad_type_infos.proto companion_banner
  • v5/common/ad_type_infos.proto headline
  • v5/common/ad_type_infos.proto description
  • v5/common/ad_type_infos.proto headline
  • v5/common/ad_type_infos.proto description1
  • v5/common/ad_type_infos.proto description2
  • v5/common/ad_type_infos.proto media_file
  • v5/common/ad_type_infos.proto path1
  • v5/common/ad_type_infos.proto path2
  • v5/common/ad_type_infos.proto short_headline
  • v5/common/ad_type_infos.proto long_headline
  • v5/common/ad_type_infos.proto description
  • v5/common/ad_type_infos.proto business_name
  • v5/common/ad_type_infos.proto allow_flexible_color
  • v5/common/ad_type_infos.proto accent_color
  • v5/common/ad_type_infos.proto main_color
  • v5/common/ad_type_infos.proto call_to_action_text
  • v5/common/ad_type_infos.proto logo_image
  • v5/common/ad_type_infos.proto square_logo_image
  • v5/common/ad_type_infos.proto marketing_image
  • v5/common/ad_type_infos.proto square_marketing_image
  • v5/common/ad_type_infos.proto price_prefix
  • v5/common/ad_type_infos.proto promo_text
  • v5/common/ad_type_infos.proto app_id
  • v5/common/ad_type_infos.proto headline
  • v5/common/ad_type_infos.proto description1
  • v5/common/ad_type_infos.proto description2
  • v5/common/ad_type_infos.proto business_name
  • v5/common/ad_type_infos.proto main_color
  • v5/common/ad_type_infos.proto accent_color
  • v5/common/ad_type_infos.proto allow_flexible_color
  • v5/common/ad_type_infos.proto call_to_action_text
  • v5/common/ad_type_infos.proto price_prefix
  • v5/common/ad_type_infos.proto promo_text
  • v5/common/ad_type_infos.proto path1
  • v5/common/ad_type_infos.proto path2
  • v5/common/criteria.proto text
  • v5/common/criteria.proto url
  • v5/common/criteria.proto mobile_app_category_constant
  • v5/common/criteria.proto app_id
  • v5/common/criteria.proto name
  • v5/common/criteria.proto geo_target_constant
  • v5/common/criteria.proto parent_ad_group_criterion
  • v5/common/criteria.proto value
  • v5/common/criteria.proto value
  • v5/common/criteria.proto country_region_criterion
  • v5/common/criteria.proto state_criterion
  • v5/common/criteria.proto city_criterion
  • v5/common/criteria.proto id
  • v5/common/criteria.proto country_code
  • v5/common/criteria.proto value
  • v5/common/criteria.proto value
  • v5/common/criteria.proto value
  • v5/common/criteria.proto value
  • v5/common/criteria.proto min_days
  • v5/common/criteria.proto max_days
  • v5/common/criteria.proto min_nights
  • v5/common/criteria.proto max_nights
  • v5/common/criteria.proto start_hour
  • v5/common/criteria.proto end_hour
  • v5/common/criteria.proto video_id
  • v5/common/criteria.proto channel_id
  • v5/common/criteria.proto user_list
  • v5/common/criteria.proto radius
  • v5/common/criteria.proto longitude_in_micro_degrees
  • v5/common/criteria.proto latitude_in_micro_degrees
  • v5/common/criteria.proto postal_code
  • v5/common/criteria.proto province_code
  • v5/common/criteria.proto country_code
  • v5/common/criteria.proto province_name
  • v5/common/criteria.proto street_address
  • v5/common/criteria.proto street_address2
  • v5/common/criteria.proto city_name
  • v5/common/criteria.proto topic_constant
  • v5/common/criteria.proto google.protobuf.StringValue
  • v5/common/criteria.proto language_constant
  • v5/common/criteria.proto ip_address
  • v5/common/criteria.proto carrier_constant
  • v5/common/criteria.proto user_interest_category
  • v5/common/criteria.proto criterion_name
  • v5/common/criteria.proto argument
  • v5/common/criteria.proto operating_system_version_constant
  • v5/common/criteria.proto mobile_device_constant
  • v5/common/criteria.proto custom_affinity
  • v5/common/criteria.proto custom_intent
  • v5/common/criteria.proto feed
  • v5/common/criteria.proto google.protobuf.StringValue
  • v5/common/criteria.proto radius
  • v5/common/click_location.proto city
  • v5/common/click_location.proto country
  • v5/common/click_location.proto metro
  • v5/common/click_location.proto most_specific
  • v5/common/click_location.proto region
  • v5/common/real_time_bidding_setting.proto opt_in
  • v5/common/ad_asset.proto text
  • v5/common/ad_asset.proto asset
  • v5/common/ad_asset.proto asset
  • v5/common/ad_asset.proto asset
  • v5/common/url_collection.proto url_collection_id
  • v5/common/url_collection.proto google.protobuf.StringValue
  • v5/common/url_collection.proto google.protobuf.StringValue
  • v5/common/url_collection.proto tracking_url_template
  • v5/common/custom_parameter.proto key
  • v5/common/custom_parameter.proto value
  • v5/common/segments.proto conversion_action
  • v5/common/segments.proto conversion_action_name
  • v5/common/segments.proto conversion_adjustment
  • v5/common/segments.proto date
  • v5/common/segments.proto geo_target_airport
  • v5/common/segments.proto geo_target_canton
  • v5/common/segments.proto geo_target_city
  • v5/common/segments.proto geo_target_country
  • v5/common/segments.proto geo_target_county
  • v5/common/segments.proto geo_target_district
  • v5/common/segments.proto geo_target_metro
  • v5/common/segments.proto geo_target_most_specific_location
  • v5/common/segments.proto geo_target_postal_code
  • v5/common/segments.proto geo_target_province
  • v5/common/segments.proto geo_target_region
  • v5/common/segments.proto geo_target_state
  • v5/common/segments.proto hotel_booking_window_days
  • v5/common/segments.proto hotel_center_id
  • v5/common/segments.proto hotel_check_in_date
  • v5/common/segments.proto hotel_city
  • v5/common/segments.proto hotel_class
  • v5/common/segments.proto hotel_country
  • v5/common/segments.proto hotel_length_of_stay
  • v5/common/segments.proto hotel_rate_rule_id
  • v5/common/segments.proto hotel_state
  • v5/common/segments.proto hour
  • v5/common/segments.proto interaction_on_this_extension
  • v5/common/segments.proto month
  • v5/common/segments.proto partner_hotel_id
  • v5/common/segments.proto product_aggregator_id
  • v5/common/segments.proto product_bidding_category_level1
  • v5/common/segments.proto product_bidding_category_level2
  • v5/common/segments.proto product_bidding_category_level3
  • v5/common/segments.proto product_bidding_category_level4
  • v5/common/segments.proto product_bidding_category_level5
  • v5/common/segments.proto product_brand
  • v5/common/segments.proto product_country
  • v5/common/segments.proto product_custom_attribute0
  • v5/common/segments.proto product_custom_attribute1
  • v5/common/segments.proto product_custom_attribute2
  • v5/common/segments.proto product_custom_attribute3
  • v5/common/segments.proto product_custom_attribute4
  • v5/common/segments.proto product_item_id
  • v5/common/segments.proto product_language
  • v5/common/segments.proto product_merchant_id
  • v5/common/segments.proto product_store_id
  • v5/common/segments.proto product_title
  • v5/common/segments.proto product_type_l1
  • v5/common/segments.proto product_type_l2
  • v5/common/segments.proto product_type_l3
  • v5/common/segments.proto product_type_l4
  • v5/common/segments.proto product_type_l5
  • v5/common/segments.proto quarter
  • v5/common/segments.proto webpage
  • v5/common/segments.proto week
  • v5/common/segments.proto year
  • v5/common/segments.proto ad_group_criterion
  • v5/common/targeting_setting.proto bid_only
  • v5/common/asset_types.proto youtube_video_id
  • v5/common/asset_types.proto file_size
  • v5/common/asset_types.proto height_pixels
  • v5/common/asset_types.proto width_pixels
  • v5/common/asset_types.proto url
  • v5/common/asset_types.proto text
  • v5/common/metrics.proto absolute_top_impression_percentage
  • v5/common/metrics.proto active_view_cpm
  • v5/common/metrics.proto active_view_ctr
  • v5/common/metrics.proto active_view_impressions
  • v5/common/metrics.proto active_view_measurability
  • v5/common/metrics.proto active_view_measurable_cost_micros
  • v5/common/metrics.proto active_view_measurable_impressions
  • v5/common/metrics.proto active_view_viewability
  • v5/common/metrics.proto all_conversions_from_interactions_rate
  • v5/common/metrics.proto all_conversions_value
  • v5/common/metrics.proto all_conversions
  • v5/common/metrics.proto all_conversions_value_per_cost
  • v5/common/metrics.proto all_conversions_from_click_to_call
  • v5/common/metrics.proto all_conversions_from_directions
  • v5/common/metrics.proto google.protobuf.DoubleValue
  • v5/common/metrics.proto all_conversions_from_menu
  • v5/common/metrics.proto all_conversions_from_order
  • v5/common/metrics.proto all_conversions_from_other_engagement
  • v5/common/metrics.proto all_conversions_from_store_visit
  • v5/common/metrics.proto all_conversions_from_store_website
  • v5/common/metrics.proto average_cost
  • v5/common/metrics.proto average_cpc
  • v5/common/metrics.proto average_cpe
  • v5/common/metrics.proto average_cpm
  • v5/common/metrics.proto average_cpv
  • v5/common/metrics.proto average_page_views
  • v5/common/metrics.proto average_time_on_site
  • v5/common/metrics.proto benchmark_average_max_cpc
  • v5/common/metrics.proto benchmark_ctr
  • v5/common/metrics.proto bounce_rate
  • v5/common/metrics.proto clicks
  • v5/common/metrics.proto combined_clicks
  • v5/common/metrics.proto combined_clicks_per_query
  • v5/common/metrics.proto combined_queries
  • v5/common/metrics.proto content_budget_lost_impression_share
  • v5/common/metrics.proto content_impression_share
  • v5/common/metrics.proto conversion_last_received_request_date_time
  • v5/common/metrics.proto conversion_last_conversion_date
  • v5/common/metrics.proto content_rank_lost_impression_share
  • v5/common/metrics.proto conversions_from_interactions_rate
  • v5/common/metrics.proto conversions_value
  • v5/common/metrics.proto conversions_value_per_cost
  • v5/common/metrics.proto google.protobuf.DoubleValue
  • v5/common/metrics.proto conversions
  • v5/common/metrics.proto cost_micros
  • v5/common/metrics.proto cost_per_all_conversions
  • v5/common/metrics.proto cost_per_conversion
  • v5/common/metrics.proto cost_per_current_model_attributed_conversion
  • v5/common/metrics.proto cross_device_conversions
  • v5/common/metrics.proto ctr
  • v5/common/metrics.proto current_model_attributed_conversions
  • v5/common/metrics.proto google.protobuf.DoubleValue
  • v5/common/metrics.proto google.protobuf.DoubleValue
  • v5/common/metrics.proto current_model_attributed_conversions_value
  • v5/common/metrics.proto google.protobuf.DoubleValue
  • v5/common/metrics.proto engagement_rate
  • v5/common/metrics.proto engagements
  • v5/common/metrics.proto hotel_average_lead_value_micros
  • v5/common/metrics.proto hotel_price_difference_percentage
  • v5/common/metrics.proto hotel_eligible_impressions
  • v5/common/metrics.proto historical_quality_score
  • v5/common/metrics.proto gmail_forwards
  • v5/common/metrics.proto gmail_saves
  • v5/common/metrics.proto gmail_secondary_clicks
  • v5/common/metrics.proto impressions_from_store_reach
  • v5/common/metrics.proto impressions
  • v5/common/metrics.proto interaction_rate
  • v5/common/metrics.proto interactions
  • v5/common/metrics.proto invalid_click_rate
  • v5/common/metrics.proto invalid_clicks
  • v5/common/metrics.proto message_chats
  • v5/common/metrics.proto message_impressions
  • v5/common/metrics.proto message_chat_rate
  • v5/common/metrics.proto mobile_friendly_clicks_percentage
  • v5/common/metrics.proto organic_clicks
  • v5/common/metrics.proto organic_clicks_per_query
  • v5/common/metrics.proto organic_impressions
  • v5/common/metrics.proto organic_impressions_per_query
  • v5/common/metrics.proto organic_queries
  • v5/common/metrics.proto percent_new_visitors
  • v5/common/metrics.proto phone_calls
  • v5/common/metrics.proto phone_impressions
  • v5/common/metrics.proto phone_through_rate
  • v5/common/metrics.proto relative_ctr
  • v5/common/metrics.proto search_absolute_top_impression_share
  • v5/common/metrics.proto search_budget_lost_absolute_top_impression_share
  • v5/common/metrics.proto search_budget_lost_impressiaon_share
  • v5/common/metrics.proto search_budget_lost_top_impression_share
  • v5/common/metrics.proto search_click_share
  • v5/common/metrics.proto search_exact_match_impression_share
  • v5/common/metrics.proto search_impression_share
  • v5/common/metrics.proto search_rank_lost_absolute_top_impression_share
  • v5/common/metrics.proto search_rank_lost_impression_share
  • v5/common/metrics.proto search_rank_lost_top_impression_share
  • v5/common/metrics.proto search_top_impression_share
  • v5/common/metrics.proto speed_score
  • v5/common/metrics.proto top_impression_percentage
  • v5/common/metrics.proto valid_accelerated_mobile_pages_clicks_percentage
  • v5/common/metrics.proto value_per_all_conversions
  • v5/common/metrics.proto value_per_conversion
  • v5/common/metrics.proto value_per_current_model_attributed_conversion

Resources

Show me the fields
  • v5/resources/bidding_strategy.proto id
  • v5/resources/bidding_strategy.proto name
  • v5/resources/bidding_strategy.proto campaign_count
  • v5/resources/bidding_strategy.proto non_removed_campaign_count
  • v5/resources/mobile_device_constant.proto id
  • v5/resources/mobile_device_constant.proto name
  • v5/resources/mobile_device_constant.proto manufacturer_name
  • v5/resources/mobile_device_constant.proto operating_system_name
  • v5/resources/remarketing_action.proto id
  • v5/resources/remarketing_action.proto name
  • v5/resources/ad_group.proto id
  • v5/resources/ad_group.proto name
  • v5/resources/ad_group.proto base_ad_group
  • v5/resources/ad_group.proto tracking_url_template
  • v5/resources/ad_group.proto campaign
  • v5/resources/ad_group.proto cpc_bid_micros
  • v5/resources/ad_group.proto cpm_bid_micros
  • v5/resources/ad_group.proto target_cpa_micros
  • v5/resources/ad_group.proto cpv_bid_micros
  • v5/resources/ad_group.proto target_cpm_micros
  • v5/resources/ad_group.proto target_roas
  • v5/resources/ad_group.proto percent_cpc_bid_micros
  • v5/resources/ad_group.proto final_url_suffix
  • v5/resources/ad_group.proto effective_target_cpa_micros
  • v5/resources/ad_group.proto effective_target_roas
  • v5/resources/ad_group.proto google.protobuf.StringValue
  • v5/resources/ad_group_criterion_simulation.proto ad_group_id
  • v5/resources/ad_group_criterion_simulation.proto criterion_id
  • v5/resources/ad_group_criterion_simulation.proto start_date
  • v5/resources/ad_group_criterion_simulation.proto end_date
  • v5/resources/shared_criterion.proto shared_set
  • v5/resources/shared_criterion.proto criterion_id
  • v5/resources/domain_category.proto campaign
  • v5/resources/domain_category.proto category
  • v5/resources/domain_category.proto language_code
  • v5/resources/domain_category.proto domain
  • v5/resources/domain_category.proto coverage_fraction
  • v5/resources/domain_category.proto category_rank
  • v5/resources/domain_category.proto has_children
  • v5/resources/domain_category.proto recommended_cpc_bid_micros
  • v5/resources/click_view.proto gclid
  • v5/resources/click_view.proto page_number
  • v5/resources/click_view.proto ad_group_ad
  • v5/resources/shared_set.proto id
  • v5/resources/shared_set.proto name
  • v5/resources/shared_set.proto member_count
  • v5/resources/shared_set.proto reference_count
  • v5/resources/ad_group_criterion.proto criterion_id
  • v5/resources/ad_group_criterion.proto ad_group
  • v5/resources/ad_group_criterion.proto negative
  • v5/resources/ad_group_criterion.proto google.protobuf.StringValue
  • v5/resources/ad_group_criterion.proto bid_modifier
  • v5/resources/ad_group_criterion.proto cpc_bid_micros
  • v5/resources/ad_group_criterion.proto cpm_bid_micros
  • v5/resources/ad_group_criterion.proto cpv_bid_micros
  • v5/resources/ad_group_criterion.proto percent_cpc_bid_micros
  • v5/resources/ad_group_criterion.proto effective_cpc_bid_micros
  • v5/resources/ad_group_criterion.proto effective_cpm_bid_micros
  • v5/resources/ad_group_criterion.proto effective_cpv_bid_micros
  • v5/resources/ad_group_criterion.proto effective_percent_cpc_bid_micros
  • v5/resources/ad_group_criterion.proto google.protobuf.StringValue
  • v5/resources/ad_group_criterion.proto google.protobuf.StringValue
  • v5/resources/ad_group_criterion.proto final_url_suffix
  • v5/resources/ad_group_criterion.proto tracking_url_template
  • v5/resources/ad_group_criterion.proto quality_score
  • v5/resources/ad_group_criterion.proto first_page_cpc_micros
  • v5/resources/ad_group_criterion.proto first_position_cpc_micros
  • v5/resources/ad_group_criterion.proto top_of_page_cpc_micros
  • v5/resources/ad_group_criterion.proto estimated_add_clicks_at_first_position_cpc
  • v5/resources/ad_group_criterion.proto estimated_add_cost_at_first_position_cpc
  • v5/resources/campaign_criterion.proto campaign
  • v5/resources/campaign_criterion.proto criterion_id
  • v5/resources/campaign_criterion.proto bid_modifier
  • v5/resources/campaign_criterion.proto negative
  • v5/resources/ad_group_simulation.proto ad_group_id
  • v5/resources/ad_group_simulation.proto start_date
  • v5/resources/ad_group_simulation.proto end_date
  • v5/resources/currency_constant.proto code
  • v5/resources/currency_constant.proto name
  • v5/resources/currency_constant.proto symbol
  • v5/resources/currency_constant.proto billable_unit_micros
  • v5/resources/campaign.proto id
  • v5/resources/campaign.proto name
  • v5/resources/campaign.proto tracking_url_template
  • v5/resources/campaign.proto google.protobuf.StringValue
  • v5/resources/campaign.proto base_campaign
  • v5/resources/campaign.proto campaign_budget
  • v5/resources/campaign.proto start_date
  • v5/resources/campaign.proto end_date
  • v5/resources/campaign.proto final_url_suffix
  • v5/resources/campaign.proto optimization_score
  • v5/resources/campaign.proto bidding_strategy
  • v5/resources/campaign.proto target_google_search
  • v5/resources/campaign.proto target_search_network
  • v5/resources/campaign.proto target_content_network
  • v5/resources/campaign.proto target_partner_search_network
  • v5/resources/campaign.proto hotel_center_id
  • v5/resources/campaign.proto domain_name
  • v5/resources/campaign.proto language_code
  • v5/resources/campaign.proto use_supplied_urls_only
  • v5/resources/campaign.proto google.protobuf.StringValue
  • v5/resources/campaign.proto merchant_id
  • v5/resources/campaign.proto sales_country
  • v5/resources/campaign.proto campaign_priority
  • v5/resources/campaign.proto enable_local
  • v5/resources/campaign.proto tracking_url
  • v5/resources/campaign.proto app_id
  • v5/resources/campaign.proto google.protobuf.StringValue
  • v5/resources/ad.proto id
  • v5/resources/ad.proto google.protobuf.StringValue
  • v5/resources/ad.proto google.protobuf.StringValue
  • v5/resources/ad.proto tracking_url_template
  • v5/resources/ad.proto final_url_suffix
  • v5/resources/ad.proto display_url
  • v5/resources/ad.proto added_by_google_ads
  • v5/resources/ad.proto name
  • v5/resources/ad_parameter.proto ad_group_criterion
  • v5/resources/ad_parameter.proto parameter_index
  • v5/resources/ad_parameter.proto insertion_text
  • v5/resources/account_budget.proto id
  • v5/resources/account_budget.proto billing_setup
  • v5/resources/account_budget.proto name
  • v5/resources/account_budget.proto proposed_start_date_time
  • v5/resources/account_budget.proto approved_start_date_time
  • v5/resources/account_budget.proto total_adjustments_micros
  • v5/resources/account_budget.proto amount_served_micros
  • v5/resources/account_budget.proto purchase_order_number
  • v5/resources/account_budget.proto notes
  • v5/resources/account_budget.proto proposed_end_date_time
  • v5/resources/account_budget.proto approved_end_date_time
  • v5/resources/account_budget.proto proposed_spending_limit_micros
  • v5/resources/account_budget.proto approved_spending_limit_micros
  • v5/resources/account_budget.proto adjusted_spending_limit_micros
  • v5/resources/account_budget.proto account_budget_proposal
  • v5/resources/account_budget.proto name
  • v5/resources/account_budget.proto start_date_time
  • v5/resources/account_budget.proto purchase_order_number
  • v5/resources/account_budget.proto notes
  • v5/resources/account_budget.proto creation_date_time
  • v5/resources/account_budget.proto end_date_time
  • v5/resources/account_budget.proto spending_limit_micros
  • v5/resources/conversion_action.proto id
  • v5/resources/conversion_action.proto name
  • v5/resources/conversion_action.proto owner_customer
  • v5/resources/conversion_action.proto include_in_conversions_metric
  • v5/resources/conversion_action.proto click_through_lookback_window_days
  • v5/resources/conversion_action.proto view_through_lookback_window_days
  • v5/resources/conversion_action.proto phone_call_duration_seconds
  • v5/resources/conversion_action.proto app_id
  • v5/resources/conversion_action.proto default_value
  • v5/resources/conversion_action.proto default_currency_code
  • v5/resources/conversion_action.proto always_use_default_value
  • v5/resources/conversion_action.proto event_name
  • v5/resources/conversion_action.proto event_name
  • v5/resources/conversion_action.proto project_id
  • v5/resources/dynamic_search_ads_search_term_view.proto search_term
  • v5/resources/dynamic_search_ads_search_term_view.proto headline
  • v5/resources/dynamic_search_ads_search_term_view.proto landing_page
  • v5/resources/dynamic_search_ads_search_term_view.proto page_url
  • v5/resources/dynamic_search_ads_search_term_view.proto has_negative_keyword
  • v5/resources/dynamic_search_ads_search_term_view.proto has_matching_keyword
  • v5/resources/dynamic_search_ads_search_term_view.proto has_negative_url
  • v5/resources/campaign_budget.proto id
  • v5/resources/campaign_budget.proto name
  • v5/resources/campaign_budget.proto amount_micros
  • v5/resources/campaign_budget.proto total_amount_micros
  • v5/resources/campaign_budget.proto explicitly_shared
  • v5/resources/campaign_budget.proto reference_count
  • v5/resources/campaign_budget.proto has_recommended_budget
  • v5/resources/campaign_budget.proto recommended_budget_amount_micros
  • v5/resources/campaign_budget.proto recommended_budget_estimated_change_weekly_clicks
  • v5/resources/campaign_budget.proto google.protobuf.Int64Value
  • v5/resources/campaign_budget.proto google.protobuf.Int64Value
  • v5/resources/campaign_budget.proto recommended_budget_estimated_change_weekly_views
  • v5/resources/merchant_center_link.proto id
  • v5/resources/merchant_center_link.proto merchant_center_account_name
  • v5/resources/ad_group_ad.proto ad_group
  • v5/resources/geographic_view.proto country_criterion_id
  • v5/resources/mobile_app_category_constant.proto id
  • v5/resources/mobile_app_category_constant.proto name
  • v5/resources/campaign_bid_modifier.proto campaign
  • v5/resources/campaign_bid_modifier.proto criterion_id
  • v5/resources/campaign_bid_modifier.proto bid_modifier
  • v5/resources/change_status.proto campaign
  • v5/resources/change_status.proto ad_group
  • v5/resources/distance_view.proto metric_system
  • v5/resources/carrier_constant.proto id
  • v5/resources/carrier_constant.proto name
  • v5/resources/carrier_constant.proto country_code
  • v5/resources/language_constant.proto id
  • v5/resources/language_constant.proto code
  • v5/resources/language_constant.proto name
  • v5/resources/language_constant.proto targetable
  • v5/resources/ad_group_bid_modifier.proto ad_group
  • v5/resources/ad_group_bid_modifier.proto criterion_id
  • v5/resources/ad_group_bid_modifier.proto bid_modifier
  • v5/resources/ad_group_bid_modifier.proto base_ad_group
  • v5/resources/customer.proto id
  • v5/resources/customer.proto descriptive_name
  • v5/resources/customer.proto currency_code
  • v5/resources/customer.proto time_zone
  • v5/resources/customer.proto tracking_url_template
  • v5/resources/customer.proto final_url_suffix
  • v5/resources/customer.proto auto_tagging_enabled
  • v5/resources/customer.proto has_partners_badge
  • v5/resources/customer.proto manager
  • v5/resources/customer.proto test_account
  • v5/resources/customer.proto optimization_score
  • v5/resources/customer.proto call_reporting_enabled
  • v5/resources/customer.proto call_conversion_reporting_enabled
  • v5/resources/customer.proto call_conversion_action
  • v5/resources/customer.proto conversion_tracking_id
  • v5/resources/customer.proto cross_account_conversion_tracking_id
  • v5/resources/customer.proto google_global_site_tag
  • v5/resources/customer_negative_criterion.proto id
  • v5/resources/geo_target_constant.proto id
  • v5/resources/geo_target_constant.proto name
  • v5/resources/geo_target_constant.proto country_code
  • v5/resources/geo_target_constant.proto target_type
  • v5/resources/geo_target_constant.proto canonical_name
  • v5/resources/campaign_criterion_simulation.proto campaign_id
  • v5/resources/campaign_criterion_simulation.proto criterion_id
  • v5/resources/campaign_criterion_simulation.proto start_date
  • v5/resources/campaign_criterion_simulation.proto end_date
  • v5/resources/asset.proto id
  • v5/resources/asset.proto name
  • v5/resources/topic_constant.proto id
  • v5/resources/topic_constant.proto topic_constant_parent
  • v5/resources/topic_constant.proto google.protobuf.StringValue
  • v5/resources/campaign_shared_set.proto campaign
  • v5/resources/campaign_shared_set.proto shared_set
  • v5/resources/operating_system_version_constant.proto id
  • v5/resources/operating_system_version_constant.proto name
  • v5/resources/operating_system_version_constant.proto os_major_version
  • v5/resources/operating_system_version_constant.proto os_minor_version
  • v5/resources/google_ads_field.proto name
  • v5/resources/google_ads_field.proto selectable
  • v5/resources/google_ads_field.proto filterable
  • v5/resources/google_ads_field.proto sortable
  • v5/resources/google_ads_field.proto google.protobuf.StringValue
  • v5/resources/google_ads_field.proto google.protobuf.StringValue
  • v5/resources/google_ads_field.proto google.protobuf.StringValue
  • v5/resources/google_ads_field.proto google.protobuf.StringValue
  • v5/resources/google_ads_field.proto google.protobuf.StringValue
  • v5/resources/google_ads_field.proto type_url
  • v5/resources/google_ads_field.proto is_repeated
  • v5/resources/google_ads_field.proto google.protobuf.StringValue
  • v5/resources/google_ads_field.proto resource_name_format
  • v5/resources/google_ads_field.proto google.protobuf.StringValue
  • v5/resources/google_ads_field.proto google.protobuf.StringValue
  • v5/resources/google_ads_field.proto links_to
  • v5/resources/google_ads_field.proto google.protobuf.StringValue
  • v5/resources/media_file.proto id
  • v5/resources/media_file.proto source_url
  • v5/resources/media_file.proto name
  • v5/resources/media_file.proto file_size
  • v5/resources/media_file.proto ad_duration_millis
  • v5/resources/media_file.proto ad_duration_millis
  • v5/resources/media_file.proto youtube_video_id
  • v5/resources/media_file.proto advertising_id_code
  • v5/resources/media_file.proto isci_code

Services

Show me the fields
  • v5/services/conversion_adjustment_upload_service.proto conversion_action
  • v5/services/conversion_adjustment_upload_service.proto adjustment_date_time
  • v5/services/conversion_adjustment_upload_service.proto order_id
  • v5/services/conversion_adjustment_upload_service.proto adjusted_value
  • v5/services/conversion_adjustment_upload_service.proto currency_code
  • v5/services/conversion_adjustment_upload_service.proto gclid
  • v5/services/conversion_adjustment_upload_service.proto conversion_date_time
  • v5/services/conversion_adjustment_upload_service.proto conversion_action
  • v5/services/conversion_adjustment_upload_service.proto adjustment_date_time
  • v5/services/conversion_adjustment_upload_service.proto order_id
  • v5/services/customer_service.proto email_address
  • v5/services/conversion_upload_service.proto gclid
  • v5/services/conversion_upload_service.proto conversion_action
  • v5/services/conversion_upload_service.proto conversion_date_time
  • v5/services/conversion_upload_service.proto conversion_value
  • v5/services/conversion_upload_service.proto currency_code
  • v5/services/conversion_upload_service.proto order_id
  • v5/services/conversion_upload_service.proto caller_id
  • v5/services/conversion_upload_service.proto call_start_date_time
  • v5/services/conversion_upload_service.proto conversion_action
  • v5/services/conversion_upload_service.proto conversion_date_time
  • v5/services/conversion_upload_service.proto conversion_value
  • v5/services/conversion_upload_service.proto currency_code
  • v5/services/conversion_upload_service.proto external_attribution_credit
  • v5/services/conversion_upload_service.proto external_attribution_model
  • v5/services/conversion_upload_service.proto gclid
  • v5/services/conversion_upload_service.proto conversion_action
  • v5/services/conversion_upload_service.proto conversion_date_time
  • v5/services/conversion_upload_service.proto caller_id
  • v5/services/conversion_upload_service.proto call_start_date_time
  • v5/services/conversion_upload_service.proto conversion_action
  • v5/services/conversion_upload_service.proto conversion_date_time
  • v5/services/geo_target_constant_service.proto locale
  • v5/services/geo_target_constant_service.proto country_code
  • v5/services/geo_target_constant_service.proto google.protobuf.StringValue
  • v5/services/geo_target_constant_service.proto google.protobuf.StringValue
  • v5/services/geo_target_constant_service.proto locale
  • v5/services/geo_target_constant_service.proto reach
  • v5/services/geo_target_constant_service.proto search_term

Migrating from v3 to v4

Changes to Services and their Components
AdGroupAdAssetView Changed the format of AdGroupAdAssetView.resource_name from
customers/{id}/adGroupAdAssets/{id} to
customers/{id}/adGroupAdAssetViews/{id}.
AdGroupCriterionError The following errors were moved to CriterionError:
  • INVALID_LISTING_GROUP_HIERARCHY
  • LISTING_GROUP_UNIT_CANNOT_HAVE_CHILDREN
  • LISTING_GROUP_SUBDIVISION_REQUIRES_OTHERS_CASE
  • LISTING_GROUP_REQUIRES_SAME_DIMENSION_TYPE_AS_SIBLINGS
  • LISTING_GROUP_ALREADY_EXISTS
  • LISTING_GROUP_DOES_NOT_EXIST
  • LISTING_GROUP_CANNOT_BE_REMOVED
  • INVALID_LISTING_GROUP_TYPE
  • LISTING_GROUP_ADD_MAY_ONLY_USE_TEMP_ID
CriterionError Renamed error enum values from CriterionError:
  • PRODUCT_FILTER_TOO_LONG -> LISTING_SCOPE_TOO_LONG
  • PRODUCT_SCOPE_TOO_MANY_DIMENSIONS -> LISTING_SCOPE_TOO_MANY_DIMENSIONS
  • PRODUCT_PARTITION_TOO_LONG -> LISTING_GROUP_TOO_LONG
  • PRODUCT_PARTITION_TOO_MANY_DIMENSIONS -> LISTING_GROUP_TREE_TOO_DEEP
  • INVALID_PRODUCT_DIMENSION -> INVALID_LISTING_DIMENSION
  • INVALID_PRODUCT_DIMENSION_TYPE -> INVALID_LISTING_DIMENSION_TYPE
KeywordPlanKeywordService

Removed KeywordPlanKeywordService. The replacement is KeywordPlanAdGroupKeywordService.

Removed KeywordPlanKeywordError. The replacement is KeywordPlanAdGroupKeywordError.

KeywordPlanNegativeKeywordService

Removed KeywordPlanNegativeKeywordService. The replacement is KeywordPlanCampaignKeywordService.

Removed KeywordPlanNegativeKeywordError. The replacement is KeywordPlanCampaignKeywordError.

MutateJobService Renamed MutateJobService to BatchJobService. This service is not yet available for general use, but you can start coding against the service.