package google.ads.googleads.v0.services
Get desktop application:
View/edit binary Protocol Buffers messages
A service for managing account-level budgets via proposals. A proposal is a request to create a new budget or make changes to an existing one. Reads for account-level budgets managed by these proposals will be supported in a future version. Please use BudgetOrderService until then: https://developers.google.com/adwords/api/docs/guides/budget-order Mutates: The CREATE operation creates a new proposal. UPDATE operations aren't supported. The REMOVE operation cancels a pending proposal.
Returns an account-level budget proposal in full detail.
Request message for [AccountBudgetProposalService.GetAccountBudgetProposal][google.ads.googleads.v0.services.AccountBudgetProposalService.GetAccountBudgetProposal].
string resource_name = 1
The resource name of the account-level budget proposal to fetch.
Creates, updates, or removes account budget proposals. Operation statuses are returned.
Request message for [AccountBudgetProposalService.MutateAccountBudgetProposal][google.ads.googleads.v0.services.AccountBudgetProposalService.MutateAccountBudgetProposal].
string customer_id = 1
The ID of the customer.
optional operation = 2
The operation to perform on an individual account-level budget proposal.
Response message for account-level budget mutate operations.
optional result = 2
The result of the mutate.
A service for fetching an account-level budget. Account-level budgets are mutated by creating proposal resources.
Returns an account-level budget in full detail.
message
account_budget_service.proto:46Request message for [AccountBudgetService.GetAccountBudget][google.ads.googleads.v0.services.AccountBudgetService.GetAccountBudget].
string resource_name = 1
The resource name of the account-level budget to fetch.
Service to manage ads in an ad group.
Returns the requested ad in full detail.
message
ad_group_ad_service.proto:53Request message for [AdGroupAdService.GetAdGroupAd][google.ads.googleads.v0.services.AdGroupAdService.GetAdGroupAd].
string resource_name = 1
The resource name of the ad to fetch.
Creates, updates, or removes ads. Operation statuses are returned.
message
ad_group_ad_service.proto:59Request message for [AdGroupAdService.MutateAdGroupAds][google.ads.googleads.v0.services.AdGroupAdService.MutateAdGroupAds].
string customer_id = 1
The ID of the customer whose ads are being modified.
repeated operations = 2
The list of operations to perform on individual ads.
message
ad_group_ad_service.proto:92Response message for an ad group ad mutate.
repeated results = 2
All results for the mutate.
Service to manage ad group audience views.
Returns the requested ad group audience view in full detail.
Request message for [AdGroupAudienceViewService.GetAdGoupAudienceView][].
string resource_name = 1
The resource name of the ad group audience view to fetch.
Service to manage ad group bid modifiers.
Returns the requested ad group bid modifier in full detail.
Request message for [AdGroupBidModifierService.GetAdGroupBidModifier][google.ads.googleads.v0.services.AdGroupBidModifierService.GetAdGroupBidModifier].
string resource_name = 1
The resource name of the ad group bid modifier to fetch.
Creates, updates, or removes ad group bid modifiers. Operation statuses are returned.
Request message for [AdGroupBidModifierService.MutateAdGroupBidModifiers][google.ads.googleads.v0.services.AdGroupBidModifierService.MutateAdGroupBidModifiers].
string customer_id = 1
ID of the customer whose ad group bid modifiers are being modified.
repeated operations = 2
The list of operations to perform on individual ad group bid modifiers.
Response message for ad group bid modifiers mutate.
repeated results = 2
All results for the mutate.
Service to manage ad group criteria.
Returns the requested criterion in full detail.
Request message for [AdGroupCriterionService.GetAdGroupCriterion][google.ads.googleads.v0.services.AdGroupCriterionService.GetAdGroupCriterion].
string resource_name = 1
The resource name of the criterion to fetch.
Creates, updates, or removes criteria. Operation statuses are returned.
Request message for [AdGroupCriterionService.MutateAdGroupCriteria][google.ads.googleads.v0.services.AdGroupCriterionService.MutateAdGroupCriteria].
string customer_id = 1
ID of the customer whose criteria are being modified.
repeated operations = 2
The list of operations to perform on individual criteria.
Response message for an ad group criterion mutate.
repeated results = 2
All results for the mutate.
Service to manage ad group feeds.
Returns the requested ad group feed in full detail.
message
ad_group_feed_service.proto:53Request message for [AdGroupFeedService.GetAdGroupFeed][google.ads.googleads.v0.services.AdGroupFeedService.GetAdGroupFeed].
string resource_name = 1
The resource name of the ad group feed to fetch.
Creates, updates, or removes ad group feeds. Operation statuses are returned.
message
ad_group_feed_service.proto:59Request message for [AdGroupFeedService.MutateAdGroupFeeds][google.ads.googleads.v0.services.AdGroupFeedService.MutateAdGroupFeeds].
string customer_id = 1
The ID of the customer whose ad group feeds are being modified.
repeated operations = 2
The list of operations to perform on individual ad group feeds.
message
ad_group_feed_service.proto:90Response message for an ad group feed mutate.
repeated results = 2
All results for the mutate.
Service to manage ad groups.
rpc GetAdGroup (, )
ad_group_service.proto:36Returns the requested ad group in full detail.
message
ad_group_service.proto:52Request message for [AdGroupService.GetAdGroup][google.ads.googleads.v0.services.AdGroupService.GetAdGroup].
string resource_name = 1
The resource name of the ad group to fetch.
Creates, updates, or removes ad groups. Operation statuses are returned.
message
ad_group_service.proto:58Request message for [AdGroupService.MutateAdGroups][google.ads.googleads.v0.services.AdGroupService.MutateAdGroups].
string customer_id = 1
The ID of the customer whose ad groups are being modified.
repeated operations = 2
The list of operations to perform on individual ad groups.
message
ad_group_service.proto:88Response message for an ad group mutate.
repeated results = 2
All results for the mutate.
Service to manage age range views.
Returns the requested age range view in full detail.
message
age_range_view_service.proto:43Request message for [AgeRangeViewService.GetAgeRangeView][google.ads.googleads.v0.services.AgeRangeViewService.GetAgeRangeView].
string resource_name = 1
The resource name of the age range view to fetch.
Service to manage bidding strategies.
Returns the requested bidding strategy in full detail.
Request message for [BiddingStrategyService.GetBiddingStrategy][google.ads.googleads.v0.services.BiddingStrategyService.GetBiddingStrategy].
string resource_name = 1
The resource name of the bidding strategy to fetch.
Creates, updates, or removes bidding strategies. Operation statuses are returned.
Request message for [BiddingStrategyService.MutateBiddingStrategies][google.ads.googleads.v0.services.BiddingStrategyService.MutateBiddingStrategies].
string customer_id = 1
The ID of the customer whose bidding strategies are being modified.
repeated operations = 2
The list of operations to perform on individual bidding strategies.
Response message for bidding strategy mutate.
repeated results = 2
All results for the mutate.
A service for designating the business entity responsible for accrued costs. A billing setup is associated with a Payments account. Billing-related activity for all billing setups associated with a particular Payments account will appear on a single invoice generated monthly. Mutates: The REMOVE operation cancels a pending billing setup. The CREATE operation creates a new billing setup.
Returns a billing setup.
message
billing_setup_service.proto:60Request message for [BillingSetupService.GetBillingSetup][google.ads.googleads.v0.services.BillingSetupService.GetBillingSetup].
string resource_name = 1
The resource name of the billing setup to fetch.
Creates a billing setup, or cancels an existing billing setup.
message
billing_setup_service.proto:66Request message for billing setup mutate operations.
string customer_id = 1
Id of the customer to apply the billing setup mutate operation to.
optional operation = 2
The operation to perform.
message
billing_setup_service.proto:93Response message for a billing setup operation.
optional result = 1
A result that identifies the resource affected by the mutate request.
Service to manage campaign audience views.
Returns the requested campaign audience view in full detail.
Request message for [CampaignAudienceViewService.GetCampaignAudienceView][google.ads.googleads.v0.services.CampaignAudienceViewService.GetCampaignAudienceView].
string resource_name = 1
The resource name of the campaign audience view to fetch.
Service to manage campaign bid modifiers.
Returns the requested campaign bid modifier in full detail.
Request message for [CampaignBidModifierService.GetCampaignBidModifier][google.ads.googleads.v0.services.CampaignBidModifierService.GetCampaignBidModifier].
string resource_name = 1
The resource name of the campaign bid modifier to fetch.
Creates, updates, or removes campaign bid modifiers. Operation statuses are returned.
Request message for [CampaignBidModifierService.MutateCampaignBidModifier][].
string customer_id = 1
ID of the customer whose campaign bid modifiers are being modified.
repeated operations = 2
The list of operations to perform on individual campaign bid modifiers.
Response message for campaign bid modifiers mutate.
repeated results = 2
All results for the mutate.
Service to manage campaign budgets.
Returns the requested Campaign Budget in full detail.
message
campaign_budget_service.proto:53Request message for [CampaignBudgetService.GetCampaignBudget][google.ads.googleads.v0.services.CampaignBudgetService.GetCampaignBudget].
string resource_name = 1
The resource name of the campaign budget to fetch.
Creates, updates, or removes campaign budgets. Operation statuses are returned.
message
campaign_budget_service.proto:59Request message for [CampaignBudgetService.MutateCampaignBudgets][google.ads.googleads.v0.services.CampaignBudgetService.MutateCampaignBudgets].
string customer_id = 1
The ID of the customer whose campaign budgets are being modified.
repeated operations = 2
The list of operations to perform on individual campaign budgets.
message
campaign_budget_service.proto:90Response message for campaign budget mutate.
repeated results = 2
All results for the mutate.
Service to manage campaign criteria.
Returns the requested criterion in full detail.
Request message for [CampaignCriterionService.GetCampaignCriterion][google.ads.googleads.v0.services.CampaignCriterionService.GetCampaignCriterion].
string resource_name = 1
The resource name of the criterion to fetch.
Creates, updates, or removes criteria. Operation statuses are returned.
Request message for [CampaignCriterionService.MutateCampaignCriteria][google.ads.googleads.v0.services.CampaignCriterionService.MutateCampaignCriteria].
string customer_id = 1
The ID of the customer whose criteria are being modified.
repeated operations = 2
The list of operations to perform on individual criteria.
Response message for campaign criterion mutate.
repeated results = 2
All results for the mutate.
Service to manage campaign feeds.
Returns the requested campaign feed in full detail.
message
campaign_feed_service.proto:53Request message for [CampaignFeedService.GetCampaignFeed][google.ads.googleads.v0.services.CampaignFeedService.GetCampaignFeed].
string resource_name = 1
The resource name of the campaign feed to fetch.
Creates, updates, or removes campaign feeds. Operation statuses are returned.
message
campaign_feed_service.proto:59Request message for [CampaignFeedService.MutateCampaignFeeds][google.ads.googleads.v0.services.CampaignFeedService.MutateCampaignFeeds].
string customer_id = 1
The ID of the customer whose campaign feeds are being modified.
repeated operations = 2
The list of operations to perform on individual campaign feeds.
message
campaign_feed_service.proto:90Response message for a campaign feed mutate.
repeated results = 2
All results for the mutate.
Service to manage campaign groups.
Returns the requested campaign group in full detail.
message
campaign_group_service.proto:53Request message for [CampaignGroupService.GetCampaignGroup][google.ads.googleads.v0.services.CampaignGroupService.GetCampaignGroup].
string resource_name = 1
The resource name of the campaign group to fetch.
Creates, updates, or removes campaign groups. Operation statuses are returned.
message
campaign_group_service.proto:59Request message for [CampaignGroupService.MutateCampaignGroups][google.ads.googleads.v0.services.CampaignGroupService.MutateCampaignGroups].
string customer_id = 1
The ID of the customer whose campaign groups are being modified.
repeated operations = 2
The list of operations to perform on individual campaign groups.
message
campaign_group_service.proto:91Response message for campaign group mutate.
repeated results = 2
All results for the mutate.
Service to manage campaigns.
rpc GetCampaign (, )
campaign_service.proto:36Returns the requested campaign in full detail.
message
campaign_service.proto:52Request message for [CampaignService.GetCampaign][google.ads.googleads.v0.services.CampaignService.GetCampaign].
string resource_name = 1
The resource name of the campaign to fetch.
Creates, updates, or removes campaigns. Operation statuses are returned.
message
campaign_service.proto:58Request message for [CampaignService.MutateCampaigns][google.ads.googleads.v0.services.CampaignService.MutateCampaigns].
string customer_id = 1
The ID of the customer whose campaigns are being modified.
repeated operations = 2
The list of operations to perform on individual campaigns.
message
campaign_service.proto:89Response message for campaign mutate.
repeated results = 2
All results for the mutate.
Service to manage campaign shared sets.
Service to fetch carrier constants.
Returns the requested carrier constant in full detail.
Request message for [CarrierConstantService.GetCarrierConstant][google.ads.googleads.v0.services.CarrierConstantService.GetCarrierConstant].
string resource_name = 1
Resource name of the carrier constant to fetch.
Service to fetch change statuses.
Returns the requested change status in full detail.
message
change_status_service.proto:43Request message for '[ChangeStatusService.GetChangeStatus][google.ads.googleads.v0.services.ChangeStatusService.GetChangeStatus]'.
string resource_name = 1
The resource name of the change status to fetch.
Service to manage conversion actions.
Returns the requested conversion action.
Request message for [ConversionActionService.GetConversionAction].
string resource_name = 1
The resource name of the conversion action to fetch.
Creates, updates or removes conversion actions. Operation statuses are returned.
Request message for [ConversionActionService.MutateConversionActions].
string customer_id = 1
The ID of the customer whose conversion actions are being modified.
repeated operations = 2
The list of operations to perform on individual conversion actions.
Response message for conversion action mutate.
repeated results = 2
All results for the mutate.
Service to manage customer client links.
Returns the requested CustomerClientLink in full detail.
Request message for [CustomerClientLinkService.GetCustomerClientLink][google.ads.googleads.v0.services.CustomerClientLinkService.GetCustomerClientLink].
string resource_name = 1
The resource name of the customer client link to fetch.
Service to manage customer clients in a manager hierarchy.
Returns the requested customer client in full detail.
message
customer_client_service.proto:43Request message for [CustomerClientService.GetCustomerClient][google.ads.googleads.v0.services.CustomerClientService.GetCustomerClient].
string resource_name = 1
The resource name of the customer client to fetch.
Service to manage customer feeds.
Returns the requested customer feed in full detail.
message
customer_feed_service.proto:53Request message for [CustomerFeedService.GetCustomerFeed][google.ads.googleads.v0.services.CustomerFeedService.GetCustomerFeed].
string resource_name = 1
The resource name of the customer feed to fetch.
Creates, updates, or removes customer feeds. Operation statuses are returned.
message
customer_feed_service.proto:59Request message for [CustomerFeedService.MutateCustomerFeeds][google.ads.googleads.v0.services.CustomerFeedService.MutateCustomerFeeds].
string customer_id = 1
The ID of the customer whose customer feeds are being modified.
repeated operations = 2
The list of operations to perform on individual customer feeds.
message
customer_feed_service.proto:90Response message for a customer feed mutate.
repeated results = 2
All results for the mutate.
Service to manage customer-manager links.
Returns the requested CustomerManagerLink in full detail.
Request message for [CustomerManagerLinkService.GetCustomerManagerLink][google.ads.googleads.v0.services.CustomerManagerLinkService.GetCustomerManagerLink].
string resource_name = 1
The resource name of the CustomerManagerLink to fetch.
Service to manage customers.
Creates a new client under manager. The new client customer is returned.
message
customer_service.proto:84Request message for [CustomerService.CreateCustomerClient][google.ads.googleads.v0.services.CustomerService.CreateCustomerClient].
string customer_id = 1
The ID of the Manager under whom client customer is being created.
optional customer_client = 2
The new client customer to create. The resource name on this customer will be ignored.
message
customer_service.proto:103Response message for CreateCustomerClient mutate.
string resource_name = 2
The resource name of the newly created customer client.
rpc GetCustomer (, )
customer_service.proto:37Returns the requested customer in full detail.
message
customer_service.proto:69Request message for [CustomerService.GetCustomer][google.ads.googleads.v0.services.CustomerService.GetCustomer].
string resource_name = 1
The resource name of the customer to fetch.
Returns resource names of customers directly accessible by the user authenticating the call.
message
customer_service.proto:121Request message for [CustomerService.ListAccessibleCustomers][google.ads.googleads.v0.services.CustomerService.ListAccessibleCustomers].
(message has no fields)
message
customer_service.proto:126Response message for [CustomerService.ListAccessibleCustomers][google.ads.googleads.v0.services.CustomerService.ListAccessibleCustomers].
repeated string resource_names = 1
Resource name of customers directly accessible by the user authenticating the call.
Updates a customer. Operation statuses are returned.
message
customer_service.proto:75Request message for [CustomerService.MutateCustomer][google.ads.googleads.v0.services.CustomerService.MutateCustomer].
string customer_id = 1
The ID of the customer being modified.
optional operation = 4
The operation to perform on the customer
message
customer_service.proto:109Response message for customer mutate.
optional result = 2
Result for the mutate.
Service to manage display keyword views.
Returns the requested display keyword view in full detail.
Request message for [DisplayKeywordViewService.GetDisplayKeywordView][google.ads.googleads.v0.services.DisplayKeywordViewService.GetDisplayKeywordView].
string resource_name = 1
The resource name of the display keyword view to fetch.
Service to manage feed items.
Returns the requested feed item in full detail.
message
feed_item_service.proto:53Request message for [FeedItemService.GetFeedItem][google.ads.googleads.v0.services.FeedItemService.GetFeedItem].
string resource_name = 1
The resource name of the feed item to fetch.
Creates, updates, or removes feed items. Operation statuses are returned.
message
feed_item_service.proto:59Request message for [FeedItemService.MutateFeedItems][google.ads.googleads.v0.services.FeedItemService.MutateFeedItems].
string customer_id = 1
The ID of the customer whose feed items are being modified.
repeated operations = 2
The list of operations to perform on individual feed items.
message
feed_item_service.proto:90Response message for an feed item mutate.
repeated results = 2
All results for the mutate.
Service to manage feed mappings.
Returns the requested feed mapping in full detail.
message
feed_mapping_service.proto:52Request message for [FeedMappingService.GetFeedMapping][google.ads.googleads.v0.services.FeedMappingService.GetFeedMapping].
string resource_name = 1
The resource name of the feed mapping to fetch.
Creates or removes feed mappings. Operation statuses are returned.
message
feed_mapping_service.proto:58Request message for [FeedMappingService.MutateFeedMappings][google.ads.googleads.v0.services.FeedMappingService.MutateFeedMappings].
string customer_id = 1
The ID of the customer whose feed mappings are being modified.
repeated operations = 2
The list of operations to perform on individual feed mappings.
message
feed_mapping_service.proto:82Response message for a feed mapping mutate.
repeated results = 2
All results for the mutate.
service FeedService
feed_service.proto:34Service to manage feeds.
rpc GetFeed (, )
feed_service.proto:36Returns the requested feed in full detail.
message
feed_service.proto:53Request message for [FeedService.GetFeed][google.ads.googleads.v0.services.FeedService.GetFeed].
string resource_name = 1
The resource name of the feed to fetch.
rpc MutateFeeds (, )
feed_service.proto:44Creates, updates, or removes feeds. Operation statuses are returned.
message
feed_service.proto:59Request message for [FeedService.MutateFeeds][google.ads.googleads.v0.services.FeedService.MutateFeeds].
string customer_id = 1
The ID of the customer whose feeds are being modified.
repeated operations = 2
The list of operations to perform on individual feeds.
message
feed_service.proto:90Response message for an feed mutate.
repeated results = 2
All results for the mutate.
Service to manage gender views.
Returns the requested gender view in full detail.
message
gender_view_service.proto:43Request message for [GenderViewService.GetGenderView][google.ads.googleads.v0.services.GenderViewService.GetGenderView].
string resource_name = 1
The resource name of the gender view to fetch.
Service to fetch geo target constants.
Returns the requested geo target constant in full detail.
Request message for [GeoTargetConstantService.GetGeoTargetConstant][google.ads.googleads.v0.services.GeoTargetConstantService.GetGeoTargetConstant].
string resource_name = 1
The resource name of the geo target constant to fetch.
Returns GeoTargetConstant suggestions by location name or by resource name.
Request message for [GeoTargetConstantService.SuggestGeoTargetConstantsRequest][].
optional locale = 3
If possible, returned geo targets are translated using this locale. If not, en is used by default. This is also used as a hint for returned geo targets.
optional country_code = 5
Returned geo targets are restricted to this country code.
oneof query
Required. A selector of geo target constants.
location_names = 1
The location names to search by. At most 25 names can be set.
geo_targets = 2
The geo target constant resource names to filter by.
Response message for [GeoTargetConstantService.SuggestGeoTargetConstants][google.ads.googleads.v0.services.GeoTargetConstantService.SuggestGeoTargetConstants]
repeated geo_target_constant_suggestions = 1
Geo target constant suggestions.
Service to fetch Google Ads API fields.
Returns just the requested field.
Request message for [GoogleAdsFieldService.GetGoogleAdsField][google.ads.googleads.v0.services.GoogleAdsFieldService.GetGoogleAdsField].
string resource_name = 1
The resource name of the field to get.
Returns all fields that match the search query.
Request message for [GoogleAdsFieldService.SearchGoogleAdsFields][google.ads.googleads.v0.services.GoogleAdsFieldService.SearchGoogleAdsFields].
string query = 1
The query string.
string page_token = 2
Token of the page to retrieve. If not specified, the first page of results will be returned. Use the value obtained from `next_page_token` in the previous response in order to request the next page of results.
int32 page_size = 3
Number of elements to retrieve in a single page. When too large a page is requested, the server may decide to further limit the number of returned resources.
Response message for [GoogleAdsFieldService.SearchGoogleAdsFields][google.ads.googleads.v0.services.GoogleAdsFieldService.SearchGoogleAdsFields].
repeated results = 1
The list of fields that matched the query.
string next_page_token = 2
Pagination token used to retrieve the next page of results. Pass the content of this string as the `page_token` attribute of the next request. `next_page_token` is not returned for the last page.
int64 total_results_count = 3
Total number of results that match the query ignoring the LIMIT clause.
Service to fetch data and metrics across resources.
rpc Mutate (, )
google_ads_service.proto:121Creates, updates, or removes resources. Operation statuses are returned.
message
google_ads_service.proto:411Request message for [GoogleAdsService.Mutate][google.ads.googleads.v0.services.GoogleAdsService.Mutate].
string customer_id = 1
The ID of the customer whose resources are being modified.
repeated mutate_operations = 2
The list of operations to perform on individual resources.
message
google_ads_service.proto:420Response message for [GoogleAdsService.Mutate][google.ads.googleads.v0.services.GoogleAdsService.Mutate].
repeated mutate_operation_responses = 1
All responses for the mutate.
rpc Search (, )
google_ads_service.proto:113Returns all rows that match the search query.
message
google_ads_service.proto:130Request message for [GoogleAdsService.Search][google.ads.googleads.v0.services.GoogleAdsService.Search].
string customer_id = 1
The ID of the customer being queried.
string query = 2
The query string.
string page_token = 3
Token of the page to retrieve. If not specified, the first page of results will be returned. Use the value obtained from `next_page_token` in the previous response in order to request the next page of results.
int32 page_size = 4
Number of elements to retrieve in a single page. When too large a page is requested, the server may decide to further limit the number of returned resources.
message
google_ads_service.proto:150Response message for [GoogleAdsService.Search][google.ads.googleads.v0.services.GoogleAdsService.Search].
repeated results = 1
The list of rows that matched the query.
string next_page_token = 2
Pagination token used to retrieve the next page of results. Pass the content of this string as the `page_token` attribute of the next request. `next_page_token` is not returned for the last page.
int64 total_results_count = 3
Total number of results that match the query ignoring the LIMIT clause.
optional field_mask = 5
FieldMask that represents what fields were requested by the user.
Service to manage Hotel Group Views.
Returns the requested Hotel Group View in full detail.
Request message for [HotelGroupViewService.GetHotelGroupView][google.ads.googleads.v0.services.HotelGroupViewService.GetHotelGroupView].
string resource_name = 1
Resource name of the Hotel Group View to fetch.
Service to manage Hotel Performance Views.
Returns the requested Hotel Performance View in full detail.
Request message for [HotelPerformanceViewService.GetHotelPerformanceView][google.ads.googleads.v0.services.HotelPerformanceViewService.GetHotelPerformanceView].
string resource_name = 1
Resource name of the Hotel Performance View to fetch.
Service to manage Keyword Plan ad groups.
Returns the requested Keyword Plan ad group in full detail.
Request message for [KeywordPlanAdGroupService.GetKeywordPlanAdGroup][google.ads.googleads.v0.services.KeywordPlanAdGroupService.GetKeywordPlanAdGroup].
string resource_name = 1
The resource name of the Keyword Plan ad group to fetch.
Creates, updates, or removes Keyword Plan ad groups. Operation statuses are returned.
Request message for [KeywordPlanAdGroupService.MutateKeywordPlanAdGroups][google.ads.googleads.v0.services.KeywordPlanAdGroupService.MutateKeywordPlanAdGroups].
string customer_id = 1
The ID of the customer whose Keyword Plan ad groups are being modified.
repeated operations = 2
The list of operations to perform on individual Keyword Plan ad groups.
Response message for a Keyword Plan ad group mutate.
repeated results = 2
All results for the mutate.
Service to manage Keyword Plan campaigns.
Returns the requested Keyword Plan campaign in full detail.
Request message for [KeywordPlanCampaignService.GetKeywordPlanCampaign][google.ads.googleads.v0.services.KeywordPlanCampaignService.GetKeywordPlanCampaign].
string resource_name = 1
The resource name of the Keyword Plan campaign to fetch.
Creates, updates, or removes Keyword Plan campaigns. Operation statuses are returned.
Request message for [KeywordPlanCampaignService.MutateKeywordPlanCampaigns][google.ads.googleads.v0.services.KeywordPlanCampaignService.MutateKeywordPlanCampaigns].
string customer_id = 1
The ID of the customer whose Keyword Plan campaigns are being modified.
repeated operations = 2
The list of operations to perform on individual Keyword Plan campaigns.
Response message for a Keyword Plan campaign mutate.
repeated results = 2
All results for the mutate.
Service to generate keyword ideas.
Returns a list of keyword ideas.
Request message for [KeywordIdeaService.GenerateKeywordIdeas][].
string customer_id = 1
The ID of the customer with the recommendation.
optional language = 7
The resource name of the language to target. Required
repeated geo_target_constants = 8
The resource names of the location to target. Max 10
enums.KeywordPlanNetworkEnum.KeywordPlanNetwork keyword_plan_network = 9
Targeting network.
oneof seed
The type of seed to generate keyword ideas.
keyword_and_url_seed = 2
A Keyword and a specific Url to generate ideas from e.g. cars, www.example.com/cars.
keyword_seed = 3
A Keyword or phrase to generate ideas from, e.g. cars.
url_seed = 5
A specific url to generate ideas from, e.g. www.example.com/cars.
Response message for [KeywordIdeaService.GenerateKeywordIdeas][].
repeated results = 1
Results of generating keyword ideas.
Service to manage Keyword Plan ad group keywords.
Returns the requested Keyword Plan keyword in full detail.
Request message for [KeywordPlanKeywordService.GetKeywordPlanKeyword][google.ads.googleads.v0.services.KeywordPlanKeywordService.GetKeywordPlanKeyword].
string resource_name = 1
The resource name of the ad group keyword to fetch.
Creates, updates, or removes Keyword Plan keywords. Operation statuses are returned.
Request message for [KeywordPlanKeywordService.MutateKeywordPlanKeywords][google.ads.googleads.v0.services.KeywordPlanKeywordService.MutateKeywordPlanKeywords].
string customer_id = 1
The ID of the customer whose Keyword Plan keywords are being modified.
repeated operations = 2
The list of operations to perform on individual Keyword Plan keywords.
Response message for a Keyword Plan keyword mutate.
repeated results = 2
All results for the mutate.
Service to manage Keyword Plan negative keywords.
Returns the requested plan in full detail.
Request message for [KeywordPlanNegativeKeywordService.GetKeywordPlanNegativeKeyword][google.ads.googleads.v0.services.KeywordPlanNegativeKeywordService.GetKeywordPlanNegativeKeyword].
string resource_name = 1
The resource name of the plan to fetch.
Creates, updates, or removes Keyword Plan negative keywords. Operation statuses are returned.
Request message for [KeywordPlanNegativeKeywordService.MutateKeywordPlanNegativeKeywords][google.ads.googleads.v0.services.KeywordPlanNegativeKeywordService.MutateKeywordPlanNegativeKeywords].
string customer_id = 1
The ID of the customer whose negative keywords are being modified.
repeated operations = 2
The list of operations to perform on individual Keyword Plan negative keywords.
Response message for a Keyword Plan negative keyword mutate.
repeated results = 2
All results for the mutate.
Service to manage keyword plans.
Returns the requested Keyword Plan forecasts.
message
keyword_plan_service.proto:121Request message for [KeywordPlanService.GenerateForecastMetrics][google.ads.googleads.v0.services.KeywordPlanService.GenerateForecastMetrics].
string keyword_plan = 1
The resource name of the keyword plan to be forecasted.
message
keyword_plan_service.proto:127Response message for [KeywordPlanService.GenerateForecastMetrics][google.ads.googleads.v0.services.KeywordPlanService.GenerateForecastMetrics].
repeated campaign_forecasts = 1
List of campaign forecasts. One maximum.
repeated ad_group_forecasts = 2
List of ad group forecasts.
repeated keyword_forecasts = 3
List of keyword forecasts.
Returns the requested Keyword Plan historical metrics.
message
keyword_plan_service.proto:192Request message for [KeywordPlanService.GenerateHistoricalMetrics][google.ads.googleads.v0.services.KeywordPlanService.GenerateHistoricalMetrics].
string keyword_plan = 1
The resource name of the keyword plan of which historical metrics are requested.
message
keyword_plan_service.proto:199Response message for [KeywordPlanService.GenerateHistoricalMetrics][google.ads.googleads.v0.services.KeywordPlanService.GenerateHistoricalMetrics].
repeated metrics = 1
List of keyword historical metrics.
Returns the requested plan in full detail.
message
keyword_plan_service.proto:71Request message for [KeywordPlanService.GetKeywordPlan][google.ads.googleads.v0.services.KeywordPlanService.GetKeywordPlan].
string resource_name = 1
The resource name of the plan to fetch.
Creates, updates, or removes keyword plans. Operation statuses are returned.
message
keyword_plan_service.proto:77Request message for [KeywordPlanService.MutateKeywordPlans][google.ads.googleads.v0.services.KeywordPlanService.MutateKeywordPlans].
string customer_id = 1
The ID of the customer whose keyword plans are being modified.
repeated operations = 2
The list of operations to perform on individual keyword plans.
message
keyword_plan_service.proto:109Response message for a keyword plan mutate.
repeated results = 2
All results for the mutate.
Service to manage keyword views.
Returns the requested keyword view in full detail.
message
keyword_view_service.proto:43Request message for [KeywordViewService.GetKeywordView][google.ads.googleads.v0.services.KeywordViewService.GetKeywordView].
string resource_name = 1
The resource name of the keyword view to fetch.
Service to fetch language constants.
Returns the requested language constant.
Request message for [LanguageConstantService.GetLanguageConstant][google.ads.googleads.v0.services.LanguageConstantService.GetLanguageConstant].
string resource_name = 1
Resource name of the language constant to fetch.
Service to manage Managed Placement views.
Returns the requested Managed Placement view in full detail.
Request message for [ManagedPlacementViewService.GetManagedPlacementView][google.ads.googleads.v0.services.ManagedPlacementViewService.GetManagedPlacementView].
string resource_name = 1
The resource name of the Managed Placement View to fetch.
Service to manage media files.
Returns the requested media file in full detail.
message
media_file_service.proto:51Request message for [MediaFileService.GetMediaFile][google.ads.googleads.v0.services.MediaFileService.GetMediaFile]
string resource_name = 1
The resource name of the media file to fetch.
Creates media files. Operation statuses are returned.
message
media_file_service.proto:57Request message for [MediaFileService.MutateMediaFiles][google.ads.googleads.v0.services.MediaFileService.MutateMediaFiles]
string customer_id = 1
The ID of the customer whose media files are being modified.
repeated operations = 2
The list of operations to perform on individual media file.
message
media_file_service.proto:75Response message for a media file mutate.
repeated results = 2
All results for the mutate.
Service to manage parental status views.
Returns the requested parental status view in full detail.
Request message for [ParentalStatusViewService.GetParentalStatusView][google.ads.googleads.v0.services.ParentalStatusViewService.GetParentalStatusView].
string resource_name = 1
The resource name of the parental status view to fetch.
Service to provide Payments accounts that can be used to set up consolidated billing.
Returns all Payments accounts associated with all managers between the login customer ID and specified serving customer in the hierarchy, inclusive.
Request message for fetching all accessible Payments accounts.
string customer_id = 1
The ID of the customer to apply the PaymentsAccount list operation to.
Response message for [PaymentsAccountService.ListPaymentsAccounts][google.ads.googleads.v0.services.PaymentsAccountService.ListPaymentsAccounts].
repeated payments_accounts = 1
The list of accessible Payments accounts.
Service to manage product group views.
Returns the requested product group view in full detail.
Request message for [ProductGroupViewService.GetProductGroupView][google.ads.googleads.v0.services.ProductGroupViewService.GetProductGroupView].
string resource_name = 1
The resource name of the product group view to fetch.
Service to manage recommendations.
Applies given recommendations with corresponding apply parameters.
message
recommendation_service.proto:69Request message for [RecommendationService.ApplyRecommendation][google.ads.googleads.v0.services.RecommendationService.ApplyRecommendation].
string customer_id = 1
The ID of the customer with the recommendation.
bool partial_failure = 3
If true, successful operations will be carried out and invalid operations will return errors. If false, operations will be carried out as a transaction if and only if they are all valid. Default is false.
repeated operations = 2
The list of operations to apply recommendations. If partial_failure=false all recommendations should be of the same type There is a limit of 100 operations per request.
message
recommendation_service.proto:148Response message for [RecommendationService.ApplyRecommendation][google.ads.googleads.v0.services.RecommendationService.ApplyRecommendation].
repeated results = 1
Results of operations to apply recommendations.
optional partial_failure_error = 2
Errors that pertain to operation failures in the partial failure mode. Returned only when partial_failure = true and all errors occur inside the operations. If any errors occur outside the operations (e.g. auth errors) we return the RPC level error.
Dismisses given recommendations.
message
recommendation_service.proto:166Request message for [RecommendationService.DismissRecommendation][google.ads.googleads.v0.services.RecommendationService.DismissRecommendation].
string customer_id = 1
The ID of the customer with the recommendation.
bool partial_failure = 2
If true, successful operations will be carried out and invalid operations will return errors. If false, operations will be carried in a single transaction if and only if they are all valid. Default is false.
repeated operations = 3
The list of operations to dismiss recommendations. If partial_failure=false all recommendations should be of the same type There is a limit of 100 operations per request.
message
recommendation_service.proto:189Response message for [RecommendationService.DismissRecommendation][google.ads.googleads.v0.services.RecommendationService.DismissRecommendation].
repeated results = 1
Results of operations to dismiss recommendations.
optional partial_failure_error = 2
Errors that pertain to operation failures in the partial failure mode. Returned only when partial_failure = true and all errors occur inside the operations. If any errors occur outside the operations (e.g. auth errors) we return the RPC level error.
Returns the requested recommendation in full detail.
message
recommendation_service.proto:63Request message for [RecommendationService.GetRecommendation][google.ads.googleads.v0.services.RecommendationService.GetRecommendation].
string resource_name = 1
The resource name of the recommendation to fetch.
Service to manage search term views.
Returns the attributes of the requested search term view.
Request message for [SearchTermViewService.GetSearchTermView][google.ads.googleads.v0.services.SearchTermViewService.GetSearchTermView].
string resource_name = 1
The resource name of the search term view to fetch.
Service to manage shared criteria.
Service to manage shared sets.
Service to fetch topic constants.
Returns the requested topic constant in full detail.
message
topic_constant_service.proto:43Request message for [TopicConstantService.GetTopicConstant][google.ads.googleads.v0.services.TopicConstantService.GetTopicConstant].
string resource_name = 1
Resource name of the Topic to fetch.
Service to manage topic views.
Returns the requested topic view in full detail.
message
topic_view_service.proto:43Request message for [TopicViewService.GetTopicView][google.ads.googleads.v0.services.TopicViewService.GetTopicView].
string resource_name = 1
The resource name of the topic view to fetch.
Service to fetch Google Ads User Interest.
Returns the requested user interest in full detail
message
user_interest_service.proto:43Request message for [UserInterestService.GetUserInterest][google.ads.googleads.v0.services.UserInterestService.GetUserInterest].
string resource_name = 1
Resource name of the UserInterest to fetch.
Service to manage user lists.
Returns the requested user list.
message
user_list_service.proto:52Request message for [UserListService.GetUserList][google.ads.googleads.v0.services.UserListService.GetUserList].
string resource_name = 1
The resource name of the user list to fetch.
Creates or updates user lists. Operation statuses are returned.
message
user_list_service.proto:58Request message for [UserListService.MutateUserLists][google.ads.googleads.v0.services.UserListService.MutateUserLists].
string customer_id = 1
The ID of the customer whose user lists are being modified.
repeated operations = 2
The list of operations to perform on individual user lists.
message
user_list_service.proto:89Response message for user list mutate.
repeated results = 2
All results for the mutate.
Service to manage videos.
rpc GetVideo (, )
video_service.proto:35Returns the requested video in full detail.
message
video_service.proto:43Request message for [VideoService.GetVideo][google.ads.googleads.v0.services.VideoService.GetVideo].
string resource_name = 1
The resource name of the video to fetch.
A single operation to propose the creation of a new account-level budget or edit/end/remove an existing one.
Used in:
optional update_mask = 3
FieldMask that determines which budget fields are modified. While budgets may be modified, proposals that propose such modifications are final. Therefore, update operations are not supported for proposals. Proposals that modify budgets have the 'update' proposal type. Specifying a mask for any other proposal type is considered an error.
oneof operation
The mutate operation.
create = 2
Create operation: A new proposal to create a new budget, edit an existing budget, end an actively running budget, or remove an approved budget scheduled to start in the future. No resource name is expected for the new proposal.
string remove = 1
Remove operation: A resource name for the removed proposal is expected, in this format: `customers/{customer_id}/accountBudgetProposals/{account_budget_proposal_id}` A request may be cancelled iff it is pending.
message
ad_group_ad_service.proto:68A single operation (create, update, remove) on an ad group ad.
Used in: ,
optional update_mask = 4
FieldMask that determines which resource fields are modified in an update.
optional policy_validation_parameter = 5
Configuration for how policies are validated.
oneof operation
The mutate operation.
create = 1
Create operation: No resource name is expected for the new ad.
update = 2
Update operation: The ad is expected to have a valid resource name.
string remove = 3
Remove operation: A resource name for the removed ad is expected, in this format: `customers/{customer_id}/adGroupAds/{ad_group_id}_{ad_id}`
A single operation (create, remove, update) on an ad group bid modifier.
Used in: ,
optional update_mask = 4
FieldMask that determines which resource fields are modified in an update.
oneof operation
The mutate operation.
create = 1
Create operation: No resource name is expected for the new ad group bid modifier.
update = 2
Update operation: The ad group bid modifier is expected to have a valid resource name.
string remove = 3
Remove operation: A resource name for the removed ad group bid modifier is expected, in this format: `customers/{customer_id}/adGroupBidModifiers/{ad_group_id}_{criterion_id}`
A single operation (create, remove, update) on an ad group criterion.
Used in: ,
optional update_mask = 4
FieldMask that determines which resource fields are modified in an update.
oneof operation
The mutate operation.
create = 1
Create operation: No resource name is expected for the new criterion.
update = 2
Update operation: The criterion is expected to have a valid resource name.
string remove = 3
Remove operation: A resource name for the removed criterion is expected, in this format: `customers/{customer_id}/adGroupCriteria/{ad_group_id}_{criterion_id}`
message
ad_group_feed_service.proto:68A single operation (create, update, remove) on an ad group feed.
Used in:
optional update_mask = 4
FieldMask that determines which resource fields are modified in an update.
oneof operation
The mutate operation.
create = 1
Create operation: No resource name is expected for the new ad group feed.
update = 2
Update operation: The ad group feed is expected to have a valid resource name.
string remove = 3
Remove operation: A resource name for the removed ad group feed is expected, in this format: `customers/{customer_id}/adGroupFeeds/{ad_group_id}_{feed_id}`
message
ad_group_service.proto:67A single operation (create, update, remove) on an ad group.
Used in: ,
optional update_mask = 4
FieldMask that determines which resource fields are modified in an update.
oneof operation
The mutate operation.
create = 1
Create operation: No resource name is expected for the new ad group.
update = 2
Update operation: The ad group is expected to have a valid resource name.
string remove = 3
Remove operation: A resource name for the removed ad group is expected, in this format: `customers/{customer_id}/adGroups/{ad_group_id}`
message
recommendation_service.proto:88Information about the operation to apply a recommendation and any parameters to customize it.
Used in:
string resource_name = 1
The resource name of the recommendation to apply.
oneof apply_parameters
Parameters to use when applying the recommendation.
campaign_budget = 2
Optional parameters to use when applying a campaign budget recommendation.
text_ad = 3
Optional parameters to use when applying a text ad recommendation.
keyword = 4
Optional parameters to use when applying keyword recommendation.
target_cpa_opt_in = 5
Optional parameters to use when applying target CPA opt-in recommendation.
message
recommendation_service.proto:90Parameters to use when applying a campaign budget recommendation.
Used in:
optional new_budget_amount_micros = 1
New budget amount to set for target budget resource. This is a required field.
message
recommendation_service.proto:104Parameters to use when applying keyword recommendation.
Used in:
optional ad_group = 1
The ad group resource to add keyword to. This is a required field.
enums.KeywordMatchTypeEnum.KeywordMatchType match_type = 2
The match type of the keyword. This is a required field.
optional cpc_bid_micros = 3
Optional, CPC bid to set for the keyword. If not set, keyword will use bid based on bidding strategy used by target ad group.
message
recommendation_service.proto:117Parameters to use when applying Target CPA recommendation.
Used in:
optional target_cpa_micros = 1
Average CPA to use for Target CPA bidding strategy. This is a required field.
optional new_campaign_budget_amount_micros = 2
Optional, budget amount to set for the campaign.
message
recommendation_service.proto:97Parameters to use when applying a text ad recommendation.
Used in:
optional ad = 1
New ad to add to recommended ad group. All necessary fields need to be set in this message. This is a required field.
message
recommendation_service.proto:160The result of applying a recommendation.
Used in:
string resource_name = 1
Returned for successful applies.
A single operation (create, update, remove) on a bidding strategy.
Used in: ,
optional update_mask = 4
FieldMask that determines which resource fields are modified in an update.
oneof operation
The mutate operation.
create = 1
Create operation: No resource name is expected for the new bidding strategy.
update = 2
Update operation: The bidding strategy is expected to have a valid resource name.
string remove = 3
Remove operation: A resource name for the removed bidding strategy is expected, in this format: `customers/{customer_id}/biddingStrategies/{bidding_strategy_id}`
message
billing_setup_service.proto:76A single operation on a billing setup, which describes the cancellation of an existing billing setup.
Used in:
oneof operation
Only one of these operations can be set. "Update" operations are not supported.
create = 2
Creates a billing setup. No resource name is expected for the new billing setup.
string remove = 1
Resource name of the billing setup to remove. A setup cannot be removed unless it is in a pending state or its scheduled start time is in the future. The resource name looks like `customers/{customer_id}/billingSetups/{billing_id}`.
A single operation (create, remove, update) on a campaign bid modifier.
Used in: ,
optional update_mask = 4
FieldMask that determines which resource fields are modified in an update.
oneof operation
The mutate operation.
create = 1
Create operation: No resource name is expected for the new campaign bid modifier.
update = 2
Update operation: The campaign bid modifier is expected to have a valid resource name.
string remove = 3
Remove operation: A resource name for the removed campaign bid modifier is expected, in this format: `customers/{customer_id}/CampaignBidModifiers/{campaign_id}_{criterion_id}`
message
campaign_budget_service.proto:68A single operation (create, update, remove) on a campaign budget.
Used in: ,
optional update_mask = 4
FieldMask that determines which resource fields are modified in an update.
oneof operation
The mutate operation.
create = 1
Create operation: No resource name is expected for the new budget.
update = 2
Update operation: The campaign budget is expected to have a valid resource name.
string remove = 3
Remove operation: A resource name for the removed budget is expected, in this format: `customers/{customer_id}/campaignBudgets/{budget_id}`
A single operation (create, update, remove) on a campaign criterion.
Used in: ,
optional update_mask = 4
FieldMask that determines which resource fields are modified in an update.
oneof operation
The mutate operation.
create = 1
Create operation: No resource name is expected for the new criterion.
update = 2
Update operation: The criterion is expected to have a valid resource name.
string remove = 3
Remove operation: A resource name for the removed criterion is expected, in this format: `customers/{customer_id}/campaignCriteria/{campaign_id}_{criterion_id}`
message
campaign_feed_service.proto:68A single operation (create, update, remove) on a campaign feed.
Used in:
optional update_mask = 4
FieldMask that determines which resource fields are modified in an update.
oneof operation
The mutate operation.
create = 1
Create operation: No resource name is expected for the new campaign feed.
update = 2
Update operation: The campaign feed is expected to have a valid resource name.
string remove = 3
Remove operation: A resource name for the removed campaign feed is expected, in this format: `customers/{customer_id}/campaignFeeds/{campaign_id}_{feed_id}`
message
campaign_group_service.proto:68A single operation (create, update, remove) on a campaign group.
Used in: ,
optional update_mask = 4
FieldMask that determines which resource fields are modified in an update.
oneof operation
The mutate operation.
create = 1
Create operation: No resource name is expected for the new campaign group.
update = 2
Update operation: The campaign group is expected to have a valid resource name.
string remove = 3
Remove operation: A resource name for the removed campaign group is expected, in this format: `customers/{customer_id}/campaignGroups/{campaign_group_id}`
message
campaign_service.proto:67A single operation (create, update, remove) on a campaign.
Used in: ,
optional update_mask = 4
FieldMask that determines which resource fields are modified in an update.
oneof operation
The mutate operation.
create = 1
Create operation: No resource name is expected for the new campaign.
update = 2
Update operation: The campaign is expected to have a valid resource name.
string remove = 3
Remove operation: A resource name for the removed campaign is expected, in this format: `customers/{customer_id}/campaigns/{campaign_id}`
A single operation (create, remove) on an campaign shared set.
Used in: ,
oneof operation
The mutate operation.
create = 1
Create operation: No resource name is expected for the new campaign shared set.
string remove = 3
Remove operation: A resource name for the removed campaign shared set is expected, in this format: `customers/{customer_id}/campaignSharedSets/{campaign_id}_{shared_set_id}`
A single operation (create, update, remove) on a conversion action.
Used in: ,
optional update_mask = 4
FieldMask that determines which resource fields are modified in an update.
oneof operation
The mutate operation.
create = 1
Create operation: No resource name is expected for the new conversion action.
update = 2
Update operation: The conversion action is expected to have a valid resource name.
string remove = 3
Remove operation: A resource name for the removed conversion action is expected, in this format: `customers/{customer_id}/conversionActions/{conversion_action_id}`
message
customer_feed_service.proto:68A single operation (create, update, remove) on a customer feed.
Used in:
optional update_mask = 4
FieldMask that determines which resource fields are modified in an update.
oneof operation
The mutate operation.
create = 1
Create operation: No resource name is expected for the new customer feed.
update = 2
Update operation: The customer feed is expected to have a valid resource name.
string remove = 3
Remove operation: A resource name for the removed customer feed is expected, in this format: `customers/{customer_id}/customerFeeds/{feed_id}`
message
customer_service.proto:94A single update on a customer.
Used in:
optional update = 1
Mutate operation. Only updates are supported for customer.
optional update_mask = 2
FieldMask that determines which resource fields are modified in an update.
message
recommendation_service.proto:168Operation to dismiss a single recommendation identified by resource_name.
Used in:
string resource_name = 1
The resource name of the recommendation to dismiss.
message
recommendation_service.proto:191The result of dismissing a recommendation.
Used in:
string resource_name = 1
Returned for successful dismissals.
message
feed_item_service.proto:68A single operation (create, update, remove) on an feed item.
Used in:
optional update_mask = 4
FieldMask that determines which resource fields are modified in an update.
oneof operation
The mutate operation.
create = 1
Create operation: No resource name is expected for the new feed item.
update = 2
Update operation: The feed item is expected to have a valid resource name.
string remove = 3
Remove operation: A resource name for the removed feed item is expected, in this format: `customers/{customer_id}/feedItems/{feed_id}_{feed_item_id}`
message
feed_mapping_service.proto:67A single operation (create, remove) on a feed mapping.
Used in:
oneof operation
The mutate operation.
create = 1
Create operation: No resource name is expected for the new feed mapping.
string remove = 3
Remove operation: A resource name for the removed feed mapping is expected, in this format: `customers/{customer_id}/feedMappings/{feed_id}_{feed_mapping_id}`
message
feed_service.proto:68A single operation (create, update, remove) on an feed.
Used in:
optional update_mask = 4
FieldMask that determines which resource fields are modified in an update.
oneof operation
The mutate operation.
create = 1
Create operation: No resource name is expected for the new feed.
update = 2
Update operation: The feed is expected to have a valid resource name.
string remove = 3
Remove operation: A resource name for the removed feed is expected, in this format: `customers/{customer_id}/feeds/{feed_id}`
message
keyword_plan_service.proto:174Forecast metrics.
Used in: , ,
optional impressions = 1
Impressions
optional ctr = 2
Ctr
optional average_cpc = 3
AVG cpc
optional clicks = 5
Clicks
optional cost_micros = 6
Cost
The result of generating keyword ideas.
Used in:
optional text = 2
Text of the keyword idea. As in Keyword Plan historical metrics, this text may not be an actual keyword, but the canonical form of multiple keywords. See KeywordPlanKeywordHistoricalMetrics message in KeywordPlanService.
optional keyword_idea_metrics = 3
The historical metrics for the keyword
A geo target constant suggestion.
Used in:
optional locale = 1
The language this GeoTargetConstantSuggestion is currently translated to. It affects the name of geo target fields. For example, if locale=en, then name=Spain. If locale=es, then name=España. The default locale will be returned if no translation exists for the locale in the request.
optional reach = 2
Approximate user population that will be targeted, rounded to the nearest 100.
optional search_term = 3
If the request searched by location name, this is the location name that matched the geo target.
optional geo_target_constant = 4
The GeoTargetConstant result.
repeated geo_target_constant_parents = 5
The list of parents of the geo target constant.
message
google_ads_service.proto:169A returned row from the query.
Used in:
optional account_budget = 42
The account budget in the query.
optional account_budget_proposal = 43
The account budget proposal referenced in the query.
optional ad_group = 3
The ad group referenced in the query.
optional ad_group_ad = 16
The ad referenced in the query.
optional ad_group_audience_view = 57
The ad group audience view referenced in the query.
optional ad_group_bid_modifier = 24
The bid modifier referenced in the query.
optional ad_group_criterion = 17
The criterion referenced in the query.
optional ad_group_feed = 67
The ad group feed referenced in the query.
optional age_range_view = 48
The age range view referenced in the query.
optional bidding_strategy = 18
The bidding strategy referenced in the query.
optional billing_setup = 41
The billing setup referenced in the query.
optional campaign_budget = 19
The campaign budget referenced in the query.
optional campaign = 2
The campaign referenced in the query.
optional campaign_audience_view = 69
The campaign audience view referenced in the query.
optional campaign_bid_modifier = 26
The campaign bid modifier referenced in the query.
optional campaign_criterion = 20
The campaign criterion referenced in the query.
optional campaign_feed = 63
The campaign feed referenced in the query.
optional campaign_group = 25
Campaign Group referenced in AWQL query.
optional campaign_shared_set = 30
Campaign Shared Set referenced in AWQL query.
optional carrier_constant = 66
The carrier constant referenced in the query.
optional change_status = 37
The ChangeStatus referenced in the query.
optional customer = 1
The customer referenced in the query.
optional customer_manager_link = 61
The CustomerManagerLink referenced in the query.
optional customer_client_link = 62
The CustomerClientLink referenced in the query.
optional customer_client = 70
The CustomerClient referenced in the query.
optional customer_feed = 64
The customer feed referenced in the query.
optional display_keyword_view = 47
The display keyword view referenced in the query.
optional feed = 46
The feed referenced in the query.
optional feed_item = 50
The feed item referenced in the query.
optional feed_mapping = 58
The feed mapping referenced in the query.
optional gender_view = 40
The gender view referenced in the query.
optional geo_target_constant = 23
The geo target constant referenced in the query.
optional hotel_group_view = 51
The hotel group view referenced in the query.
optional hotel_performance_view = 71
The hotel performance view referenced in the query.
optional keyword_view = 21
The keyword view referenced in the query.
optional keyword_plan = 32
The keyword plan referenced in the query.
optional keyword_plan_campaign = 33
The keyword plan campaign referenced in the query.
optional keyword_plan_negative_keyword = 34
The keyword plan negative keyword referenced in the query.
optional keyword_plan_ad_group = 35
The keyword plan ad group referenced in the query.
optional keyword_plan_keyword = 36
The keyword plan keyword referenced in the query.
optional language_constant = 55
The language constant referenced in the query.
optional managed_placement_view = 53
The managed placement view referenced in the query.
optional parental_status_view = 45
The parental status view referenced in the query.
optional product_group_view = 54
The product group view referenced in the query.
optional recommendation = 22
The recommendation referenced in the query.
optional search_term_view = 68
The search term view referenced in the query.
optional shared_criterion = 29
The shared set referenced in the query.
optional shared_set = 27
The shared set referenced in the query.
optional topic_view = 44
The topic view referenced in the query.
optional user_interest = 59
The user interest referenced in the query.
optional user_list = 38
The user list referenced in the query.
optional topic_constant = 31
The topic constant referenced in the query.
optional video = 39
The video referenced in the query.
optional metrics = 4
The metrics.
enums.AdNetworkTypeEnum.AdNetworkType ad_network_type = 5
Ad network type.
optional date = 6
Date to which metrics apply. yyyy-MM-dd format, e.g., 2018-04-17.
enums.DayOfWeekEnum.DayOfWeek day_of_week = 7
Day of the week, e.g., MONDAY.
enums.DeviceEnum.Device device = 8
Device to which metrics apply.
optional hotel_booking_window_days = 83
Hotel booking window in days.
optional hotel_center_id = 72
Hotel center ID.
optional hotel_check_in_date = 73
Hotel check-in date. Formatted as yyyy-MM-dd.
enums.DayOfWeekEnum.DayOfWeek hotel_check_in_day_of_week = 74
Hotel check-in day of week.
optional hotel_city = 75
Hotel city.
optional hotel_class = 76
Hotel class.
optional hotel_country = 77
Hotel country.
enums.HotelDateSelectionTypeEnum.HotelDateSelectionType hotel_date_selection_type = 78
Hotel date selection type.
optional hotel_length_of_stay = 79
Hotel length of stay.
optional hotel_state = 81
Hotel state.
optional hour = 9
Hour of day as a number between 0 and 23, inclusive.
optional month = 10
Month as represented by the date of the first day of a month. Formatted as yyyy-MM-dd.
enums.MonthOfYearEnum.MonthOfYear month_of_year = 28
Month of the year, e.g., January.
optional partner_hotel_id = 82
Partner hotel ID.
enums.PlaceholderTypeEnum.PlaceholderType placeholder_type = 65
Placeholder type. This is only used with feed item metrics.
optional quarter = 12
Quarter as represented by the date of the first day of a quarter. Uses the calendar year for quarters, e.g., the second quarter of 2018 starts on 2018-04-01. Formatted as yyyy-MM-dd.
enums.SearchTermMatchTypeEnum.SearchTermMatchType search_term_match_type = 56
Match type of the keyword that triggered the ad, including variants.
enums.SlotEnum.Slot slot = 13
Position of the ad.
optional week = 14
Week as defined as Monday through Sunday, and represented by the date of Monday. Formatted as yyyy-MM-dd.
optional year = 15
Year, formatted as yyyy.
Keyword And Url Seed
Used in:
optional url = 1
The URL to crawl in order to generate keyword ideas.
repeated keywords = 2
Requires at least one keyword.
message
keyword_plan_service.proto:151An ad group forecast.
Used in:
optional keyword_plan_ad_group = 1
The resource name of the Keyword Plan ad group related to the forecast. `customers/{customer_id}/keywordPlanAdGroups/{keyword_plan_ad_group_id}`
optional ad_group_forecast = 2
The forecast for the Keyword Plan ad group.
A single operation (create, update, remove) on a Keyword Plan ad group.
Used in:
optional update_mask = 4
The FieldMask that determines which resource fields are modified in an update.
oneof operation
The mutate operation.
create = 1
Create operation: No resource name is expected for the new Keyword Plan ad group.
update = 2
Update operation: The Keyword Plan ad group is expected to have a valid resource name.
string remove = 3
Remove operation: A resource name for the removed Keyword Plan ad group is expected, in this format: `customers/{customer_id}/keywordPlanAdGroups/{kp_ad_group_id}`
message
keyword_plan_service.proto:140A campaign forecast.
Used in:
optional keyword_plan_campaign = 1
The resource name of the Keyword Plan campaign related to the forecast. `customers/{customer_id}/keywordPlanCampaigns/{keyword+plan_campaign_id}`
optional campaign_forecast = 2
The forecast for the Keyword Plan campaign.
A single operation (create, update, remove) on a Keyword Plan campaign.
Used in:
optional update_mask = 4
The FieldMask that determines which resource fields are modified in an update.
oneof operation
The mutate operation.
create = 1
Create operation: No resource name is expected for the new Keyword Plan campaign.
update = 2
Update operation: The Keyword Plan campaign is expected to have a valid resource name.
string remove = 3
Remove operation: A resource name for the removed Keyword Plan campaign is expected, in this format: `customers/{customer_id}/keywordPlanCampaigns/{keywordPlan_campaign_id}`
message
keyword_plan_service.proto:162A keyword forecast.
Used in:
optional keyword_plan_ad_group_keyword = 1
The resource name of the Keyword Plan keyword related to the forecast. `customers/{customer_id}/keywordPlanAdGroupKeywords/{keyword_plan_ad_group_keyword_id}`
optional keyword_forecast = 2
The forecast for the Keyword Plan keyword.
message
keyword_plan_service.proto:205A keyword historical metrics.
Used in:
optional search_query = 1
The text of the query associated with one or more ad_group_keywords in the plan. Note that we de-dupe your keywords list, eliminating close variants before returning the plan's keywords as text. For example, if your plan originally contained the keywords 'car' and 'cars', the returned search query will only contain 'car'.
optional keyword_metrics = 2
The historical metrics for the query associated with one or more ad_group_keywords in the plan.
A single operation (create, update, remove) on a Keyword Plan keyword.
Used in:
optional update_mask = 4
The FieldMask that determines which resource fields are modified in an update.
oneof operation
The mutate operation.
create = 1
Create operation: No resource name is expected for the new Keyword Plan ad group keyword.
update = 2
Update operation: The Keyword Plan keyword is expected to have a valid resource name.
string remove = 3
Remove operation: A resource name for the removed Keyword Plan keyword is expected, in this format: `customers/{customer_id}/keywordPlanKeywords/{kp_ad_group_keyword_id}`
A single operation (create, update, remove) on a Keyword Plan negative keyword.
Used in:
optional update_mask = 4
The FieldMask that determines which resource fields are modified in an update.
oneof operation
The mutate operation.
create = 1
Create operation: No resource name is expected for the new Keyword Plan negative keyword.
update = 2
Update operation: The Keyword Plan negative keyword expected to have a valid resource name.
string remove = 3
Remove operation: A resource name for the removed Keyword Plan negative keywords expected in this format: `customers/{customer_id}/keywordPlanNegativeKeywords/{kp_negative_keyword_id}`
message
keyword_plan_service.proto:86A single operation (create, update, remove) on a keyword plan.
Used in:
optional update_mask = 4
The FieldMask that determines which resource fields are modified in an update.
oneof operation
The mutate operation.
create = 1
Create operation: No resource name is expected for the new keyword plan.
update = 2
Update operation: The keyword plan is expected to have a valid resource name.
string remove = 3
Remove operation: A resource name for the removed keyword plan is expected in this format: `customers/{customer_id}/keywordPlans/{keyword_plan_id}`
Keyword Seed
Used in:
repeated keywords = 1
Requires at least one keyword.
message
media_file_service.proto:66A single operation to create media file.
Used in:
oneof operation
The mutate operation.
create = 1
Create operation: No resource name is expected for the new media file.
The result for the account budget proposal mutate.
Used in:
string resource_name = 1
Returned for successful operations.
message
ad_group_ad_service.proto:98The result for the ad mutate.
Used in: ,
string resource_name = 1
The resource name returned for successful operations.
The result for the criterion mutate.
Used in: ,
string resource_name = 1
Returned for successful operations.
The result for the criterion mutate.
Used in: ,
string resource_name = 1
Returned for successful operations.
message
ad_group_feed_service.proto:96The result for the ad group feed mutate.
Used in:
string resource_name = 1
Returned for successful operations.
message
ad_group_service.proto:94The result for the ad group mutate.
Used in: ,
string resource_name = 1
Returned for successful operations.
The result for the bidding strategy mutate.
Used in: ,
string resource_name = 1
Returned for successful operations.
message
billing_setup_service.proto:99Result for a single billing setup mutate.
Used in:
string resource_name = 1
Returned for successful operations.
The result for the criterion mutate.
Used in: ,
string resource_name = 1
Returned for successful operations.
message
campaign_budget_service.proto:96The result for the campaign budget mutate.
Used in: ,
string resource_name = 1
Returned for successful operations.
The result for the criterion mutate.
Used in: ,
string resource_name = 1
Returned for successful operations.
message
campaign_feed_service.proto:96The result for the campaign feed mutate.
Used in:
string resource_name = 1
Returned for successful operations.
message
campaign_group_service.proto:97The result for the campaign group mutate.
Used in: ,
string resource_name = 1
Returned for successful operations.
message
campaign_service.proto:95The result for the campaign mutate.
Used in: ,
string resource_name = 1
Returned for successful operations.
The result for the campaign shared set mutate.
Used in: ,
string resource_name = 1
Returned for successful operations.
The result for the conversion action mutate.
Used in: ,
string resource_name = 1
Returned for successful operations.
message
customer_feed_service.proto:96The result for the customer feed mutate.
Used in:
string resource_name = 1
Returned for successful operations.
message
customer_service.proto:115The result for the customer mutate.
Used in:
string resource_name = 1
Returned for successful operations.
message
feed_item_service.proto:96The result for the feed item mutate.
Used in:
string resource_name = 1
Returned for successful operations.
message
feed_mapping_service.proto:88The result for the feed mapping mutate.
Used in:
string resource_name = 1
Returned for successful operations.
message
feed_service.proto:96The result for the feed mutate.
Used in:
string resource_name = 1
Returned for successful operations.
The result for the Keyword Plan ad group mutate.
Used in:
string resource_name = 1
Returned for successful operations.
The result for the Keyword Plan campaign mutate.
Used in:
string resource_name = 1
Returned for successful operations.
The result for the Keyword Plan keyword mutate.
Used in:
string resource_name = 1
Returned for successful operations.
The result for the Keyword Plan negative keyword mutate.
Used in:
string resource_name = 1
Returned for successful operations.
message
keyword_plan_service.proto:115The result for the keyword plan mutate.
Used in:
string resource_name = 1
Returned for successful operations.
message
media_file_service.proto:81The result for the media file mutate.
Used in:
string resource_name = 1
The resource name returned for successful operations.
message
google_ads_service.proto:426A single operation (create, update, remove) on a resource.
Used in:
oneof operation
The mutate operation.
ad_group_ad_operation = 1
An ad group ad mutate operation.
ad_group_bid_modifier_operation = 2
An ad group bid modifier mutate operation.
ad_group_criterion_operation = 3
An ad group criterion mutate operation.
ad_group_operation = 5
An ad group mutate operation.
bidding_strategy_operation = 6
A bidding strategy mutate operation.
campaign_bid_modifier_operation = 7
A campaign bid modifier mutate operation.
campaign_budget_operation = 8
A campaign budget mutate operation.
campaign_group_operation = 9
A campaign group mutate operation.
campaign_operation = 10
A campaign mutate operation.
campaign_shared_set_operation = 11
A campaign shared set mutate operation.
conversion_action_operation = 12
A conversion action mutate operation.
campaign_criterion_operation = 13
A campaign criterion mutate operation.
shared_criterion_operation = 14
A shared criterion mutate operation.
shared_set_operation = 15
A shared set mutate operation.
user_list_operation = 16
A user list mutate operation.
message
google_ads_service.proto:477Response message for the resource mutate.
Used in:
oneof response
The mutate response
ad_group_ad_result = 1
The result for the ad group ad mutate.
ad_group_bid_modifier_result = 2
The result for the ad group bid modifier mutate.
ad_group_criterion_result = 3
The result for the ad group criterion mutate.
ad_group_result = 5
The result for the ad group mutate.
bidding_strategy_result = 6
The result for the bidding strategy mutate.
campaign_bid_modifier_result = 7
The result for the campaign bid modifier mutate.
campaign_budget_result = 8
The result for the campaign budget mutate.
campaign_group_result = 9
The result for the campaign group mutate.
campaign_result = 10
The result for the campaign mutate.
campaign_shared_set_result = 11
The result for the campaign shared set mutate.
conversion_action_result = 12
The result for the conversion action mutate.
campaign_criterion_result = 13
The result for the campaign criterion mutate.
shared_criterion_result = 14
The result for the shared criterion mutate.
shared_set_result = 15
The result for the shared set mutate.
user_list_result = 16
The result for the user list mutate.
The result for the shared criterion mutate.
Used in: ,
string resource_name = 1
Returned for successful operations.
The result for the shared set mutate.
Used in: ,
string resource_name = 1
Returned for successful operations.
message
user_list_service.proto:95The result for the user list mutate.
Used in: ,
string resource_name = 1
Returned for successful operations.
A single operation (create, remove) on an shared criterion.
Used in: ,
oneof operation
The mutate operation.
create = 1
Create operation: No resource name is expected for the new shared criterion.
string remove = 3
Remove operation: A resource name for the removed shared criterion is expected, in this format: `customers/{customer_id}/sharedCriteria/{shared_set_id}_{criterion_id}`
A single operation (create, update, remove) on an shared set.
Used in: ,
optional update_mask = 4
FieldMask that determines which resource fields are modified in an update.
oneof operation
The mutate operation.
create = 1
Create operation: No resource name is expected for the new shared set.
update = 2
Update operation: The shared set is expected to have a valid resource name.
string remove = 3
Remove operation: A resource name for the removed shared set is expected, in this format: `customers/{customer_id}/sharedSets/{shared_set_id}`
A list of geo target constant resource names.
Used in:
repeated geo_target_constants = 1
A list of geo target constant resource names.
A list of location names.
Used in:
repeated names = 1
A list of location names.
Url Seed
Used in:
optional url = 1
The URL to crawl in order to generate keyword ideas.
message
user_list_service.proto:67A single operation (create, update) on a user list.
Used in: ,
optional update_mask = 4
FieldMask that determines which resource fields are modified in an update.
oneof operation
The mutate operation.
create = 1
Create operation: No resource name is expected for the new user list.
update = 2
Update operation: The user list is expected to have a valid resource name.
string remove = 3
Remove operation: A resource name for the removed user list is expected, in this format: `customers/{customer_id}/userLists/{user_list_id}`