For archival purposes, so links on this page might not work.
v18 (2024-10-16)
The following new features and updates were added in v18.
Account Management
:
- (For allowlisted accounts only) Added
DataLinkService.CreateDataLink, which allows linking a Google Ads account to creator videos hosted on the creator's YouTube channel. Video linking enables the Google Ads account to run partnership ads using creator videos.
Ad Groups
- Added
AdGroup.exclude_demographic_expansion, which lets you exclude demographics from being expanded whenoptimized_targeting_enabledistrue, a feature that was previously only supported for Demand Gen.
Ads
- Added
AdGroupAd.ad_group_ad_asset_automation_settings, which allows opting ads into or out of automatic asset generation. - Added the following values to
AssetAutomationType:GENERATE_VERTICAL_YOUTUBE_VIDEOSGENERATE_SHORTER_YOUTUBE_VIDEOS
- Added
AdNetworkType.GOOGLE_OWNED_CHANNELS, which is used by ads that serve on Google-owned channels such as YouTube, Gmail, and the Discover feed.
Assets
- Renamed
AssetType.DISCOVERY_CAROUSEL_CARDtoAssetType.DEMAND_GEN_CAROUSEL_CARD.
Campaigns
- Added
metrics.store_visits_last_click_model_attributed_conversions, which returns the number of store visits attributed by the last click model of a campaign. - Added the following video view-related metrics for a campaign:
- Added
metrics.results_conversions_purchase, which returns conversion purchases for the unified goals results of a campaign. - Changed the default value of
DemandGenCampaignSettings.upgraded_targetingfromfalsetotrue.
Criterion
- Added
content_criterion_view, which returns performance metrics of targeted contents, such as keywords, placements and topics, for Display, Demand Gen and Video campaigns.
Hotel & Travel
- Support for Travel Feeds in Search Ads
- Added
ClickType.TRAVEL_ASSETSto allow segmentation of metrics of Travel Feeds in Search Ads. - Added
AssetSetType.TRAVEL_FEEDwhich can be used to opt-in and opt-out of using Travel Feed in Search Ads.
- Added
- (For allowlisted accounts only) Added travel itinerary as a new
conversion value rule with the
following new fields and values:
ConversionValueRule.itinerary_conditionwithValueRuleItineraryCondition, which allows for specifying an advance booking window, an itinerary length, and a travel start days of weekConversionValueRulePrimaryDimensionEnum.ITINERARYValueRuleSetDimension.ITINERARY
- Added the following segments for
campaignandad_groupreports to allow for segmenting performance data based on specific destinations (cities, countries and regions) for Hotel and Search campaigns:
Local Services
PhoneCallDetails.call_recording_urlwill be empty, instead of providing an invalid URL if the call recording doesn't exist for the given Local Services lead conversation.- Added
CategoryBid.target_cpa_bid_microwhich allows for setting target CPA for a category throughCampaign.local_services_campaign_settings.
Performance Max
- Support for brand guidelines
- Added
Campaign.brand_guidelines_enabled, which shows whether brand guidelines are enabled for a given Performance Max campaign. If enabled, assets withfield_typeset toBUSINESS_NAME,LOGO,LANDSCAPE_LOGOmust be linked asCampaignAssetresources instead ofAssetGroupAssetresources. - Added
CampaignError.REQUIRED_BUSINESS_NAME_ASSET_NOT_LINKEDandCampaignError.REQUIRED_LOGO_ASSET_NOT_LINKEDerrors, which indicate that Performance Max campaigns with brand guidelines enabled don't have the requiredCampaignAssetresources linked to the campaign. - When brand guidelines are enabled, at least one asset with
field_typeset toBUSINESS_NAMEand at least one withLOGOmust be linked to the campaign asCampaignAssetresources. Performance Max campaigns for online sales with a product feed must meet this requirement only when there are assets that are linked to the campaign's asset groups. - Added the following values to
AssetLinkError: BRAND_ASSETS_NOT_LINKED_AT_ASSET_GROUP_LEVEL, which is thrown when attempting to link brand assets to campaigns asCampaignAssetresources instead ofAssetGroupAssetresources in Performance Max campaigns with brand guidelines not enabled.BRAND_ASSETS_NOT_LINKED_AT_CAMPAIGN_LEVELerror, which is thrown when attempting to link brand assets to campaigns asAssetGroupAssetresources instead ofCampaignAssetresources in Performance Max campaigns with brand guidelines enabled.
- Added
- Added
performance_max_placement_view, which returns impressions of the placements where Performance Max ads served. - Added
AssetGroupListingGroupFilterError.TREE_WAS_INVALID_BEFORE_MUTATION
Planning
- (For allowlisted accounts only) Added a new service with the method
ContentCreatorInsightsService.GenerateCreatorInsights, which allows users to explore insights about top YouTube Creators. This allows customers to search for creators given an audience targeting and content targeting combination or creator insights given a list of YouTube Channel IDs. - Updates to
AudienceInsightsService.GenerateSuggestedTargetingInsights:- Moved
audience,baseline_audienceanddata_monthintoaudience_definition. - Added
audience_descriptionto generate targeting suggestions from a free form text description using generative AI.
- Moved
- Added
AudienceInsightsService.GenerateTargetingSuggestionMetrics, which returns potential reach metrics for given audience targeting combinations.
Recommendations
RecommendationService.GenerateRecommendationscan now be used to generate recommendations about optimized budget suggestions during campaign construction, by including theCAMPAIGN_BUDGETrecommendation type inGenerateRecommendationsRequest.recommendation_types[]. This works for Performance Max and Search campaigns.
Reporting
- Replaced the
summary_row_settingandreturn_total_results_countfields ofSearchGoogleAdsRequestwith thesearch_settingsfield, whose type isSearchSettingswith the following fields:omit_resultsreturn_summary_rowreturn_total_results_count
- Added the following new metrics about general invalid clicks, such as those
generated by bots or crawlers, those having irregular patterns. They can be
queried with the
campaignreport. - Added the following values to
QuotaError:EXCESSIVE_LONG_TERM_QUERY_RESOURCE_CONSUMPTION
v17.1.0 (2024-08-07)
The following new features and updates were added in v17_1.
Assets
AdGroupAdService.RemoveAutomaticallyCreatedAssets()lets you remove specified automatically created assets linked to Responsive Search Ads.
Audiences
- New enum values in
UserListCustomerTypeCategory:LOYALTY_TIER_1_MEMBERSLOYALTY_TIER_2_MEMBERSLOYALTY_TIER_3_MEMBERSLOYALTY_TIER_4_MEMBERSLOYALTY_TIER_5_MEMBERSLOYALTY_TIER_6_MEMBERSLOYALTY_TIER_7_MEMBERS
Campaigns
ShareablePreviewService.GenerateShareablePreviews()generates the URLsshareable_preview_urlin the response for shareable ad previews for enabled and paused asset groups.- The
expiration_date_timefield indicates the expiration date of the URLs in the response. - If an error occurs, the method will return
partial_failure_errorinstead of the URLs.
- The
Change History
- New change status resource type:
ASSET_GROUP.
Conversions
- New segment field for SKAdNetwork version:
segments.sk_ad_network_version offline_conversion_upload_conversion_action_summary, which exposes conversion upload diagnostics at the conversion action level.- The following metrics are added to the offline diagnostics reports to convey the number of uploaded conversions that are still being processed:
Planning
AudienceInsights.GenerateAudienceOverlapInsights(), which accepts an input primary attribute and a collection of audience attributes, and returns the estimates of the overlap of potential YouTube reach between the primary attribute and the audience attributes.
Reporting
- Support for segmenting
per_store_viewbased onsegments.date
Videos
- Support for retrieving information related to the following
standard bidding strategies
for video campaigns using reports, such as,
ad_group,campaign:Campaign.fixed_cpm(Fixed CPM (cost per thousand impression))Campaign.target_cpv(Target CPV (cost per view))
Campaign.video_campaign_settingswhich lets you determine on which inventories the video ads can be shown, using the following report fields:segments.ad_format_typewhich lets you segment the following reports based on the video ad format type:
v17 (2024-06-05)
The following features and changes were added in v17.
Ads
- Removed
AdService.getAd. This brings theAdServicein line with other services in the Google Ads API. See Retrieving objects for the recommended way to fetch ads and other resource types. - Added more validations for
ImageAdInfo.image_assetregarding dimensions and format. The following errors may be thrown if the image is invalid:
Assets
- Added new enum:
ClickType.AD_IMAGE - Added the following new reports with new metrics for Performance Max and Search campaigns:
Audiences
Batch Jobs
- Added
BatchJobError.REQUEST_TOO_LARGE, which will be thrown when the submittedAddBatchJobOperationsRequestis larger than 10484504 bytes. - Added support for setting
MutateOperation.asset_group_operationwhen usingBatchJobService. This lets you use batch processing to create and manage entire Performance Max campaigns. See our new dedicated guide.
Campaigns
- Renamed Discovery to Demand Gen in all fields, enums, errors of all
resources across the Google Ads API, such as campaigns, ads, and assets. For
example,
AdvertisingChannelType.DISCOVERYis nowAdvertisingChannelType.DEMAND_GEN. - Added
Campaign.keyword_match_typeto let you set keyword match type for all keywords in a campaign.
Conversions
- For SKAdNetwork
conversions,
- Renamed
segments.sk_ad_network_conversion_valuetosegments.sk_ad_network_fine_conversion_value. - Added
segments.sk_ad_network_redistributed_fine_conversion_value.
- Renamed
- The following metrics are now returned with the response even when they are zero. This makes them consistent with other metrics.
Criteria
- Added to following fields to
AdGroupCriterionto show whether the ad group criterion is serving or the reasons why it's not serving:primary_statusprimary_status_reasons
- Added support for
metrics.search_impression_shareforgender_view - Added support for
metrics.phone_callsforkeyword_view
Local Services
- Added
LocalServicesLeadService.AppendLeadConversation()used to append a newLocalServicesLeadConversationtoLocalServicesLead, which sends the messages to users through appropriate channels like SMS depending on how the lead was created.- The size of
AppendLeadConversationRequest.conversationsis limited to 1,000. - Only
LocalServicesLeadwithlead_typeset toLeadType.MESSAGEcan be specified inConversation.local_services_lead.
- The size of
- Added new enum values to
ConversationType:WHATSAPPto represent a conversation introduced through WhatsApp.ADS_APIto represent a conversation introduced using the newLocalServicesLeadService.AppendLeadConversation()method.
- Added the following new fields to
local_services_verification_artifact:local_services_verification_artifact.insurance_verification_artifact.expiration_date_timelocal_services_verification_artifact.license_verification_artifact.expiration_date_time
Reporting
- You can now select only fields related to one linked product
when querying
product_link. Selecting multiple fields of several linked products will throwQueryError.PROHIBITED_FIELD_COMBINATION_IN_SELECT_CLAUSE. For example,product_link.advertising_partner.customerandproduct_link.data_partner.data_partner_idcannot be selected in the same query. - Passing a
page_sizetoGoogleAdsService.Searchwill result in aRequestError.PAGE_SIZE_NOT_SUPPORTEDerror.
Shopping
- Added a new report
shopping_product, which corresponds to the Products page of the Google Ads UI. It supports returning data related to the current state of products from Google Merchant Center accounts linked to a Google Ads account.- You can filter metrics from the
shopping_productreport usingsegments.datewhen usingGoogleAdsService.SearchorGoogleAdsService.SearchStream. Segmentation by date is not permitted and will return aShoppingProductError.UNSUPPORTED_DATE_SEGMENTATIONerror.
- You can filter metrics from the
Unified Goals
- Added
UserListCustomerTypeService.MutateUserListCustomerTypes()to configure audience customer types. - Removed
CustomerLifecycleGoal.lifecycle_goal_customer_definition_settings. To configure audience settings of customer lifecycle goals, useUserListCustomerTypeService.MutateUserListCustomerTypes()instead.- Attach or un-attach a user list by setting
UserListCustomerType.customer_type_categorytoUserListCustomerTypeCategory.PURCHASERSto include it into or exclude it from an existing customer definition for customer lifecycle goals, respectively. Visit segment your audiences for more details.
- Attach or un-attach a user list by setting
Videos
- Added the following values to
ContentLabelType. You can exclude theseContentLabelTypesat the customer level:BRAND_SUITABILITY_CONTENT_FOR_FAMILIESBRAND_SUITABILITY_GAMES_FIGHTINGBRAND_SUITABILITY_GAMES_MATUREBRAND_SUITABILITY_HEALTH_SENSITIVEBRAND_SUITABILITY_HEALTH_SOURCE_UNDETERMINEDBRAND_SUITABILITY_NEWS_RECENTBRAND_SUITABILITY_NEWS_SENSITIVEBRAND_SUITABILITY_NEWS_SOURCE_NOT_FEATUREDBRAND_SUITABILITY_POLITICSBRAND_SUITABILITY_RELIGION
- Added
AdVideoAsset.ad_video_asset_infoto support inventory preferences for video assets when creatingDemandGenVideoResponsiveAdInfo. - (Allowlisted accounts only) Made
Campaign.video_brand_safety_suitabilitymutable.
v16.1.0 (2024-04-24)
The following features and changes were added in v16.1.
Account Management
CustomerNegativeCriterion.ip_blockwhich supports adding an IP as a negative criterion at the customer level.- New enum value:
ProductLinkError.LINK_EXISTS. - New enum value:
ProductLinkInvitationError.CUSTOMER_NOT_PERMITTED_TO_CREATE_INVITATION.
Assets
- Support for assets related to Demand Gen to
ad_group_ad_asset_viewandasset_field_type_view. - New enum value:
AssetFieldType.DISCOVERY_CAROUSEL_CARD.
Audiences
- New enum value:
ResourceLimitType.LOOKALIKE_USER_LISTS_PER_CUSTOMERwhich limits the number of lookalike user lists a customer can have to 1000.
Campaigns
- Support for returning Target
ROAS campaign bid simulations for
App campaigns using the
campaign_simulationreport. - New enum value:
CampaignError.DYNAMIC_TEXT_ASSET_CANNOT_OPT_OUT_WITH_FINAL_URL_EXPANSION_OPT_IN. - New enum value:
AdGroupPrimaryStatusReason.AD_GROUP_PAUSED_DUE_TO_LOW_ACTIVITY. - New enum value:
CampaignCriterionError.CANNOT_REMOVE_ALL_LOCATIONS_DUE_TO_TOO_MANY_COUNTRY_EXCLUSIONS.
Conversions
SkAdNetworkConversionValueSchema.postback_mappingswhich supports SKAdNetwork 4.0 features.- Added support for warnings for
CustomerSkAdNetworkConversionValueSchemaServiceasMutateCustomerSkAdNetworkConversionValueSchemaRequest.enable_warnings. When set totrue, any non-blocking errors pertaining to operation failures will be returned asMutateCustomerSkAdNetworkConversionValueSchemaResponse.warning. - New enum values in
CustomerSkAdNetworkConversionValueSchemaError:INVALID_EVENT_COUNTERINVALID_EVENT_NAME
Criteria
- New fields in
BrandInfo:display_nameprimary_urlrejection_reasonstatus
- New enum:
BrandRequestRejectionReason. - New enum value:
CriterionType.LIFE_EVENT.
Experiments
- New enum value:
ExperimentError.INVALID_DURATION_FOR_AN_EXPERIMENT.
Local Services
local_services_lead.credit_details.credit_stateandlocal_services_lead.credit_details.credit_state_last_update_date_timewhich returns the state of credit and the timestamp when the credit state was updated, respectively.local_services_lead_conversation.message_details.attachment_urlswhich returns the URLs that can be used to download the contents of the attachment.
Videos
customer.video_brand_safety_suitabilityandBrandSafetySuitabilitywhich support retrieving video brand safety suitability at the customer level.- New enum value:
VideoCampaignError.MUTATE_REQUIRES_RESERVATION.
v16 (2024-02-21)
The following features and changes were added in v16.
Account Management
- Migrated
advertising_partnerfromAccountLinktoProductLinkandProductLinkInvitation. - Removed
data_partnerandgoogle_adsfromAccountLink. - Added
IdentityVerificationServiceto manage advertiser verification.StartIdentityVerification()is used to start a verification session using the providedverification_program. It creates a new verification session and returns an empty response for a successfully created verification.GetIdentityVerification()can be used for retrieving verification information, which returns several objects ofIdentityVerification. EachIdentityVerificationincludes:verification_programwhich is the identity verification program typeidentity_verification_requirementthat contains details related to the deadline by which the advertiser should finish verificationverification_progressthat contains details related to the verification session including:program_statusrepresents the current status of this verification sessionaction_urldirects the customer to a URL to complete the verification.invitation_link_expiration_timerepresents the expiration date for theaction_url
- Enums:
- Errors:
- Added
AuthorizationError.ACTION_NOT_PERMITTED_FOR_SUSPENDED_ACCOUNT.
Assets
- Changes to
asset_group:- Added support for time-related segments, such as
segments.yearandsegments.month. - Made
campaignan attributed resource instead of segmenting resource.
- Added support for time-related segments, such as
Campaigns
- Changes to Demand Gen campaigns:
- Added support for setting
Campaign.shopping_settingto an existing Demand Gen campaign. - Added
ShoppingSetting.disable_product_feedto disable the optional product feed of Demand Gen campaigns. - Added
Ad.demand_gen_product_adand the correspondingDemandGenProductAdInfo, available to Demand Gen campaigns with a non-nullCampaign.shopping_setting.
- Added support for setting
- Added to following fields to
AdGroupto show whether the ad group is serving or the reasons why it's not serving:primary_statusprimary_status_reasons
- Added to following fields to
AdGroupAdto show whether the ad group ad is serving or the reasons why it's not serving:primary_statusprimary_status_reasons
- Added the following values to
AdGroupError:CANNOT_ADD_AD_GROUP_FOR_CAMPAIGN_TYPEINVALID_STATUS
Experiment
- Added
Experiment.sync_enabledto specify if sync should be enabled in the experiment. With sync enabled, changes made to the original campaign while your experiment is running, are automatically copied to the experiment campaign. - Added
ExperimentError.CANNOT_ENABLE_SYNC_FOR_UNSUPPORTED_EXPERIMENT_TYPE. - Added
CampaignError.CANNOT_MODIFY_TEXT_ASSET_AUTOMATION_WITH_ENABLED_TRIAL.
Hotel & Travel
- Added the following fields to
ListingDimensionInfofor a Things to do ad to enable creating listing groups based on the state and city where the travel activity is available: - Added support for the following segments to
travel_activity_performance_view:
Local Services
- Added
LocalServicesVerificationArtifact.business_registration_check_verification_artifactandBusinessRegistrationCheckArtifactto allow advertisers to monitor the progress of the business registration verification process. - Added a new resource
local_services_employeeto allow advertisers to retrieve the employee information they've added.
Planning
- Removed
scorefromAudienceInsightsAttributeMetadata.
Recommendations
- Added
RecommendationService.GenerateRecommendations()which returns recommendations based on the specified settings, such as recommendation types and advertising channel types. This is particularly helpful during campaign construction. - Added
RecommendationMetrics.conversions_value. - Recommended keywords with unset keyword match type now have
recommended_match_typeset toUNSPECIFIEDinstead ofUNKNOWN. - Added the following types of recommendations:
MAXIMIZE_CONVERSION_VALUE_OPT_INwhich recommends opting in to the Maximize conversion value bidding strategyIMPROVE_GOOGLE_TAG_COVERAGEwhich recommends deploying Google Tag on more pagesPERFORMANCE_MAX_FINAL_URL_OPT_INwhich recommends turning on final URL expansion for your Performance Max campaignsREFRESH_CUSTOMER_MATCH_LISTwhich recommends updating a customer list that hasn't been updated in the last 90 daysCUSTOM_AUDIENCE_OPT_INwhich recommends creating a custom audienceLEAD_FORM_ASSETwhich recommends adding lead form assets at the campaign or customer levelIMPROVE_DEMAND_GEN_AD_STRENGTHwhich recommends improving ad strength on Demand Gen campaigns
Shopping
- Added
CampaignError.CANNOT_LINK_TO_COMPARISON_SHOPPING_SERVICE_ACCOUNTandCampaignError.CANNOT_TARGET_NETWORK_FOR_COMPARISON_SHOPPING_SERVICE_LINKED_ACCOUNTSin order to provide more detailed errors for Shopping campaigns linked to a Comparison Shopping Service Center account. - Added the following values to
AssetGroupListingGroupFilterError:DIMENSION_TYPE_NOT_ALLOWEDDUPLICATE_WEBPAGE_FILTER_UNDER_ASSET_GROUPFILTER_EXCLUSION_NOT_ALLOWEDLISTING_SOURCE_NOT_ALLOWEDMULTIPLE_LISTING_SOURCESMULTIPLE_WEBPAGE_CONDITION_TYPES_NOT_ALLOWEDMULTIPLE_WEBPAGE_TYPES_PER_ASSET_GROUPPAGE_FEED_FILTER_HAS_PARENT
Lifecycle Goals
- Added
updatetoCustomerLifecycleGoalOperationandCampaignLifecycleGoalOperationto make these operation types consistent with other operation types in the API.
v15 (2023-10-18)
The following new features and updates were introduced in v15.
Account Management
- If your account is suspended because of unauthorized account
activity,
customer.statusandcustomer_client.statusare now returned asSUSPENDED. Previously, they were returned asENABLED. - Added support for adding and removing a link between a Google Ads account and a Merchant Center account:
- Added
ProductLinkInvitationServiceandProductLinkInvitationto support updating a link invitation sent from other products, available for Hotel Center and Merchant Center accounts. - Removed
MerchantCenterLinkService.- To link Google Ads accounts with Merchant Center accounts, use
ProductLinkInvitationServiceandProductLinkService.
- To link Google Ads accounts with Merchant Center accounts, use
- Removed
AccountLink.hotel_centerand support for updating link invitations from Hotel Center accounts usingAccountLinkService.- To update a link invitation from a Hotel Center account, use
ProductLinkInvitationService.
- To update a link invitation from a Hotel Center account, use
Assets
- Replaced
ImageAdInfo.media_filewithImageAdInfo.image_assetto support adding and removing images using the assets. As a result, we also removedMediaFileService, which is no longer needed. - Added
ListingGroupFilterDimension.webpageto support creating a listing group filter based on custom labels and URL substrings.- Also replaced
AssetGroupListingGroupFilter.verticalwithAssetGroupListingGroupFilter.listing_sourceandListingGroupFilterListingSource
- Also replaced
- Added
asset_group_asset.sourceto show the source of the asset group asset. - Added
ad_group_ad_asset_view.sourceto show the source of ad group ad asset.
Audiences
- For Customer Match, added
CustomerMatchUserListMetadata.consentto support providing a consent. Starting on March 6, 2024 if consent is missing for EEA users, then the consent value is determined as not consented. Data from unconsented EEA users won't be processed and cannot be used for ad personalization using Customer Match. Check out our Customer Match guide for more details. - For Store Sales, added
UserData.consentto support providing a consent. Check out our Store Sales guide for more details. If you are using Customer Match with store sales, review the FAQ for additional information. - Added
UserList.lookalike_user_listto support creating a Lookalike segment, an audience created based on the provided existing seed audience. Lookalike segments can be used in a Demand Gen campaign only.
Campaigns
Updates to Performance Max campaigns:
AssetGroupSignalnow supports for two signal types that can be attached to an asset group for enhanced targeting:AssetGroupSignal.audience- Added
Audience.scopeandAudience.asset_groupto limit audience usage to a specific asset group.Audience.asset_groupmust be set if and only ifAudience.scopeisASSET_GROUP.
- Added
AssetGroupSignal.search_theme- Added
CriterionType.SEARCH_THEMEto support this new criterion type. This new criterion type can only be used in Performance Max campaigns to create anAssetGroupSignalby populating theAssetGroupSignal.search_themewith aSearchThemeInfocriterion.
- Added
- Added
AssetGroupSignalOperation.exempt_policy_violation_keysto support requesting exemption when adding asset group signals. - Added a new
asset_group_top_combination_viewto report the top performing assets at the asset group level. asset_groupcan now be queried with metric fields to support retrieving the performance of a Performance Max campaign.- In
PerformanceMaxUpgradeStatus, renamedUPGRADE_ELIGIBLEtoUPGRADE_ELIGIBLE.
For Demand Gen and Discovery Target CPA campaigns, the campaign-level Target CPA bid simulations (
campaign_simulation.target_cpa_point_list.points) now returnsTargetCpaSimulationPoint.interactionsinstead ofTargetCpaSimulationPoint.clicks.Added
BrandSuggestionServicethat can suggest brands based on the provided brand prefix and the excluded list of brands. These brands can be used to create aBRANDcriterion, added to aBRANDSshared set, and then attached to a campaign by creating aCampaignCriterionwithbrand_listset to the shared set. The campaign criteria can be targeted in Search campaigns and excluded in Performance Max campaigns, respectively.Added
Campaign.asset_automation_settings[]to show the automation status of each asset type.Added the following values to the
CampaignPrimaryStatusReasonenum:NO_ASSET_GROUPSASSET_GROUPS_PAUSED
Conversions
- Added
CallConversion.consentandClickConversion.consentto support providing a consent. Check out our call conversions guide and click conversions guide for more details. - Added the following fields related to
SKAdNetwork
conversions, available when querying them with
customerorcampaign: - Replaced
metrics.sk_ad_network_conversionswithmetrics.sk_ad_network_installs. - Added support for diagnosing offline conversion upload
- Moved the
offline_conversion_upload_client_summaryfrom a field on thecustomerresource to a top-level report. Use this report to obtain useful details of the conversion upload status such as the successful events count, success rate, and error percentage.- Caveat: A conversion that is uploaded but results in a
ConversionUploadError.CLICK_NOT_FOUNDerror is still counted as successful, but it's also flagged as anOfflineConversionAlert.
- Caveat: A conversion that is uploaded but results in a
- Added
job_idas an optional parameter for the following request types so you can logically group multiple upload requests into a single conceptual job: - Added
INVALID_JOB_IDto the following errors: - Replaced
INVALID_CONVERSION_ACTIONwithNO_CONVERSION_ACTION_FOUNDandINVALID_CONVERSION_ACTION_TYPEin the following errors:
- Moved the
- Added three reports to support Android Privacy Sandbox Cross-network
attribution without
redirects:
android_privacy_shared_key_google_campaignwhich containsshared_campaign_keyand some fields that help encode the key.android_privacy_shared_key_google_ad_groupwhich containsshared_ad_group_keyand some fields that help encode the key.android_privacy_shared_key_google_network_typewhich containsshared_network_type_keyand some fields that help encode the key.
- Added
ConversionActionError.CANNOT_SET_RULE_BASED_ATTRIBUTION_MODELS. AConversionActionOperationthat attempts to use one of the deprecated rule-based attribution models now fails with this error. Previously, the operation would fail with anUNKNOWNerror.
Hotel & Travel
- Added support for the following fields in
travel_activity_group_viewandtravel_activity_performance_view:- Segments:
- Metrics:
metrics.search_absolute_top_impression_sharemetrics.search_budget_lost_absolute_top_impression_sharemetrics.search_budget_lost_impression_sharemetrics.search_budget_lost_top_impression_sharemetrics.search_impression_sharemetrics.search_rank_lost_absolute_top_impression_sharemetrics.search_rank_lost_impression_sharemetrics.search_rank_lost_top_impression_sharemetrics.search_top_impression_share
Local Services Ads
- Added
LocalServicesSettingsand its fields to thecustomerreport for returning a Local Services advertiser's granular license and insurance statuses. - Added the following new reports for Local
Services:
local_services_leadcontains all the details pertaining to Local Services Ads leads such aslead_charged,lead_type,lead_status.- Enums:
local_services_lead_conversationcontains message and phone conversation details such asconversation_channel,call_duration_millis,call_recording_url.- Phone call recording URL is authenticated against the target customer account and its manager accounts.
local_services_verification_artifactreturns a Local Services advertiser's artifacts such as background check, business licenses, and business insurance data. Any documents associated with license and insurance can be accessed through a URL.
Planning
- Added support to return
Forecast.viewsandPlannedProductForecast.viewsforReachPlanService.ListPlannableProductsfor applicable product types. - Added support to return
PlannableTargeting.surface_targetingforReachPlanService.ListPlannableProducts, which describes the available surfaces for a product. - Added a new
ReachPlanSurfaceenum. - Added support for targeting Target
frequency using
AdvancedProductTargeting.target_frequency_settings, which returnsPlannedProductForecast.average_frequency. - Added
AudienceInsightsService.GenerateSuggestedTargetingInsightsto return suggested targetable audiences. - Added the following values to
ReachPlanError:NOT_FORECASTABLE_NOT_ENOUGH_INVENTORYNOT_FORECASTABLE_ACCOUNT_NOT_ENABLED
Recommendations
- Added
RecommendationSubscriptionServicewhich manages recommendation subscriptions: - Added the following types of recommendations:
FORECASTING_SET_TARGET_CPAwhich recommends setting a target CPA for campaigns that don't have one specified, in advance of a seasonal event that is forecasted to increase traffic.SET_TARGET_CPAwhich recommends setting a target CPA for campaigns that don't have one specified.SET_TARGET_ROASwhich recommends setting a target ROAS for campaigns that don't have one specified.
Reporting
- Added the following new metrics, which can be queried with
campaign(available for Display, Video, Discovery, and App campaigns) andsegments.device:
Shopping
- Removed
ShoppingSetting.sales_country, whose values are now returned asShoppingSetting.feed_label.- You can continue to use a specific Merchant Center
feed for a campaign by using
the
ShoppingSetting.feed_labelfield. It should be set to the feed label value or the two-letter country code previously used forShoppingSetting.sales_country. For more details, see the support article for feed labels.
- You can continue to use a specific Merchant Center
feed for a campaign by using
the
- Removed the dependency of product categories on a country code in reporting.
The set of supported category IDs has not changed.
- Replaced the following fields used in
shopping_performance_view:segments.product_bidding_category_level1withsegments.product_category_level1segments.product_bidding_category_level2withsegments.product_category_level2segments.product_bidding_category_level3withsegments.product_category_level3segments.product_bidding_category_level4withsegments.product_category_level4segments.product_bidding_category_level5withsegments.product_category_level5
- Replaced
product_bidding_category_constantwithproduct_category_constant, which returns all available localizations of a category in a repeated field. - Replaced
ListingDimensionInfo.product_bidding_categorywithListingDimensionInfo.product_category. - Replaced
ListingGroupFilterDimension.product_bidding_categorywithListingGroupFilterDimension.product_category.
- Replaced the following fields used in
- Removed support for adding
Campaign.shopping_settingto Search campaigns. Trying to create a Search campaign withCampaign.shopping_settingor addCampaign.shopping_settingto an existing Search campaign now results inOPERATION_NOT_PERMITTED_FOR_CONTEXT. - Removed support for adding
CampaignCriterion.listing_scopeto Search campaigns. Trying to addCampaignCriterion.listing_scopeto an existing Search campaign now results inOPERATION_NOT_PERMITTED_FOR_CONTEXT. - Added following conversions with cart
data metrics:
metrics.ordersmetrics.average_order_value_microsmetrics.average_cart_sizemetrics.cost_of_goods_sold_microsmetrics.gross_profit_microsmetrics.gross_profit_marginmetrics.revenue_microsmetrics.units_soldmetrics.cross_sell_cost_of_goods_sold_microsmetrics.cross_sell_gross_profit_microsmetrics.cross_sell_revenue_microsmetrics.cross_sell_units_soldmetrics.lead_cost_of_goods_sold_microsmetrics.lead_gross_profit_microsmetrics.lead_revenue_microsmetrics.lead_units_sold- All these metrics are selectable with following reports:
Unified Goals
- Added
CustomerLifecycleGoalService.ConfigureCustomerLifecycleGoalsfor configuring customer acquisition goals at the customer level.- Report:
customer_lifecycle_goal
- Report:
- Added
CampaignLifecycleGoalService.ConfigureCampaignLifecycleGoalsfor configuring customer acquisition goals at the campaign level.- Report:
campaign_lifecycle_goal
- Report:
- Added
CampaignConversionGoalError.CANNOT_USE_STORE_SALE_GOAL_FOR_PERFORMANCE_MAX_CAMPAIGN. - Added the following values to
ConversionGoalCampaignConfigError:EMPTY_CONVERSION_GOALSSTORE_SALE_STORE_VISIT_CANNOT_BE_BOTH_INCLUDEDPERFORMANCE_MAX_CAMPAIGN_CANNOT_USE_CUSTOM_GOAL_WITH_STORE_SALES
Videos
- Added support for targeting Google TV at the campaign level:
- Added support for targeting YouTube at the campaign level:
- Added
NetworkSettings.target_youtube - In
AdNetworkType, mergedYOUTUBE_WATCHandYOUTUBE_SEARCHintoYOUTUBE. - Added
CampaignError.CANNOT_TARGET_DISPLAY_NETWORK_WITHOUT_YOUTUBE. ## v14.1.0 (2023-08-09)
- Added
The following new features and updates were introduced in v14.1.
Account Management
Customer.customer_agreement_settingwhich shows if the customer has accepted the lead form term of service
Assets
- New fields in
AssetGroupto show whether the asset group is serving or the reasons why it's not serving:primary_statusprimary_status_reasons
- New fields in
AssetGroupAssetto show whether the asset group asset is serving or the reasons why it's not serving:primary_statusprimary_status_detailsprimary_status_reasons
- New values in the
CallToActionTypeenum:BUY_NOWDONATE_NOWORDER_NOWPLAY_NOWSEE_MORESTART_NOWVISIT_SITEWATCH_NOW
- New values in the
AssetLinkErrorenum:CUSTOMER_NOT_VERIFIEDUNSUPPORTED_CALL_TO_ACTIONPAGE_FEED_INVALID_LABEL_TEXT
Billing
- New fields in
InvoiceandAccountSummary:export_charge_subtotal_amount_microsexport_charge_tax_amount_microsexport_charge_total_amount_micros
Campaigns
New values in the
CampaignPrimaryStatusReasonenum:HAS_ASSET_GROUPS_DISAPPROVEDHAS_ASSET_GROUPS_LIMITED_BY_POLICYMOST_ASSET_GROUPS_UNDER_REVIEW
(Allowlisted accounts only)
DiscoveryCampaignSettingswithupgraded_targeting:- When
upgraded_targetingis set totrue, you can add a location and a language as an ad group criterion
- When
Criteria
New enum value:
CriterionError.INVALID_DETAILED_DEMOGRAPHIC(Allowlisted accounts only) Support for adding
LanguageInfoandLocationInfoas anAdGroupCriterion:- This is available only for a Discovery campaign with upgraded targeting enabled
Experiments
- New values in the
ExperimentErrorenum:DUPLICATE_EXPERIMENT_CAMPAIGN_NAMECANNOT_REMOVE_IN_CREATION_EXPERIMENTCANNOT_ADD_CAMPAIGN_WITH_DEPRECATED_AD_TYPES
Recommendations
- New types of recommendations:
PerformanceMaxOptInRecommendationwhich recommends creating the first Performance Max campaign in the accountImprovePerformanceMaxAdStrengthRecommendationwhich recommends improving the asset group's strength of a Performance Max campaignMigrateDynamicSearchAdsCampaignToPerformanceMaxRecommendationwhich recommends migrating a Dynamic Search Ad campaign to Performance Max
Reporting
- New metrics and segments about new versus returning customers:
- New
customer_search_term_insightandcampaign_search_term_insightviews:metrics.search_volumeshows the volume range for a search term insight category
Shopping
- New fields for listing groups:
- New field:
ShoppingSetting.advertising_partner_ids - New values in the
CampaignErrorenum:NOT_LINKED_ADVERTISING_PARTNERINVALID_NUMBER_OF_ADVERTISING_PARTNER_IDS
Videos
- (Allowlisted accounts only)
AdType.DISCOVERY_VIDEO_RESPONSIVE_ADand its correspondingDiscoveryVideoResponsiveAdInfo
v14 (2023-06-07)
The following new features and updates were introduced in v14.
Campaigns
Conversions
Added support for identifying Google Analytics conversions and determining whether a conversion is imported from a Universal Analytics or GA4 property:
- Added the following values to
ConversionActionType:UNIVERSAL_ANALYTICS_GOALUNIVERSAL_ANALYTICS_TRANSACTIONGOOGLE_ANALYTICS_4_CUSTOMGOOGLE_ANALYTICS_4_PURCHASE
- Added
ConversionAction.google_analytics_4_settings
- Added the following values to
Added
Customer.offline_conversion_client_summaries, which summarizes the status and diagnostic information of the customer's offline conversion uploads and adjustments.- Enums
OfflineEventUploadClient:GOOGLE_ADS_APIGOOGLE_ADS_WEB_CLIENTADS_DATA_CONNECTOR
OfflineConversionDiagnosticStatus:EXCELLENTGOODNEEDS_ATTENTIONNO_RECENT_UPLOAD
- Enums
Added
job_idto the responses returned byConversionAdjustmentUploadService.UploadConversionAdjustmentsandConversionUploadService.UploadClickConversionsfor associating a response to anOfflineConversionUploadSummary.job_id.
Criteria
Added support for retrieving, creating and updating account-level negative keywords:
- Fields:
- Enums:
CriterionType.NEGATIVE_KEYWORD_LISTSharedSetType.ACCOUNT_LEVEL_NEGATIVE_KEYWORDSResourceLimitTypeSHARED_SETS_PER_ACCOUNT_FOR_ACCOUNT_LEVEL_NEGATIVE_KEYWORDSACCOUNT_LEVEL_NEGATIVE_KEYWORDS_PER_SHARED_SET
- Errors:
CriterionErrorNEGATIVE_KEYWORD_SHARED_SET_DOES_NOT_EXISTCANNOT_ADD_REMOVED_NEGATIVE_KEYWORD_SHARED_SETCANNOT_HAVE_MULTIPLE_NEGATIVE_KEYWORD_LIST_PER_ACCOUNTCUSTOMER_CANNOT_ADD_CRITERION_OF_THIS_TYPE
Hotel Ads
- Renamed
SuggestTravelAssetsRequest.place_idtoSuggestTravelAssetsRequest.place_ids
Planning
- Removed the following methods from
KeywordPlanService:GenerateForecastCurveGenerateForecastMetricsGenerateForecastTimeSeriesGenerateHistoricalMetrics
- Added
KeywordPlanIdeaService.GenerateKeywordForecastMetricsto support generating keyword campaign forecast metrics without the need of creating a keyword plan first. - Removed support for retrieving the
campaign_criterion_simulationreport - Added support for
YOUTUBE_DYNAMIC_LINEUPas a dimension inAudienceInsightsService.ListAudienceInsightsAttributes. - Added
DynamicLineupAttributeMetadata.sample_channels, used inGenerateAudienceCompositionInsightsresponses to provide sample channels within lineups.
Recommendations
- Added
DynamicImageExtensionOptInRecommendationwhich recommends enabling dynamic image extensions on the account - Added
LowerTargetRoasRecommendationwhich recommends lowering target ROAS - Added
RaiseTargetCpaRecommendationwhich recommends raising target CPA - Added
ResponsiveSearchAdAssetRecommendation.current_ad
Reporting
- Added the following values to
ServedAssetFieldType, which are available fromad_group_ad_asset_view.pinned_field:SITELINKCALLMOBILE_APPCALLOUTSTRUCTURED_SNIPPETPRICEPROMOTIONAD_IMAGELEAD_FORMBUSINESS_LOGO
v13.1.0 (2023-04-26)
The following new features and updates were introduced in v13.1.
Assets
LeadFormField.has_location_answersupports displaying locations from the location assets associated with campaigns or a customer with a lead form.Accompanying errors:
New values in the
AssetGroupErrorenum:PATH1_REQUIRED_WHEN_PATH2_IS_SETSHORT_DESCRIPTION_REQUIREDFINAL_URL_REQUIREDFINAL_URL_CONTAINS_INVALID_DOMAIN_NAMEAD_CUSTOMIZER_NOT_SUPPORTEDCANNOT_MUTATE_ASSET_GROUP_FOR_REMOVED_CAMPAIGN
Audiences
- New values in the
UserListErrorenum:APP_ID_NOT_ALLOWEDCANNOT_MUTATE_SYSTEM_LISTMOBILE_APP_IS_SENSITIVE
Campaigns
- Support for returning campaign-level bid simulations for Performance
Max using
campaign_simulation. - (Allowlisted accounts only)
Campaign.listing_typeandListingTypefor Performance Max campaigns. This field is replacingShoppingSetting.use_vehicles_inventory, which will be used only for Smart Shopping campaigns.
Conversions
CustomerSkAdNetworkConversionValueSchemaService.MutateCustomerSkAdNetworkConversionValueSchemaenables advertisers to define SKAdNetwork conversion value schemas for iOS app campaigns.- New enum value:
CustomConversionGoalError.NON_BIDDABLE_CONVERSION_ACTION_NOT_ELIGIBLE_FOR_CUSTOM_GOAL
Planning
- New fields in the following request and response objects of
AudienceInsightsService:GenerateAudienceCompositionInsightsRequest.baseline_audiencesupports specifying the baseline audience to which the audience of interest is being compared.ListInsightsEligibleDatesResponse.last_thirty_dayssupports retrieving the current default date range used inGenerateAudienceCompositionInsightsrequests.
Recommendations
- New types of
recommendationfor Shopping campaigns and Google Merchant Center:shopping_add_age_group_recommendationshopping_add_color_recommendationshopping_add_gender_recommendationshopping_add_gtin_recommendationshopping_add_more_identifiers_recommendationshopping_add_size_recommendationshopping_add_products_to_campaign_recommendationshopping_fix_disapproved_products_recommendationshopping_target_all_offers_recommendationshopping_fix_suspended_merchant_center_account_recommendationshopping_fix_merchant_center_account_suspension_warning_recommendationshopping_migrate_regular_shopping_campaign_offers_to_performance_max_recommendation
Reporting
- New metrics:
metrics.average_target_cpa_microsto show the average target CPA.metrics.average_target_roasto show the average target ROAS.
v13 (2023-02-15)
The following new features and updates were introduced in v13.
Account Management
- Added
ProductLinkServiceto support adding and removing a link between a Google Ads account and another product. This is similar to the Linked accounts view in the Google Ads UI. In this version, only Customer Match data partner linking is supported.
Assets
Added the following fields to
Customerto track the migration status of location and image assets:location_asset_auto_migration_doneimage_asset_auto_migration_donelocation_asset_auto_migration_done_timeimage_asset_auto_migration_done_time
Added the following fields to
CustomerAsset,CampaignAsset,AdGroupAsset:primary_statusprimary_status_detailsprimary_status_reasons
Added
Asset.field_type_policy_summariesto return information about policy summaries for each field type.Asset field types
- Added
AssetFieldType.BUSINESS_LOGO. - Added support for setting
CampaignAsset.field_typeto the following values:
- Added
Added
INVALID_EXCLUDED_PARENT_ASSET_SET_TYPEtoAdded the following fields to
AssetSetError:OAUTH_INFO_INVALIDOAUTH_INFO_MISSINGCANNOT_DELETE_AS_ENABLED_LINKAGES_EXIST
Audiences
- Removed
CombinedRuleUserListInfoandExpressionRuleUserListInfoand their references fromRuleBasedUserListInfo. UseFlexibleUserListInfoinstead. - Added
QualifyingQuestionandqualifying_questionto support returning details about qualifying questions of lead form assets. When advertisers suggest a qualifying question, it'll be reviewed and approved before being used in the lead forms.
Batch Jobs
- Added
BatchJobMetadata.execution_limit_secondsto return the limit of execution in seconds. Batch jobs will be canceled if their execution time is longer than specified in this field.
Billing
- Added
InvalidActivitySummaryto allow for returning more details about the invalid activity for the invoice. - Added
AccountBudgetProposalError.CANCELED_BILLING_SETUP.
Campaigns
- Added
SmartCampaignSettingService.GetSmartCampaignStatusfor retrieving a more aggregated view of assets belonging to the Smart campaign. This should be preferred over other status fields—for example,Campaign.primary_statusorCampaign.primary_status_reasonsfor Smart campaigns. - Replaced
AdGroup.explorer_auto_optimizer_settingwithAdGroup.optimized_targeting_enabledto support optimized targeting. This is for the followingAdvertisingChannelType:DISPLAY,VIDEO,DISCOVERY. This field is for allowlisted customers only. - Added several new enum values to
CampaignError:AVERAGE_DAILY_SPEND_TOO_HIGHCANNOT_ATTACH_TO_REMOVED_CAMPAIGN_GROUPCANNOT_ATTACH_TO_BIDDING_STRATEGYCANNOT_CHANGE_BUDGET_PERIODCANNOT_CREATE_DRAFT_CAMPAIGNCANNOT_CREATE_MORE_THAN_ONE_DRAFT_CAMPAIGNNOT_ENOUGH_CONVERSIONSCANNOT_SET_MORE_THAN_ONE_CONVERSION_ACTIONNOT_COMPATIBLE_WITH_BUDGET_TYPENOT_COMPATIBLE_WITH_UPLOAD_CLICKS_CONVERSIONTRIAL_MUST_USE_SAME_BUDGET_AS_BASEINVALID_EXCLUDED_PARENT_ASSET_SET_TYPE
Conversions
ConversionUploadError.CUSTOMER_NOT_ACCEPTED_CUSTOMER_DATA_TERMSwill be returned if you upload aClickConversionwithuser_identifiersset usingConversionUploadService.UploadClickConversion, but have not accepted the customer data terms.ConversionUploadError.CLICK_CONVERSION_ALREADY_EXISTSwill be returned if you try to upload the same combination ofgbraid,conversion_action, andconversion_date_timeon different days.ConversionUploadError.CUSTOMER_NOT_ENABLED_ENHANCED_CONVERSIONS_FOR_LEADSwill be returned if you haven't followed the setup instructions before using enhanced conversions for leads.- Added
ConversionActionType.WEBPAGE_CODELESSto represent conversions created from website events.
Criteria
- Added
CampaignCriterion.local_service_idandLocalServiceIdInfoto allow for adding and removing services an advertiser serves to a Local Services Campaign.CampaignCriterionError.AT_LEAST_ONE_LOCAL_SERVICE_ID_CRITERION_REQUIRED_FOR_LOCAL_SERVICES_CAMPAIGNwill be returned if you attempt to remove the last campaign criterion that containslocal_service_idfrom a Local Services Campaign.CampaignCriterionError.LOCAL_SERVICE_ID_NOT_FOUND_FOR_CATEGORYwill be returned if you attempt to add a campaign criterion that containslocal_service_idthat is invalid for the category of your Local Service campaign. You can get information about the category by fetchingcampaign.local_services_campaign_settings.category_bids.
Errors
- Starting in v13, the error codes returned for some invalid operations have
changed for the following fields.
Previous error New error BiddingError.INVALID_BIDFieldError.FIELD_CANNOT_BE_CLEAREDBiddingError.CANNOT_ATTACH_BIDDING_STRATEGY_TO_CAMPAIGNCampaignError.CANNOT_ATTACH_TO_BIDDING_STRATEGYDistinctError.DUPLICATE_ELEMENTMutateError.ID_EXISTS_IN_MULTIPLE_MUTATESOperationAccessDeniedError.OPERATION_NOT_PERMITTED_FOR_CAMPAIGN_TYPEContextError.OPERATION_NOT_PERMITTED_FOR_CONTEXTBiddingError.BID_TOO_SMALLRangeError.TOO_LOWOperationAccessDeniedError.CREATE_OPERATION_NOT_PERMITTEDContextError.OPERATION_NOT_PERMITTED_FOR_CONTEXTCampaignError.MISSING_SHOPPING_SETTINGFieldError.REQUIREDOperationAccessDeniedError.MUTATE_NOT_PERMITTED_FOR_CUSTOMERMutateError.MUTATE_NOT_ALLOWED
Hotel & Travel
- Added support for Performance Max for travel goals with the following new
fields, resources, and enums:
- Fields
- Enums
- Added
TravelAssetSuggestionServiceto suggest required images and text assets (such as headlines, descriptions, long descriptions) to be used to create asset groups in Performance Max for travel goal campaigns. - Allowlisted customers only: Added support for Things to do ads
campaigns by adding the
following new fields, resources, and enums:
- Fields
Campaign.travel_campaign_settingsandTravelCampaignSettingsAd.travel_adandTravelAdInfoListingDimensionInfoactivity_idandActivityIdInfoactivity_ratingandActivityRatingInfoactivity_countryandActivityCountryInfo
- Enums
- For campaign creation
- For ad group creation
- For ad creation
- Errors
- Reports
- Fields
Recommendations
- The following feed-based recommendations are replaced with asset-based
recommendations:
Recommendation.call_extension_recommendationreplaced byRecommendation.call_asset_recommendationRecommendation.callout_extension_recommendationreplaced byRecommendation.callout_asset_recommendationRecommendation.sitelink_extension_recommendationreplaced byRecommendation.sitelink_asset_recommendation
- Added
Recommendation.campaignsto show the campaigns targeted by the recommendation. - Removed
ResponsiveSearchAdAssetRecommendation.current_ad.
Shopping
- Removed
ProductBiddingCategoryInfo.country_code. - Added support for
segments.product_feed_labelinshopping_performance_view.
Video
- Removed
PreferredContentInfoand its reference fromAdGroupBidModifier. - Added call-to-action fields for video bumper ads:
- Added
TargetCpm.target_frequency_goalandTargetCpmTargetFrequencyGoalto support providing additional details about the goal of the Target CPM bidding strategy. - Added
AdvertisingChannelSubType.VIDEO_REACH_TARGET_FREQUENCY. - Added
PlacementType.GOOGLE_PRODUCTS.
12.0.0 (2022-10-26)
The features and changes below were added in v12.
Account Management
- Added a new account link type,
ADVERTISING_PARTNERfor linking a customer account to another one. This is preparation for an upcoming feature in a following release. - Added
AccountLinkError.PERMISSION_DENIEDfor the case where a non-admin user tries to create an account link.
Ads
- Removed support for creating a new Gmail ad. Use Discovery campaigns instead.
Assets
- Added support for retrieving
CustomLeadFormSubmissionFieldthroughLeadFormSubmissionDatausingGoogleAdsService.SearchStreamorGoogleAdsService.Search. Added support for adding, updating, and removing
CampaignAssetandAdGroupAssetwith thefield_typeasAD_IMAGE(for allowlisted customers only).- You can retrieve stats for Image assets (
asset_field_type_view.field_type = AD_IMAGE) using theasset_field_type_viewreport.
- You can retrieve stats for Image assets (
The
asset_set_assetreport now supports metrics and segments.Added
ad_group_ad_asset_view.pinned_fieldto allow filtering by a pinned asset.Added support for
segment.conversion_actionto thead_group_ad_asset_viewreport.Added support for linking customers and ad groups with asset sets for test accounts only.
CustomerAssetSetServicefor adding/updating/removingCustomerAssetSet, which represents a link between aCustomerand anAssetSet.AdGroupAssetSetServicefor adding/updating/removingAdGroupAssetSet, which represents a link between anAdGroupand anAssetSet.
Added support for mutating and fetching location assets for test accounts only.
Fields:
- Added
Asset.location_assetwhose type isLocationAsset. - Added the following fields to
AssetSet:location_group_parent_asset_set_idasset_set_source(oneof field)location_set(use withCustomerAssetSet)business_profile_location_group(use withCampaignAssetSetandAdGroupAssetSet)chain_location_group(use withCampaignAssetSetandAdGroupAssetSet)
- Added
excluded_parent_asset_set_typestoCampaignandAdGroup.
- Added
Enums:
- Added
AssetType.LOCATION. - Added the following values to
AssetSetType:LOCATION_SYNCBUSINESS_PROFILE_DYNAMIC_LOCATION_GROUPCHAIN_DYNAMIC_LOCATION_GROUPSTATIC_LOCATION_GROUP
- Added
Reports (available for all accounts):
per_store_viewreturns stats at the place ID level. There are no stats returned yet; this is a future feature that was added so you can begin building your implementation against it.asset_set_type_viewreturns stats at theAssetSetTypelevel, which currently only supports location asset set.
Audiences
Added the following values to
OfflineUserDataJobFailureReason:HIGH_AVERAGE_TRANSACTION_VALUELOW_AVERAGE_TRANSACTION_VALUENEWLY_OBSERVED_CURRENCY_CODE
Bidding
Added support for linked portfolio bidding strategies and campaign budget. Bidding strategies and campaign budgets can modify these links using bulk mutates:
Billing
- Added
AccountSummaryasInvoice.account_summaries[]for reporting reconciliation (for allowlisted customers only). - Added
BillingSetupError.TOO_MANY_BILLING_SETUPS_FOR_PAYMENTS_ACCOUNT. - Added
AccountBudgetProposalError.INVALID_MASTER_SERVICE_AGREEMENT.
Campaigns
Changes in Smart campaigns:
- Updated
SmartCampaignSuggestService.SuggestKeywordThemesto generate more keyword theme suggestions for Smart campaigns and can suggest free-form keyword themes in some cases. - Improved error handling and added more user-facing error codes for
SmartCampaignSuggestService.SuggestKeywordThemes.
- Updated
Removed support for creating new Smart Display campaigns. Existing Smart Display campaigns still serve as usual.
OperationAccessDeniedError.CREATE_OPERATION_NOT_PERMITTEDis thrown if you try to create a new Smart Display campaign.
Added the following fields to
Campaign:primary_statusto provide insight into why a campaign is not serving or not serving optimally.primary_status_reasonsto provide reasons into why a campaign is not serving or not serving optimally. These reasons are aggregated to determineprimary_status.
Enabled adding and removing location targeting to Local Services campaigns except for proximity targeting.
- Added the following errors to
CampaignCriterionErrorfor the Local service campaigns:AT_LEAST_ONE_POSITIVE_LOCATION_REQUIRED_FOR_LOCAL_SERVICES_CAMPAIGNCANNOT_ADD_OR_REMOVE_LOCATION_FOR_LOCAL_SERVICES_CAMPAIGNCANNOT_TARGET_COUNTRY_FOR_LOCAL_SERVICES_CAMPAIGNLOCATION_INVALID_FOR_LOCAL_SERVICES_CAMPAIGNLOCATION_NOT_IN_HOME_COUNTRY_FOR_LOCAL_SERVICES_CAMPAIGNLOCATION_NOT_LAUNCHED_FOR_LOCAL_SERVICES_CAMPAIGN
- Added the following errors to
Conversions
conversion_tracking_idwill always be > 0 for all customers. Previously, this field could be 0 for customers who hadn't created any conversion actions before.- Added
debug_enabledfor performing all checks and returning errors if found when uploading enhanced conversions.
Criteria
Added the following asset set fields to
LocationGroupInfofor test accounts:enable_customer_level_location_asset_setlocation_group_asset_sets
Added the following values to
CriterionError:CANNOT_SET_ASSET_SET_FIELD_FOR_CUSTOMERCANNOT_SET_ASSET_SETS_WITH_FEED_ITEM_SETSCANNOT_SET_BOTH_ASSET_SET_AND_FEEDCANNOT_SET_FEED_OR_FEED_ITEM_SETS_FOR_CUSTOMERCANNOT_SET_GEO_TARGET_CONSTANTS_WITH_ASSET_SETSINVALID_LOCATION_GROUP_ASSET_SETS
Errors
Error codes returned for some invalid operations have changed for the following fields.
| Previous Error | New Error |
|---|---|
| BiddingError.BID_TOO_BIG | RangeError.TOO_HIGH |
| BiddingError.BID_TOO_SMALL | RangeError.TOO_LOW |
| FieldError.INVALID_VALUE | ContextError.OPERATION_NOT_PERMITTED_FOR_CONTEXT |
| BiddingStrategyError |
FieldError.IMMUTABLE_FIELD |
| MutateError.RESOURCE_READ_ONLY | MutateError.MUTATE_NOT_ALLOWED |
| OperationAccessDeniedError |
MutateError.MUTATE_NOT_ALLOWED |
Experiments
- Removed
CampaignExperimentServicein favor of the previously added new experiments. - Renamed
ExperimentArm.trialtoExperimentArm.experiment. - When you create a new experiment arm using
MutateExperimentArmsand setresponse_content_typeof your mutate request toMUTABLE_RESOURCE, it now also populates values inExperimentArm.in_design_campaigns.
Feeds
Added
LEGACY_FEED_TYPE_READ_ONLYto the following enums:
Planning
AudienceInsightsService.ListAudienceInsightsAttributesnow acceptsAudienceInsightsDimension.GEO_TARGET_COUNTRYandAudienceInsightsDimension.SUB_COUNTRY_LOCATION, enabling clients to discover the location criteria that can be used inAudienceInsightsService.- Added
AudienceInsightsService.ListInsightsEligibleDates(available to allowlisted accounts only), enabling clients to discover the set of date ranges that can be used inAudienceInsightsService. Removed
GenerateProductMixIdeasfromReachPlanService.Added
Targeting.plannable_location_ids, which supports targeting multiple geo locations within the same parent location in a single reach forecast.
Recommendations
- Added
RaiseTargetCpaBidTooLowRecommendationwhich identifies target CPA adjustments to help campaigns start serving. - Added
ForecastingSetTargetRoasRecommendationwhich identifies target ROAS adjustments to capture additional conversion value from expected traffic increases.
Reporting
- Added support for returning the number of clicks for sitelinks (when
segments.click_type= SITELINKS) in thelanding_page_viewreport. Added the following purchased traffic metrics:
Video
- Made
AdGroup.cpv_bid_microsmutable.
11.1.0 (2022-08-17)
The functionality and changes below were added in v11.1.
Assets
- Added
AssetGroup.ad_strengthto represent the overall quality of the asset group.- When advertisers mutate asset groups or assets associated with the asset
groups, this field is recalculated. Until the recalculation is finished, the
value is
PENDING.
- When advertisers mutate asset groups or assets associated with the asset
groups, this field is recalculated. Until the recalculation is finished, the
value is
- Added
AssetLinkError.EXCLUDED_PARENT_FIELD_TYPE.
Audiences
- Added
FlexibleRuleUserListInfoandRuleBasedUserListInfo.flexible_rule_user_list. - Added more values to the
LeadFormFieldUserInputTypeenum (used as predefined questions for lead form extensions). - Added the following fields to
UserAttribute:lifecycle_stagefirst_purchase_date_timeevent_attribute
- Added the following errors to
OfflineUserDataJobError:FIRST_PURCHASE_TIME_GREATER_THAN_LAST_PURCHASE_TIMEINVALID_LIFECYCLE_STAGEINVALID_EVENT_VALUEEVENT_ATTRIBUTE_ALL_FIELDS_ARE_REQUIRED
Bidding
- Added
Campaign.bidding_strategy_system_statusto show the system status of the bidding strategy, such as whether it is learning, limited, or misconfigured. Learn more.
Campaigns
- Added support for the following metrics in the campaign
report:
all_conversions_from_click_to_callall_conversions_from_directionsall_conversions_from_menuall_conversions_from_orderall_conversions_from_other_engagementall_conversions_from_store_visitall_conversions_from_store_website
- Made
metrics.phone_callcompatible withsegments.hourin the campaign report.
Experiments
- You can now create experiments using
GoogleAdsService.Mutate(). Previously, it was possible only when usingExperimentService.
Planning
Added
Targeting.audience_targeting, which allows for specifying affinity and in-market categories to generate a reach forecast usingReachPlanService.GenerateReachForecast.Added support for YouTube Select:
- Added support for returning
YouTubeSelectLineUpas product metadata when callingReachPlanService.ListPlannableProducts. - Added
PlannedProduct.advanced_product_targeting, which allows for specifyingYouTubeSelectSettingsto generate a reach forecast usingReachPlanService.GenerateReachForecast.
- Added support for returning
Added
AudienceInsightsService.GenerateAudienceCompositionInsights(available to allowlisted accounts only), used to find attributes strongly associated with a particular audience, similar to Insights Finder.
Recommendations
- Added
UpgradeLocalCampaignToPerformanceMaxRecommendation. Learn more. - Added
DisplayExpansionOptInRecommendation.
11.0 (2022-06-08)
The functionality and changes below were added in v11.0.
Assets
- Added
AssetSourceto show the source of asset or asset link for whom generated the entity. This is available assourceinAsset,CustomerAsset,CampaignAsset, andAdGroupAsset.
Audiences
- Removed
DateSpecificRuleUserListInfoandRuleBasedUserListInfo.date_specific_rule_user_list.
Bidding
- Renamed
MaximizeConversions.target_cpatoMaximizeConversions.target_cpa_micros.MaximizeConversions.target_cpaofAccessibleBiddingStrategyis renamed totarget_cpa_micros.
Campaigns
Smart campaigns
- Added
SmartCampaignSetting.ad_optimized_business_profile_settingandAdOptimizedBusinessProfileSettingto allow Smart campaigns to use business profiles optimized for ads as landing pages. - Added
SmartCampaignSetting.business_profile_locationto accept the resource names of the Google Business Profile location to associate with Smart campaigns. - Removed
SmartCampaignSetting.business_location_id, which is superseded bySmartCampaignSetting.business_profile_location.
- Added
Added
Campaign.performance_max_upgrade, whose type isPerformanceMaxUpgrade, to show the status information about a campaign being upgraded to Performance Max. Use the newUpgradeSmartShoppingCampaignToPerformanceMaxRecommendationto initiate the upgrade.The
search_click_sharemetric is now available for Performance Max campaigns.-
Added the
ManualCpabidding strategy andCampaign.local_services_campaign_settings, whose type isLocalServicesCampaignSettings.You can set bids of the
ManualCpabidding strategy throughLocalServicesCampaignSettings.category_bids.Added support for setting the
MaximizeConversionsbidding strategy as standard bidding strategy.Added support for setting ad schedules as a campaign criterion.
Conversions
Added two new fields to
FirebaseSettings:Added
ConversionAdjustmentUploadError.ORDER_ID_CONTAINS_PII.Removed
ConversionUploadError.EXTERNALLY_ATTRIBUTED_CONVERSION_TYPE_NOT_PERMITTED_WITH_BRAID.
Criteria
Experiments
- Removed
ExperimentType.SMART_DISPLAY.
Planning
- Added
KeywordPlanIdeaService.GenerateAdGroupThemes, which you can provide keywords and a list of ad groups. The method returns suggested modifications (such as keyword text and match type) of the keywords along with the suggested ad groups in which the keywords should be placed. - Added two methods to
AudienceInsightsServicethat are available to allowlisted accounts only:GenerateInsightsFinderReport, used to create links to audience insight reports in Insights Finder.ListAudienceInsightsAttributes, used to discover topics or categories for which insights are available.
Added several new fields to support co-viewing metrics in Reach Forecast.
Several new fields as part of
ReachForecast:In
Forecast:on_target_coview_reachtotal_coview_reachon_target_coview_impressionstotal_coview_impressionsIn
EffectiveFrequencyBreakdown:effective_coview_reachon_target_effective_coview_reachIn
PlannedProductForecast:on_target_coview_reachtotal_coview_reachon_target_coview_impressionstotal_coview_impressions
Added
ForecastMetricOption.include_coview, which is used inGenerateReachForecastRequest.forecast_metric_optionsas an option to request the above co-view metrics to be included in the response.
Recommendation
Reporting
- Made
segments.asset_interaction_target.assetandsegments.asset_interaction_target.interaction_on_this_assetcompatible withad_groupandcampaign.
Shopping
- Added
ShoppingSetting.feed_label, a more flexible way of matching campaigns with Merchant feeds. This field replaces the functionality ofShoppingSetting.sales_country. Only one of these fields can be used at a time, but both fields are supported. This is available to allowlisted accounts only.
10.1.0 (2022-04-27)
The functionality and changes below were added in v10.1.0.
Assets
- Added the following for lead
forms:
- Support for retrieving submitted lead form data through
LeadFormSubmissionDatausingGoogleAdsService.SearchandGoogleAdsService.SearchStream LeadFormAsset.custom_question_fields
- Support for retrieving submitted lead form data through
- Added the following asset types:
- Added
dynamic_real_estate_assettoAssetto support dynamic real estate assets. - Added
dynamic_custom_assettoAssetto support dynamic custom assets. - Added
dynamic_hotels_and_rentals_assettoAssetto support dynamic hotels and rentals assets. - Added
dynamic_flights_assettoAssetto support dynamic flights assets. - Added
dynamic_travel_assettoAssetto support dynamic travel assets. - Added
dynamic_local_assettoAssetto support dynamic local assets. - Added
dynamic_jobs_assettoAssetto support dynamic jobs assets.
- Added
- Added support for the following fields to
asset_group_product_group_view:asset_groupasset_group_listing_group_filter
- Added
ad_group_ad_asset_combination_view.enabled. - Added
AssetError.NAME_CONFLICT_FOR_ASSET_TYPE.
Audiences
- Added support for
metrics.absolute_top_impression_percentageandmetrics.top_impression_percentageincampaign_audience_viewandad_group_audience_view. - Added
ResourceLimitType.RULE_BASED_USER_LISTS_PER_CUSTOMER. - Added the following values to
AudienceError:AUDIENCE_SEGMENT_NOT_FOUNDAUDIENCE_SEGMENT_TYPE_NOT_SUPPORTEDDUPLICATE_AUDIENCE_SEGMENTTOO_MANY_SEGMENTSTOO_MANY_DIMENSIONS_OF_SAME_TYPEIN_USE
Batch Jobs
- Added
BatchJobOperation.removeto support removing batch jobs in thePENDINGstate.
Campaigns
- Added support for retrieving, creating, and updating Discovery campaigns, their ad groups, and their ads.
- Added support for retrieving, creating, and updating campaign
groups:
- Resource:
CampaignGroup - Service:
CampaignGroupService - Fields in other resources:
- Enums:
- Resource:
- Local Services campaigns, previously in Beta, are now in generally availability
- Added legacy support for the following dimensions to
ListingDimensionInfofor Display campaigns only:
Change History
- Added the following values to
ChangeEventResourceType:ASSET_SETASSET_SET_ASSETCAMPAIGN_ASSET_SET
Conversions
- Added
ConversionTrackingSetting.google_ads_conversion_customer, used to determine which Google Ads account is managing your account's conversions. - Added
ClickConversion.conversion_environmentto support reporting the environment on which a conversion was recorded. This feature is available to allowlisted accounts only. - Added support for
metrics.all_conversions_valueandmetrics.all_conversionsinconversion_action. - Added
ConversionValueRuleSetError.UNSUPPORTED_CONVERSION_ACTION_CATEGORIES. - Added
ConversionAdjustmentUploadError.MISSING_ORDER_ID_FOR_WEBPAGE. - Added
ConversionUploadError.CUSTOMER_NOT_ACCEPTED_CUSTOMER_DATA_TERMS.
Criteria
Experiments
Hotel Ads
- Added support for getting
hotel_center_idthroughAccountLink.hotel_center.
Planning
- Added
KeywordPlanIdeaService.GenerateKeywordHistoricalMetrics. It returns the historical metrics for a given list of keywords without asking for any plan, campaigns, or ad groups. - Added
KeywordPlanHistoricalMetrics.average_cpc_microswhich is the average cost per click in micros of a given keyword.- Added a new field
HistoricalMetricsOption.include_average_cpc, which is used inGenerateKeywordIdeasRequest.historical_metrics_optionsas an option to requestKeywordPlanHistoricalMetrics.average_cpc_microsto be included in the response. The default value if not specified isfalse.
- Added a new field
- Added
GenerateKeywordIdeaResult.close_variantswhich is the list of close variants from the requested keywords that are combined into thisGenerateKeywordIdeaResult.
Reporting
segments.click_typenow returnsCROSS_NETWORKfor Performance Max and Discovery campaigns.- Added the following fields for
SKAdNetwork
conversion segments, available when fetching the data of
customerorcampaign: - Made
metrics.absolute_top_impression_percentageandmetrics.top_impression_percentagecompatible withsegments.geo_target_regionandsegments.geo_target_city.
Video
10.0 (2022-02-09)
The functionality and changes below were added in v10.0.
All Services
The get method and any services that exclusively had a get method have been
removed. Retrieve objects with Search
and SearchStream from GoogleAdsService.
Account Management
- Added
Customer.statusandCustomerClient.status, whose type isCustomerStatus, to show the status of the account. customer_clientcontains inactive accounts in addition to active and test accounts.
Ads
- Renamed Video TrueView Discovery Ad format to In-Feed Video Ad:
VideoTrueViewDiscoveryAdInfois renamed toInFeedVideoAdInfo.AdType.VIDEO_TRUEVIEW_DISCOVERY_ADis renamed toAdType.IN_FEED_VIDEO_AD.
- Renamed
MutateOperation.customizer_customizer_operationtoMutateOperation.customer_customizer_operation.
Assets
- Added support for
ad_group_ad_asset_combination_viewfor responsive search ads. - Added support for reporting the performance of App pre registration
ads in
ad_group_ad_asset_view. - For Image and Media Bundle assets (
Assetthat hasimage_assetandmedia_bundle_assetset, respectively):- Made
namerequired. - Added support for auto-renaming the asset names on creation. If an asset exists with the same name but different content, it is renamed by appending the specified name with a timestamp and a counter.
- Made
- For the following asset types, if an asset with a different name having the same content already exists then the asset uploaded will be silently dropped.
- Added the following values related to asset sets to
ResourceLimitType:PAGE_FEED_ASSET_SETS_PER_CUSTOMERDYNAMIC_EDUCATION_FEED_ASSET_SETS_PER_CUSTOMERASSET_PER_PAGE_FEED_ASSET_SETASSET_PER_DYNAMIC_EDUCATION_FEED_ASSET_SET
- Added the following values to
AssetError:MOBILE_APP_INVALID_APP_IDMOBILE_APP_INVALID_FINAL_URL_FOR_APP_DOWNLOAD_URLNAME_REQUIRED_FOR_ASSET_TYPE
Audiences
- Added support for
Audienceused to create a targeting based on created dimensions, such as demographics or memberships in user lists and user interests:- Resource:
Audience - Service:
AudienceService - Fields in other resources:
- Enums:
- Resource:
Bidding
- Removed support for creating seasonality adjustments on manager accounts.
- Added the following values to
BiddingError:BIDDING_STRATEGY_AND_BUDGET_MUST_BE_ALIGNEDBIDDING_STRATEGY_AND_BUDGET_MUST_BE_ATTACHED_TO_THE_SAME_CAMPAIGNS_TO_ALIGNBIDDING_STRATEGY_AND_BUDGET_MUST_BE_REMOVED_TOGETHER
Campaigns
- Smart campaigns have exited open beta and entered general availability.
- Added support for Local Services
Ads campaigns as open
beta.
- They have
AdvertisingChannelTypeasLOCAL_SERVICES. - Added support for retrieving these campaigns using
SearchandSearchStream. - Added support for updating their
statusandamount_microsof their associatedCampaignBudgetobjects.
- They have
- Performance Max Campaigns now support asset group signals which advertisers can use to tell the campaign who's most likely to convert.
- Added
Campaign.use_vehicle_inventoryfor Smart Shopping campaigns.
Conversions
- Added the following fields to the
conversion_tracking_settingattribute ofCustomer:conversion_tracking_statusindicates whether the customer is using conversion tracking, and who is the conversion tracking owner.accepted_customer_data_termsindicates if the conversion tracking owner has accepted the customer data terms.enhanced_conversions_for_leads_enabledindicates if the customer has opted into enhanced conversions for leads.
- Made
ConversionAction.primary_for_goaloptional to support setting the value tofalseduringcreateoperations. - Made
ConversionValueRuleSet.attachment_typeimmutable. - Added
ConversionValueRuleSet.conversion_action_categoriesandValueRuleSetDimension.NO_CONDITIONto support conversion value rules for store visits and store sales. - Added the following values to
ConversionValueRuleSetError:INELIGIBLE_CONVERSION_ACTION_CATEGORIESDIMENSION_NO_CONDITION_USED_WITH_OTHER_DIMENSIONSDIMENSION_NO_CONDITION_NOT_ALLOWED
- Removed
LEADfrom theConversionActionCategoryenum and replaced with the following new values:QUALIFIED_LEADCONVERTED_LEAD
- Added
ExternalConversionSource.DISPLAY_AND_VIDEO_360_FLOODLIGHT.
Experiments
- Added a new
ExperimentServicewith a set of new resources, which is a replacement for campaign experiments.- Creating a new experiment and experiment arm through
GoogleAdsService.Mutate()is not supported yet.
- Creating a new experiment and experiment arm through
Hotel Ads
- Added
hotel_reconciliation.campaignand added support for the following metrics:
Recommendations
- Added support for returning
ResponsiveSearchAdAssetRecommendation. - Added support for returning
UseBroadMatchKeywordRecommendation.
Reporting
- Fixed inconsistencies where rows with zero metrics were returned when segments were selected in some reports. All reports will now follow the expected behavior of ignoring zero-metric rows in reports that select metrics and segments.
- Added a new meta parameter
omit_unselected_resource_names. When set totrue, the response fromGoogleAdsServicewill only return resource name fields that you explicitly request in theSELECTclause of your query. - When retrieving
Campaign.start_dateandCampaign.end_date, the date returned will always be formatted based on the time zone of the customer specified ascustomer_idofSearchGoogleAdsRequestorSearchGoogleAdsStreamRequest. Previously, the returned date could vary based on the time zone of the manager account specified inlogin-customer-id. - Added support for
metrics.absolute_top_impression_percentageandmetrics.top_impression_percentage- in
geographic_view - with
segments.hour
- in
- Added support for the following segments for
metrics.sk_ad_network_conversions(SKAdNetwork conversions), which is available when fetching the data ofcustomerorcampaign:segments.sk_ad_network_user_typesegments.sk_ad_network_ad_event_typesegments.sk_ad_network_source_app.sk_ad_network_source_app_id
- Added
metrics.biddable_app_install_conversionsandmetrics.biddable_app_post_install_conversions.
RMF
- Added new requirements for Performance Max and Smart campaigns. We are also documenting the required minimum functionality for other developer tools such as shopping, hotel and app campaigns, and simplifying standard shopping campaigns to align with full service campaigns.
9.0 (2021-11-03)
The functionality and changes below were added in v9.0.
Account Management
- Added the following errors:
Ads
- Added support for ad customizers for Responsive Search Ads through the following services:
- Added support for pre-registration ads which helps in pre-registering the app or game from the Play store to help gauge interest before an app or a game is available to install. For more information, see App campaigns for pre-registration.
- Added the following enums to
AdError:CALL_AD_VERIFICATION_URL_FINAL_URL_DOES_NOT_HAVE_SAME_DOMAINCALL_AD_FINAL_URL_AND_VERIFICATION_URL_CANNOT_BOTH_BE_EMPTYCUSTOMIZER_TYPE_FORBIDDEN_FOR_FIELDINVALID_CUSTOMIZER_ATTRIBUTE_NAME
Assets
- Added the following asset types, which will be available in all accounts by the end of 2021:
- Added support for asset groups for Performance Max:
- Added
AssetGroupServiceto allow for removingAssetGroup, which represents a bunch of assets. UseGoogleAdsService.mutateto create or update anAssetGroup. An asset group is used in a Performance Max campaign to group assets, a final URL, and audience signals. The asset group and the conversion goals are pulled together to create a campaign. - Added
AssetGroupAssetServiceto allow for adding/updating/removingAssetGroupAsset, which is a link between an asset and an asset group. - Added
AssetGroupListingGroupFilterServiceto allow for adding/updating/removingAssetGroupListingGroupFilter, which represents a listing group filter tree node in an asset group. - Added
asset_group_product_group_view, for retrieving product groups in an asset group. At the time of the release, requests for this view will return an error. The view will start returning data at a later date.
- Added
- Added support for asset sets:
- Added
AssetSetServiceto allow for adding/updating/removingAssetSet, which represents a collection of assets, which will eventually replace theFeedService.AssetSetTyperepresents feed types that are currently supported. - Added
AssetSetAssetServiceto allow for adding/updating/removingAssetSetAsset, which represents a link between an asset and an asset set. - Added
CampaignAssetSetServiceto allow for adding/updating/removingCampaignAssetSet, which represents a link between a campaign and an asset set.
- Added
- Added support for reporting the performance of the following ad types in
ad_group_ad_asset_view: - Added
AssetLinkError.YOUTUBE_VIDEO_DURATION_NOT_DEFINED. - Added
FeedError.LEGACY_EXTENSION_TYPE_READ_ONLYfor extension types migrated to Asset. TextAssetis now read/write.- Added values to
AssetError:CALL_CARRIER_SPECIFIC_SHORT_NUMBER_NOT_ALLOWEDCALL_CUSTOMER_CONSENT_FOR_CALL_RECORDING_REQUIREDCALL_DISALLOWED_NUMBER_TYPECALL_INVALID_CONVERSION_ACTIONCALL_INVALID_COUNTRY_CODECALL_INVALID_DOMESTIC_PHONE_NUMBER_FORMATCALL_INVALID_PHONE_NUMBERCALL_PHONE_NUMBER_NOT_SUPPORTED_FOR_COUNTRYCALL_PREMIUM_RATE_NUMBER_NOT_ALLOWEDCALL_VANITY_PHONE_NUMBER_NOT_ALLOWEDPRICE_HEADER_SAME_AS_DESCRIPTION
Audiences
- Added support for warnings for
OfflineUserDataJobServicethroughAddOfflineUserDataJobOperationsRequest.enable_warnings. Whenenable_warningsis set totrueand the request succeeds, any non-blocking errors relating to operation failures will be returned asAddOfflineUserDataJobResponse.warning. No warnings are returned if the request fails. Learn more. - Added
CreateOfflineUserDataJobRequest.enable_match_rate_range_preview. When it's set totrue, the match rate range for the uploaded offline user data job will be calculated and returned asOfflineUserDataJobMetadata.match_rate_range, which you can retrieve using the newly addedOfflineUserDataJob.operation_metadatafield.match_rate_rangeshows the range of the match rate (efficacy) of your Customer Match uploads, which is the number of matched user data rows divided by the total number of Customer Match uploaded rows.
- Added
UserAttribute.shopping_loyaltyto allow for sending loyalty-related data withUserAttribute. - Added
OfflineUserDataJobError.INVALID_ITEM_ID.
Bidding
- Added the following fields for
MaximizeConversionsandMaximizeConversionValueportfolio bidding strategies: - Removed support for
CampaignCriterionSimulationfor Shopping campaigns. - Removed support for
AdGroupSimulationfor Video campaigns.
Billing
- Added the following errors:
Campaigns
- Added support for Performance Max campaigns, which is a new campaign type that provides a unified buying service to virtually all Google Ads inventory.
Changes in Smart campaigns:
- Smart campaigns have entered open beta and users no longer need to be allowlisted to use them.
Added
SmartCampaignSuggestService.SuggestKeywordThemesto generate keyword theme suggestions for Smart campaigns based on the business details provided.This provides more comprehensive suggestions than
SuggestKeywordThemeConstants, and is now the recommended way to generate keyword themes for a Smart campaign.Improved error handling and additional user-facing error codes.
Conversions
- Added support for conversion goals to help you more easily optimize towards your advertising objects.
- Changes related to
ConversionAdjustmentUploadService:- Moved
gclid_date_time_pairandorder_idout of the oneof field ofConversionAdjustment.- If
adjustment_typeisENHANCEMENT,order_idis required. We recommend advertisers to setgclid_date_time_pairtoGclidDateTimePair.conversion_date_time.GclidDateTimePair.gclidis optional. - If
ConversionAdjustmentTypeis of other types, only one oforder_idandgclid_date_time_paircan be set. Otherwise, aGCLID_DATE_TIME_PAIR_AND_ORDER_ID_BOTH_SETerror is thrown.
- If
- Moved
- Changes related to
ConversionUploadService:- Changed
CartData.merchant_idfromstringtoint64. - Added
ClickConversion.gbraidandClickConversion.wbraidfields as click identifiers for iOS devices.
- Changed
- Made
UserIdentifier.user_identifier_sourceoptional. - Improved
ConversionUploadServiceandConversionAdjustmentServiceto report an error if theClickConversion,CallConversion, orConversionAdjustmentin a mutate operation already exists or is a duplicate to another one in the same mutate operation. Prior to v9, the Google Ads API would silently ignore such operations. The error returned by each service will be as follows:- For
ConversionUploadService:- For a click conversion: a
ConversionUploadErrorwithCLICK_CONVERSION_ALREADY_EXISTSorDUPLICATE_CLICK_CONVERSION_IN_REQUEST - For a call conversion: a
ConversionUploadErrorwithCALL_CONVERSION_ALREADY_EXISTSorDUPLICATE_CALL_CONVERSION_IN_REQUEST
- For a click conversion: a
- For
ConversionAdjustmentService:- For a restatement: a
ConversionAdjustmentUploadErrorwithRESTATEMENT_ALREADY_EXISTSorDUPLICATE_ADJUSTMENT_IN_REQUEST - For an enhancement: a
ConversionAdjustmentUploadErrorwithCONVERSION_ALREADY_ENHANCEDorDUPLICATE_ENHANCEMENT_IN_REQUEST
- For a restatement: a
- For
- Removed
INVALID_USER_IDENTIFIER_SOURCEfromConversionAdjustmentUploadErrorandConversionUploadError.
Feeds
Deprecated extension setting services:
AdGroupExtensionSettingServiceCampaignExtensionSettingServiceCustomerExtensionSettingServiceExtensionFeedItemService
Deprecated most use cases of feed service in favor of assets:
- All extensions apart from location extensions should migrate to assets.
- DSA page feed should migrate to assets.
- Dynamic remarketing for education should migrate to assets. Other dynamic remarketing types will follow in a release.
- Ad customizers are the only non-deprecated use case for feeds.
Hotel Ads
- Added support for retrieving
hotel_reconciliationresources, which contain booking information to reconcile bookings from commission campaigns. - Removed
HOTEL_ADS_COMMISSIONfromBudgetType.
Mutates
- Added
MutateError.OPERATION_DOES_NOT_SUPPORT_PARTIAL_FAILURE, thrown whenMutateGoogleAdsRequest.partial_failureis set totruebutMutateGoogleAdsRequest.mutate_operations[]contains mutate operations that don't support partial failure.
Planning
- Added
PlannableLocation.location_typewhich contains the location's type (COUNTRY,STATE, etc.). - Added
PlannableLocation.country_codewhich contains the ISO-3166-1 alpha-2 code associated with the location. - Added
CampaignDuration.date_rangewhich allows the duration of a planning campaign to be specified as a date range.
Reporting
A value for any of the following date-related segments in the WHERE clause must be the start of the field's period:
Fields Allowed filter values segments.weekYYYY-MM-DDwhereDDis the date that is Monday andYYYYandMMare valid year and month values, respectively.segments.monthYYYY-MM-01whereYYYYandMMare valid year and month values, respectively.segments.quarterYYYY-01-01orYYYY-04-01orYYYY-07-01orYYYY-10-01.Failing to set the correct values will result in a
MISALIGNED_DATE_FOR_FILTERerror.segments.sk_ad_network_conversion_valuenow supports distinguishing between 0 conversion value and conversion value missing from the postback received from Apple. Note that this feature will only be available for SKAdNetwork conversions received after September 20th, 2021.Published the
phone_calls,phone_impressions, andphone_through_ratemetric fields in the following resources:
RMF
- RMF requirements have been considerably simplified.
Video
- Added
VideoTrueViewDiscoveryAdInfo.thumbnail. - Added
VideoNonSkippableInStreamAdInfo.action_button_labelandVideoNonSkippableInStreamAdInfo.action_headline. - Removed the
optionalkeyword from the following fields to be consistent with their behaviors, since null and the default values of those fields (empty strings) have the same meaning for the Google Ads API: - Migrated Video ads from using
MediaFileto represent videos and images to using assets.- Changed the type of the following fields from
stringtoAdImageAsset: - Replaced
VideoAdInfo.media_file(available until v8) withVideoAdInfo.videoand changed the type fromstringtoAdVideoAsset.
- Changed the type of the following fields from
8.1.0 (2021-08-11)
The functionality and changes below were added in v8.1.0.
Ads
- Added
action_itemstoAdGroupAdto provide you with feedback to improve your ad strength.
Bidding
- Added support for seasonality
adjustments and data
exclusions, which can be applied to
specific campaigns, to all campaigns that belong to specific channel types, or
to specific devices:
- Added
BiddingSeasonalityAdjustmentto let Smart Bidding apply conversion rate adjustments for future events such as promotions or sales. - Added
BiddingDataExclusionto let Smart Bidding exclude data from specific dates when there are issues with an account's conversion tracking.
- Added
- Added
BiddingStrategyType.INVALIDto indicate a campaign does not have a bidding strategy and cannot serve. This can occur if a campaign was previously using a manager-owned bidding strategy before being unlinked from the manager account. In this case, the campaign would transition to theINVALIDbidding strategy type.
Campaigns
- Added
SmartCampaignSuggestService.SuggestSmartCampaignAd()to get suggestions for up to three headlines and two descriptions for Smart campaign ads based on information such as the landing page and keyword themes provided.
Change History
- Added the following resource types to
ChangeEventResourceType:AD_GROUP_ASSETASSETCAMPAIGN_ASSETCUSTOMER_ASSET
- Added the following new resource types to
ChangeStatusResourceType:AD_GROUP_ASSETASSETCAMPAIGN_ASSETCAMPAIGN_SHARED_SETCUSTOMER_ASSETSHARED_SET
Conversions
- Added
ConversionValueRuleandConversionValueRuleSetresources to adjust values of conversion events based on conditions like geographic location, device and audiences, and better express the value of conversions as they relate to your business. - Added
ClickConversion.user_identifiersto support uploading conversions with enhanced conversions for leads data - Added
ENHANCEMENTtoConversionAdjustmentTypeand the following fields to support uploading enhancements to existing conversions: - Added the following values to
ConversionUploadError:CLICK_NOT_FOUNDINVALID_USER_IDENTIFIEREXTERNALLY_ATTRIBUTED_CONVERSION_ACTION_NOT_PERMITTED_WITH_USER_IDENTIFIERUNSUPPORTED_USER_IDENTIFIERINVALID_USER_IDENTIFIER_SOURCE
- Added the following values to
ConversionAdjustmentUploadError:CUSTOMER_NOT_ACCEPTED_CUSTOMER_DATA_TERMSCONVERSION_ACTION_NOT_ELIGIBLE_FOR_ENHANCEMENTINVALID_USER_IDENTIFIERINVALID_USER_IDENTIFIERINVALID_USER_IDENTIFIER_SOURCE
Criteria
Planning
- Added
Forecast.effective_frequency_breakdownsto show a list of effective frequency forecasts. Effective frequency forecasts include the on-target and total number of unique people reached for a given effective frequency. - Added
GenerateReachForecastRequest.effective_frequency_limitwhich is used to createeffective_frequency_breakdownsof the generatedForecast.effective_frequency_limitis the highest minimum effective frequency (the number of times a person was shown the ad).
8.0 (2021-06-09)
The functionality and changes below were added in v8.0.
Account Management
- Added
CustomerClient.applied_labelsto show the labels applied to customers managed by the requesting manager customer.
Ads
CallOnlyAdInfois replaced withCallAdInfo.- Added
CANNOT_UPDATE_DEPRECATED_ADStoAdGroupAdError.
Asset
- Set
response_content_typetoMUTABLE_RESOURCEas a request parameter to return all the fields mutated in a mutate request forCustomerAssetService,CampaignAssetServiceandAdGroupAssetService. - Added support for the following metrics for
CustomerAsset,CampaignAssetandAdGroupAsset:absolute_top_impression_percentageall_conversionsall_conversions_from_interactions_rateall_conversions_valueaverage_costaverage_cpcaverage_cpeaverage_cpmaverage_cpvclicksconversionsconversions_from_interactions_rateconversions_valuecost_microscost_per_all_conversionscost_per_conversioncross_device_conversionsctrengagement_rateengagementsinteractionsinteraction_event_typesinteraction_rateimpressionstop_impression_percentagevalue_per_all_conversionsvalue_per_conversionvideo_view_ratevideo_views
- Added
segments.asset_interaction_targetforCustomerAsset,CampaignAssetandAdGroupAssetto indicate if the interactions are on the asset itself. - Added
AssetFieldTypeViewServiceto support retrieving metrics for each asset field type when the asset is used as extension. - Updated the following values of
LeadFormFieldUserInputType:- Replaced
GIVEN_NAMEwithFIRST_NAME. - Replaced
FAMILY_NAMEwithLAST_NAME.
- Replaced
- Asset-based extensions
SitelinkAsset,CalloutAsset,StructuredSnippetAsset, which were available for test accounts in v7, will be enabled for production accounts two weeks after this release.
Audiences
- Added
TransactionAttribute.item_attributeto support associate information about a sold item with a transaction. - Added the following fields to
UserAttribute:last_purchase_date_timeaverage_purchase_countaverage_purchase_value_microsacquisition_date_time
- Added the following values to
OfflineUserDataJobError:FUTURE_TIME_NOT_ALLOWEDLAST_PURCHASE_TIME_LESS_THAN_ACQUISITION_TIME
Bidding
- Updated
Maximize_conversion_value.target_roasto support an optional Target ROAS setting on the Maximize Conversion Value portfolio and standard bidding strategies for Search campaigns. This field will become mutable for all customers at a future date. We will post a notification on the Google Ads Developer blog when developers can update this field. - Updated
Maximize_conversions.target_cpato support an optional Target CPA setting on the Maximize Conversions portfolio and standard bidding strategies for Search campaigns. This field will become mutable for all customers at a future date. We will post a notification on the Google Ads Developer blog when developers can update this field. - Added support for creating and managing cross-account bidding
strategies
in manager accounts, and the ability to attach them to campaigns in customer
accounts:
- Added
BiddingStrategy.currency_codefor bidding strategies in manager customers, which can be set on creation and defaults to the manager customer's currency. For serving customers, this field cannot be set; all strategies in a serving customer implicitly use the serving customer's currency. In all cases theeffective_currency_codefield returns the currency used by the strategy. - Added
AccessibleBiddingStrategyto represent a view of all BiddingStrategies owned by and shared with the customer. - Added
AccessibleBiddingStrategyServiceto read accessible bidding strategies. - Added
Campaign.accessible_bidding_strategyfor retrieving the fields of the portfolio bidding strategy identified bybidding_strategy.When a campaign uses a cross-account bidding strategy, this will be a subset of the properties normally defined for a bidding strategy, since certain properties are only accessible by a bidding strategy’s owner.
- Added
Campaigns
- Replaced
CampaignError.PAYMENT_MODE_NOT_COMPATIBLE_WITH_VIEW_THROUGH_CONVERSIONwithCampaignError.NOT_COMPATIBLE_WITH_VIEW_THROUGH_CONVERSION_OPTIMIZATION. Reports incompatibilities with view through conversions setup. - Added support for Smart campaigns:
- Added new enum values to support Smart campaigns:
- Added
SmartCampaignSettingandSmartCampaignSettingServiceto configure Smart campaigns. - Added
KeywordThemeConstantServiceandSmartCampaignSuggestServiceto retrieve suggestions for Smart campaign budgets and keyword themes. - Added
smart_campaign_search_term_viewto retrieve performance metrics for Smart campaigns.
Conversions
- Added
ClickConversion.cart_datato support uploading conversions with shopping cart information. - Added
CONVERSION_NOT_COMPLIANT_WITH_ATT_POLICYtoConversionUploadError.
Criteria
- Added
DetailedDemographicServiceto retrieveUserInterestwithDetailedDemographicas theTaxonomyType.
Feeds
- Added
DYNAMIC_FILTER_INVALID_CHAIN_IDStoFeedItemSetError.
Recommendations
7.0 (2021-04-28)
The functionality and changes below were added in v7.0.
Account Management
- Updated
CustomerService.CreateCustomerClient,CustomerClientLinkService.MutateCustomerClientLink,CustomerManagerLinkService.MutateCustomerManagerLink,CustomerManagerLinkService.MoveManagerLink,MerchantCenterLinkService.MutateMerchantCenterLinkto enable settingvalidate_only. - Added
AccessInvitationError.EMAIL_DOMAIN_POLICY_VIOLATED.
Ads
- Added
AdGroupAd.labelsto allow for easier selection and filtering with labels. - Updated
AdService.MutateAdsto enable settingpartial_failure. - Updated
AdGroupAd.policy_summary.policy_topic_entriesof typeFULLY_LIMITEDto return an approval status ofDISAPPROVEDrather thanUNKNOWN. - Updated
MediaUploadErrorto include the valueDIMENSIONS_NOT_ALLOWED. - Updated
AdService.MutateAdsto enable settingvalidate_only.
Assets
- Added
CustomerAssetServiceandAdGroupAssetServiceto support adding new asset types. - Added
promotion_asset,final_mobile_urls,tracking_url_template,url_custom_parameters, andfinal_url_suffixtoAssetto support promotion assets. - Added assets for Test accounts only:
- Updated
AssetService.MutateAssetsto enable settingpartial_failure. - Added values to
AssetError:DUPLICATE_ASSETS_WITH_DIFFERENT_FIELD_VALUEPROMOTION_CANNOT_SET_PERCENT_OFF_AND_MONEY_AMOUNT_OFFPROMOTION_CANNOT_SET_PROMOTION_CODE_AND_ORDERS_OVER_AMOUNTSCHEDULES_CANNOT_OVERLAPTOO_MANY_DECIMAL_PLACES_SPECIFIED
- Added
INVALID_EXCLUDED_PARENT_ASSET_FIELD_TYPEtoAdGroupErrorandCampaignError. - Added
excluded_parent_asset_field_typestoCampaignandAdGroup. - Updated
AssetService.MutateAssetsto enable settingvalidate_only. - Added
INVALID_STATUStoAssetLinkError. - Added
PAUSEDtoAssetLinkStatus. - Updated
CampaignAsset.statusto be mutable. Updates are now allowed forCampaignAsset. - Updated
AdGroupAsset.statusto be mutable. Updates are now allowed forAdGroupAsset.
Audiences
- Updated
OfflineUserDataJobService.CreateOfflineUserDataJob,OfflineUserDataJobService.RunOfflineUserDataJob, andOfflineUserDataJobService.AddOfflineUserDataJobOperationsto enable settingvalidate_only.
Batch Jobs
- Set
response_content_typetoMUTABLE_RESOURCEas a request parameter to return all the fields mutated in a mutate request forBatchJobService.
Bidding
- Added
BiddingStrategySimulationServiceandCampaignSimulationServiceto support the management of shared bidding strategy simulations and campaigns simulations. - Set
response_content_typetoMUTABLE_RESOURCEas a request parameter to return all the fields mutated in a mutate request forBiddingStrategyService.
Campaigns
- Added
CampaignError.PAYMENT_MODE_NOT_COMPATIBLE_WITH_VIEW_THROUGH_CONVERSIONto report incompatibilities with view through conversions setup.
Campaign Drafts and Experiments
- Updated
CampaignDraftService.PromotCampaignDraftto enable settingvalidate_only. - Updated
CampaignExperimentService.GraduateCampaignExperiment,CampaignExperimentService.PromoteCampaignExperiment,CampaignExperimentService.EndCampaignExperiment,CampaignExperimentService.CreateExperimentto enable settingvalidate_only.
Conversions
- Added
ConversionCustomVariableServiceto support adding and updating custom variables while uploading offline conversions. - Added
CallConversion.custom_variablesandClickConversion.custom_variableswithConversionUploadError.CUSTOM_VARIABLE_NOT_ENABLEDandConversionUploadError.CUSTOM_VARIABLE_VALUE_CONTAINS_PIIto support uploading custom variables with an offline call conversion. - Set
response_content_typetoMUTABLE_RESOURCEas a request parameter to return all the fields mutated in a mutate request forConversionActionService.
Criteria
- Added
AdGroupCriterion.labelsto allow for easier selection and filtering with labels. - Added
AdGroupCriterion.display_nameandCampaignCriterion.display_name. - Added
coverage_percentageandsampletoWebpageInfo. - Added
WebpageViewServiceto support retrieving webpage criterion metrics. - Added
LifeEventServiceto retrieveUserInterestwithLifeEventas theTaxonomyType.
Feeds
- Updated
FeedItemTargetService.MutateFeedItemTargetsto enable settingpartial_failure. - Updated
FeedItemTargetService.MutateFeedItemTargetsto enable settingvalidate_only. - Set
response_content_typetoMUTABLE_RESOURCEas a request parameter to return all the fields mutated in a mutate request forCustomerExtensionSettingService. - Set
response_content_typetoMUTABLE_RESOURCEas a request parameter to return all the fields mutated in a mutate request forCampaignExtensionSettingService.
Hotel Ads
- Added
hotel_check_in_date_rangetoAdGroupBidModifier. By setting the range of dates, the bid will be modified if the user's check-in date falls within the range.
Planning
KeywordPlanIdeaService- Added
GenerateKeywordIdeasRequest.keyword_annotationfield to request annotation data for keywords.- Added
KeywordPlanKeywordAnnotation.KEYWORD_CONCEPTto retrieve the keyword concepts for each generated keyword idea.- Concepts are available in the Google Ads UI under Keyword Planner.
- A concept group is a cluster of related concepts. The
KeywordPlanConceptGroupTypeof the concept group identifies the type of classification performed to generate the concepts. - A concept is a semantic grouping of keywords within the concept group.
- Each keyword can belong to multiple concept groups, but only one concept within a concept group.
- When
keyword_annotationis requested, the annotations are returned inGenerateKeywordIdeaResult.keyword_annotations.- When
KEYWORD_CONCEPTis requested, the concepts are returned inGenerateKeywordIdeaResult.keyword_annotations.concepts.
- When
- Added
- Added
HistoricalMetricsOptions.year_month_rangeinGenerateKeywordIdeasRequest.historical_metrics_optionsfield to select the custom date range for the search volume. The default value if not specified is the last 12 months. - Added
KeywordPlanAggregateMetrics.aggregate_metrics_typestoGenerateKeywordIdeasRequest.aggregate_metricsto request aggregate metrics for the generated keyword ideas.- Added
KeywordPlanAggregateMetricType.DEVICEto request device breakdown of the average monthly search volume metrics for all the keyword ideas. - The device breakdown will be returned in the
GenerateKeywordIdeaResponse.aggregate_metric_results.device_searches.
- Added
- Added
KeywordPlanService- Added
HistoricalMetricsOptions.year_month_rangeinGenerateHistoricalMetricsRequest.historical_metrics_optionsfield to select the custom date range for the search volume. Thisyear_month_rangeaffects both keyword level and aggregate level metrics. - Added
KeywordPlanAggregateMetrics.aggregate_metrics_typestoGenerateHistoricalMetricsRequest.aggregate_metricsto request aggregate metrics for the keywords in the keyword plan.- Added
KeywordPlanAggregateMetricType.DEVICEto request device breakdown of the search volume metrics for all the keywords in the keyword plan. - The device breakdown will be returned in the
GenerateHistoricalMetricsResponse.aggregate_metric_results.device_searches.
- Added
- Added
ReachPlanService- Added
Forecast.viewable_impressionsandPlannedProductForecast.viewable_impressionswhich contain the number of times the ad's impressions were considered viewable.
- Added
Protos
- Updated the method comments in the proto library to include a list of possible errors that can be thrown for each method.
Recommendations
- Added
Recommendation.marginal_roi_campaign_budget_recommendation. This recommendation suggests adjusting a campaign's budget if we predict that its ROI will go up.
Reporting
- Added support for querying
SKAdNetwork
metrics with
segments.sk_ad_network_conversion_valueandmetrics.sk_ad_network_conversions.- The
segments.sk_ad_network_conversion_valuefield is only selectable with other date segments onCustomerandCampaign resources. - The
metrics.sk_ad_network_conversionsfield can only be segmented bysegments.sk_ad_network_conversion_valueand other date segments onCustomerandCampaignresources.
- The
- Added
click_view.keywordandclick_view.keyword_info, which contains information about the keyword associated with the GCLID if one is available. - Included
request-idin theGoogleAdsService.SearchStreamresponse andGoogleAdsFailuredetails.
Resources
- Added support for returning errors that specifically say which resources has
exceeded the limit when
ResourceCountLimitExceededError.RESOURCE_LIMITis returned:- Added
ResourceLimitTypeEnumto include which resource limit was exceeded. - Added
resource_count_detailstoErrorDetailsto include details of the maximum limit of the resource and the current count of the resource type in the account.
- Added
Tools
- Updated the reporting reference documentation to include a new and improved interactive Google Ads Query Language query builder.
Video
- Added
VIDEO_EFFICIENT_REACHtoAdGroupType.
6.1.0 (2021-02-10)
The functionality and changes below were added in v6.1.0.
Account Management
- Added
CustomerUserAccessInvitationServiceto manage access invitations extended to users for a Google Ads account. - Added
AuthorizationError.ACCESS_DENIED_FOR_ACCOUNT_TYPE.
Ads
- Added
AdOperation.policy_validation_parameterto support specifying how policies are validated, similar toAdGroupAdOperation.policy_validation_parameter. - Added
YoutubeVideoAsset.youtube_video_title. - Added the following errors to
AssetLinkError:IMAGE_NOT_WITHIN_SPECIFIED_DIMENSION_RANGEINVALID_PINNED_FIELDMEDIA_BUNDLE_ASSET_FILE_SIZE_TOO_LARGENOT_ENOUGH_AVAILABLE_ASSET_LINKS_FOR_VALID_COMBINATIONNOT_ENOUGH_AVAILABLE_ASSET_LINKS_WITH_FALLBACKNOT_ENOUGH_AVAILABLE_ASSET_LINKS_WITH_FALLBACK_FOR_VALID_COMBINATIONYOUTUBE_VIDEO_REMOVEDYOUTUBE_VIDEO_TOO_LONGYOUTUBE_VIDEO_TOO_SHORT
Campaigns
- Set
response_content_typetoMUTABLE_RESOURCEas a request parameter to return all the fields mutated in a mutate request forCampaignBidModifierService. - Set
response_content_typetoMUTABLE_RESOURCEas a request parameter to return all the fields mutated in a mutate request forCampaignSharedSetService. - Added
CampaignError.HEC_AGREEMENT_REQUIRED.
Change History
- Added new resource types
FEED,FEED_ITEM,CAMPAIGN_FEED,AD_GROUP_FEED,AD_GROUP_ADtoChangeEventResourceType.
Conversions
- Added
ThirdPartyAppAnalyticsSettings.provider_nameto support linking the third-party app analytics provider toConversionAction.
Criteria
- Set
response_content_typetoMUTABLE_RESOURCEas a request parameter to return all the fields mutated in a mutate request forCustomerNegativeCriterionService. - Set
response_content_typetoMUTABLE_RESOURCEas a request parameter to return all the fields mutated in a mutate request forSharedCriterionService. - Added
COMBINED_AUDIENCEto the list of possible values forCriterionType.
Feeds
- Added support for
FEED_ITEM_SET_IDinMatchingFunction.function_string. - Set
response_content_typetoMUTABLE_RESOURCEas a request parameter to return all the fields mutated in a mutate request forFeedMappingService.
Hotel Ads
- Added the values
LOWEST_UNIQUEandONLY_PARTNER_SHOWNtoHotelPriceBucketin preparation for the upcoming changes to Hotel Ads pricing buckets. These values will not be returned from the API until the date listed in the blog post, but you can start development preparing for this change now.
Recommendations
- Added support for
ResponsiveSearchAdRecommendation.
Reporting
- Added the following conversion-related fields:
- Updated the following fields to be selectable with
Segments.hour. - Added the
call_viewresource for reporting on call extensions and call only ads. This view provides equivalent functionality to theCALL_METRICS_CALL_DETAILS_REPORTin the AdWords API.
Resources
- Improved an error message thrown when a malformed resource name is passed by
also showing the correct form. For example,
customers/{customer_id}/customerUserAccesses/{user_id}instead ofcustomers/{part_1}/customerUserAccesses/{part_2}.
6.0.0 (2020-11-05)
The functionality and changes below were added in v6.0.0.
Account Management
- Added
CustomerUserAccessto support managing users in a Google Ads account. - Added support for updates in
AccountLinkService.
Ads
- Added
ExtensionFeedItem.image_feed_itemto support image extensions. - Added
ResponsiveDisplayAdInfo.control_spec. - Added
AdAsset.asset_performance_labelandAdAsset.policy_summary_infoto be used with responsive search ads. - Added
AssetFieldType.LEAD_FORMto support lead form extensions. - Added
Asset.policy_summary. - Added
MediaUploadError.MEDIA_UPLOAD_ERROR_CUSTOM_EXIT_NOT_ALLOWED.
Audiences
- Added
UserList.match_rate_percentagefor Customer Match user lists. - Added
UserData.user_attributes,UserIdentifier.user_identifier_source, andOfflineUserDataJobType.CUSTOMER_MATCH_WITH_ATTRIBUTESto support Customer Match with user attributes uploads. - Added
CombinedAudienceto create the audience withAdGroupCriterion.combined_audienceandCampaignCriterion.combined_audiencefor targeting. - Added
CustomAudiencewithAdGroupCriterion.custom_audienceandCampaignCriterion.custom_audiencefor targeting. - Uploading
STORE_SALES_UPLOAD_THIRD_PARTYdata withOfflineUserDataJobServicewill requireuser_identifier_sourceto specify whether a user identifier is first-party or third-party.
Bidding
- Added
BiddingStrategy.maximize_conversion_valueandBiddingStrategy.maximize_conversionsto support these bidding strategies as portfolio bidding strategies. - Added
MaximizeConversions.target_cpa.
Billing
- Added the following fields to
Invoice:adjustments_subtotal_amount_microsadjustments_tax_amount_microsadjustments_total_amount_microsregulatory_costs_subtotal_amount_microsregulatory_costs_tax_amount_microsregulatory_costs_total_amount_micros
- Removed
Invoice.invoice_level_adjustment_micros.
Campaigns
- Added segment:
Change History
- Added the resource
ChangeEventto retrieve the Change History of a Google Ads account. This is similar to Change History in the UI, including retrieving what interface made the change and who made the change.
Client libraries
- The API finished moving towards using field
presence
such as
optional stringandoptional doubleinstead of wrapper types such asStringValueandDoubleValue. Your code will be easier to use and more concise with payloads that are significantly smaller. Approximately half of our resources have been updated in this release; the other half was updated in v5. The full list is in the migration guide, and our code examples have been updated. - Added a separator (
~) for compound IDs in resource name patterns. For example, inad_group_ad.proto,customers/{customer}/adGroupAds/{ad_group_ad}changed tocustomers/{customer_id}/adGroupAds/{ad_group_id}~{ad_id}.
Criteria
- Added support for feed item sets in location criterion with:
- Display names have been updated for some constants. The following fields are affected. See the migration guide for details:
- Added
CriterionError.CANNOT_TARGET_PLACEMENTS_FOR_SEARCH_CAMPAIGNS.
Feeds
- Set
response_content_typetoMUTABLE_RESOURCEas a request parameter to return all the fields mutated in a mutate request forFeedItemTargetService.
Planning
- Added
ProductMetadata.plannable_product_namewhich contains the name of the product. - Replaced
ReachForecast.forecasted_product_allocationswithReachForecast.planned_product_reach_forecasts;planned_product_reach_forecastscontains budget allocations and forecasts for each product.
Recommendations
- Added
Customer.optimization_score_weight. This is only available for non-manager accounts and is used to determine the overall optimization score of the manager account. Retrieve the optimization score and optimization score weight of sub-accounts and multiply them (Customer.optimization_score * Customer.optimization_score_weight) to determine the overall optimization score. - Added support for the recommendation type
FORECASTING_CAMPAIGN_BUDGET.
Reporting
- Updated
Metrics.conversions_value_per_costto be selectable withKeywordView.
5.0.0 (2020-08-26)
The functionality and changes below were added in v5.0.0.
Account Management
- Replaced
AccountLinkOperation.createwithAccountLinkService.CreateAccountLink. AddedThirdPartyAppAnalyticsLinkService.RegenerateShareableLinkId. This is for customers on an allowlist. Added the following to support this feature: - Added errors:
- Renamed the following errors:
AuthorizationError.DEVELOPER_TOKEN_NOT_WHITELISTEDtoAuthorizationError.DEVELOPER_TOKEN_NOT_ON_ALLOWLIST.FieldError.BLACKLISTED_VALUEtoFieldError.BLOCKED_VALUENotWhitelistedErrortoNotAllowlistedError.NotWhitelistedError.CUSTOMER_NOT_WHITELISTED_FOR_THIS_FEATUREtoNotAllowlistedError.CUSTOMER_NOT_ALLOWLISTED_FOR_THIS_FEATURE.
Ads
- Updated
AdGroupAd.policy_summaryto make subfields selectable and to make non-repeated subfields filterable. - Added
MediaImage.full_size_image_urlandMediaImage.preview_size_image_url. - Added
MediaBundle.url. - Updated
AdGroupAdAssetViewto return removed assets. - Renamed
AssetError.CUSTOMER_NOT_WHITELISTED_FOR_ASSET_TYPEtoAssetError.CUSTOMER_NOT_ON_ALLOWLIST_FOR_ASSET_TYPE. - Added errors:
AssetLinkError.UNSUPPORTED_FIELD_TYPEAssetLinkError.FIELD_TYPE_INCOMPATIBLE_WITH_ASSET_TYPEAssetLinkError.FIELD_TYPE_INCOMPATIBLE_WITH_CAMPAIGN_TYPEMediaUploadError.ANIMATED_VISUAL_EFFECTMediaUploadError.ANIMATION_TOO_LONGMediaUploadError.ASPECT_RATIO_NOT_ALLOWEDMediaUploadError.AUDIO_NOT_ALLOWED_IN_MEDIA_BUNDLEMediaUploadError.CMYK_JPEG_NOT_ALLOWEDMediaUploadError.FLASH_NOT_ALLOWEDMediaUploadError.FRAME_RATE_TOO_HIGHMediaUploadError.GOOGLE_WEB_DESIGNER_ZIP_FILE_NOT_PUBLISHEDMediaUploadError.IMAGE_CONSTRAINTS_VIOLATEDMediaUploadError.INVALID_MEDIA_BUNDLEMediaUploadError.INVALID_MEDIA_BUNDLE_ENTRYMediaUploadError.INVALID_MIME_TYPEMediaUploadError.INVALID_PATHMediaUploadError.LAYOUT_PROBLEMMediaUploadError.MALFORMED_URLMediaUploadError.MEDIA_BUNDLE_NOT_ALLOWEDMediaUploadError.MEDIA_BUNDLE_NOT_COMPATIBLE_TO_PRODUCT_TYPEMediaUploadError.MEDIA_BUNDLE_REJECTED_BY_MULTIPLE_ASSET_SPECSMediaUploadError.TOO_MANY_FILES_IN_MEDIA_BUNDLEMediaUploadError.UNSUPPORTED_GOOGLE_WEB_DESIGNER_ENVIRONMENTMediaUploadError.UNSUPPORTED_HTML5_FEATUREMediaUploadError.URL_IN_MEDIA_BUNDLE_NOT_SSL_COMPLIANTMediaUploadError.VIDEO_FILE_NAME_TOO_LONGMediaUploadError.VIDEO_MULTIPLE_FILES_WITH_SAME_NAMEMediaUploadError.VIDEO_NOT_ALLOWED_IN_MEDIA_BUNDLE
Audiences
- Renamed the following errors:
OfflineUserDataJobError.NOT_WHITELISTED_FOR_USER_IDtoOfflineUserDataJobError.NOT_ON_ALLOWLIST_FOR_USER_IDOfflineUserDataJobError.NOT_WHITELISTED_FOR_STORE_SALES_DIRECTtoOfflineUserDataJobError.NOT_ON_ALLOWLIST_FOR_STORE_SALES_DIRECTOfflineUserDataJobError.NOT_WHITELISTED_FOR_UNIFIED_STORE_SALEStoOfflineUserDataJobError.NOT_ON_ALLOWLIST_FOR_UNIFIED_STORE_SALESUserListError.ADVERTISER_NOT_WHITELISTED_FOR_USING_UPLOADED_DATAtoUserListError.ADVERTISER_NOT_ON_ALLOWLIST_FOR_USING_UPLOADED_DATA
Batch jobs
- Removed
BatchJobOperation.removeas jobs in aPENDINGstate will automatically be removed after 1 day. - Added
BatchJobMetadata.start_date_time.
Bidding
- Added
BiddingStrategy.effective_currency_code. - Added
campaign_bid_modifiertoGoogleAdsService.SearchandGoogleAdsService.SearchStream. - Added support for Percent CPC in simulations:
- Added
PERCENT_CPC_BIDtoSimulationType. - Added
percent_cpc_bid_point_listtoAdGroupCriterionSimulation.
- Added
- Updated
AdGroupBidModifier.criterionto be required on creation. - Updated
CampaignBidModifier.criterionto be required on creation.
Campaigns
- Added the ability to select
segments.budget_campaign_association_statuswithcampaign_budget. Thecampaign_idwill always be returned in queries to thecampaign_budgetresource. - Updated
DynamicSearchAdsSetting.feedsto be settable. - Updated
Campaign.start_dateandCampaign.end_dateto be filterable. - Added
BudgetPeriod.CUSTOM_PERIOD.
Client libraries
- The API is moving towards using field
presence
such as
optional stringandoptional doubleinstead of wrapper types such asStringValueandDoubleValue. Your code will be easier to use and more concise with payloads that are significantly smaller. Approximately half of our resources have been updated in this release. The full list is in the migration guide, and our code examples have been updated. The rest of the resources will change to field presence in a future release.
Constants
Conversions
Added the following values to
ConversionActionTypeEnum.ConversionActionType:ANDROID_APP_PRE_REGISTRATIONANDROID_INSTALLS_ALL_OTHER_APPSFLOODLIGHT_ACTIONFLOODLIGHT_TRANSACTIONGOOGLE_HOSTEDLEAD_FORM_SUBMITSALESFORCESEARCH_ADS_360SMART_CAMPAIGN_AD_CLICKS_TO_CALLSMART_CAMPAIGN_MAP_CLICKS_TO_CALLSMART_CAMPAIGN_MAP_DIRECTIONSSMART_CAMPAIGN_TRACKED_CALLSSTORE_VISITS
More information about these conversion action types is available in the additional conversion action types guide.
Feeds
- Added
ExtensionSettingError.DISALLOWED_TEXT. - Renamed the following errors:
ExtensionFeedItemError.CUSTOMER_NOT_WHITELISTED_FOR_CALLTRACKINGtoExtensionFeedItemError.CUSTOMER_NOT_ON_ALLOWLIST_FOR_CALLTRACKINGExtensionSettingError.CUSTOMER_NOT_WHITELISTED_FOR_CALLTRACKINGtoExtensionSettingError.CUSTOMER_NOT_ON_ALLOWLIST_FOR_CALLTRACKINGFeedItemValidationError.CUSTOMER_NOT_WHITELISTED_FOR_CALLTRACKINGtoFeedItemValidationError.CUSTOMER_NOT_ON_ALLOWLIST_FOR_CALLTRACKING
Hotel Ads
- Added a new service
CampaignAssetServicewithAssetFieldType.BOOK_ON_GOOGLEandAssetLinkStatusto create Hotel AdsBOOK_ON_GOOGLElinks.
Limits
- Added more detailed errors when a developer is exceeding either the account rate limits or the developer token rate limits. The error will include if it was the account or the developer token with details on the limit that was reached.
Planning
- Added
KeywordPlanKeywordHistoricalMetrics.close_variants[]to return the close variant keywords that have been merged to compute the historical metrics. - Added
KeywordPlanService.GenerateForecastTimeSeriesthat returns the weekly forecast trend for Keyword Plan for the next 52 weeks.
Recommendations
- Added Recommendation
TargetRoasOptInRecommendation.
Reporting
Request Parameters
- Set
response_content_typetoMUTABLE_RESOURCEas a request parameter to return all the fields mutated in a mutate request. This was added to some services includingGoogleAdsService.Mutate. By default only the resource name is returned on a mutate.
Resources
- 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
UNKNOWNreturned in enum types. These are the fields that are affected:AccountLink.typeAd.typeAdGroupCriterion.typeAsset.typeCampaign.advertising_channel_sub_typeCampaign.advertising_channel_typeChangeStatus.resource_typeConversionAction.typeCustomInterest.typeDetailPlacementView.placement_typeGroupPlacementView.placement_typeMobileDeviceConstant.typeOfflineUserDataJob.statusSharedSet.typeUserList.type
Shopping
- Updated
LandingPageViewto include shopping metrics.
Video
- Added
AdvertisingChannelSubType.VIDEO_SEQUENCEfor video sequence campaigns. - Added
VideoResponsiveAdInfofor video responsive ads. - Renamed the following metrics:
metrics.video_quartile_100_rate->metrics.video_quartile_p100_ratemetrics.video_quartile_75_rate->metrics.video_quartile_p75_ratemetrics.video_quartile_50_rate->metrics.video_quartile_p50_ratemetrics.video_quartile_25_rate->metrics.video_quartile_p25_rate
4.0.0 beta (2020-07-08)
The functionality and changes below were added in v4.0.0.
Account Management
- Added
ThirdPartyAppAnalyticsLinkServiceandAccountLinkService. This lets users create a link between a third-party app and Google Ads. A user can use these links to import data and view metrics to manage campaigns. - Added
linked-customer-idto the request header. This header is only required for methods that update the resources of an entity when permissioned using Linked Accounts in the Google Ads UI (AccountLinkresource in the Google Ads API). Set this value to the customer ID of the data provider that updates the resources of the specified customer ID. It should be set without dashes, for example1234567890instead of123-456-7890. Learn more about Linked Accounts. - Added
CreateCustomerClientResponse.invitation_link, which is a link for inviting users to access the created customer. This is accessible to allowlisted customers only, and the allowlist is currently closed.
Ads
- Changed the format of
AdGroupAdAssetView.resource_namefromcustomers/{id}/adGroupAdAssets/{id}tocustomers/{id}/adGroupAdAssetViews/{id}. - Added support for local ads with
AdType.LOCAL_ADandAd.local_ad.
Audiences
- Added support to remove user data by adding
UserDataOperation.removetoUserDataService. - Changed
OfflineUserDataJobfields to have the correct annotation ofImmutable: - Added error values to
OfflineUserDataJobError:CUSTOM_KEY_DISABLEDCUSTOM_KEY_NOT_PREDEFINEDCUSTOM_KEY_NOT_SETNOT_WHITELISTED_FOR_UNIFIED_STORE_SALES
Batch Jobs
- Renamed
MutateJobServicetoBatchJobService. This service is not yet available for general use, but you can start coding against the service.
Bidding
- Added support for Target ROAS in simulations:
- Added
TARGET_ROAStoSimulationType. - Added
target_roas_point_listtoAdGroupSimulation.
- Added
- Updated
AdGroup,AgeRangeView,KeywordView, andParentalStatusViewto be selectable withBiddingStrategy.
Billing
- Added
CANNOT_CREATE_BUDGET_THROUGH_APItoAccountBudgetProposalError.
Campaigns
- Added support for Local Campaigns. Create a local campaign by setting the
Campaign.advertising_channel_typetoLOCAL,Campaign.advertising_channel_sub_typetoLOCAL_CAMPAIGN,Campaign.local_campaign_setting.location_source_typetoGOOGLE_MY_BUSINESS, andCampaign.optimization_goal_settingto a value. You currently cannot filter on location when creating a Local campaign. Use the Google Ads UI or Google Ads Editor to do location filtering. - Added
SETTING_VALUE_NOT_COMPATIBLE_WITH_CAMPAIGNtoSettingError. - Added support to retrieve Smart
campaigns with
Campaign.advertising_channel_typeset toSMART.
Conversions
- Added new values to
ConversionActionTypeto include:FIREBASE_ANDROID_FIRST_OPENFIREBASE_ANDROID_IN_APP_PURCHASEFIREBASE_ANDROID_CUSTOMFIREBASE_IOS_FIRST_OPENFIREBASE_IOS_IN_APP_PURCHASEFIREBASE_IOS_CUSTOMSTORE_SALESSTORE_SALES_DIRECT_UPLOADTHIRD_PARTY_APP_ANALYTICS_ANDROID_FIRST_OPENTHIRD_PARTY_APP_ANALYTICS_ANDROID_IN_APP_PURCHASETHIRD_PARTY_APP_ANALYTICS_ANDROID_CUSTOMTHIRD_PARTY_APP_ANALYTICS_IOS_FIRST_OPENTHIRD_PARTY_APP_ANALYTICS_IOS_IN_APP_PURCHASETHIRD_PARTY_APP_ANALYTICS_IOS_CUSTOM
- Added
CREATION_NOT_SUPPORTEDtoConversionActionError.
Criteria
- Added
disapproval_reasonstoAdGroupCriterion. - Added
income_range_viewto retrieve income range metrics.
Hotel Ads
- Added support for booking on Google assets with
AssetType.BOOK_ON_GOOGLEandAsset.book_on_google_asset. - Added
metrics.hotel_eligible_impressions.
Planning
KeywordPlanIdeaService- Keyword ideas returned per query will generally be more relevant and
fewer. We now try only to return keyword ideas that are more specific than
the search term. Some examples:
- A search for "jacket" returns "denim jacket" and "black windbreaker" but not "clothing".
- A search for "vacuum" returns "lightweight vacuum" and "robot vacuum" but not "cleaning products".
- A search for "dogs" returns "corgi" and "german shepherd" but not "animal".
- If the keywords we return are too specific, try searching for a more general term.
- Added fields for historical metrics in keyword plan ideas:
- Added
GenerateKeywordIdeasRequest.include_adult_keywordsso adult keyword ideas can be requested. - Added
GenerateKeywordIdeasRequest.site_seedso keyword ideas can be generated for the site. - Added paging support to the
GenerateKeywordIdeasmethod.
- Keyword ideas returned per query will generally be more relevant and
fewer. We now try only to return keyword ideas that are more specific than
the search term. Some examples:
KeywordPlanService- Added fields for historical metrics in keyword plans:
- Added
KeywordPlanService.GenerateForecastCurveto generate a forecast curve for a plan. Curve provides forecast metrics for the keyword plan at different cost per click (CPC) bid points.
- Added
KeywordPlanAdGroupKeywordServiceto manage keyword plan ad group keywords.- Both ad group positive and negative keywords are supported.
- Added
KeywordPlanCampaignKeywordServiceto manage keyword plan campaign keywords.- Only campaign negative keywords are supported.
- Removed
KeywordPlanKeywordService. The replacement isKeywordPlanAdGroupKeywordService. - Removed
KeywordPlanNegativeKeywordService. The replacement is eitherKeywordPlanAdGroupKeywordServiceorKeywordPlanCampaignKeywordService. - Added errors:
- Added
GenerateReachForecastRequest.cookie_frequency_cap_settingto allow specifying a frequency cap time unit other than month toReachPlanService.
Recommendations
- Added
Customer.optimization_score.
Reporting
- Starting in v4,
segments.date,segments.week,segments.month,segments.quarter, andsegments.yearwill function as follows:- These segments can be filtered in the
WHEREclause without being required in theSELECTclause. - If any of these segments are in the
SELECTclause, at least one of these segments should have a finite date range specified in theWHEREclause.
- These segments can be filtered in the
Shopping
- Moved errors from
AdGroupCriterionErrortoCriterionError:INVALID_LISTING_GROUP_HIERARCHYLISTING_GROUP_UNIT_CANNOT_HAVE_CHILDRENLISTING_GROUP_SUBDIVISION_REQUIRES_OTHERS_CASELISTING_GROUP_REQUIRES_SAME_DIMENSION_TYPE_AS_SIBLINGSLISTING_GROUP_ALREADY_EXISTSLISTING_GROUP_DOES_NOT_EXISTLISTING_GROUP_CANNOT_BE_REMOVEDINVALID_LISTING_GROUP_TYPELISTING_GROUP_ADD_MAY_ONLY_USE_TEMP_ID
- Renamed the following errors inside
CriterionError:PRODUCT_FILTER_TOO_LONG -> LISTING_SCOPE_TOO_LONGPRODUCT_SCOPE_TOO_MANY_DIMENSIONS -> LISTING_SCOPE_TOO_MANY_DIMENSIONSPRODUCT_PARTITION_TOO_LONG -> LISTING_GROUP_TOO_LONGPRODUCT_PARTITION_TOO_MANY_DIMENSIONS -> LISTING_GROUP_TREE_TOO_DEEPINVALID_PRODUCT_DIMENSION -> INVALID_LISTING_DIMENSIONINVALID_PRODUCT_DIMENSION_TYPE -> INVALID_LISTING_DIMENSION_TYPE
- Merged the following errors in
CriterionError:INVALID_PRODUCT_FILTER and INVALID_PRODUCT_DIMENSION -> INVALID_LISTING_DIMENSIONPRODUCT_SCOPE_TOO_LONG and PRODUCT_FILTER_TOO_LONG -> LISTING_SCOPE_TOO_LONG
3.1.0 beta (2020-04-29)
The functionality and changes below were added in v3.1.0.
Account Management
Ads
- Added errors:
Audiences
- Added a new service
OfflineUserDataJobServicewhich supports asynchronous upload of Customer Match data and store sales (direct upload) data. These features have restricted access. - Added a new service
UserDataServicefor uploading small batches of Customer Match data concurrently. This feature has restricted access.
Billing
- Added support for retrieving the paying manager
customer with
PaymentsAccount.paying_manager_customerwhen making a request toPaymentsAccountService.ListPaymentsAccounts. - Added errors:
Conversions
- Added new values to
ConversionActionCategoryto include:
Criteria
- Added errors:
CriterionError.CANNOT_SET_BIDS_ON_LISTING_GROUP_SUBDIVISIONCriterionError.DUPLICATE_LISTING_DIMENSION_TYPECriterionError.DUPLICATE_LISTING_DIMENSION_VALUECriterionError.LISTING_SCOPE_IN_OPERATOR_NOT_SUPPORTEDCriterionError.LISTING_SCOPE_TOO_MANY_DIMENSION_TYPESCriterionError.LISTING_SCOPE_TOO_MANY_IN_OPERATORS
Hotel Ads
AdGroupType.PROMOTED_HOTEL_ADSad groups are now enabled for only allowlisted customers.
Recommendations
- Added support for retrieving campaign optimization
score in
Campaign.optimization_score.
Reporting
- Added support to segment
metrics.content_impression_sharebysegments.hour.
Video
- Added support for retrieving video responsive ads.
- Added
AdGroupType.VIDEO_RESPONSIVE. - Added
AdType.VIDEO_RESPONSIVE_AD.
- Added
3.0.0 beta (2020-02-27)
The functionality and changes below were added in v3.0.0.
Account Management
- Added errors:
- Added support for moving a client customer to a new manager customer with
CustomerManagerLinkService.MoveManagerLink. - Added support for returning test customers in
CustomerClient. Filter out test accounts using theCustomerClient.test_accountfield.
Ads
- Added errors:
AdError.AD_CUSTOMIZERS_MAY_NOT_BE_ADJACENTAdError.PLACEHOLDER_CANNOT_HAVE_EMPTY_DEFAULT_VALUEAdError.PLACEHOLDER_COUNTDOWN_FUNCTION_CANNOT_HAVE_DEFAULT_VALUEAdError.PLACEHOLDER_DEFAULT_VALUE_MISSINGAdError.UNEXPECTED_PLACEHOLDER_DEFAULT_VALUEAdError.UPDATING_AD_WITH_NO_ENABLED_ASSOCIATIONImageError.IMAGE_CONSTRAINTS_VIOLATEDMediaUploadError.EXTERNAL_URL_NOT_ALLOWEDMediaUploadError.INVALID_URL_REFERENCEMediaUploadError.MISSING_PRIMARY_MEDIA_BUNDLE_ENTRYStringLengthError.EMPTY
Billing
- Updated
PaymentsAccountService.ListPaymentsAccountsto returnPaymentsAccountError.NOT_SUPPORTED_FOR_MANAGER_CUSTOMERwhen making a request to a manager account. - Added errors:
Campaigns
- Removed
BiddingStrategy.page_one_promoted. - Removed
BiddingStrategy.target_outrank_share. - Removed the following unused errors:
CampaignError.MISSING_UNIVERSAL_APP_CAMPAIGN_SETTINGSettingError.UNIVERSAL_APP_CAMPAIGN_SETTING_DUPLICATE_DESCRIPTIONSettingError.UNIVERSAL_APP_CAMPAIGN_SETTING_DESCRIPTION_LINE_WIDTH_TOO_LONGSettingError.UNIVERSAL_APP_CAMPAIGN_SETTING_APP_ID_CANNOT_BE_MODIFIEDSettingError.TOO_MANY_YOUTUBE_MEDIA_IDS_IN_UNIVERSAL_APP_CAMPAIGNSettingError.TOO_MANY_IMAGE_MEDIA_IDS_IN_UNIVERSAL_APP_CAMPAIGNSettingError.MEDIA_INCOMPATIBLE_FOR_UNIVERSAL_APP_CAMPAIGNSettingError.TOO_MANY_EXCLAMATION_MARKS
- Added errors:
- Updated
TargetingSettingto includeTargetingSetting.target_restriction_operations, which enables updating specificTargetingSetting.target_restrictionsvalues. - Removed the following unused enum values:
BudgetPeriod.CUSTOMBudgetPeriod.FIXED_DAILY
Constants
- Added
CurrencyConstantServiceto retrieve currency constants.
Conversions
- Added errors:
Criteria
- Removed
GAMEfromContentLabelType. - Added
CriterionError.CANNOT_TARGET_USER_LIST_FOR_SMART_DISPLAY_CAMPAIGNS.
Feeds
- Added
FeedItemTarget.status. - Added errors:
CampaignFeedError.NO_EXISTING_LOCATION_CUSTOMER_FEEDExtensionFeedItemError.CONCRETE_EXTENSION_TYPE_REQUIREDExtensionFeedItemError.SCHEDULE_END_NOT_AFTER_STARTFeedError.CANNOT_HAVE_LOCATION_AND_AFFILIATE_LOCATION_FEEDSFeedError.GMB_ACCESS_ERRORFeedMappingError.ATTRIBUTE_FIELD_MAPPING_MISSING_FIELD
Hotel Ads
- Added
PaymentMode.GUEST_STAYfor Hotel commission campaign to allow creating and editing hotel pay per stay campaigns. This mode is only supported by campaigns withAdvertisingChannelType.HOTEL,BiddingStrategyType.COMMISSION, andBudgetType.HOTEL_ADS_COMMISSION. - Added
AdGroupType.PROMOTED_HOTEL_ADSto support the promoted hotels feature.
Reach Forecasting
- Added Network Type to the
Targetingsettings you can use inGenerateReachForecastRequest.
Reporting
Streaming
- Added the support of streaming results as
GoogleAdsService.SearchStream. Compared with paging, where you need to send requests for every page you want to retrieve, streaming lets you send one request to the server that returns a stream to read a sequence of messages back.
- Added the support of streaming results as
Querying
- Introduced returning total results count when retrieving data from
GoogleAdService.Searchby settingreturn_total_results_counttotruein the request; previous versions always returned the total result count. Setting this totruewill incur a performance penalty. - Introduced multiple ways of returning summaries in results when
retrieving data from
GoogleAdService.Searchby settingsummary_row_setting. Previous versions had the settingreturn_summary_row, which has been removed in this version. - Added
DatabaseError.REQUEST_TOO_LARGEto indicate that the request needs to be split into smaller requests.
- Introduced returning total results count when retrieving data from
View - Dynamic Search Ads Search Term
View - Geographic
- Added
segments.geo_target_countrytogeographic_view.
- Added
View - Hotel Group
- Added metric
metrics.search_click_sharetohotel_group_view.
- Added metric
View - Hotel Performance
- Added metric
metrics.search_click_sharetohotel_performance_view.
- Added metric
View - User Location
Shopping
- Renamed shopping objects and fields containing listing to product including:
ListingBrandInfotoProductBrandInfoListingCustomAttributeInfotoProductCustomAttributeInfoListingCustomAttributeIndextoProductCustomAttributeIndex
Video
- Added error
YoutubeVideoRegistrationError.VIDEO_NOT_ELIGIBLE.
2.2.0 beta (2019-09-25)
The functionality and changes below were added in v2.2.0.
Billing
- Added a restricted-access
InvoiceServicefor retrieving information about monthly invoices for a specified billing setup. This service is currently not open for sign-ups.
Reporting
- Segments
segments.interaction_on_this_extensionandsegments.placeholder_typeare now selectable with:segments.month_of_yearis now selectable with:
- View - Genders
- Added the ability to segment by
segments.dateingender_view.
- Added the ability to segment by
- View - Hotel Performance
- Added the ability to segment by
segments.hotel_price_bucketinhotel_performance_view.
- Added the ability to segment by
- View - Shared Sets
- Added the ability to select
bidding_strategyanduser_listresources when usingshared_setas the main resource inGoogleAdsService.Search.
- Added the ability to select
- View - User Locations
- Added the ability to filter by
resource_nameinuser_location_view.
- Added the ability to filter by
2.1.0 beta (2019-08-08)
The functionality and changes below were added in v2.1.0.
Account Management
- Added
time_zone,test_account,manager,descriptive_name,currency_code, andidtoCustomerClientto make it easier to retrieve customers in an account hierarchy.
Ads
- Added
ExpandedDynamicSearchAd.description2to create and retrieve the second part of the ad description.
Audiences
- Added
custom_affinitytoCampaignCriterionto target Custom Affinity audiences.
Hotel Ads
- Added the ability to select
metrics.hotel_price_difference_percentage.
Labels
- Added the ability to select
campaign.labelswith other compatible resources inGoogleAdsService.Search.
Reach Forecasting
- Introduced a restricted access
ReachPlanService, which lets users accurately forecast the commercial reach of video campaigns on YouTube and Google Video Partner inventory. For more details, refer to the Reach Forecasting guide.
Reporting
Querying
- Added the ability to select
campaignandcampaign_shared_setwhen usingshared_setas the main resource inGoogleAdsService.Search. - Added the ability to select the
bidding_strategyresource in - Added the ability to select the
user_listresource inad_group_audience_viewandcampaign_audience_viewinGoogleAdsService.Search. - Added the ability to segment by
segments.dateincampaign_audience_view. - Added the ability to select
segments.ad_network_typeandsegments.deviceindistance_view.
2.0.0 (2019-06-26)
The functionality and changes below were added in v2.0.0. This release contains breaking changes. For breaking changes, see the migration guide.
Account Management
- Updated
CustomerServiceto allow users to add roles and emails on account creation. This is for allowlisted customers only and is not currently open for any new customers.
Ads
- Introduced
AdServicefor updating existing ads that were created usingAdGroupAdService. Updating ads maintains existing metrics. The ads that can be updated include:
Bidding
- For simulations (equivalent to Bid
Landscapes in the AdWords API):
- Added
parent_required_budget_microstoBidModifierSimulationPoint. - Added
viewstoCpvBidSimulationPoint. - Added support for
SHOPPINGcampaigns inCampaignCriterionSimulation. All fields that are not compatible with shopping campaigns are noted in the comments. - Added support for
SHOPPINGandDISPLAYsimulation inAdGroupCriterionSimulation.
- Added
Campaigns
- Added
PRESENCE_OR_INTERESTtoNegativeGeoTargetTypeandPositiveGeoTargetType. - Renamed
LOCATION_OF_PRESENCEtoLOCATIONinNegativeGeoTargetTypeandPositiveGeoTargetType. - Updated the Campaign
GeoTargetingTypeto default toPRESENCE_OR_INTERESTforNegativeGeoTargetTypeandPositiveGeoTargetType.
Criteria
- Added
SOCIAL_ISSUEStoContentLabelType.
Feeds
- Introduced
targeted_keywordinExtensionFeedItem. - Introduced
PlaceholderType, and renamedFeedItemPlaceholderPolicyInfo.placeholder_typetoplaceholder_type_enum, using the enum rather than an integer. - Updated
ExtensionFeedItemServiceto support partial failure. - Removed review extensions by removing
ExtensionTypeREVIEW. This was already deprecated in AdWords API.
Hotel Ads
- Introduced
segments.geo_target_countryin theHotelPerformanceView.
Labels
- Added the ability to retrieve all label resource names associated with the
AdGroupresource usingAdGroup.labels.
Reporting
- Metrics
- Introduced call metrics with reports including
ExtensionFeedItem: - Removed:
metrics.average_positionmetrics.impression_reach- For other metrics to use, see this blog post.
- Updated
segments.click_typeto NOT be compatible with: - Updated
segments.deviceto be compatible with: - Updated
segment.month_of_yearto be compatible with:
- Introduced call metrics with reports including
- Querying
- Introduced summary rows when retrieving data from
GoogleAdService.Search()by settingreturn_summary_rowtotruein the request. - For
GoogleAdsFieldService, the page size that can be passed in must be 1 to 10000 inclusive. Any other number now results in anINVALID_PAGE_SIZEerror.
- Introduced summary rows when retrieving data from
- Views - Ad Assets
- Introduced the
AdGroupAdAssetViewresource for querying ad asset metrics.
- Introduced the
- Views - Clicks
- Updated
ClickViewto include ad group ad attributes.
- Updated
- Views - Distance
- Introduced the
DistanceViewresource (equivalent to the User Ad Distance Report in the AdWords API).
- Introduced the
- Views - Geographic
- Introduced the
UserLocationViewresource (equivalent to the Geo Performance Report whereisTargetingLocationis false in the AdWords API). - Replaced
country_geo_target_constantwithcountry_criterion_idinGeographicView.
- Introduced the
Video
- Introduced
companion_bannerinVideoBumperInStreamAdInfoandVideoNonSkippableInStreamAdInfo. Note that this is a breaking change for some people as this introduced a new field in an empty object.
1.3.0 (2019-05-22)
The functionality and changes below were added in v1.3.0.
Bidding
- When updating bidding strategies, you are no longer required to set required fields when updating non-required fields.
Campaign drafts and experiments
- Added support for campaign drafts and experiments with the
CampaignDraftandCampaignExperimentresources (equivalent to Campaign Drafts and Experiments in the AdWords API).
Conversions
- Added the ability to turn on validation only for the methods
UploadClickConversions,UploadCallConversions, andUploadConversionAdjustments.
Criteria
- Added
CONNECTED_TVtoDevice.
Feeds
- Added campaign (
targeted_campaign), ad group (targeted_ad_group), and location (targeted_geo_target_constant) targeting toExtensionFeedItem.
Hotel Ads
- Added the following segments:
segments.hotel_rate_rule_idsegments.hotel_rate_type
Labels
- Added the ability to retrieve all label resource names associated with the
Campaignresource usingCampaign.labels.
Shopping
- Added support for Comparison Listing Ads:
SHOPPING_COMPARISON_LISTING_ADScampaign advertising channel sub typeSHOPPING_COMPARISON_LISTING_ADSad group typeSHOPPING_COMPARISON_LISTING_ADad typeCOMPARISON_LISTING_ADclick type
- Access is restricted to Comparison Shopping Service customers.
1.2.0 (2019-04-29)
The functionality and changes below were added in v1.2.0.
Ads
- Added
AppEngagementAdInfofor managing App Campaigns for Engagement. - Added
DisplayUploadAdInfofor retrieving and managing ads of the following types:HTML5_UPLOAD_ADDYNAMIC_HTML5_EDUCATION_ADDYNAMIC_HTML5_FLIGHT_ADDYNAMIC_HTML5_HOTEL_RENTAL_ADDYNAMIC_HTML5_JOB_ADDYNAMIC_HTML5_LOCAL_ADDYNAMIC_HTML5_REAL_ESTATE_ADDYNAMIC_HTML5_CUSTOM_ADDYNAMIC_HTML5_TRAVEL_ADDYNAMIC_HTML5_HOTEL_AD
- Added the ability to select
AdParameterinGoogleAdsService. - Added
TextAssetfor retrieving text assets in ads. - Added
FULLY_LIMITEDtoPolicyTopicEntryType.
Campaigns
- Create App Campaigns for engagement by creating a
Campaignand setting theadvertising_channel_typetoMULTI_CHANNELand theadvertising_channel_sub_typetoAPP_CAMPAIGN_FOR_ENGAGEMENT. This feature is currently allowlisted.
Bidding
- Added the ability to use pay-per-conversion bidding with
PaymentMode.CONVERSIONS. - Added simulations (equivalent to Bid
Landscapes in the AdWords API)
for:
- Campaign criteria:
CampaignCriterionSimulation. - Ad group criteria:
AdGroupCriterionSimulation. - Ad groups:
AdGroupSimulation.
- Campaign criteria:
Criteria
- Added display
nametoMobileApplicationInfocriteria (equivalent toMobileApplication.displayNamein the AdWords API). - Added
LocationGroupInfocriteria (equivalent toLocationGroupsin the AdWords API).
Feeds
- Added
ad_schedulesanddevicetoExtensionFeedItem. - Added
month_of_year,day_of_week, andcross_device_conversionsegmentation toExtensionFeedItemandFeedItem. - Added the ability to select
AdGroupAdwithFeedItem. - Added
LocationFeedItemandAffiliateLocationFeedItemfor read-only retrieval. - Updated
PromotionFeedItem.redemption_startandPromotionFeedItem.end_timeto make them selectable in a flatExtensionFeedItem.
Hotel Ads
- Added segment
segments.hotel_user_set_datestoCampaignAudienceViewandAdGroupAudienceView. - Added the commission bidding strategy for hotel campaigns. In order to use
this bidding strategy, you will need to set up a hotel
Campaignwith the following fields:campaign_budgetbeing the resource name forCampaignBudgetof typeHOTEL_ADS_COMMISSIONpayment_modeset toCONVERSION_VALUEcommissiondefining the commission rate
Parameters in Google Ads Query Language
- A new component called PARAMETERS has been added to the Google Ads Query
Language grammar. In this version, users can include campaign drafts when
creating a query by including the parameter
include_drafts. An example would be:SELECT campaign.name, campaign.experiment_type, FROM campaign PARAMETERS include_drafts = true
Recommendations
- Added new Recommendations:
CallExtensionRecommendationCalloutExtensionRecommendationSitelinkExtensionRecommendation
Reporting
- Local Campaigns - Per store report
- Added metrics for Local Campaigns known as the Per Store Report in the Locations tab of the UI. This report has conversion metrics for feed items; used for location and affiliate location feed items.
- Added the following metrics for
Campaign,Customer, andExtensionFeedItem:metrics.all_conversions_from_click_to_callmetrics.all_conversions_from_directionsmetrics.all_conversions_from_menumetrics.all_conversions_from_ordermetrics.all_conversions_from_other_engagementmetrics.all_conversions_from_store_visitmetrics.all_conversions_from_store_website
- Views - Feed Placeholder View
- Added the ability to select
AdGroupAd,AdGroup,andCampaignwithFeedPlaceholderView.
- Added the ability to select
- Views - Geographic
- Added the ability to select
segments.geo_target_city,segments.geo_target_metro, andsegments.geo_target_regionwithsegments.date. - Added segments:
segments.geo_target_airportsegments.geo_target_countysegments.geo_target_districtsegments.geo_target_most_specific_locationsegments.geo_target_postal_codesegments.geo_target_state
- Added the ability to select
- Views - Location View
- Added segments to
LocationView:segments.month_of_yearsegments.average_cpesegments.engagement_ratesegments.engagements
- Added segments to
- Views - Landing Pages
- Added new
LandingPageViewandExpandedLandingPageViewresources (enhanced version of Landing Page Report in the AdWords API) along with related metrics:metrics.mobile_friendly_clicks_percentagemetrics.speed_scoremetrics.valid_accelerated_mobile_pages_clicks_percentage
- Added new
- View - Search Terms
- Added a new
PaidOrganicSearchTermViewresource (equivalent to Paid Organic Query Report in the AdWords API), along with the following new metrics and segments intended for use with this resource:- Segments:
segments.search_engine_results_page_type
- Metrics:
metrics.combined_clicksmetrics.combined_clicks_per_querymetrics.combined_queriesmetrics.organic_clicksmetrics.organic_clicks_per_querymetrics.organic_impressionsmetrics.organic_impressions_per_querymetrics.organic_queries
- Segments:
- The
SearchTermViewresource can now be segmented by theAdGroupAdresource. segments.search_term_match_typeis now compatible withsegments.keyword.ad_group_criterion,segments.keyword.info.match_type, andsegments.keyword.info.text.
- Added a new
1.1.0 (2019-03-27)
The functionality and changes below were added in v1.1.0.
Ads
- Introduced
AssetServicefor managing assets for asset-based ads. - Added
ResponsiveDisplayAdInfo(equivalent toMultiAssetResponsiveDisplayAdin AdWords API). - Added
AppAdInfo(equivalent toUniversalAppAdin AdWords API). - Added
headline1andheadline2fields toCallOnlyAdInfo.
Campaigns
- Create App Campaigns
(equivalent to
UniveralAppCampaignInfoin AdWords API) by creating aCampaignand setting theadvertising_channel_typetoMULTI_CHANNELand theadvertising_channel_sub_typetoAPP_CAMPAIGN. - Create search dynamic ad groups by creating an ad group of type
SEARCH_DYNAMIC_ADS.
Conversions
- Adjust conversions with the new
ConversionAdjustmentUploadService. - Upload call conversions with the
UploadCallConversionsRequestin theConversionUploadService.
Criteria
AdGroupCriterionnow includesexempt_policy_violation_keysfor exemption requests.AdGroupCriterionnow includesapproval_status.SharedCriterion,CampaignCriterion, andAdGroupCriterionnow include support formobile_application.
Hotel Ads
- Added conversion metrics into
HotelPerformanceViewandHotelGroupView, including:all_conversionsall_conversions_from_interactions_rateall_conversions_from_interactions_value_per_interactionall_conversions_valueall_conversions_value_per_costconversionsconversions_from_interactions_rateconversions_from_interactions_value_per_interactionconversions_valueconversions_value_per_costcost_per_all_conversionscost_per_conversioncross_device_conversionsvalue_per_all_conversionsvalue_per_conversion
- Added impression share metrics into
HotelPerformanceViewandHotelGroupView, including:search_absolute_top_impression_sharesearch_budget_lost_absolute_top_impression_sharesearch_budget_lost_impression_sharesearch_budget_lost_top_impression_sharesearch_impression_sharesearch_rank_lost_absolute_top_impression_sharesearch_rank_lost_impression_sharesearch_rank_lost_top_impression_sharesearch_top_impression_share
Recommendations
- Added 2
Recommendationtypes:MoveUnusedBudgetRecommendationKeywordMatchTypeRecommendation
Reporting
- Segments
segments.deviceis now selectable with:CampaignBudgetis now selectable with the following conversion segments:
- Views - Geographic
- Added segments:
segments.geo_target_airport
- Added segments:
- Views - Keywords
- The
metrics.cross_device_conversionsfield is now selectable withKeywordView. DisplayKeywordViewcan now be segmented bysegments.month_of_year.
- The
- View - Placements
GroupPlacementViewcan now be segmented bysegments.month_of_year.GroupPlacementViewnow includesad_network_typeandengagement metricsincludingmetrics.engagementsandmetrics.engagement_rate.
- View - Search Terms
DynamicSearchAdsSearchTermViewcan now be segmented bysegments.webpage.SearchTermViewcan now be segmented bysegments.keyword.ad_group_criterion,segments.keyword.info.match_type, andsegments.keyword.info.text.
1.0.0 (2019-02-27)
The functionality and changes below were added in v1.0.0.
Terms of Service
The Terms and Conditions has changed. You'll need to accept the new Terms and Conditions and update your contact information in the API center. If you don't, you will get an error when trying to access v1.
- Sign in to the manager account where you have your developer token at ads.google.com.
- Click TOOLS & SETTINGS at the top of the page.
- Under SETUP, select API Center.
- Scroll down to API contact email, and update it.
- Scroll down to Principal place of business, accept the new conditions, and click Save.
Resource Names
- The delimiter separating IDs in all resource names has changed from
underscore
_to tilde~. When parsing resource names, update your code to take into account the new delimiter.
Account Management
- Added support for Labels.
- The new
LabelServicelets developers add, modify, remove, and view labels. - Labels can be applied to and removed from resources using the
AdGroupAdLabelService,AdGroupCriterionLabelService,AdGroupLabelService,CampaignLabelService, andCustomerLabelService.
- The new
- Introduced
MerchantCenterLinkServicefor management of links between Google Ads and Google Merchant Center.
Ads
- Added Responsive Search Ads with
ResponsiveSearchAdInfo. - Renamed
ResponsiveDisplayAdInfotoLegacyResponsiveDisplayAdInfo. Check out the recent blog post on Display ads for more details. - Removed
DynamicSearchAdInfo. If you are usingDynamicSearchAdInfo, migrate your ads toExpandedDynamicSearchAdInfoby March 6, 2019. - Added
product_imagesandproduct_videostoGmailAdInfo. - Added
ad_id_to_copy_image_fromtoImageAdInfo. - Added
ad_strengthtoAdGroupAd. - Added
ad.system_managed_entity_sourcetoAdGroupAd.
Audiences
- Introduced the
CustomInterestService.
Batch Jobs
- Access to the batch jobs feature is currently restricted. We have released the services so you can start coding against this interface. Subscribe to the Google Ads API blog for updates when this feature will be available.
- Added
MutateJobServiceto support submitting and monitoring asynchronous jobs containing large numbers of operations. Operations that are supported in the new service are documented inMutateOperation.
Bidding
- Added support for the Target Impression Share bidding
strategy. This is a new
BiddingStrategythat is available only in the Google Ads API. - Added
BiddingStrategy.status.
Billing
- The
proposal_typefield in theAccountBudgetProposalresource now returns a value for resources that previously returnedUNKNOWN. - The
AccountBudgetProposalServiceno longer returns errors if a valid billing setup resource name is specified for operations that mutate an existing budget.
Campaigns
- Introduced
DomainCategoryto retrieve categories for a website. - Added
geo_target_type_settingtoCampaign.
Change History
ChangeStatusServicenow provides support forAdGroupBidModifier,AdGroupFeed, andCampaignFeedresources.
Conversions
- Introduced
ConversionUploadServiceto enable uploading conversions from clicks. - Added
metrics.conversion_or_adjustment_lag_bucketandmetrics.conversion_lag_bucket.
Criteria
- Introduced
CustomerNegativeCriterionService. - The
AdGroupCriterionresource now hasfinal_mobile_urls,final_url_suffix, andsystem_serving_status. This makes thesystem_serving_statusavailable with thekeyword_view. - Added support for
mobile_deviceinCampaignCriterion. - Introduced the
LanguageConstant.targetablefield. - Introduced support for
CustomIntentandCustomAffinitycriteria.
Feeds
- Introduced the
CustomerExtensionSettingService,CampaignExtensionSettingService, andAdGroupExtensionSettingServiceto manage app, call, callout, message, price, promotion, review, sitelink, and structured snippet extensions. - Introduced the
ExtensionFeedItemService. - Introduced the
FeedItemTargetService. - Introduced support for managing matching functions using structured
objects/protos instead of strings in
CustomerFeed,CampaignFeed, andAdGroupFeed. Campaign.dynamic_search_ad_setting.feed_idswas changed tocampaign.dynamic_search_ads_setting.feedsso that feed IDs can be replaced by feed resources.FeedItemValidationError.extra_informationwas renamed toFeedItemValidationError.extra_info.- In
FeedItem, the type of theprice_valuefield was changed fromPricetoMoney.
Hotel Ads
- Added Hotel Ads click types to
segments.click_type:HOTEL_PRICE,HOTEL_BOOK_ON_GOOGLE_ROOM_SELECTION.
Reporting
- Query Grammar
- Changed the meaning of
metricsandsegmentsin GoogleAdsFieldService. These are now only returned for artifacts of categoryRESOURCEand they only contain the metrics and segments that are selectable when the given resource is in theFROMclause.
- Changed the meaning of
Segments
- Added
segments.click_type. Added segments for conversions:
Added ability to segment ads by keyword criteria with
segments.keyword.info.match_typeandsegments.keyword.info.textforAdGroupAd.Added
segments.interaction_on_this_extensionforFeedItem.
- Added
Views - Ads
- A new
ClickViewresource has been added. This is the equivalent of the Click Performance Report in the AdWords API. Consistent with the Click Performance Report, requests including theClickViewresource must specify a filter on a single day in the past 90 days. - Introduced the
DynamicSearchAdsSearchTermViewresource (equivalent to Keywordless Query Report in the AdWords API).
- A new
Views - Bidding
- Introduced the
DetailPlacementView(equivalent to URL Performance Report in the AdWords API) andGroupPlacementView. - Added
campaign_countandnon_removed_campaign_counttobidding_strategy(equivalent to Bid Goal Performance Report in the AdWords API).
- Introduced the
Views - Feeds
- Introduced the
FeedPlaceholderView(equivalent of the Placeholder Report in the AdWords API). - Added more metrics and segments in
FeedItem. - Added metrics for
ExtensionFeedItem.
- Introduced the
Views - Geographic
- Introduced the
GeographicViewresource (equivalent to the Geo Performance Report whereisTargetingLocationistrueOR there is no predicate onisTargetingLocationin the AdWords API). - Introduced the
LocationViewresource (equivalent to Campaign Location Target Report in the AdWords API).
- Introduced the
Zero Rows
- Search queries that include at least one segment will no longer return rows where all selected metrics equal zero. Queries that don't include any segments are unchanged and will continue to return rows where all metrics equal zero. Unlike the existing AdWords API, there is no way to disable this behavior.
Shopping
- Added
ProductBiddingCategoryConstantService(equivalent to Shopping Performance Report in the AdWords API). - Bidding Categories are now supported in
ListingDimensionInfoas a part ofListingGroupsandListingScopes. - Added the
ShoppingPerformanceViewresource (equivalent to Shopping Performance Report in the AdWords API) which includes the following metrics and segments:Metrics:all_conversionsall_conversions_from_interactions_rateall_conversions_valueaverage_cpcclicksconversionsconversions_from_interactions_rateconversions_valuecost_microscost_per_all_conversionscost_per_conversioncross_device_conversionsctrimpressionssearch_absolute_top_impression_sharesearch_click_sharesearch_impression_sharevalue_per_all_conversionsvalue_per_conversion
Segments:ad_group(resource)ad_network_typecampaign(resource)click_typeconversion_actionconversion_action_categoryconversion_action_namedateday_of_weekdeviceexternal_conversion_sourcemonthproduct_aggregator_idproduct_bidding_category_level1product_bidding_category_level2product_bidding_category_level3product_bidding_category_level4product_bidding_category_level5product_brandproduct_channelproduct_channel_exclusivityproduct_conditionproduct_countryproduct_custom_attribute0product_custom_attribute1product_custom_attribute2product_custom_attribute3product_custom_attribute4product_item_idproduct_languageproduct_merchant_idproduct_store_idproduct_titleproduct_type_l1product_type_l2product_type_l3product_type_l4product_type_l5quarterweekyear
Video
- Updated
MediaVideo.ad_duration_millisto have millisecond precision as the precision used to only be out to the second while ending in000. - Added more metrics and segments compatible with
Video(equivalent to Video Performance Report in the AdWords API). - For reporting, added video types for
AdandMediaVideo. - Added the ability to report on target CPM bidding strategies.
0.7.0 (2019-01-30)
The functionality and changes below were added in v0.7.0.
Ads
- Support for managing ad parameters with the AdParameterService.
Audiences
- Added support for the targeting setting in campaigns and ad groups.
- Added support for rule based, logical, and basic user lists.
- Added support for managing remarketing actions for a basic user list.
Billing
- Support for retrieving account-level budget proposals that were previously cancelled or rejected.
Campaigns
CampaignGroupshas been removed.
Change History
Client Accounts
- Introduced signal to identify if a customer is a test account.
- Introduced signal to identify if a customer is a manager account.
- Exposed conversion tracking settings of a customer.
Conversions
- Added support for retrieving current model attributed conversion metrics.
- Added support for retrieval of conversion actions using
GoogleAdsService.Search. - Added support for segmenting your conversion data by
conversion_attribution_event_type.
Criteria and Location
- Added ability to create criterion with
CriterionTypeMOBILE_APP_CATEGORY,WEBPAGE,OPERATING_SYSTEM_VERSION, andAPP_PAYMENT_MODELto identify when and where to show ads. - Added ability to retrieve the
canonical_namefrom theGeoTargetConstant.
Feeds
- Ad customizer stats are now returned with
FeedItemstats.
Manager Accounts
CustomerClientLink- Added `MutateCustomerClientLink() method, which modifies the customer
client link in the manager account tree. These combinations are
possible:
CustomerClientLinkOperation.create+ManagerLinkStatus.PENDING: Customer extends an invitation to a client.CustomerClientLinkOperation.update+ManagerLinkStatus.CANCELED: Manager rescinds invitation.CustomerClientLinkOperation.update+ManagerLinkStatus.INACTIVE: Manager terminates links.CustomerClientLinkOperation.update+ManagerLinkStatus.ACTIVEwithhiddenfield set totrue: This makes anACTIVElink hidden.
- Added `MutateCustomerClientLink() method, which modifies the customer
client link in the manager account tree. These combinations are
possible:
CustomerManagerLink- Added
MutateCustomerManagerLinkmethod, which modifies the customer manager link in the manager account tree. These combinations are possible:CustomerManagerLinkOperation.update+ManagerLinkStatus.ACTIVE: Client accepts invitation.CustomerManagerLinkOperation.update+ManagerLinkStatus.REFUSED: Client declines invitation.CustomerManagerLinkOperation.update+ManagerLinkStatus.INACTIVE: Client terminates invitation.
- Added
Request Parameters
- Set
validate_onlytotrueas a request parameter to only validate the request, but not perform it. This was added to all services includingGoogleAdsService.Mutate. - Set
partial_failuretotrueas a mutate parameter to continue on failure and commit valid operations even if other operations in the same request failed.
Reporting
- All segment fields are now in a
segments, which means all queries
must be updated to include
segments.before the segment field name. - Additional metrics were added for ad
groups, campaigns, budgets, campaign negative keywords, keywords, shared
set criteria, campaign ad schedule targets, and bid goals including:
absolute_top_impression_percentage,active_view_cpm,active_view_ctr,active_view_impressions,active_view_measurability,active_view_measurable_cost_micros,active_view_measurable_impressions,active_view_viewability,average_frequency,average_page_views,average_time_on_site,benchmark_average_max_cpc,cost_per_current_model_attributed_conversion,current_model_attributed_conversions,current_model_attributed_conversions_from_interactions_rate,current_model_attributed_conversions_from_interactions_value_per_interaction,current_model_attributed_conversions_value,current_model_attributed_conversions_value_per_cost,gmail_forwards,gmail_saves,gmail_secondary_clicks,historical_creative_quality_score,historical_landing_page_quality_score,historical_quality_score,historical_search_predicted_ctr,impression_reach,interaction_types,search_budget_lost_absolute_top_impression_share,search_click_share,search_rank_lost_absolute_top_impression_share,search_rank_lost_top_impression_share,search_top_impression_share,top_impression_percentage, andvalue_per_current_model_attributed_conversion.
Shopping
- Retrieve
metrics.benchmark_average_max_cpcin Product Group View (previously known as Product Partition Report in the AdWords API).
Video
- Query standard campaigns with
target_cpm_microsset in anAdGroup. - Retrieve TrueView for Reach metrics.
- Retrieve
video_brand_safety_suitabilityin aCampaign. - Retrieve
metrics.active_view_ctr.
0.6.0 (2018-11-29)
The functionality and changes below were added in v0.6.0.
Account Management
CustomerClientresource- Returns the list of clients managed by the selected customer.
- CustomerService
- Added `CreateCustomerClient() method, which creates a new client under the selected customer.
- CustomerService now supports mutates.
- New fields available in the
[Customer](/google-ads/api/reference/rpc/v22/Customer) arefinal_url_suffixandtracking_url_template`. - Descriptive
name,currency,time_zone,final_url_suffix,tracking_url_template,auto_tagging_enabled,call_reporting_settingare now mutable.
Ads
- Create ads of type
GMAIL_ADin AdGroupAdService. - Create ads of type
IMAGE_ADin AdGroupAdService.
Audiences
- Create audiences using UserListService.
Billing
- PaymentsAccountService (read-only service)
- View a list of all billing accounts (refer to the BillingSetupService to designate a billing account to a billing setup).
Conversions
- Conversion actions return AMP tag snippets.
Criteria
- You can now create criteria with
CriterionTypeLANGUAGE,CARRIER,USER_LIST,USER_INTEREST, andIP_BLOCK.
Feeds
- Manage feeds and retrieve feed metrics with AdGroupFeedService, CustomerFeedService, FeedService, CampaignFeedService, and FeedMappingService.
Hotel Ads
- Made following derived metrics compatible with the existing
HotelGroupViewresource:- average_cpc
- average_cpm
- ctr
- Added the HotelPerformanceViewService.
- Added the
HotelPerformanceViewresource- Note that the resource name for
HotelPerformanceViewiscustomers/<customer_id>/hotelPerformanceView
- Note that the resource name for
Made
HotelPerformanceViewcompatible with following metrics:- average_cpc
- average_cpm
- average_position
- clicks
- cost_micros
- ctr
- impressions
- hotel_average_lead_value_micros
These metrics can be segmented by
- ad_network_type
- date
- day_of_week
- device
- hotel_booking_window_days
- hotel_center_id
- hotel_check_in_date
- hotel_check_in_day_of_week
- hotel_city
- hotel_class
- hotel_country
- hotel_date_selection_type
- hotel_length_of_stay
- hotel_state
- hour
- month
- partner_hotel_id
- quarter
- week
- year
The above metrics can also be segmented by the campaign and ad group resources. For example:
select campaign.id, metrics.clicks from hotel_performance_view select ad_group.id, metrics.impressions from hotel_performance_view
Keyword Planning
Published improved and extended version of Keyword Planning services keeping parity with Keyword Planner.
In order to accomplish this, we have introduced the Keyword Plan as a key concept. As with Keyword Planner, API users will be able to create Keyword Plans that can be accessed and modified at a later time. A Keyword Plan is much like any other Google Ads entity. As such, it is structured similarly to a standard serving campaign (
KeywordPlan>KeywordPlanCampaign>KeywordPlanAdGroup>KeywordPlanKeyword).Much like campaigns, the full set of Keyword Plan entities need to be created in order to get Forecasted Metrics or Historical Metrics (Search Volume Data).
KeywordPlanService.GenerateForecastMetrics- This service replaces the AdWords API's
TrafficEstimatorService.get. It returns forecast metrics for all the keywords present in yourKeywordPlan. It returns consistent forecast data with Keyword Planner offering forecast metrics at the keyword, ad group or campaign level.
- This service replaces the AdWords API's
KeywordPlanService.GenerateHistoricalMetrics- This service replaces the AdWords API's
TargetingIdeaService.getwithRequestType=STATS; it returns historical metrics for all the canonicalized keywords present in your Keyword Plan. This means that if multipleKeywordPlanKeyworditems are close variants of the same canonical keyword, a single version of theKeywordPlanKeywordwill be returned along with historical metrics. This is consistent with Keyword Planner.
- This service replaces the AdWords API's
[
KeywordPlanIdeaService.GenerateKeywordIdeas](/google-ads/api/reference/rpc/v22/KeywordPlanService#generatekeywordideas`- This service replaces
TargetingIdeaService.getwithRequestType=IDEAS; it returns canonicalized keyword suggestions along with historical metrics. These keywords can be added to your Keyword Plans for forecasting or obtaining overall historical metrics for your plan. This is the only service which does not require a Keyword Plan to be created because it provides keyword suggestions to assist with plan creation.
- This service replaces
Mutates
- Pass in multiple kinds of operations with
GoogleAdsService.Mutate.
Recommendations
- Added the `DismissRecommendation() method to the RecommendationService, so that users can dismiss a recommendation.
Reports
SearchTermView(known as Search Query Performance Report in the AdWords API).- The accompanying
SearchTermMatchTypesegmentation was also added.
- The accompanying
Shopping
- Standard Shopping Campaigns
- CampaignCriterionService
- Added support for
ListingScopes("product filters").- All dimensions except Bidding Category are available.
- Added support for
- CampaignCriterionService
- Product Group View (known
as Product Partition
Report in the
AdWords API).
- Added
benchmark_ctrmetric. - Added
search_absolute_top_impression_sharemetric.
- Added
Video
- The
average_cpvmetric is now available for tracking video stats.
0.5.0 (2018-10-31)
The functionality and changes below were added in v0.5.0.
Account Management
- CustomerService.ListAccessibleCustomers
- Service for managing Google Ads accounts.
Billing
- BillingSetupService
- Create a new billing setup.
- Cancel an approved billing setup that is scheduled to start in the future.
- Cancel a pending billing setup that is not yet approved.
- AccountBudgetService
- View all approved account-level budgets, including budget adjustments.
- View currently pending account-level budget proposals (if any).
- AccountBudgetProposalService
- Create account-level budget proposal to update a budget or create a new budget.
- View all account-level budget proposals. All approved values and
proposed budget values are visible. Approved values are prefixed with
approved_.
Campaigns
- Create campaigns with
AdvertisingChannelSubTypeDISPLAY_GMAIL_ADfor Gmail Ad campaigns andDISPLAY_SMART_CAMPAIGNfor Smart Display campaigns. - Query more
Metricsfor accounts, campaigns, ad groups, keywords, and bidding strategies.
Change history
ResourceTypeEnumwas renamed toChangeStatusResourceTypeEnum.
Creatives
- MediaFileService
- A service to upload media to be used in ads.
- Create call-only ads with
CallOnlyAdInfo. - Set and create the ad rotation mode on an ad group.
- Query
Metricssuch as impressions, clicks, cost, conversions, and average position for ads.
Conversion tracking
- Lets you measure the performance of your advertising against your business goals.
- Conversion actions
- Set up and edit the settings associated with your conversion actions, including website tracking and call conversion tracking.
Hotel Ads
- Use Google Ads Query Language to
query hotel group stats. For each hotel group:
- Read the corresponding listing group case value.
- Read direct child listing groups' types.
- Read the parent listing group ID.
- Read the listing group path, which contains the case value from the root node of the hotel group tree to the current hotel group.
Location, Demographics, and Criteria
- `GeoTargetConstantService
- A service for retrieving geo constants and suggesting geo constants based on input.
- Create criterion with
CriterionTypeAGE_RANGE,GENDER,INCOME_RANGE,PARENTAL_STATUS,PLACEMENT,PROXIMITY,TOPIC,YOUTUBE_CHANNEL, andYOUTUBE_VIDEOto identify when and where to show ads. - Define
placementinSharedCriterion. - Retrieve
Metricsfor audiences, age ranges, display keywords, gender, parental status, and display topics.
Shopping
- `ProductGroupView resource
- Supported metrics
- all_conversions_from_interactions_rate
- all_conversions
- all_conversions_value
- average_cpc
- average_cpm
- benchmark_average_max_cpc
- clicks
- conversions_from_interactions_rate
- conversions
- conversions_value
- cost_micros
- cost_per_all_conversions
- cost_per_conversion
- cross_device_conversions
- ctr
- impressions
- search_click_share
- search_impression_share
- value_per_all_conversions
- value_per_conversion
- view_through_conversions
- Supported segments
- ad_network_type
- date
- day_of_week
- device
- month
- month_of_year
- quarter
- week
- Year
- Supported metrics
0.4.0 (2018-09-21)
The functionality and changes below were added in v0.4.0.
Allowlist removed
The allowlist for API access has been removed. All API users who have an existing developer token in the AdWords API can use that developer token for the Google Ads API.
Billing
-
- Designate the business entity responsible for an account's accrued costs.
- Each billing setup is associated with a Payments account. All billing setups pointing to the same Payments account will appear on a single monthly invoice.
- You can cancel a pending or future approved billing setup. Note that not all settable fields are exposed yet, including the billing setup's start and end times.
- Note that creating or changing billing setups is not supported yet.
-
- Create new budgets and make changes to existing budgets, including:
- edit existing budgets
- end a currently running budget
- remove a budget (approved to start in the future)
- Cancel proposals that are still pending.
- There are some fields that are currently settable, but are not yet selectable.
- Approved values (where there is a discrepancy between the proposed
budget value and the approved value) will be exposed as fields prefixed
with
approved_in a future version. - Reads for account-level budgets managed by these proposals will be supported in a future version. Use BudgetOrderService until then.
- Create new budgets and make changes to existing budgets, including:
Campaigns
- GoogleAdsService
- Retrieve shared sets.
- Retrieve campaign shared sets.
Change history
ChangeStatusinGoogleAdService.Search- Retrieves the current status of resources that have changed since a requested time.
- Supported resources are:
AD_GROUPAD_GROUP_ADAD_GROUP_CRITERIONCAMPAIGNCAMPAIGN_CRITERION
Creatives
- The field
policy_validation_parameterhas been added to the AdGroupAdOperation. It enables setting policy topics that should be ignored so the ad can be saved despite having policy validations. - The field
policy_summaryhas been added toAdGroupAdto display the current approval status of an ad (including any policy violations ignored). - The fields
ad.added_by_google_adsandad.device_preferencewere added inAdGroupAd.
Conversion tracking
Conversion tracking lets you measure the performance of your advertising against your business goals. The API will allow you to set up and edit your conversion tracking setup.
- With
ConversionAction, you can set up and edit the settings associated with your conversion actions including website tracking and call conversion tracking.
Shopping
- Standard Shopping Campaigns
- CampaignService
- Create standard Shopping campaigns with
SHOPPING.advertising_channel_type. - Supported bidding strategy types:
MANUAL_CPC,TARGET_SPEND,TARGET_ROAS.
- Create standard Shopping campaigns with
- BiddingStrategyService
- Create portfolio bidding strategy of types
ENHANCED_CPC,TARGET_SPEND,TARGET_ROAS.
- Create portfolio bidding strategy of types
- AdGroupService
- Create ad groups of type
SHOPPING_PRODUCT_ADS.
- Create ad groups of type
- AdGroupAdService
- Create ads of type
SHOPPING_PRODUCT_AD.
- Create ads of type
- AdGroupCriterionService
- Subdivide product offers through listing groups, which represent product groups.
- Supported listing dimension types:
- Product Condition
- Product Type
- Listing Brand
- Custom Attribute (L0-4)
- Product Channel
- Product Channel Exclusivity
- Product Offer Id
- CampaignService
Video
- GoogleAdsService
- Retrieve information about your video campaigns from
GoogleAdsService.Search.
- Retrieve information about your video campaigns from
- Video Ads
- Video specific metrics
- Video views, video view rate
- Video quartiles
- View-through conversions
- Video specific metrics
- Video creatives
- ManualCPV bidding strategy
0.3.0 (2018-08-29)
Campaigns
The following were added or changed.
- CampaignService, AdGroupService
- Create Display campaigns.
- Set
advertising_channel_typeas it is now required.
- CampaignCriterionService
- Set a campaign's ad schedule using
CampaignCriterion.
- Set a campaign's ad schedule using
- CampaignSharedSetService,
SharedSetService,
SharedCriterionService
- Share negative keywords across campaigns.
- CampaignBidModifierService
- Set campaign bid modifiers for
CALLinteraction types.
- Set campaign bid modifiers for
- AdGroupBidModifierService
- Set ad group bid modifiers for criteria types:
Creatives
- For ad disapproval error handling,
PolicyFindingDetailsreplacesPolicyViolationDetailsfor expanded text ads.
Hotel Ads
- The
parent_criterion_id(int64) inListingGroupInfohas been replaced withparent_criterion. The new field is a string that contains the resource name of the parent criterion.
Queries
- GoogleAdsService
- Filter by resource name in
GoogleAdService.Search. - Segment by
month_of_year. - Strings in queries must be quoted.
- Filter by resource name in
Recommendations
- Recommendations added:
MaximizeConversionsOptInRecommendationEnhancedCpcOptInRecommendationMaximizeClicksOptInRecommendationSearchPartnersOptInRecommendationOptimizeAdRotationRecommendation- The
dismissedfield was added toRecommendationresource to allow you to search, get, and apply dismissed recommendations.
Shopping
- Smart Shopping Campaigns
- CampaignService
- Create campaigns with
advertising_channel_sub_typeSHOPPING_SMART_ADS. - Supported bidding strategy type:
MAXIMIZE_CONVERSION_VALUE.
- Create campaigns with
- AdGroupService
- Create ad groups of type
SHOPPING_SMART_ADS.
- Create ad groups of type
- AdGroupAdService
- Create ads of type
SHOPPING_SMART_AD.
- Create ads of type
- AdGroupCriterionService
- Subdivide product offers through listing groups, which represent product groups.
- Supported listing dimension types:
- Product Condition
- Product Type
- Listing Brand
- Custom Attribute (L0-4)
- Supported listing dimension types:
- Subdivide product offers through listing groups, which represent product groups.
- CampaignService
0.2.0 (2018-06-14)
Hotel Ads
- Added support for the
PercentCpcbidding strategy. Check out the updated Hotel Ads guides for details.
0.1.0 (2018-06-05)
Campaigns
Search Campaigns
- CampaignCriterionService
- Set bid modifiers for platforms.
- Set bid modifiers and targeting for locations.
- Configure
LocationandPlatformcriteria.
- GeoTargetConstantService
- Query of geo targets.
Hotel Ads
- CampaignService, AdGroupService,
AdGroupAdService
- Create hotel campaigns linking to hotel center accounts.
- CampaignCriterionService
- Set bid modifiers for platforms.
- Set bid modifiers and targeting for locations.
- AdGroupBidModifierService
- Set bid modifiers for itineraries:
- Date selection
- Advance booking window
- Length of stay
- Check-in day
- Set bid modifiers for itineraries:
- AdGroupCriterionService
- Manipulate Hotel groups (listing groups).
- GeoTargetConstantService
- Query geo targets needed for hotel ads.
Recommendations
- Recommendations include:
KeywordCampaignBudgetTextAd(expanded text ads)TargetCpaOptIn
GoogleAdsService.Search- Search for Recommendations supports filtering and selecting with ad group, campaign, or campaign budget (depending on the Recommendation).
- RecommendationService
- Apply Recommendations applies the recommendation as-is or overrides and applies the recommendation.
GetRecommendationretrieves one recommendation at a time and is meant for exploratory use rather than the retrieval of multiple recommendations. To retrieve multiple campaigns in one call, useGoogleAdsService.
Customer
Customer.has_partners_badgeis available for verifying if this customer has a Partners program badge.
0.0.0 (2018-04-23)
GoogleAdsFieldService
- GoogleAdsFieldService provides a catalog of all queryable fields. The metadata on these fields includes descriptions, types, and compatibility with other fields. Learn more.
GoogleAdsService
GoogleAdsService is meant for retrieving multiple resources in a single query. Queryable resources include:
CustomerCampaignAdGroupAdGroupAdCampaignBudgetBiddingStrategy
Metrics such as impressions and clicks can also be retrieved using GoogleAdsService for these resources:
CustomerCampaignAdGroupAdGroupAdCampaignBudgetBiddingStrategyKeywordView(Keyword)
GoogleAdsService segments by fields, such as date fields. Learn more.
Services for resources
CampaignService
MutateCampaignscreates, updates, or removes search campaigns. It can also configure network settings and bidding strategies.GetCampaignretrieves one campaign at a time. It is meant for exploratory use rather than for retrieval of multiple campaigns. To retrieve multiple campaigns in a single call, use GoogleAdsService. Learn more.
CampaignBudgetService
MutateCampaignBudgetscreates, updates, or removes campaign budgets.GetCampaignBudgetis meant for exploratory use rather than for retrieval of multiple campaign budgets. To retrieve multiple campaign budgets, use GoogleAdsService. Learn more.
AdGroupService
MutateAdGroupscreates, updates, or removes ad groups under search campaigns. It can also set bids on ad groups.GetAdGroupretrieves one ad group at a time. It is meant for exploratory use rather than for retrieval of multiple ad groups. To retrieve multiple ad groups, use GoogleAdsService. Learn more.
AdGroupAdService
MutateAdGroupAdscreates, updates, or removes ads in search campaigns. Supported ads are listed inAdTypeand include:- TEXT_AD
- EXPANDED_TEXT_AD
- DYNAMIC_SEARCH_AD
- CALL_ONLY_AD
- EXPANDED_DYNAMIC_SEARCH_AD
GetAdGroupAdretrieves one ad at a time. It is meant for exploratory use rather than for retrieval of multiple ads. To retrieve multiple ads, use GoogleAdsService. Learn more.
BiddingStrategyService
MutateBiddingStrategiescreates, updates, or removes search campaign bidding strategies. Both standard and portfolio bidding strategies are supported.GetBiddingStrategyretrieves one bidding strategy at a time. It is meant for exploratory use rather than for retrieval of multiple bidding strategies. To retrieve multiple bidding strategies, use GoogleAdsService. Learn more.
CampaignCriterionService and AdGroupCriterionService
MutateCampaignCriteriaandMutateAdGroupCriteriacreate, update, or remove keyword criteria in search campaigns.GetCampaignCriterionandGetAdGroupCriterionretrieve one criterion at a time. They are meant for exploratory use rather than for retrieval of multiple criteria. To retrieve multiple criteria, use GoogleAdsService. Learn more.
CustomerService
GetCustomerretrieves specific details about an account.