package google.ads.googleads.v2.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. Until then, please use the BudgetOrderService from the AdWords API. Learn more at 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.v2.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.v2.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.
bool validate_only = 3
If true, the request is validated but not executed. Only errors are returned, not results.
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:51Request message for [AccountBudgetService.GetAccountBudget][google.ads.googleads.v2.services.AccountBudgetService.GetAccountBudget].
string resource_name = 1
The resource name of the account-level budget to fetch.
Service to fetch ad group ad asset views.
Returns the requested ad group ad asset view in full detail.
Request message for [AdGroupAdAssetViewService.GetAdGroupAdAssetView][google.ads.googleads.v2.services.AdGroupAdAssetViewService.GetAdGroupAdAssetView].
string resource_name = 1
The resource name of the ad group ad asset view to fetch.
Service to manage labels on ad group ads.
Returns the requested ad group ad label in full detail.
Request message for [AdGroupAdLabelService.GetAdGroupAdLabel][google.ads.googleads.v2.services.AdGroupAdLabelService.GetAdGroupAdLabel].
string resource_name = 1
The resource name of the ad group ad label to fetch.
Creates and removes ad group ad labels. Operation statuses are returned.
Request message for [AdGroupAdLabelService.MutateAdGroupAdLabels][google.ads.googleads.v2.services.AdGroupAdLabelService.MutateAdGroupAdLabels].
string customer_id = 1
ID of the customer whose ad group ad labels are being modified.
repeated operations = 2
The list of operations to perform on ad group ad labels.
bool partial_failure = 3
If true, successful operations will be carried out and invalid operations will return errors. If false, all operations will be carried out in one transaction if and only if they are all valid. Default is false.
bool validate_only = 4
If true, the request is validated but not executed. Only errors are returned, not results.
Response message for an ad group ad labels mutate.
optional partial_failure_error = 3
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 an RPC level error.
repeated results = 2
All results for the mutate.
Service to manage ads in an ad group.
Returns the requested ad in full detail.
message
ad_group_ad_service.proto:59Request message for [AdGroupAdService.GetAdGroupAd][google.ads.googleads.v2.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:65Request message for [AdGroupAdService.MutateAdGroupAds][google.ads.googleads.v2.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.
bool partial_failure = 3
If true, successful operations will be carried out and invalid operations will return errors. If false, all operations will be carried out in one transaction if and only if they are all valid. Default is false.
bool validate_only = 4
If true, the request is validated but not executed. Only errors are returned, not results.
message
ad_group_ad_service.proto:108Response message for an ad group ad mutate.
optional partial_failure_error = 3
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 an RPC level error.
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.v2.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.v2.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.
bool partial_failure = 3
If true, successful operations will be carried out and invalid operations will return errors. If false, all operations will be carried out in one transaction if and only if they are all valid. Default is false.
bool validate_only = 4
If true, the request is validated but not executed. Only errors are returned, not results.
Response message for ad group bid modifiers mutate.
optional partial_failure_error = 3
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 an RPC level error.
repeated results = 2
All results for the mutate.
Service to manage labels on ad group criteria.
Returns the requested ad group criterion label in full detail.
Request message for [AdGroupCriterionLabelService.GetAdGroupCriterionLabel][google.ads.googleads.v2.services.AdGroupCriterionLabelService.GetAdGroupCriterionLabel].
string resource_name = 1
The resource name of the ad group criterion label to fetch.
Creates and removes ad group criterion labels. Operation statuses are returned.
Request message for [AdGroupCriterionLabelService.MutateAdGroupCriterionLabels][google.ads.googleads.v2.services.AdGroupCriterionLabelService.MutateAdGroupCriterionLabels].
string customer_id = 1
ID of the customer whose ad group criterion labels are being modified.
repeated operations = 2
The list of operations to perform on ad group criterion labels.
bool partial_failure = 3
If true, successful operations will be carried out and invalid operations will return errors. If false, all operations will be carried out in one transaction if and only if they are all valid. Default is false.
bool validate_only = 4
If true, the request is validated but not executed. Only errors are returned, not results.
Response message for an ad group criterion labels mutate.
optional partial_failure_error = 3
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 an RPC level error.
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.v2.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.v2.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.
bool partial_failure = 3
If true, successful operations will be carried out and invalid operations will return errors. If false, all operations will be carried out in one transaction if and only if they are all valid. Default is false.
bool validate_only = 4
If true, the request is validated but not executed. Only errors are returned, not results.
Response message for an ad group criterion mutate.
optional partial_failure_error = 3
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 an RPC level error.
repeated results = 2
All results for the mutate.
Service to fetch ad group criterion simulations.
Returns the requested ad group criterion simulation in full detail.
Request message for [AdGroupCriterionSimulationService.GetAdGroupCriterionSimulation][google.ads.googleads.v2.services.AdGroupCriterionSimulationService.GetAdGroupCriterionSimulation].
string resource_name = 1
The resource name of the ad group criterion simulation to fetch.
Service to manage ad group extension settings.
Returns the requested ad group extension setting in full detail.
Request message for [AdGroupExtensionSettingService.GetAdGroupExtensionSetting][google.ads.googleads.v2.services.AdGroupExtensionSettingService.GetAdGroupExtensionSetting].
string resource_name = 1
The resource name of the ad group extension setting to fetch.
Creates, updates, or removes ad group extension settings. Operation statuses are returned.
Request message for [AdGroupExtensionSettingService.MutateAdGroupExtensionSettings][google.ads.googleads.v2.services.AdGroupExtensionSettingService.MutateAdGroupExtensionSettings].
string customer_id = 1
The ID of the customer whose ad group extension settings are being modified.
repeated operations = 2
The list of operations to perform on individual ad group extension settings.
bool partial_failure = 3
If true, successful operations will be carried out and invalid operations will return errors. If false, all operations will be carried out in one transaction if and only if they are all valid. Default is false.
bool validate_only = 4
If true, the request is validated but not executed. Only errors are returned, not results.
Response message for an ad group extension setting mutate.
optional partial_failure_error = 3
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 an RPC level error.
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:59Request message for [AdGroupFeedService.GetAdGroupFeed][google.ads.googleads.v2.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:65Request message for [AdGroupFeedService.MutateAdGroupFeeds][google.ads.googleads.v2.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.
bool partial_failure = 3
If true, successful operations will be carried out and invalid operations will return errors. If false, all operations will be carried out in one transaction if and only if they are all valid. Default is false.
bool validate_only = 4
If true, the request is validated but not executed. Only errors are returned, not results.
message
ad_group_feed_service.proto:106Response message for an ad group feed mutate.
optional partial_failure_error = 3
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 an RPC level error.
repeated results = 2
All results for the mutate.
Service to manage labels on ad groups.
Returns the requested ad group label in full detail.
message
ad_group_label_service.proto:58Request message for [AdGroupLabelService.GetAdGroupLabel][google.ads.googleads.v2.services.AdGroupLabelService.GetAdGroupLabel].
string resource_name = 1
The resource name of the ad group label to fetch.
Creates and removes ad group labels. Operation statuses are returned.
message
ad_group_label_service.proto:64Request message for [AdGroupLabelService.MutateAdGroupLabels][google.ads.googleads.v2.services.AdGroupLabelService.MutateAdGroupLabels].
string customer_id = 1
ID of the customer whose ad group labels are being modified.
repeated operations = 2
The list of operations to perform on ad group labels.
bool partial_failure = 3
If true, successful operations will be carried out and invalid operations will return errors. If false, all operations will be carried out in one transaction if and only if they are all valid. Default is false.
bool validate_only = 4
If true, the request is validated but not executed. Only errors are returned, not results.
message
ad_group_label_service.proto:99Response message for an ad group labels mutate.
optional partial_failure_error = 3
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 an RPC level error.
repeated results = 2
All results for the mutate.
Service to manage ad groups.
rpc GetAdGroup (, )
ad_group_service.proto:42Returns the requested ad group in full detail.
message
ad_group_service.proto:58Request message for [AdGroupService.GetAdGroup][google.ads.googleads.v2.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:64Request message for [AdGroupService.MutateAdGroups][google.ads.googleads.v2.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.
bool partial_failure = 3
If true, successful operations will be carried out and invalid operations will return errors. If false, all operations will be carried out in one transaction if and only if they are all valid. Default is false.
bool validate_only = 4
If true, the request is validated but not executed. Only errors are returned, not results.
message
ad_group_service.proto:104Response message for an ad group mutate.
optional partial_failure_error = 3
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 an RPC level error.
repeated results = 2
All results for the mutate.
Service to fetch ad group simulations.
Returns the requested ad group simulation in full detail.
Request message for [AdGroupSimulationService.GetAdGroupSimulation][google.ads.googleads.v2.services.AdGroupSimulationService.GetAdGroupSimulation].
string resource_name = 1
The resource name of the ad group simulation to fetch.
Service to manage ad parameters.
Returns the requested ad parameter in full detail.
message
ad_parameter_service.proto:59Request message for [AdParameterService.GetAdParameter][google.ads.googleads.v2.services.AdParameterService.GetAdParameter]
string resource_name = 1
The resource name of the ad parameter to fetch.
Creates, updates, or removes ad parameters. Operation statuses are returned.
message
ad_parameter_service.proto:65Request message for [AdParameterService.MutateAdParameters][google.ads.googleads.v2.services.AdParameterService.MutateAdParameters]
string customer_id = 1
The ID of the customer whose ad parameters are being modified.
repeated operations = 2
The list of operations to perform on individual ad parameters.
bool partial_failure = 3
If true, successful operations will be carried out and invalid operations will return errors. If false, all operations will be carried out in one transaction if and only if they are all valid. Default is false.
bool validate_only = 4
If true, the request is validated but not executed. Only errors are returned, not results.
message
ad_parameter_service.proto:106Response message for an ad parameter mutate.
optional partial_failure_error = 3
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 an RPC level error.
repeated results = 2
All results for the mutate.
Service to fetch ad schedule views.
Returns the requested ad schedule view in full detail.
Request message for [AdScheduleViewService.GetAdScheduleView][google.ads.googleads.v2.services.AdScheduleViewService.GetAdScheduleView].
string resource_name = 1
The resource name of the ad schedule view to fetch.
service AdService
ad_service.proto:37Service to manage ads.
rpc GetAd (, )
ad_service.proto:41Returns the requested ad in full detail.
message
ad_service.proto:57Request message for [AdService.GetAd][google.ads.googleads.v2.services.AdService.GetAd].
string resource_name = 1
The resource name of the ad to fetch.
rpc MutateAds (, )
ad_service.proto:48Updates ads. Operation statuses are returned.
message
ad_service.proto:63Request message for [AdService.MutateAds][google.ads.googleads.v2.services.AdService.MutateAds].
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_service.proto:87Response message for an ad 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:48Request message for [AgeRangeViewService.GetAgeRangeView][google.ads.googleads.v2.services.AgeRangeViewService.GetAgeRangeView].
string resource_name = 1
The resource name of the age range view to fetch.
Service to manage assets. Asset types can be created with AssetService are YoutubeVideoAsset, MediaBundleAsset and ImageAsset. TextAsset should be created with Ad inline.
rpc GetAsset (, )
asset_service.proto:42Returns the requested asset in full detail.
message
asset_service.proto:58Request message for [AssetService.GetAsset][google.ads.googleads.v2.services.AssetService.GetAsset]
string resource_name = 1
The resource name of the asset to fetch.
rpc MutateAssets (, )
asset_service.proto:49Creates assets. Operation statuses are returned.
message
asset_service.proto:64Request message for [AssetService.MutateAssets][google.ads.googleads.v2.services.AssetService.MutateAssets]
string customer_id = 1
The ID of the customer whose assets are being modified.
repeated operations = 2
The list of operations to perform on individual assets.
message
asset_service.proto:84Response message for an asset mutate.
repeated results = 2
All results for the mutate.
Service to manage bidding strategies.
Returns the requested bidding strategy in full detail.
Request message for [BiddingStrategyService.GetBiddingStrategy][google.ads.googleads.v2.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.v2.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.
bool partial_failure = 3
If true, successful operations will be carried out and invalid operations will return errors. If false, all operations will be carried out in one transaction if and only if they are all valid. Default is false.
bool validate_only = 4
If true, the request is validated but not executed. Only errors are returned, not results.
Response message for bidding strategy mutate.
optional partial_failure_error = 3
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 an RPC level error.
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:65Request message for [BillingSetupService.GetBillingSetup][google.ads.googleads.v2.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:71Request 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:98Response 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.v2.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.v2.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.
bool partial_failure = 3
If true, successful operations will be carried out and invalid operations will return errors. If false, all operations will be carried out in one transaction if and only if they are all valid. Default is false.
bool validate_only = 4
If true, the request is validated but not executed. Only errors are returned, not results.
Response message for campaign bid modifiers mutate.
optional partial_failure_error = 3
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 an RPC level error.
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:59Request message for [CampaignBudgetService.GetCampaignBudget][google.ads.googleads.v2.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:65Request message for [CampaignBudgetService.MutateCampaignBudgets][google.ads.googleads.v2.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.
bool partial_failure = 3
If true, successful operations will be carried out and invalid operations will return errors. If false, all operations will be carried out in one transaction if and only if they are all valid. Default is false.
bool validate_only = 4
If true, the request is validated but not executed. Only errors are returned, not results.
Response message for campaign budget mutate.
optional partial_failure_error = 3
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 an RPC level error.
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.v2.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.v2.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.
bool partial_failure = 3
If true, successful operations will be carried out and invalid operations will return errors. If false, all operations will be carried out in one transaction if and only if they are all valid. Default is false.
bool validate_only = 4
If true, the request is validated but not executed. Only errors are returned, not results.
Response message for campaign criterion mutate.
optional partial_failure_error = 3
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 an RPC level error.
repeated results = 2
All results for the mutate.
Service to fetch campaign criterion simulations.
Returns the requested campaign criterion simulation in full detail.
Request message for [CampaignCriterionSimulationService.GetCampaignCriterionSimulation][google.ads.googleads.v2.services.CampaignCriterionSimulationService.GetCampaignCriterionSimulation].
string resource_name = 1
The resource name of the campaign criterion simulation to fetch.
Service to manage campaign drafts.
Returns the requested campaign draft in full detail.
message
campaign_draft_service.proto:88Request message for [CampaignDraftService.GetCampaignDraft][google.ads.googleads.v2.services.CampaignDraftService.GetCampaignDraft].
string resource_name = 1
The resource name of the campaign draft to fetch.
Creates, updates, or removes campaign drafts. Operation statuses are returned.
message
campaign_draft_service.proto:94Request message for [CampaignDraftService.MutateCampaignDrafts][google.ads.googleads.v2.services.CampaignDraftService.MutateCampaignDrafts].
string customer_id = 1
The ID of the customer whose campaign drafts are being modified.
repeated operations = 2
The list of operations to perform on individual campaign drafts.
bool partial_failure = 3
If true, successful operations will be carried out and invalid operations will return errors. If false, all operations will be carried out in one transaction if and only if they are all valid. Default is false.
bool validate_only = 4
If true, the request is validated but not executed. Only errors are returned, not results.
message
campaign_draft_service.proto:142Response message for campaign draft mutate.
optional partial_failure_error = 3
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 an RPC level error.
repeated results = 2
All results for the mutate.
Promotes the changes in a draft back to the base campaign. This method returns a Long Running Operation (LRO) indicating if the Promote is done. Use [Operations.GetOperation] to poll the LRO until it is done. Only a done status is returned in the response. See the status in the Campaign Draft resource to determine if the promotion was successful. If the LRO failed, use [CampaignDraftService.ListCampaignDraftAsyncErrors][google.ads.googleads.v2.services.CampaignDraftService.ListCampaignDraftAsyncErrors] to view the list of error reasons.
message
campaign_draft_service.proto:113Request message for [CampaignDraftService.PromoteCampaignDraft][google.ads.googleads.v2.services.CampaignDraftService.PromoteCampaignDraft].
string campaign_draft = 1
The resource name of the campaign draft to promote.
Returns all errors that occurred during CampaignDraft promote. Throws an error if called before campaign draft is promoted. Supports standard list paging.
message
campaign_draft_service.proto:160Request message for [CampaignDraftService.ListCampaignDraftAsyncErrors][google.ads.googleads.v2.services.CampaignDraftService.ListCampaignDraftAsyncErrors].
string resource_name = 1
The name of the campaign draft from which to retrieve the async errors.
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 a page request is too large, the server may decide to further limit the number of returned resources.
message
campaign_draft_service.proto:177Response message for [CampaignDraftService.ListCampaignDraftAsyncErrors][google.ads.googleads.v2.services.CampaignDraftService.ListCampaignDraftAsyncErrors].
repeated errors = 1
Details of the errors when performing the asynchronous operation.
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.
CampaignExperimentService manages the life cycle of campaign experiments. It is used to create new experiments from drafts, modify experiment properties, promote changes in an experiment back to its base campaign, graduate experiments into new stand-alone campaigns, and to remove an experiment. An experiment consists of two variants or arms - the base campaign and the experiment campaign, directing a fixed share of traffic to each arm. A campaign experiment is created from a draft of changes to the base campaign and will be a snapshot of changes in the draft at the time of creation.
Returns the requested campaign experiment in full detail.
Request message for [CampaignExperimentService.GetCampaignExperiment][google.ads.googleads.v2.services.CampaignExperimentService.GetCampaignExperiment].
string resource_name = 1
The resource name of the campaign experiment to fetch.
Creates a campaign experiment based on a campaign draft. The draft campaign will be forked into a real campaign (called the experiment campaign) that will begin serving ads if successfully created. The campaign experiment is created immediately with status INITIALIZING. This method return a long running operation that tracks the forking of the draft campaign. If the forking fails, a list of errors can be retrieved using the ListCampaignExperimentAsyncErrors method. The operation's metadata will be a StringValue containing the resource name of the created campaign experiment.
Request message for [CampaignExperimentService.CreateCampaignExperiment][google.ads.googleads.v2.services.CampaignExperimentService.CreateCampaignExperiment].
string customer_id = 1
The ID of the customer whose campaign experiment is being created.
optional campaign_experiment = 2
The campaign experiment to be created.
bool validate_only = 3
If true, the request is validated but not executed. Only errors are returned, not results.
Updates campaign experiments. Operation statuses are returned.
Request message for [CampaignExperimentService.MutateCampaignExperiments][google.ads.googleads.v2.services.CampaignExperimentService.MutateCampaignExperiments].
string customer_id = 1
The ID of the customer whose campaign experiments are being modified.
repeated operations = 2
The list of operations to perform on individual campaign experiments.
bool partial_failure = 3
If true, successful operations will be carried out and invalid operations will return errors. If false, all operations will be carried out in one transaction if and only if they are all valid. Default is false.
bool validate_only = 4
If true, the request is validated but not executed. Only errors are returned, not results.
Response message for campaign experiment mutate.
optional partial_failure_error = 3
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 an RPC level error.
repeated results = 2
All results for the mutate.
Graduates a campaign experiment to a full campaign. The base and experiment campaigns will start running independently with their own budgets.
Request message for [CampaignExperimentService.GraduateCampaignExperiment][google.ads.googleads.v2.services.CampaignExperimentService.GraduateCampaignExperiment].
string campaign_experiment = 1
The resource name of the campaign experiment to graduate.
string campaign_budget = 2
Resource name of the budget to attach to the campaign graduated from the experiment.
Response message for campaign experiment graduate.
string graduated_campaign = 1
The resource name of the campaign from the graduated experiment. This campaign is the same one as CampaignExperiment.experiment_campaign.
Promotes the changes in a experiment campaign back to the base campaign. The campaign experiment is updated immediately with status PROMOTING. This method return a long running operation that tracks the promoting of the experiment campaign. If the promoting fails, a list of errors can be retrieved using the ListCampaignExperimentAsyncErrors method.
Request message for [CampaignExperimentService.PromoteCampaignExperiment][google.ads.googleads.v2.services.CampaignExperimentService.PromoteCampaignExperiment].
string campaign_experiment = 1
The resource name of the campaign experiment to promote.
Immediately ends a campaign experiment, changing the experiment's scheduled end date and without waiting for end of day. End date is updated to be the time of the request.
Request message for [CampaignExperimentService.EndCampaignExperiment][google.ads.googleads.v2.services.CampaignExperimentService.EndCampaignExperiment].
string campaign_experiment = 1
The resource name of the campaign experiment to end.
Returns all errors that occurred during CampaignExperiment create or promote (whichever occurred last). Supports standard list paging.
Request message for [CampaignExperimentService.ListCampaignExperimentAsyncErrors][google.ads.googleads.v2.services.CampaignExperimentService.ListCampaignExperimentAsyncErrors].
string resource_name = 1
The name of the campaign experiment from which to retrieve the async errors.
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 a page request is too large, the server may decide to further limit the number of returned resources.
Response message for [CampaignExperimentService.ListCampaignExperimentAsyncErrors][google.ads.googleads.v2.services.CampaignExperimentService.ListCampaignExperimentAsyncErrors].
repeated errors = 1
Details of the errors when performing the asynchronous operation.
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.
Service to manage campaign extension settings.
Returns the requested campaign extension setting in full detail.
Request message for [CampaignExtensionSettingService.GetCampaignExtensionSetting][google.ads.googleads.v2.services.CampaignExtensionSettingService.GetCampaignExtensionSetting].
string resource_name = 1
The resource name of the campaign extension setting to fetch.
Creates, updates, or removes campaign extension settings. Operation statuses are returned.
Request message for [CampaignExtensionSettingService.MutateCampaignExtensionSettings][google.ads.googleads.v2.services.CampaignExtensionSettingService.MutateCampaignExtensionSettings].
string customer_id = 1
The ID of the customer whose campaign extension settings are being modified.
repeated operations = 2
The list of operations to perform on individual campaign extension settings.
bool partial_failure = 3
If true, successful operations will be carried out and invalid operations will return errors. If false, all operations will be carried out in one transaction if and only if they are all valid. Default is false.
bool validate_only = 4
If true, the request is validated but not executed. Only errors are returned, not results.
Response message for a campaign extension setting mutate.
optional partial_failure_error = 3
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 an RPC level error.
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:59Request message for [CampaignFeedService.GetCampaignFeed][google.ads.googleads.v2.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:65Request message for [CampaignFeedService.MutateCampaignFeeds][google.ads.googleads.v2.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.
bool partial_failure = 3
If true, successful operations will be carried out and invalid operations will return errors. If false, all operations will be carried out in one transaction if and only if they are all valid. Default is false.
bool validate_only = 4
If true, the request is validated but not executed. Only errors are returned, not results.
message
campaign_feed_service.proto:106Response message for a campaign feed mutate.
optional partial_failure_error = 3
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 an RPC level error.
repeated results = 2
All results for the mutate.
Service to manage labels on campaigns.
Returns the requested campaign-label relationship in full detail.
message
campaign_label_service.proto:58Request message for [CampaignLabelService.GetCampaignLabel][google.ads.googleads.v2.services.CampaignLabelService.GetCampaignLabel].
string resource_name = 1
The resource name of the campaign-label relationship to fetch.
Creates and removes campaign-label relationships. Operation statuses are returned.
message
campaign_label_service.proto:64Request message for [CampaignLabelService.MutateCampaignLabels][google.ads.googleads.v2.services.CampaignLabelService.MutateCampaignLabels].
string customer_id = 1
ID of the customer whose campaign-label relationships are being modified.
repeated operations = 2
The list of operations to perform on campaign-label relationships.
bool partial_failure = 3
If true, successful operations will be carried out and invalid operations will return errors. If false, all operations will be carried out in one transaction if and only if they are all valid. Default is false.
bool validate_only = 4
If true, the request is validated but not executed. Only errors are returned, not results.
message
campaign_label_service.proto:99Response message for a campaign labels mutate.
optional partial_failure_error = 3
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 an RPC level error.
repeated results = 2
All results for the mutate.
Service to manage campaigns.
rpc GetCampaign (, )
campaign_service.proto:42Returns the requested campaign in full detail.
message
campaign_service.proto:58Request message for [CampaignService.GetCampaign][google.ads.googleads.v2.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:64Request message for [CampaignService.MutateCampaigns][google.ads.googleads.v2.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.
bool partial_failure = 3
If true, successful operations will be carried out and invalid operations will return errors. If false, all operations will be carried out in one transaction if and only if they are all valid. Default is false.
bool validate_only = 4
If true, the request is validated but not executed. Only errors are returned, not results.
message
campaign_service.proto:105Response message for campaign mutate.
optional partial_failure_error = 3
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 an RPC level error.
repeated results = 2
All results for the mutate.
Service to manage campaign shared sets.
Returns the requested campaign shared set in full detail.
Request message for [CampaignSharedSetService.GetCampaignSharedSet][google.ads.googleads.v2.services.CampaignSharedSetService.GetCampaignSharedSet].
string resource_name = 1
The resource name of the campaign shared set to fetch.
Creates or removes campaign shared sets. Operation statuses are returned.
Request message for [CampaignSharedSetService.MutateCampaignSharedSets][google.ads.googleads.v2.services.CampaignSharedSetService.MutateCampaignSharedSets].
string customer_id = 1
The ID of the customer whose campaign shared sets are being modified.
repeated operations = 2
The list of operations to perform on individual campaign shared sets.
bool partial_failure = 3
If true, successful operations will be carried out and invalid operations will return errors. If false, all operations will be carried out in one transaction if and only if they are all valid. Default is false.
bool validate_only = 4
If true, the request is validated but not executed. Only errors are returned, not results.
Response message for a campaign shared set mutate.
optional partial_failure_error = 3
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 an RPC level error.
repeated results = 2
All results for the mutate.
Service to fetch carrier constants.
Returns the requested carrier constant in full detail.
Request message for [CarrierConstantService.GetCarrierConstant][google.ads.googleads.v2.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:48Request message for '[ChangeStatusService.GetChangeStatus][google.ads.googleads.v2.services.ChangeStatusService.GetChangeStatus]'.
string resource_name = 1
The resource name of the change status to fetch.
Service to fetch click views.
Returns the requested click view in full detail.
message
click_view_service.proto:48Request message for [ClickViewService.GetClickView][google.ads.googleads.v2.services.ClickViewService.GetClickView].
string resource_name = 1
The resource name of the click view to fetch.
Service to manage conversion actions.
Returns the requested conversion action.
Request message for [ConversionActionService.GetConversionAction][google.ads.googleads.v2.services.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][google.ads.googleads.v2.services.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.
bool partial_failure = 3
If true, successful operations will be carried out and invalid operations will return errors. If false, all operations will be carried out in one transaction if and only if they are all valid. Default is false.
bool validate_only = 4
If true, the request is validated but not executed. Only errors are returned, not results.
Response message for [ConversionActionService.MutateConversionActions][google.ads.googleads.v2.services.ConversionActionService.MutateConversionActions].
optional partial_failure_error = 3
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 an RPC level error.
repeated results = 2
All results for the mutate.
Service to upload conversion adjustments.
Processes the given conversion adjustments.
Request message for [ConversionAdjustmentUploadService.UploadConversionAdjustments][google.ads.googleads.v2.services.ConversionAdjustmentUploadService.UploadConversionAdjustments].
string customer_id = 1
The ID of the customer performing the upload.
repeated conversion_adjustments = 2
The conversion adjustments that are being uploaded.
bool partial_failure = 3
If true, successful operations will be carried out and invalid operations will return errors. If false, all operations will be carried out in one transaction if and only if they are all valid. This should always be set to true.
bool validate_only = 4
If true, the request is validated but not executed. Only errors are returned, not results.
Response message for [ConversionAdjustmentUploadService.UploadConversionAdjustments][google.ads.googleads.v2.services.ConversionAdjustmentUploadService.UploadConversionAdjustments].
optional partial_failure_error = 1
Errors that pertain to conversion adjustment failures in the partial failure mode. Returned when all errors occur inside the adjustments. If any errors occur outside the adjustments (e.g. auth errors), we return an RPC level error.
repeated results = 2
Returned for successfully processed conversion adjustments. Proto will be empty for rows that received an error. Results are not returned when validate_only is true.
Service to upload conversions.
Processes the given click conversions.
Request message for [ConversionUploadService.UploadClickConversions][google.ads.googleads.v2.services.ConversionUploadService.UploadClickConversions].
string customer_id = 1
The ID of the customer performing the upload.
repeated conversions = 2
The conversions that are being uploaded.
bool partial_failure = 3
If true, successful operations will be carried out and invalid operations will return errors. If false, all operations will be carried out in one transaction if and only if they are all valid. This should always be set to true.
bool validate_only = 4
If true, the request is validated but not executed. Only errors are returned, not results.
Response message for [ConversionUploadService.UploadClickConversions][google.ads.googleads.v2.services.ConversionUploadService.UploadClickConversions].
optional partial_failure_error = 1
Errors that pertain to conversion failures in the partial failure mode. Returned when all errors occur inside the conversions. If any errors occur outside the conversions (e.g. auth errors), we return an RPC level error.
repeated results = 2
Returned for successfully processed conversions. Proto will be empty for rows that received an error. Results are not returned when validate_only is true.
Processes the given call conversions.
Request message for [ConversionUploadService.UploadCallConversions][google.ads.googleads.v2.services.ConversionUploadService.UploadCallConversions].
string customer_id = 1
The ID of the customer performing the upload.
repeated conversions = 2
The conversions that are being uploaded.
bool partial_failure = 3
If true, successful operations will be carried out and invalid operations will return errors. If false, all operations will be carried out in one transaction if and only if they are all valid. This should always be set to true.
bool validate_only = 4
If true, the request is validated but not executed. Only errors are returned, not results.
Response message for [ConversionUploadService.UploadCallConversions][google.ads.googleads.v2.services.ConversionUploadService.UploadCallConversions].
optional partial_failure_error = 1
Errors that pertain to conversion failures in the partial failure mode. Returned when all errors occur inside the conversions. If any errors occur outside the conversions (e.g. auth errors), we return an RPC level error.
repeated results = 2
Returned for successfully processed conversions. Proto will be empty for rows that received an error. Results are not returned when validate_only is true.
Service to manage custom interests.
Returns the requested custom interest in full detail.
message
custom_interest_service.proto:57Request message for [CustomInterestService.GetCustomInterest][google.ads.googleads.v2.services.CustomInterestService.GetCustomInterest].
string resource_name = 1
The resource name of the custom interest to fetch.
Creates or updates custom interests. Operation statuses are returned.
message
custom_interest_service.proto:63Request message for [CustomInterestService.MutateCustomInterests][google.ads.googleads.v2.services.CustomInterestService.MutateCustomInterests].
string customer_id = 1
The ID of the customer whose custom interests are being modified.
repeated operations = 2
The list of operations to perform on individual custom interests.
bool validate_only = 4
If true, the request is validated but not executed. Only errors are returned, not results.
message
custom_interest_service.proto:93Response message for custom interest 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.v2.services.CustomerClientLinkService.GetCustomerClientLink].
string resource_name = 1
The resource name of the customer client link to fetch.
Creates or updates a customer client link. Operation statuses are returned.
Request message for [CustomerClientLinkService.MutateCustomerClientLink][google.ads.googleads.v2.services.CustomerClientLinkService.MutateCustomerClientLink].
string customer_id = 1
The ID of the customer whose customer link are being modified.
optional operation = 2
The operation to perform on the individual CustomerClientLink.
Response message for a CustomerClientLink mutate.
optional result = 1
A result that identifies the resource affected by the mutate request.
Service to get clients in a customer's hierarchy.
Returns the requested client in full detail.
message
customer_client_service.proto:48Request message for [CustomerClientService.GetCustomerClient][google.ads.googleads.v2.services.CustomerClientService.GetCustomerClient].
string resource_name = 1
The resource name of the client to fetch.
Service to manage customer extension settings.
Returns the requested customer extension setting in full detail.
Request message for [CustomerExtensionSettingService.GetCustomerExtensionSetting][google.ads.googleads.v2.services.CustomerExtensionSettingService.GetCustomerExtensionSetting].
string resource_name = 1
The resource name of the customer extension setting to fetch.
Creates, updates, or removes customer extension settings. Operation statuses are returned.
Request message for [CustomerExtensionSettingService.MutateCustomerExtensionSettings][google.ads.googleads.v2.services.CustomerExtensionSettingService.MutateCustomerExtensionSettings].
string customer_id = 1
The ID of the customer whose customer extension settings are being modified.
repeated operations = 2
The list of operations to perform on individual customer extension settings.
bool partial_failure = 3
If true, successful operations will be carried out and invalid operations will return errors. If false, all operations will be carried out in one transaction if and only if they are all valid. Default is false.
bool validate_only = 4
If true, the request is validated but not executed. Only errors are returned, not results.
Response message for a customer extension setting mutate.
optional partial_failure_error = 3
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 an RPC level error.
repeated results = 2
All results for the mutate.
Service to manage customer feeds.
Returns the requested customer feed in full detail.
message
customer_feed_service.proto:59Request message for [CustomerFeedService.GetCustomerFeed][google.ads.googleads.v2.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:65Request message for [CustomerFeedService.MutateCustomerFeeds][google.ads.googleads.v2.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.
bool partial_failure = 3
If true, successful operations will be carried out and invalid operations will return errors. If false, all operations will be carried out in one transaction if and only if they are all valid. Default is false.
bool validate_only = 4
If true, the request is validated but not executed. Only errors are returned, not results.
message
customer_feed_service.proto:106Response message for a customer feed mutate.
optional partial_failure_error = 3
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 an RPC level error.
repeated results = 2
All results for the mutate.
Service to manage labels on customers.
Returns the requested customer-label relationship in full detail.
message
customer_label_service.proto:58Request message for [CustomerLabelService.GetCustomerLabel][google.ads.googleads.v2.services.CustomerLabelService.GetCustomerLabel].
string resource_name = 1
The resource name of the customer-label relationship to fetch.
Creates and removes customer-label relationships. Operation statuses are returned.
message
customer_label_service.proto:64Request message for [CustomerLabelService.MutateCustomerLabels][google.ads.googleads.v2.services.CustomerLabelService.MutateCustomerLabels].
string customer_id = 1
ID of the customer whose customer-label relationships are being modified.
repeated operations = 2
The list of operations to perform on customer-label relationships.
bool partial_failure = 3
If true, successful operations will be carried out and invalid operations will return errors. If false, all operations will be carried out in one transaction if and only if they are all valid. Default is false.
bool validate_only = 4
If true, the request is validated but not executed. Only errors are returned, not results.
message
customer_label_service.proto:99Response message for a customer labels mutate.
optional partial_failure_error = 3
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 an RPC level error.
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.v2.services.CustomerManagerLinkService.GetCustomerManagerLink].
string resource_name = 1
The resource name of the CustomerManagerLink to fetch.
Creates or updates customer manager links. Operation statuses are returned.
Request message for [CustomerManagerLinkService.MutateCustomerManagerLink][google.ads.googleads.v2.services.CustomerManagerLinkService.MutateCustomerManagerLink].
string customer_id = 1
The ID of the customer whose customer manager links are being modified.
repeated operations = 2
The list of operations to perform on individual customer manager links.
Response message for a CustomerManagerLink mutate.
repeated results = 1
A result that identifies the resource affected by the mutate request.
Service to manage customer negative criteria.
Returns the requested criterion in full detail.
Request message for [CustomerNegativeCriterionService.GetCustomerNegativeCriterion][google.ads.googleads.v2.services.CustomerNegativeCriterionService.GetCustomerNegativeCriterion].
string resource_name = 1
The resource name of the criterion to fetch.
Creates or removes criteria. Operation statuses are returned.
Request message for [CustomerNegativeCriterionService.MutateCustomerNegativeCriteria][google.ads.googleads.v2.services.CustomerNegativeCriterionService.MutateCustomerNegativeCriteria].
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.
bool partial_failure = 3
If true, successful operations will be carried out and invalid operations will return errors. If false, all operations will be carried out in one transaction if and only if they are all valid. Default is false.
bool validate_only = 4
If true, the request is validated but not executed. Only errors are returned, not results.
Response message for customer negative criterion mutate.
optional partial_failure_error = 3
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 an RPC level error.
repeated results = 2
All results for the mutate.
Service to manage customers.
rpc GetCustomer (, )
customer_service.proto:43Returns the requested customer in full detail.
message
customer_service.proto:75Request message for [CustomerService.GetCustomer][google.ads.googleads.v2.services.CustomerService.GetCustomer].
string resource_name = 1
The resource name of the customer to fetch.
Updates a customer. Operation statuses are returned.
message
customer_service.proto:81Request message for [CustomerService.MutateCustomer][google.ads.googleads.v2.services.CustomerService.MutateCustomer].
string customer_id = 1
The ID of the customer being modified.
optional operation = 4
The operation to perform on the customer
bool validate_only = 5
If true, the request is validated but not executed. Only errors are returned, not results.
message
customer_service.proto:127Response message for customer mutate.
optional result = 2
Result for the mutate.
Returns resource names of customers directly accessible by the user authenticating the call.
message
customer_service.proto:139Request message for [CustomerService.ListAccessibleCustomers][google.ads.googleads.v2.services.CustomerService.ListAccessibleCustomers].
(message has no fields)
message
customer_service.proto:144Response message for [CustomerService.ListAccessibleCustomers][google.ads.googleads.v2.services.CustomerService.ListAccessibleCustomers].
repeated string resource_names = 1
Resource name of customers directly accessible by the user authenticating the call.
Creates a new client under manager. The new client customer is returned.
message
customer_service.proto:94Request message for [CustomerService.CreateCustomerClient][google.ads.googleads.v2.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.
optional email_address = 3
Email address of the user who should be invited on the created client customer. Accessible to whitelisted customers only.
enums.AccessRoleEnum.AccessRole access_role = 4
The proposed role of user on the created client customer. Accessible to whitelisted customers only.
message
customer_service.proto:121Response message for CreateCustomerClient mutate.
string resource_name = 2
The resource name of the newly created customer client.
Service to fetch Detail Placement views.
Returns the requested Detail Placement view in full detail.
Request message for [DetailPlacementViewService.GetDetailPlacementView][google.ads.googleads.v2.services.DetailPlacementViewService.GetDetailPlacementView].
string resource_name = 1
The resource name of the Detail Placement view to fetch.
Service to manage display keyword views.
Returns the requested display keyword view in full detail.
Request message for [DisplayKeywordViewService.GetDisplayKeywordView][google.ads.googleads.v2.services.DisplayKeywordViewService.GetDisplayKeywordView].
string resource_name = 1
The resource name of the display keyword view to fetch.
Service to fetch distance views.
Returns the attributes of the requested distance view.
message
distance_view_service.proto:48Request message for [DistanceViewService.GetDistanceView][google.ads.googleads.v2.services.DistanceViewService.GetDistanceView].
string resource_name = 1
The resource name of the distance view to fetch.
Service to fetch domain categories.
Returns the requested domain category.
message
domain_category_service.proto:49Request message for [DomainCategoryService.GetDomainCategory][google.ads.googleads.v2.services.DomainCategoryService.GetDomainCategory].
string resource_name = 1
Resource name of the domain category to fetch.
Service to fetch dynamic search ads views.
Returns the requested dynamic search ads search term view in full detail.
Request message for [DynamicSearchAdsSearchTermViewService.GetDynamicSearchAdsSearchTermView][google.ads.googleads.v2.services.DynamicSearchAdsSearchTermViewService.GetDynamicSearchAdsSearchTermView].
string resource_name = 1
The resource name of the dynamic search ads search term view to fetch.
Service to fetch expanded landing page views.
Returns the requested expanded landing page view in full detail.
Request message for [ExpandedLandingPageViewService.GetExpandedLandingPageView][google.ads.googleads.v2.services.ExpandedLandingPageViewService.GetExpandedLandingPageView].
string resource_name = 1
The resource name of the expanded landing page view to fetch.
Service to manage extension feed items.
Returns the requested extension feed item in full detail.
Request message for [ExtensionFeedItemService.GetExtensionFeedItem][google.ads.googleads.v2.services.ExtensionFeedItemService.GetExtensionFeedItem].
string resource_name = 1
The resource name of the extension feed item to fetch.
Creates, updates, or removes extension feed items. Operation statuses are returned.
Request message for [ExtensionFeedItemService.MutateExtensionFeedItems][google.ads.googleads.v2.services.ExtensionFeedItemService.MutateExtensionFeedItems].
string customer_id = 1
The ID of the customer whose extension feed items are being modified.
repeated operations = 2
The list of operations to perform on individual extension feed items.
bool partial_failure = 3
If true, successful operations will be carried out and invalid operations will return errors. If false, all operations will be carried out in one transaction if and only if they are all valid. Default is false.
bool validate_only = 4
If true, the request is validated but not executed. Only errors are returned, not results.
Response message for an extension feed item mutate.
optional partial_failure_error = 3
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 an RPC level error.
repeated results = 2
All results for the mutate.
Service to manage feed items.
Returns the requested feed item in full detail.
message
feed_item_service.proto:59Request message for [FeedItemService.GetFeedItem][google.ads.googleads.v2.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:65Request message for [FeedItemService.MutateFeedItems][google.ads.googleads.v2.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.
bool partial_failure = 3
If true, successful operations will be carried out and invalid operations will return errors. If false, all operations will be carried out in one transaction if and only if they are all valid. Default is false.
bool validate_only = 4
If true, the request is validated but not executed. Only errors are returned, not results.
message
feed_item_service.proto:106Response message for an feed item mutate.
optional partial_failure_error = 3
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 an RPC level error.
repeated results = 2
All results for the mutate.
Service to manage feed item targets.
Returns the requested feed item targets in full detail.
Request message for [FeedItemTargetService.GetFeedItemTarget][google.ads.googleads.v2.services.FeedItemTargetService.GetFeedItemTarget].
string resource_name = 1
The resource name of the feed item targets to fetch.
Creates or removes feed item targets. Operation statuses are returned.
Request message for [FeedItemTargetService.MutateFeedItemTargets][google.ads.googleads.v2.services.FeedItemTargetService.MutateFeedItemTargets].
string customer_id = 1
The ID of the customer whose feed item targets are being modified.
repeated operations = 2
The list of operations to perform on individual feed item targets.
Response message for an feed item target 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:58Request message for [FeedMappingService.GetFeedMapping][google.ads.googleads.v2.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:64Request message for [FeedMappingService.MutateFeedMappings][google.ads.googleads.v2.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.
bool partial_failure = 3
If true, successful operations will be carried out and invalid operations will return errors. If false, all operations will be carried out in one transaction if and only if they are all valid. Default is false.
bool validate_only = 4
If true, the request is validated but not executed. Only errors are returned, not results.
message
feed_mapping_service.proto:98Response message for a feed mapping mutate.
optional partial_failure_error = 3
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 an RPC level error.
repeated results = 2
All results for the mutate.
Service to fetch feed placeholder views.
Returns the requested feed placeholder view in full detail.
Request message for [FeedPlaceholderViewService.GetFeedPlaceholderView][google.ads.googleads.v2.services.FeedPlaceholderViewService.GetFeedPlaceholderView].
string resource_name = 1
The resource name of the feed placeholder view to fetch.
service FeedService
feed_service.proto:38Service to manage feeds.
rpc GetFeed (, )
feed_service.proto:42Returns the requested feed in full detail.
message
feed_service.proto:59Request message for [FeedService.GetFeed][google.ads.googleads.v2.services.FeedService.GetFeed].
string resource_name = 1
The resource name of the feed to fetch.
rpc MutateFeeds (, )
feed_service.proto:50Creates, updates, or removes feeds. Operation statuses are returned.
message
feed_service.proto:65Request message for [FeedService.MutateFeeds][google.ads.googleads.v2.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.
bool partial_failure = 3
If true, successful operations will be carried out and invalid operations will return errors. If false, all operations will be carried out in one transaction if and only if they are all valid. Default is false.
bool validate_only = 4
If true, the request is validated but not executed. Only errors are returned, not results.
message
feed_service.proto:106Response message for an feed mutate.
optional partial_failure_error = 3
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 an RPC level error.
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:48Request message for [GenderViewService.GetGenderView][google.ads.googleads.v2.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.v2.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.v2.services.GeoTargetConstantService.SuggestGeoTargetConstants]
repeated geo_target_constant_suggestions = 1
Geo target constant suggestions.
Service to manage geographic views.
Returns the requested geographic view in full detail.
message
geographic_view_service.proto:48Request message for [GeographicViewService.GetGeographicView][google.ads.googleads.v2.services.GeographicViewService.GetGeographicView].
string resource_name = 1
The resource name of the geographic view to fetch.
Service to fetch Google Ads API fields.
Returns just the requested field.
Request message for [GoogleAdsFieldService.GetGoogleAdsField][google.ads.googleads.v2.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.v2.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.v2.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 Search (, )
google_ads_service.proto:178Returns all rows that match the search query.
message
google_ads_service.proto:245Request message for [GoogleAdsService.Search][google.ads.googleads.v2.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.
bool validate_only = 5
If true, the request is validated but not executed.
bool return_summary_row = 6
If true, summary row will be included in the response. Otherwise(false or not specified) summary row will not be returned.
message
google_ads_service.proto:272Response message for [GoogleAdsService.Search][google.ads.googleads.v2.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.
optional summary_row = 6
Summary row that contains summary of metrics in results. Summary of metrics means aggregation of metrics across all results, here aggregation could be sum, average, rate, etc.
rpc Mutate (, )
google_ads_service.proto:236Creates, updates, or removes resources. This method supports atomic transactions with multiple types of resources. For example, you can atomically create a campaign and a campaign budget, or perform up to thousands of mutates atomically. This method is essentially a wrapper around a series of mutate methods. The only features it offers over calling those methods directly are: - Atomic transactions - Temp resource names (described below) - Somewhat reduced latency over making a series of mutate calls Note: Only resources that support atomic transactions are included, so this method can't replace all calls to individual services. ## Atomic Transaction Benefits Atomicity makes error handling much easier. If you're making a series of changes and one fails, it can leave your account in an inconsistent state. With atomicity, you either reach the desired state directly, or the request fails and you can retry. ## Temp Resource Names Temp resource names are a special type of resource name used to create a resource and reference that resource in the same request. For example, if a campaign budget is created with `resource_name` equal to `customers/123/campaignBudgets/-1`, that resource name can be reused in the `Campaign.budget` field in the same request. That way, the two resources are created and linked atomically. To create a temp resource name, put a negative number in the part of the name that the server would normally allocate. Note: - Resources must be created with a temp name before the name can be reused. For example, the previous CampaignBudget+Campaign example would fail if the mutate order was reversed. - Temp names are not remembered across requests. - There's no limit to the number of temp names in a request. - Each temp name must use a unique negative number, even if the resource types differ. ## Latency It's important to group mutates by resource type or the request may time out and fail. Latency is roughly equal to a series of calls to individual mutate methods, where each change in resource type is a new call. For example, mutating 10 campaigns then 10 ad groups is like 2 calls, while mutating 1 campaign, 1 ad group, 1 campaign, 1 ad group is like 4 calls.
message
google_ads_service.proto:593Request message for [GoogleAdsService.Mutate][google.ads.googleads.v2.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.
bool partial_failure = 3
If true, successful operations will be carried out and invalid operations will return errors. If false, all operations will be carried out in one transaction if and only if they are all valid. Default is false.
bool validate_only = 4
If true, the request is validated but not executed. Only errors are returned, not results.
message
google_ads_service.proto:612Response message for [GoogleAdsService.Mutate][google.ads.googleads.v2.services.GoogleAdsService.Mutate].
optional partial_failure_error = 3
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 an RPC level error.
repeated mutate_operation_responses = 1
All responses for the mutate.
Service to fetch Group Placement views.
Returns the requested Group Placement view in full detail.
Request message for [GroupPlacementViewService.GetGroupPlacementView][google.ads.googleads.v2.services.GroupPlacementViewService.GetGroupPlacementView].
string resource_name = 1
The resource name of the Group Placement view to fetch.
Service to manage Hotel Group Views.
Returns the requested Hotel Group View in full detail.
Request message for [HotelGroupViewService.GetHotelGroupView][google.ads.googleads.v2.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.v2.services.HotelPerformanceViewService.GetHotelPerformanceView].
string resource_name = 1
Resource name of the Hotel Performance View to fetch.
A service to fetch invoices issued for a billing setup during a given month.
rpc ListInvoices (, )
invoice_service.proto:41Returns all invoices associated with a billing setup, for a given month.
message
invoice_service.proto:50Request message for fetching the invoices of a given billing setup that were issued during a given month.
string customer_id = 1
The ID of the customer to fetch invoices for.
string billing_setup = 2
Required. The billing setup resource name of the requested invoices. `customers/{customer_id}/billingSetups/{billing_setup_id}`
string issue_year = 3
Required. The issue year to retrieve invoices, in yyyy format. Only invoices issued in 2019 or later can be retrieved.
enums.MonthOfYearEnum.MonthOfYear issue_month = 4
Required. The issue month to retrieve invoices.
message
invoice_service.proto:68Response message for [InvoiceService.ListInvoices][google.ads.googleads.v2.services.InvoiceService.ListInvoices].
repeated invoices = 1
The list of invoices that match the billing setup and time period.
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.v2.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.v2.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.
bool partial_failure = 3
If true, successful operations will be carried out and invalid operations will return errors. If false, all operations will be carried out in one transaction if and only if they are all valid. Default is false.
bool validate_only = 4
If true, the request is validated but not executed. Only errors are returned, not results.
Response message for a Keyword Plan ad group mutate.
optional partial_failure_error = 3
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 an RPC level error.
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.v2.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.v2.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.
bool partial_failure = 3
If true, successful operations will be carried out and invalid operations will return errors. If false, all operations will be carried out in one transaction if and only if they are all valid. Default is false.
bool validate_only = 4
If true, the request is validated but not executed. Only errors are returned, not results.
Response message for a Keyword Plan campaign mutate.
optional partial_failure_error = 3
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 an RPC level error.
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.v2.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.v2.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.
bool partial_failure = 3
If true, successful operations will be carried out and invalid operations will return errors. If false, all operations will be carried out in one transaction if and only if they are all valid. Default is false.
bool validate_only = 4
If true, the request is validated but not executed. Only errors are returned, not results.
Response message for a Keyword Plan keyword mutate.
optional partial_failure_error = 3
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 an RPC level error.
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.v2.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.v2.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.
bool partial_failure = 3
If true, successful operations will be carried out and invalid operations will return errors. If false, all operations will be carried out in one transaction if and only if they are all valid. Default is false.
bool validate_only = 4
If true, the request is validated but not executed. Only errors are returned, not results.
Response message for a Keyword Plan negative keyword mutate.
optional partial_failure_error = 3
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 an RPC level error.
repeated results = 2
All results for the mutate.
Service to manage keyword plans.
Returns the requested plan in full detail.
message
keyword_plan_service.proto:77Request message for [KeywordPlanService.GetKeywordPlan][google.ads.googleads.v2.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:83Request message for [KeywordPlanService.MutateKeywordPlans][google.ads.googleads.v2.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.
bool partial_failure = 3
If true, successful operations will be carried out and invalid operations will return errors. If false, all operations will be carried out in one transaction if and only if they are all valid. Default is false.
bool validate_only = 4
If true, the request is validated but not executed. Only errors are returned, not results.
message
keyword_plan_service.proto:125Response message for a keyword plan mutate.
optional partial_failure_error = 3
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 an RPC level error.
repeated results = 2
All results for the mutate.
Returns the requested Keyword Plan forecasts.
message
keyword_plan_service.proto:143Request message for [KeywordPlanService.GenerateForecastMetrics][google.ads.googleads.v2.services.KeywordPlanService.GenerateForecastMetrics].
string keyword_plan = 1
The resource name of the keyword plan to be forecasted.
message
keyword_plan_service.proto:149Response message for [KeywordPlanService.GenerateForecastMetrics][google.ads.googleads.v2.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:213Request message for [KeywordPlanService.GenerateHistoricalMetrics][google.ads.googleads.v2.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:220Response message for [KeywordPlanService.GenerateHistoricalMetrics][google.ads.googleads.v2.services.KeywordPlanService.GenerateHistoricalMetrics].
repeated metrics = 1
List of keyword historical metrics.
Service to manage keyword views.
Returns the requested keyword view in full detail.
message
keyword_view_service.proto:48Request message for [KeywordViewService.GetKeywordView][google.ads.googleads.v2.services.KeywordViewService.GetKeywordView].
string resource_name = 1
The resource name of the keyword view to fetch.
Service to manage labels.
rpc GetLabel (, )
label_service.proto:40Returns the requested label in full detail.
message
label_service.proto:56Request message for [LabelService.GetLabel][google.ads.googleads.v2.services.LabelService.GetLabel].
string resource_name = 1
The resource name of the label to fetch.
rpc MutateLabels (, )
label_service.proto:47Creates, updates, or removes labels. Operation statuses are returned.
message
label_service.proto:62Request message for [LabelService.MutateLabels][google.ads.googleads.v2.services.LabelService.MutateLabels].
string customer_id = 1
ID of the customer whose labels are being modified.
repeated operations = 2
The list of operations to perform on labels.
bool partial_failure = 3
If true, successful operations will be carried out and invalid operations will return errors. If false, all operations will be carried out in one transaction if and only if they are all valid. Default is false.
bool validate_only = 4
If true, the request is validated but not executed. Only errors are returned, not results.
message
label_service.proto:102Response message for a labels mutate.
optional partial_failure_error = 3
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 an RPC level error.
repeated results = 2
All results for the mutate.
Service to fetch landing page views.
Returns the requested landing page view in full detail.
Request message for [LandingPageViewService.GetLandingPageView][google.ads.googleads.v2.services.LandingPageViewService.GetLandingPageView].
string resource_name = 1
The resource name of the landing page view to fetch.
Service to fetch language constants.
Returns the requested language constant.
Request message for [LanguageConstantService.GetLanguageConstant][google.ads.googleads.v2.services.LanguageConstantService.GetLanguageConstant].
string resource_name = 1
Resource name of the language constant to fetch.
Service to fetch location views.
Returns the requested location view in full detail.
message
location_view_service.proto:48Request message for [LocationViewService.GetLocationView][google.ads.googleads.v2.services.LocationViewService.GetLocationView].
string resource_name = 1
The resource name of the location view 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.v2.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:57Request message for [MediaFileService.GetMediaFile][google.ads.googleads.v2.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:63Request message for [MediaFileService.MutateMediaFiles][google.ads.googleads.v2.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.
bool partial_failure = 3
If true, successful operations will be carried out and invalid operations will return errors. If false, all operations will be carried out in one transaction if and only if they are all valid. Default is false.
bool validate_only = 4
If true, the request is validated but not executed. Only errors are returned, not results.
message
media_file_service.proto:91Response message for a media file mutate.
optional partial_failure_error = 3
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 an RPC level error.
repeated results = 2
All results for the mutate.
This service allows management of links between Google Ads and Google Merchant Center.
Returns Merchant Center links available for this customer.
Request message for [MerchantCenterLinkService.ListMerchantCenterLinks][google.ads.googleads.v2.services.MerchantCenterLinkService.ListMerchantCenterLinks].
string customer_id = 1
The ID of the customer onto which to apply the Merchant Center link list operation.
Response message for [MerchantCenterLinkService.ListMerchantCenterLinks][google.ads.googleads.v2.services.MerchantCenterLinkService.ListMerchantCenterLinks].
repeated merchant_center_links = 1
Merchant Center links available for the requested customer
Returns the Merchant Center link in full detail.
Request message for [MerchantCenterLinkService.GetMerchantCenterLink][google.ads.googleads.v2.services.MerchantCenterLinkService.GetMerchantCenterLink].
string resource_name = 1
Resource name of the Merchant Center link.
Updates status or removes a Merchant Center link.
Request message for [MerchantCenterLinkService.MutateMerchantCenterLink][google.ads.googleads.v2.services.MerchantCenterLinkService.MutateMerchantCenterLink].
string customer_id = 1
The ID of the customer being modified.
optional operation = 2
The operation to perform on the link
Response message for Merchant Center link mutate.
optional result = 2
Result for the mutate.
Service to fetch mobile app category constants.
Returns the requested mobile app category constant.
Request message for [MobileAppCategoryConstantService.GetMobileAppCategoryConstant][google.ads.googleads.v2.services.MobileAppCategoryConstantService.GetMobileAppCategoryConstant].
string resource_name = 1
Resource name of the mobile app category constant to fetch.
Service to fetch mobile device constants.
Returns the requested mobile device constant in full detail.
Request message for [MobileDeviceConstantService.GetMobileDeviceConstant][google.ads.googleads.v2.services.MobileDeviceConstantService.GetMobileDeviceConstant].
string resource_name = 1
Resource name of the mobile device to fetch.
Service to manage mutate jobs.
Creates a mutate job.
message
mutate_job_service.proto:91Request message for [MutateJobService.CreateMutateJobRequest][]
string customer_id = 1
The ID of the customer for which to create a mutate job.
message
mutate_job_service.proto:97Response message for [MutateJobService.CreateMutateJobResponse][]
string resource_name = 1
The resource name of the MutateJob.
Returns the mutate job.
message
mutate_job_service.proto:103Request message for [MutateJobService.GetMutateJob][google.ads.googleads.v2.services.MutateJobService.GetMutateJob]
string resource_name = 1
The resource name of the MutateJob to get.
Returns the results of the mutate job. The job must be done. Supports standard list paging.
message
mutate_job_service.proto:151Request message for [MutateJobService.ListMutateJobResults][google.ads.googleads.v2.services.MutateJobService.ListMutateJobResults].
string resource_name = 1
The resource name of the MutateJob whose results are being listed.
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 a page request is too large, the server may decide to further limit the number of returned resources.
message
mutate_job_service.proto:168Response message for [MutateJobService.ListMutateJobResults][google.ads.googleads.v2.services.MutateJobService.ListMutateJobResults].
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.
Runs the mutate job. The Operation.metadata field type is MutateJobMetadata. When finished, the long running operation will not contain errors or a response. Instead, use ListMutateJobResults to get the results of the job.
message
mutate_job_service.proto:109Request message for [MutateJobService.RunMutateJob][google.ads.googleads.v2.services.MutateJobService.RunMutateJob]
string resource_name = 1
The resource name of the MutateJob to run.
Add operations to the mutate job.
message
mutate_job_service.proto:115Request message for [MutateJobService.AddMutateJobOperations][google.ads.googleads.v2.services.MutateJobService.AddMutateJobOperations]
string resource_name = 1
The resource name of the MutateJob.
string sequence_token = 2
A token used to enforce sequencing. The first AddMutateJobOperations request for a MutateJob should not set sequence_token. Subsequent requests must set sequence_token to the value of next_sequence_token received in the previous AddMutateJobOperations response.
repeated mutate_operations = 3
The list of mutates being added. Operations can use negative integers as temp ids to signify dependencies between entities created in this MutateJob. For example, a customer with id = 1234 can create a campaign and an ad group in that same campaign by creating a campaign in the first operation with the resource name explicitly set to "customers/1234/campaigns/-1", and creating an ad group in the second operation with the campaign field also set to "customers/1234/campaigns/-1".
message
mutate_job_service.proto:140Response message for [MutateJobService.AddMutateJobOperations][google.ads.googleads.v2.services.MutateJobService.AddMutateJobOperations]
int64 total_operations = 1
The total number of operations added so far for this job.
string next_sequence_token = 2
The sequence token to be used when calling AddMutateJobOperations again if more operations need to be added. The next AddMutateJobOperations request must set the sequence_token field to the value of this field.
Service to fetch Operating System Version constants.
Returns the requested OS version constant in full detail.
Request message for [OperatingSystemVersionConstantService.GetOperatingSystemVersionConstant][google.ads.googleads.v2.services.OperatingSystemVersionConstantService.GetOperatingSystemVersionConstant].
string resource_name = 1
Resource name of the OS version to fetch.
Service to fetch paid organic search term views.
Returns the requested paid organic search term view in full detail.
Request message for [PaidOrganicSearchTermViewService.GetPaidOrganicSearchTermView][google.ads.googleads.v2.services.PaidOrganicSearchTermViewService.GetPaidOrganicSearchTermView].
string resource_name = 1
The resource name of the paid organic search term view to fetch.
Service to manage parental status views.
Returns the requested parental status view in full detail.
Request message for [ParentalStatusViewService.GetParentalStatusView][google.ads.googleads.v2.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.v2.services.PaymentsAccountService.ListPaymentsAccounts].
repeated payments_accounts = 1
The list of accessible payments accounts.
Service to fetch Product Bidding Categories.
Returns the requested Product Bidding Category in full detail.
Request message for [ProductBiddingCategoryService.GetProductBiddingCategory][].
string resource_name = 1
Resource name of the Product Bidding Category to fetch.
Service to manage product group views.
Returns the requested product group view in full detail.
Request message for [ProductGroupViewService.GetProductGroupView][google.ads.googleads.v2.services.ProductGroupViewService.GetProductGroupView].
string resource_name = 1
The resource name of the product group view to fetch.
Reach Plan Service gives users information about audience size that can be reached through advertisement on YouTube. In particular, GenerateReachForecast provides estimated number of people of specified demographics that can be reached by an ad in a given market by a campaign of certain duration with a defined budget.
Returns the list of plannable locations (for example, countries & DMAs).
message
reach_plan_service.proto:83Request message for [ReachForecastService.ListPlannableLocations][]
(message has no fields)
message
reach_plan_service.proto:88The list of plannable locations.
repeated plannable_locations = 1
The list of locations available for planning (Countries, DMAs, sub-countries). For locations like Countries, DMAs see https://developers.google.com/adwords/api/docs/appendix/geotargeting for more information.
Returns the list of per-location plannable YouTube ad formats with allowed targeting.
message
reach_plan_service.proto:114Request to list available products in a given location.
optional plannable_location_id = 1
The ID of the selected location for planning. To list the available plannable location ids use ListPlannableLocations.
message
reach_plan_service.proto:121A response with all available products.
repeated product_metadata = 1
The list of products available for planning and related targeting metadata.
Generates a product mix ideas given a set of preferences. This method helps the advertiser to obtain a good mix of ad formats and budget allocations based on its preferences.
message
reach_plan_service.proto:151Request message for [ReachForecastService.GenerateProductMixIdeas][].
string customer_id = 1
The ID of the customer.
optional plannable_location_id = 2
Required. The ID of the location, this is one of the ids returned by ListPlannableLocations.
optional currency_code = 3
Required. Currency code. Three-character ISO 4217 currency code.
optional budget_micros = 4
Required. Total budget. Amount in micros. One million is equivalent to one unit.
optional preferences = 5
The preferences of the suggested product mix. An unset preference is interpreted as all possible values are allowed, unless explicitly specified.
message
reach_plan_service.proto:198The suggested product mix.
repeated product_allocation = 1
A list of products (ad formats) and the associated budget allocation idea.
Generates a reach forecast for a given targeting / product mix.
message
reach_plan_service.proto:216Request message for [ReachPlanService.GenerateReachForecast][google.ads.googleads.v2.services.ReachPlanService.GenerateReachForecast].
string customer_id = 1
The ID of the customer.
optional currency_code = 2
Required. The currency code. Three-character ISO 4217 currency code.
optional campaign_duration = 3
Campaign duration.
optional cookie_frequency_cap = 4
Desired cookie frequency cap that will be applied to each planned product. This is equivalent to the frequency cap exposed in Google Ads when creating a campaign, it represents the maximum number of times an ad can be shown to the same user. If not specified no cap is applied.
optional min_effective_frequency = 5
Desired minimum effective frequency (the number of times a person was exposed to the ad) for the reported reach metrics [1-10]. This won't affect the targeting, but just the reporting. If not specified, a default of 1 is applied.
optional targeting = 6
The targeting to be applied to all products selected in the product mix. This is planned targeting: execution details might vary based on the advertising product, please consult an implementation specialist. If no targeting dimensions are specified, then campaigns will target everywhere and everyone. See specific metrics for details on how targeting affects them. In some cases, targeting may be overridden using the PlannedProduct.advanced_product_targeting field.
repeated planned_products = 7
The product to be planned.
message
reach_plan_service.proto:294Response message containing the generated reach curve.
optional on_target_audience_metrics = 1
Reference on target audiences for this curve.
optional reach_curve = 2
The generated reach curve for the planned product mix.
Service to manage recommendations.
Returns the requested recommendation in full detail.
message
recommendation_service.proto:69Request message for [RecommendationService.GetRecommendation][google.ads.googleads.v2.services.RecommendationService.GetRecommendation].
string resource_name = 1
The resource name of the recommendation to fetch.
Applies given recommendations with corresponding apply parameters.
message
recommendation_service.proto:75Request message for [RecommendationService.ApplyRecommendation][google.ads.googleads.v2.services.RecommendationService.ApplyRecommendation].
string customer_id = 1
The ID of the customer with the recommendation.
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.
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.
message
recommendation_service.proto:190Response message for [RecommendationService.ApplyRecommendation][google.ads.googleads.v2.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:208Request message for [RecommendationService.DismissRecommendation][google.ads.googleads.v2.services.RecommendationService.DismissRecommendation].
string customer_id = 1
The ID of the customer with the recommendation.
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.
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.
message
recommendation_service.proto:231Response message for [RecommendationService.DismissRecommendation][google.ads.googleads.v2.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.
Service to manage remarketing actions.
Returns the requested remarketing action in full detail.
Request message for [RemarketingActionService.GetRemarketingAction][google.ads.googleads.v2.services.RemarketingActionService.GetRemarketingAction].
string resource_name = 1
The resource name of the remarketing action to fetch.
Creates or updates remarketing actions. Operation statuses are returned.
Request message for [RemarketingActionService.MutateRemarketingActions][google.ads.googleads.v2.services.RemarketingActionService.MutateRemarketingActions].
string customer_id = 1
The ID of the customer whose remarketing actions are being modified.
repeated operations = 2
The list of operations to perform on individual remarketing actions.
bool partial_failure = 3
If true, successful operations will be carried out and invalid operations will return errors. If false, all operations will be carried out in one transaction if and only if they are all valid. Default is false.
bool validate_only = 4
If true, the request is validated but not executed. Only errors are returned, not results.
Response message for remarketing action mutate.
optional partial_failure_error = 3
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 an RPC level error.
repeated results = 2
All results for the mutate.
Service to manage search term views.
Returns the attributes of the requested search term view.
Request message for [SearchTermViewService.GetSearchTermView][google.ads.googleads.v2.services.SearchTermViewService.GetSearchTermView].
string resource_name = 1
The resource name of the search term view to fetch.
Service to manage shared criteria.
Returns the requested shared criterion in full detail.
Request message for [SharedCriterionService.GetSharedCriterion][google.ads.googleads.v2.services.SharedCriterionService.GetSharedCriterion].
string resource_name = 1
The resource name of the shared criterion to fetch.
Creates or removes shared criteria. Operation statuses are returned.
Request message for [SharedCriterionService.MutateSharedCriteria][google.ads.googleads.v2.services.SharedCriterionService.MutateSharedCriteria].
string customer_id = 1
The ID of the customer whose shared criteria are being modified.
repeated operations = 2
The list of operations to perform on individual shared criteria.
bool partial_failure = 3
If true, successful operations will be carried out and invalid operations will return errors. If false, all operations will be carried out in one transaction if and only if they are all valid. Default is false.
bool validate_only = 4
If true, the request is validated but not executed. Only errors are returned, not results.
Response message for a shared criterion mutate.
optional partial_failure_error = 3
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 an RPC level error.
repeated results = 2
All results for the mutate.
Service to manage shared sets.
Returns the requested shared set in full detail.
message
shared_set_service.proto:58Request message for [SharedSetService.GetSharedSet][google.ads.googleads.v2.services.SharedSetService.GetSharedSet].
string resource_name = 1
The resource name of the shared set to fetch.
Creates, updates, or removes shared sets. Operation statuses are returned.
message
shared_set_service.proto:64Request message for [SharedSetService.MutateSharedSets][google.ads.googleads.v2.services.SharedSetService.MutateSharedSets].
string customer_id = 1
The ID of the customer whose shared sets are being modified.
repeated operations = 2
The list of operations to perform on individual shared sets.
bool partial_failure = 3
If true, successful operations will be carried out and invalid operations will return errors. If false, all operations will be carried out in one transaction if and only if they are all valid. Default is false.
bool validate_only = 4
If true, the request is validated but not executed. Only errors are returned, not results.
message
shared_set_service.proto:105Response message for a shared set mutate.
optional partial_failure_error = 3
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 an RPC level error.
repeated results = 2
All results for the mutate.
Service to fetch Shopping performance views.
Returns the requested Shopping performance view in full detail.
Request message for [ShoppingPerformanceViewService.GetShoppingPerformanceView][google.ads.googleads.v2.services.ShoppingPerformanceViewService.GetShoppingPerformanceView].
string resource_name = 1
The resource name of the Shopping performance view to fetch.
Service to fetch topic constants.
Returns the requested topic constant in full detail.
message
topic_constant_service.proto:48Request message for [TopicConstantService.GetTopicConstant][google.ads.googleads.v2.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:48Request message for [TopicViewService.GetTopicView][google.ads.googleads.v2.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:48Request message for [UserInterestService.GetUserInterest][google.ads.googleads.v2.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:58Request message for [UserListService.GetUserList][google.ads.googleads.v2.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:64Request message for [UserListService.MutateUserLists][google.ads.googleads.v2.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.
bool partial_failure = 3
If true, successful operations will be carried out and invalid operations will return errors. If false, all operations will be carried out in one transaction if and only if they are all valid. Default is false.
bool validate_only = 4
If true, the request is validated but not executed. Only errors are returned, not results.
message
user_list_service.proto:105Response message for user list mutate.
optional partial_failure_error = 3
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 an RPC level error.
repeated results = 2
All results for the mutate.
Service to manage user location views.
Returns the requested user location view in full detail.
Request message for [UserLocationViewService.GetUserLocationView][google.ads.googleads.v2.services.UserLocationViewService.GetUserLocationView].
string resource_name = 1
The resource name of the user location view to fetch.
Service to manage videos.
rpc GetVideo (, )
video_service.proto:40Returns the requested video in full detail.
message
video_service.proto:48Request message for [VideoService.GetVideo][google.ads.googleads.v2.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.
A single operation (create, remove) on an ad group ad label.
Used in: ,
oneof operation
The mutate operation.
create = 1
Create operation: No resource name is expected for the new ad group ad label.
string remove = 2
Remove operation: A resource name for the ad group ad label being removed, in this format: `customers/{customer_id}/adGroupAdLabels/{ad_group_id}~{ad_id} _{label_id}`
message
ad_group_ad_service.proto:84A 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) on an ad group criterion label.
Used in: ,
oneof operation
The mutate operation.
create = 1
Create operation: No resource name is expected for the new ad group label.
string remove = 2
Remove operation: A resource name for the ad group criterion label being removed, in this format: `customers/{customer_id}/adGroupCriterionLabels/{ad_group_id}~{criterion_id}~{label_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.
repeated exempt_policy_violation_keys = 5
The list of policy violation keys that should not cause a PolicyViolationError to be reported. Not all policy violations are exemptable, please refer to the is_exemptible field in the returned PolicyViolationError. Resources violating these polices will be saved, but will not be eligible to serve. They may begin serving at a later time due to a change in policies, re-review of the resource, or a change in advertiser certificates.
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}`
A single operation (create, update, remove) on an ad group extension setting.
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 extension setting.
update = 2
Update operation: The ad group extension setting is expected to have a valid resource name.
string remove = 3
Remove operation: A resource name for the removed ad group extension setting is expected, in this format: `customers/{customer_id}/adGroupExtensionSettings/{ad_group_id}~{extension_type}`
message
ad_group_feed_service.proto:84A 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_label_service.proto:83A single operation (create, remove) on an ad group label.
Used in: ,
oneof operation
The mutate operation.
create = 1
Create operation: No resource name is expected for the new ad group label.
string remove = 2
Remove operation: A resource name for the ad group label being removed, in this format: `customers/{customer_id}/adGroupLabels/{ad_group_id}~{label_id}`
message
ad_group_service.proto:83A 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
ad_service.proto:72A single update operation on an ad.
Used in:
optional update_mask = 2
FieldMask that determines which resource fields are modified in an update.
oneof operation
The mutate operation.
update = 1
Update operation: The ad is expected to have a valid resource name in this format: `customers/{customer_id}/ads/{ad_id}`
message
ad_parameter_service.proto:84A single operation (create, update, remove) on ad parameter.
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 parameter.
update = 2
Update operation: The ad parameter is expected to have a valid resource name.
string remove = 3
Remove operation: A resource name for the ad parameter to remove is expected in this format: `customers/{customer_id}/adParameters/{ad_group_id}~{criterion_id}~{parameter_index}`
message
recommendation_service.proto:93Information 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.
callout_extension = 6
Parameters to use when applying callout extension recommendation.
call_extension = 7
Parameters to use when applying call extension recommendation.
sitelink_extension = 8
Parameters to use when applying sitelink extension recommendation.
move_unused_budget = 9
Parameters to use when applying move unused budget recommendation.
message
recommendation_service.proto:138Parameters to use when applying call extension recommendation.
Used in:
repeated call_extensions = 1
Call extensions to be added. This is a required field.
message
recommendation_service.proto:132Parameters to use when applying callout extension recommendation.
Used in:
repeated callout_extensions = 1
Callout extensions to be added. This is a required field.
message
recommendation_service.proto:95Parameters 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:109Parameters 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:150Parameters to use when applying move unused budget recommendation.
Used in:
optional budget_micros_to_move = 1
Budget amount to move from excess budget to constrained budget. This is a required field.
message
recommendation_service.proto:144Parameters to use when applying sitelink extension recommendation.
Used in:
repeated sitelink_extensions = 1
Sitelink extensions to be added. This is a required field.
message
recommendation_service.proto:122Parameters 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:102Parameters 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:202The result of applying a recommendation.
Used in:
string resource_name = 1
Returned for successful applies.
message
asset_service.proto:75A single operation to create an asset. Supported asset types are YoutubeVideoAsset, MediaBundleAsset and ImageAsset. TextAsset should be created with Ad inline.
Used in: ,
oneof operation
The mutate operation.
create = 1
Create operation: No resource name is expected for the new asset.
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:81A 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 call conversion.
Used in:
optional caller_id = 1
The caller id from which this call was placed. Caller id is expected to be in E.164 format with preceding '+' sign. e.g. "+16502531234".
optional call_start_date_time = 2
The date time at which the call occurred. The timezone must be specified. The format is "yyyy-mm-dd hh:mm:ss+|-hh:mm", e.g. "2019-01-01 12:32:45-08:00".
optional conversion_action = 3
Resource name of the conversion action associated with this conversion. Note: Although this resource name consists of a customer id and a conversion action id, validation will ignore the customer id and use the conversion action id as the sole identifier of the conversion action.
optional conversion_date_time = 4
The date time at which the conversion occurred. Must be after the call time. The timezone must be specified. The format is "yyyy-mm-dd hh:mm:ss+|-hh:mm", e.g. "2019-01-01 12:32:45-08:00".
optional conversion_value = 5
The value of the conversion for the advertiser.
optional currency_code = 6
Currency associated with the conversion value. This is the ISO 4217 3-character currency code. For example: USD, EUR.
Identifying information for a successfully processed CallConversionUpload.
Used in:
optional caller_id = 1
The caller id from which this call was placed. Caller id is expected to be in E.164 format with preceding '+' sign.
optional call_start_date_time = 2
The date time at which the call occurred. The format is "yyyy-mm-dd hh:mm:ss+|-hh:mm", e.g. "2019-01-01 12:32:45-08:00".
optional conversion_action = 3
Resource name of the conversion action associated with this conversion.
optional conversion_date_time = 4
The date time at which the conversion occurred. The format is "yyyy-mm-dd hh:mm:ss+|-hh:mm", e.g. "2019-01-01 12:32:45-08:00".
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:84A 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_draft_service.proto:119A single operation (create, update, remove) on a campaign draft.
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 draft.
update = 2
Update operation: The campaign draft is expected to have a valid resource name.
string remove = 3
Remove operation: The campaign draft is expected to have a valid resource name, in this format: `customers/{customer_id}/campaignDrafts/{base_campaign_id}~{draft_id}`
message
reach_plan_service.proto:276The duration of a planned campaign.
Used in:
optional duration_in_days = 1
The duration value in days.
A single update operation on a campaign experiment.
Used in: ,
optional update_mask = 3
FieldMask that determines which resource fields are modified in an update.
oneof operation
The mutate operation.
update = 1
Update operation: The campaign experiment is expected to have a valid resource name.
string remove = 2
Remove operation: The campaign experiment is expected to have a valid resource name, in this format: `customers/{customer_id}/campaignExperiments/{campaign_experiment_id}`
A single operation (create, update, remove) on a campaign extension setting.
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 extension setting.
update = 2
Update operation: The campaign extension setting is expected to have a valid resource name.
string remove = 3
Remove operation: A resource name for the removed campaign extension setting is expected, in this format: `customers/{customer_id}/campaignExtensionSettings/{campaign_id}~{extension_type}`
message
campaign_feed_service.proto:84A 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_label_service.proto:83A single operation (create, remove) on a campaign-label relationship.
Used in: ,
oneof operation
The mutate operation.
create = 1
Create operation: No resource name is expected for the new campaign-label relationship.
string remove = 2
Remove operation: A resource name for the campaign-label relationship being removed, in this format: `customers/{customer_id}/campaignLabels/{campaign_id}~{label_id}`
message
campaign_service.proto:83A 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 click conversion.
Used in:
optional gclid = 1
The Google click ID (gclid) associated with this conversion.
optional conversion_action = 2
Resource name of the conversion action associated with this conversion. Note: Although this resource name consists of a customer id and a conversion action id, validation will ignore the customer id and use the conversion action id as the sole identifier of the conversion action.
optional conversion_date_time = 3
The date time at which the conversion occurred. Must be after the click time. The timezone must be specified. The format is "yyyy-mm-dd hh:mm:ss+|-hh:mm", e.g. “2019-01-01 12:32:45-08:00”.
optional conversion_value = 4
The value of the conversion for the advertiser.
optional currency_code = 5
Currency associated with the conversion value. This is the ISO 4217 3-character currency code. For example: USD, EUR.
optional order_id = 6
The order ID associated with the conversion. An order id can only be used for one conversion per conversion action.
optional external_attribution_data = 7
Additional data about externally attributed conversions. This field is required for conversions with an externally attributed conversion action, but should not be set otherwise.
Identifying information for a successfully processed ClickConversion.
Used in:
optional gclid = 1
The Google Click ID (gclid) associated with this conversion.
optional conversion_action = 2
Resource name of the conversion action associated with this conversion.
optional conversion_date_time = 3
The date time at which the conversion occurred. The format is "yyyy-mm-dd hh:mm:ss+|-hh:mm", e.g. “2019-01-01 12:32:45-08:00”.
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}`
A conversion adjustment.
Used in:
optional conversion_action = 3
Resource name of the conversion action associated with this conversion adjustment. Note: Although this resource name consists of a customer id and a conversion action id, validation will ignore the customer id and use the conversion action id as the sole identifier of the conversion action.
optional adjustment_date_time = 4
The date time at which the adjustment occurred. Must be after the conversion_date_time. The timezone must be specified. The format is "yyyy-mm-dd hh:mm:ss+|-hh:mm", e.g. "2019-01-01 12:32:45-08:00".
enums.ConversionAdjustmentTypeEnum.ConversionAdjustmentType adjustment_type = 5
The adjustment type.
optional restatement_value = 6
Information needed to restate the conversion's value. Required for restatements. Should not be supplied for retractions. An error will be returned if provided for a retraction.
oneof conversion_identifier
Identifies the conversion to be adjusted.
gclid_date_time_pair = 1
Uniquely identifies a conversion that was reported without an order ID specified.
order_id = 2
The order ID of the conversion to be adjusted. If the conversion was reported with an order ID specified, that order ID must be used as the identifier here.
Information identifying a successfully processed ConversionAdjustment.
Used in:
optional conversion_action = 3
Resource name of the conversion action associated with this conversion adjustment.
optional adjustment_date_time = 4
The date time at which the adjustment occurred. The format is "yyyy-mm-dd hh:mm:ss+|-hh:mm", e.g. "2019-01-01 12:32:45-08:00".
enums.ConversionAdjustmentTypeEnum.ConversionAdjustmentType adjustment_type = 5
The adjustment type.
oneof conversion_identifier
Identifies the conversion that was adjusted.
gclid_date_time_pair = 1
Uniquely identifies a conversion that was reported without an order ID specified.
order_id = 2
The order ID of the conversion that was adjusted.
Message used as metadata returned in Long Running Operations for CreateCampaignExperimentRequest
string campaign_experiment = 1
Resource name of campaign experiment created.
message
custom_interest_service.proto:76A single operation (create, update) on a custom interest.
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 custom interest.
update = 2
Update operation: The custom interest is expected to have a valid resource name.
A single operation (create, update) on a CustomerClientLink.
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 link.
update = 2
Update operation: The link is expected to have a valid resource name.
A single operation (create, update, remove) on a customer extension setting.
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 extension setting.
update = 2
Update operation: The customer extension setting is expected to have a valid resource name.
string remove = 3
Remove operation: A resource name for the removed customer extension setting is expected, in this format: `customers/{customer_id}/customerExtensionSettings/{extension_type}`
message
customer_feed_service.proto:84A 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_label_service.proto:83A single operation (create, remove) on a customer-label relationship.
Used in: ,
oneof operation
The mutate operation.
create = 1
Create operation: No resource name is expected for the new customer-label relationship.
string remove = 2
Remove operation: A resource name for the customer-label relationship being removed, in this format: `customers/{customer_id}/customerLabels/{label_id}`
Updates the status of a CustomerManagerLink. The following actions are possible: 1. Update operation with status ACTIVE accepts a pending invitation. 2. Update operation with status REFUSED declines a pending invitation. 3. Update operation with status INACTIVE terminates link to manager.
Used in:
optional update_mask = 4
FieldMask that determines which resource fields are modified in an update.
oneof operation
The mutate operation.
update = 2
Update operation: The link is expected to have a valid resource name.
A single operation (create or remove) on a customer level negative criterion.
Used in: ,
oneof operation
The mutate operation.
create = 1
Create operation: No resource name is expected for the new criterion.
string remove = 2
Remove operation: A resource name for the removed criterion is expected, in this format: `customers/{customer_id}/customerNegativeCriteria/{criterion_id}`
message
customer_service.proto:112A 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:210Operation 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:233The result of dismissing a recommendation.
Used in:
string resource_name = 1
Returned for successful dismissals.
A single operation (create, update, remove) on an extension 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 extension feed item.
update = 2
Update operation: The extension feed item is expected to have a valid resource name.
string remove = 3
Remove operation: A resource name for the removed extension feed item is expected, in this format: `customers/{customer_id}/extensionFeedItems/{feed_item_id}`
Contains additional information about externally attributed conversions.
Used in:
optional external_attribution_credit = 1
Represents the fraction of the conversion that is attributed to the Google Ads click.
optional external_attribution_model = 2
Specifies the attribution model name.
message
feed_item_service.proto:84A 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}`
A single operation (create, remove) on an feed item target.
Used in: ,
oneof operation
The mutate operation.
create = 1
Create operation: No resource name is expected for the new feed item target.
string remove = 2
Remove operation: A resource name for the removed feed item target is expected, in this format: `customers/{customer_id}/feedItemTargets/{feed_id}~{feed_item_id}~{feed_item_target_type}~{feed_item_target_id}`
message
feed_mapping_service.proto:83A 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:84A 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
reach_plan_service.proto:322Forecasted traffic metrics for the planned products and targeting.
Used in:
optional on_target_reach = 1
Number of unique people reached at least GenerateReachForecastRequest.min_effective_frequency times that exactly matches the Targeting.
optional total_reach = 2
Total number of unique people reached at least GenerateReachForecastRequest.min_effective_frequency times. This includes people that may fall outside the specified Targeting.
optional on_target_impressions = 3
Number of ad impressions that exactly matches the Targeting.
optional total_impressions = 4
Total number of ad impressions. This includes impressions that may fall outside the specified Targeting, due to insufficent information on signed-in users.
message
keyword_plan_service.proto:195Forecast 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
Uniquely identifies a conversion that was reported without an order ID specified.
Used in: ,
optional gclid = 1
Google click ID (gclid) associated with the original conversion for this adjustment.
optional conversion_date_time = 2
The date time at which the original conversion for this adjustment occurred. The timezone must be specified. The format is "yyyy-mm-dd hh:mm:ss+|-hh:mm", e.g. "2019-01-01 12:32:45-08:00".
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:296A 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_ad_asset_view = 131
The ad group ad asset view in the query.
optional ad_group_ad_label = 120
The ad group ad label 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_criterion_label = 121
The ad group criterion label referenced in the query.
optional ad_group_criterion_simulation = 110
The ad group criterion simulation referenced in the query.
optional ad_group_extension_setting = 112
The ad group extension setting referenced in the query.
optional ad_group_feed = 67
The ad group feed referenced in the query.
optional ad_group_label = 115
The ad group label referenced in the query.
optional ad_group_simulation = 107
The ad group simulation referenced in the query.
optional ad_parameter = 130
The ad parameter referenced in the query.
optional age_range_view = 48
The age range view referenced in the query.
optional ad_schedule_view = 89
The ad schedule view referenced in the query.
optional domain_category = 91
The domain category referenced in the query.
optional asset = 105
The asset 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_criterion_simulation = 111
The campaign criterion simulation referenced in the query.
optional campaign_draft = 49
The campaign draft referenced in the query.
optional campaign_experiment = 84
The campaign experiment referenced in the query.
optional campaign_extension_setting = 113
The campaign extension setting referenced in the query.
optional campaign_feed = 63
The campaign feed referenced in the query.
optional campaign_label = 108
The campaign label referenced in the 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 conversion_action = 103
The conversion action referenced in the query.
optional click_view = 122
The ClickView referenced in the query.
optional custom_interest = 104
The CustomInterest 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_extension_setting = 114
The customer extension setting referenced in the query.
optional customer_feed = 64
The customer feed referenced in the query.
optional customer_label = 124
The customer label referenced in the query.
optional customer_negative_criterion = 88
The customer negative criterion referenced in the query.
optional detail_placement_view = 118
The detail placement view referenced in the query.
optional display_keyword_view = 47
The display keyword view referenced in the query.
optional distance_view = 132
The distance view referenced in the query.
optional dynamic_search_ads_search_term_view = 106
The dynamic search ads search term view referenced in the query.
optional expanded_landing_page_view = 128
The expanded landing page view referenced in the query.
optional extension_feed_item = 85
The extension feed item 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_item_target = 116
The feed item target referenced in the query.
optional feed_mapping = 58
The feed mapping referenced in the query.
optional feed_placeholder_view = 97
The feed placeholder view 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 geographic_view = 125
The geographic view referenced in the query.
optional group_placement_view = 119
The group placement view 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 label = 52
The label referenced in the query.
optional landing_page_view = 126
The landing page view referenced in the query.
optional language_constant = 55
The language constant referenced in the query.
optional location_view = 123
The location view referenced in the query.
optional managed_placement_view = 53
The managed placement view referenced in the query.
optional media_file = 90
The media file referenced in the query.
optional mobile_app_category_constant = 87
The mobile app category constant referenced in the query.
optional mobile_device_constant = 98
The mobile device constant referenced in the query.
optional mutate_job = 127
The mutate job referenced in the query.
optional operating_system_version_constant = 86
The operating system version constant referenced in the query.
optional paid_organic_search_term_view = 129
The paid organic search term view referenced in the query.
optional parental_status_view = 45
The parental status view referenced in the query.
optional product_bidding_category_constant = 109
The Product Bidding Category 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 shopping_performance_view = 117
The shopping performance view 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 user_location_view = 135
The user location view referenced in the query.
optional remarketing_action = 60
The remarketing action 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.
optional segments = 102
The segments.
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:173An 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:162A 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:184A 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:226A 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:102A 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
label_service.proto:81A single operation (create, remove, update) on a label.
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 label.
update = 2
Update operation: The label is expected to have a valid resource name.
string remove = 3
Remove operation: A resource name for the label being removed, in this format: `customers/{customer_id}/labels/{label_id}`
message
media_file_service.proto:82A 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.
A single update on a Merchant Center link.
Used in:
optional update_mask = 3
FieldMask that determines which resource fields are modified in an update.
oneof operation
The operation to perform
update = 1
Update operation: The merchant center link is expected to have a valid resource name.
string remove = 2
Remove operation: A resource name for the removed merchant center link is expected, in this format: `customers/{customer_id}/merchantCenterLinks/{merchant_center_id}`
The result for the account budget proposal mutate.
Used in:
string resource_name = 1
Returned for successful operations.
The result for an ad group ad label mutate.
Used in: ,
string resource_name = 1
Returned for successful operations.
message
ad_group_ad_service.proto:120The 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 an ad group criterion label 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.
The result for the ad group extension setting mutate.
Used in: ,
string resource_name = 1
Returned for successful operations.
message
ad_group_feed_service.proto:118The result for the ad group feed mutate.
Used in: ,
string resource_name = 1
Returned for successful operations.
message
ad_group_label_service.proto:111The result for an ad group label mutate.
Used in: ,
string resource_name = 1
Returned for successful operations.
message
ad_group_service.proto:116The result for the ad group mutate.
Used in: ,
string resource_name = 1
Returned for successful operations.
message
ad_parameter_service.proto:118The result for the ad parameter mutate.
Used in: ,
string resource_name = 1
The resource name returned for successful operations.
message
ad_service.proto:93The result for the ad mutate.
Used in:
string resource_name = 1
The resource name returned for successful operations.
message
asset_service.proto:90The result for the asset mutate.
Used in: ,
string resource_name = 1
The resource name 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:104Result 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.
The 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_draft_service.proto:154The result for the campaign draft mutate.
Used in: ,
string resource_name = 1
Returned for successful operations.
The result for the campaign experiment mutate.
Used in: ,
string resource_name = 1
Returned for successful operations.
The result for the campaign extension setting mutate.
Used in: ,
string resource_name = 1
Returned for successful operations.
message
campaign_feed_service.proto:118The result for the campaign feed mutate.
Used in: ,
string resource_name = 1
Returned for successful operations.
message
campaign_label_service.proto:111The result for a campaign label mutate.
Used in: ,
string resource_name = 1
Returned for successful operations.
message
campaign_service.proto:117The 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
custom_interest_service.proto:99The result for the custom interest mutate.
Used in:
string resource_name = 1
Returned for successful operations.
The result for a single customer client link mutate.
Used in:
string resource_name = 1
Returned for successful operations.
The result for the customer extension setting mutate.
Used in: ,
string resource_name = 1
Returned for successful operations.
message
customer_feed_service.proto:118The result for the customer feed mutate.
Used in: ,
string resource_name = 1
Returned for successful operations.
message
customer_label_service.proto:111The result for a customer label mutate.
Used in: ,
string resource_name = 1
Returned for successful operations.
The result for the customer manager link 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
customer_service.proto:133The result for the customer mutate.
Used in: ,
string resource_name = 1
Returned for successful operations.
The result for the extension feed item mutate.
Used in: ,
string resource_name = 1
Returned for successful operations.
message
feed_item_service.proto:118The result for the feed item mutate.
Used in: ,
string resource_name = 1
Returned for successful operations.
The result for the feed item target mutate.
Used in: ,
string resource_name = 1
Returned for successful operations.
message
feed_mapping_service.proto:110The result for the feed mapping mutate.
Used in: ,
string resource_name = 1
Returned for successful operations.
message
feed_service.proto:118The result for the feed mutate.
Used in: ,
string resource_name = 1
Returned for successful operations.
message
mutate_job_service.proto:180MutateJob result.
Used in:
int64 operation_index = 1
Index of the mutate operation.
optional mutate_operation_response = 2
Response for the mutate. May be empty if errors occurred.
optional status = 3
Details of the errors when processing the operation.
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:137The result for the keyword plan mutate.
Used in:
string resource_name = 1
Returned for successful operations.
message
label_service.proto:114The result for a label mutate.
Used in: ,
string resource_name = 1
Returned for successful operations.
message
media_file_service.proto:103The result for the media file mutate.
Used in: ,
string resource_name = 1
The resource name returned for successful operations.
The result for the Merchant Center link mutate.
Used in:
string resource_name = 1
Returned for successful operations.
message
google_ads_service.proto:624A single operation (create, update, remove) on a resource.
Used in: ,
oneof operation
The mutate operation.
ad_group_ad_label_operation = 17
An ad group ad label 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_label_operation = 18
An ad group criterion label mutate operation.
ad_group_criterion_operation = 3
An ad group criterion mutate operation.
ad_group_extension_setting_operation = 19
An ad group extension setting mutate operation.
ad_group_feed_operation = 20
An ad group feed mutate operation.
ad_group_label_operation = 21
An ad group label mutate operation.
ad_group_operation = 5
An ad group mutate operation.
ad_parameter_operation = 22
An ad parameter mutate operation.
asset_operation = 23
An asset 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_criterion_operation = 13
A campaign criterion mutate operation.
campaign_draft_operation = 24
A campaign draft mutate operation.
campaign_experiment_operation = 25
A campaign experiment mutate operation.
campaign_extension_setting_operation = 26
A campaign extension setting mutate operation.
campaign_feed_operation = 27
A campaign feed mutate operation.
campaign_label_operation = 28
A campaign label 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.
customer_extension_setting_operation = 30
A customer extension setting mutate operation.
customer_feed_operation = 31
A customer feed mutate operation.
customer_label_operation = 32
A customer label mutate operation.
customer_negative_criterion_operation = 34
A customer negative criterion mutate operation.
customer_operation = 35
A customer mutate operation.
extension_feed_item_operation = 36
An extension feed item mutate operation.
feed_item_operation = 37
A feed item mutate operation.
feed_item_target_operation = 38
A feed item target mutate operation.
feed_mapping_operation = 39
A feed mapping mutate operation.
feed_operation = 40
A feed mutate operation.
label_operation = 41
A label mutate operation.
media_file_operation = 42
A media file mutate operation.
remarketing_action_operation = 43
A remarketing action 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:747Response message for the resource mutate.
Used in: ,
oneof response
The mutate response.
ad_group_ad_label_result = 17
The result for the ad group ad label mutate.
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_label_result = 18
The result for the ad group criterion label mutate.
ad_group_criterion_result = 3
The result for the ad group criterion mutate.
ad_group_extension_setting_result = 19
The result for the ad group extension setting mutate.
ad_group_feed_result = 20
The result for the ad group feed mutate.
ad_group_label_result = 21
The result for the ad group label mutate.
ad_group_result = 5
The result for the ad group mutate.
ad_parameter_result = 22
The result for the ad parameter mutate.
asset_result = 23
The result for the asset 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_criterion_result = 13
The result for the campaign criterion mutate.
campaign_draft_result = 24
The result for the campaign draft mutate.
campaign_experiment_result = 25
The result for the campaign experiment mutate.
campaign_extension_setting_result = 26
The result for the campaign extension setting mutate.
campaign_feed_result = 27
The result for the campaign feed mutate.
campaign_label_result = 28
The result for the campaign label 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.
customer_extension_setting_result = 30
The result for the customer extension setting mutate.
customer_feed_result = 31
The result for the customer feed mutate.
customer_label_result = 32
The result for the customer label mutate.
customer_negative_criterion_result = 34
The result for the customer negative criterion mutate.
customer_result = 35
The result for the customer mutate.
extension_feed_item_result = 36
The result for the extension feed item mutate.
feed_item_result = 37
The result for the feed item mutate.
feed_item_target_result = 38
The result for the feed item target mutate.
feed_mapping_result = 39
The result for the feed mapping mutate.
feed_result = 40
The result for the feed mutate.
label_result = 41
The result for the label mutate.
media_file_result = 42
The result for the media file mutate.
remarketing_action_result = 43
The result for the remarketing action 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 remarketing action mutate.
Used in: ,
string resource_name = 1
Returned for successful operations.
The result for the shared criterion mutate.
Used in: ,
string resource_name = 1
Returned for successful operations.
message
shared_set_service.proto:117The result for the shared set mutate.
Used in: ,
string resource_name = 1
Returned for successful operations.
message
user_list_service.proto:117The result for the user list mutate.
Used in: ,
string resource_name = 1
Returned for successful operations.
message
reach_plan_service.proto:348Audience metrics for the planned products. These metrics consider the following targeting dimensions: - Location - PlannableAgeRange - Gender
Used in:
optional youtube_audience_size = 1
Reference audience size matching the considered targeting for YouTube.
optional census_audience_size = 2
Reference audience size matching the considered targeting for Census.
message
reach_plan_service.proto:99A plannable location: a country, a DMA, a metro region, a tv region, a province.
Used in:
optional id = 1
The location identifier.
optional name = 2
The unique location name in english.
optional parent_country_id = 3
The parent country code, not present if location is a country. If present will always be a criterion id: additional information, such as country name are returned both via ListPlannableLocations or directly by accessing GeoTargetConstantService with the criterion id.
message
reach_plan_service.proto:137The targeting for which traffic metrics will be reported.
Used in:
repeated enums.ReachPlanAgeRangeEnum.ReachPlanAgeRange age_ranges = 1
Allowed plannable age ranges for the product for which metrics will be reported. Actual targeting is computed by mapping this age range onto standard Google common.AgeRangeInfo values.
repeated genders = 2
Targetable genders for the ad product.
repeated devices = 3
Targetable devices for the ad product.
message
reach_plan_service.proto:282A product being planned for reach.
Used in:
optional plannable_product_code = 1
Required. Selected product for planning. Plannable products codes can be obtained from ListPlannableProducts.
optional budget_micros = 2
Required. Maximum budget allocation in micros for the selected product. The value is specified in the selected planning currency_code. E.g. 1 000 000$ = 1 000 000 000 000 micros.
message
reach_plan_service.proto:174Set of preferences about the planned mix.
Used in:
optional is_skippable = 1
True if ad skippable. If not set, default is any value.
optional starts_with_sound = 2
True if ad start with sound. If not set, default is any value.
enums.ReachPlanAdLengthEnum.ReachPlanAdLength ad_length = 3
The length of the ad. If not set, default is any value.
optional top_content_only = 4
True if ad will only show on the top content. If not set, default is false.
optional has_guaranteed_price = 5
True if the price guaranteed. The cost of serving the ad is agreed upfront and not subject to an auction. If not set, default is any value.
message
reach_plan_service.proto:204An allocation of a part of the budget on a given product.
Used in: ,
optional plannable_product_code = 1
Selected product for planning. The product codes returned are within the set of the ones returned by ListPlannableProducts when using the same location id.
optional budget_micros = 2
The value to be allocated for the suggested product in requested currency. Amount in micros. One million is equivalent to one unit.
message
reach_plan_service.proto:127The metadata associated with an available plannable product.
Used in:
optional plannable_product_code = 1
The code associated with the ad product. E.g. Trueview, Bumper To list the available plannable product codes use ListPlannableProducts.
optional plannable_targeting = 2
The allowed plannable targeting for this product.
message
reach_plan_service.proto:303The reach curve for the planned products.
Used in:
repeated reach_forecasts = 1
All points on the reach curve.
message
reach_plan_service.proto:309A point on reach curve.
Used in:
optional cost_micros = 1
The cost in micros.
optional forecast = 2
Forecasted traffic metrics for this point.
repeated forecasted_product_allocations = 3
The forecasted allocation. This differs from the input allocation if one or more product cannot fulfill the budget because of limited inventory.
A single operation (create, update) on a remarketing 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 remarketing action.
update = 2
Update operation: The remarketing action is expected to have a valid resource name.
Contains information needed to restate a conversion's value.
Used in:
optional adjusted_value = 1
The restated conversion value. This is the value of the conversion after restatement. For example, to change the value of a conversion from 100 to 70, an adjusted value of 70 should be reported.
optional currency_code = 2
The currency of the restated value. If not provided, then the default currency from the conversion action is used, and if that is not set then the account currency is used. This is the ISO 4217 3-character currency code e.g. USD or EUR.
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}`
message
shared_set_service.proto:83A 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.
message
reach_plan_service.proto:259The targeting for which traffic metrics will be reported.
Used in:
optional plannable_location_id = 1
Required. The ID of the selected location. Plannable locations ID can be obtained from ListPlannableLocations.
enums.ReachPlanAgeRangeEnum.ReachPlanAgeRange age_range = 2
Required Selected age range to be planned on.
repeated genders = 3
Targetable genders for the ad product.
repeated devices = 4
Targetable devices for the ad product.
Url Seed
Used in:
optional url = 1
The URL to crawl in order to generate keyword ideas.
message
user_list_service.proto:83A 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}`