Google Ads API is returning to beta status. Please read our blog post for more details.

Package google.ads.googleads.v1.services

Index

AccountBudgetProposalService

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.

GetAccountBudgetProposal

rpc GetAccountBudgetProposal(GetAccountBudgetProposalRequest) returns (AccountBudgetProposal)

Returns an account-level budget proposal in full detail.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

MutateAccountBudgetProposal

rpc MutateAccountBudgetProposal(MutateAccountBudgetProposalRequest) returns (MutateAccountBudgetProposalResponse)

Creates, updates, or removes account budget proposals. Operation statuses are returned.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

AccountBudgetService

A service for fetching an account-level budget.

Account-level budgets are mutated by creating proposal resources.

GetAccountBudget

rpc GetAccountBudget(GetAccountBudgetRequest) returns (AccountBudget)

Returns an account-level budget in full detail.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

AdGroupAdLabelService

Service to manage labels on ad group ads.

GetAdGroupAdLabel

rpc GetAdGroupAdLabel(GetAdGroupAdLabelRequest) returns (AdGroupAdLabel)

Returns the requested ad group ad label in full detail.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

MutateAdGroupAdLabels

rpc MutateAdGroupAdLabels(MutateAdGroupAdLabelsRequest) returns (MutateAdGroupAdLabelsResponse)

Creates and removes ad group ad labels. Operation statuses are returned.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

AdGroupAdService

Service to manage ads in an ad group.

GetAdGroupAd

rpc GetAdGroupAd(GetAdGroupAdRequest) returns (AdGroupAd)

Returns the requested ad in full detail.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

MutateAdGroupAds

rpc MutateAdGroupAds(MutateAdGroupAdsRequest) returns (MutateAdGroupAdsResponse)

Creates, updates, or removes ads. Operation statuses are returned.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

AdGroupAudienceViewService

Service to manage ad group audience views.

GetAdGroupAudienceView

rpc GetAdGroupAudienceView(GetAdGroupAudienceViewRequest) returns (AdGroupAudienceView)

Returns the requested ad group audience view in full detail.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

AdGroupBidModifierService

Service to manage ad group bid modifiers.

GetAdGroupBidModifier

rpc GetAdGroupBidModifier(GetAdGroupBidModifierRequest) returns (AdGroupBidModifier)

Returns the requested ad group bid modifier in full detail.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

MutateAdGroupBidModifiers

rpc MutateAdGroupBidModifiers(MutateAdGroupBidModifiersRequest) returns (MutateAdGroupBidModifiersResponse)

Creates, updates, or removes ad group bid modifiers. Operation statuses are returned.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

AdGroupCriterionLabelService

Service to manage labels on ad group criteria.

GetAdGroupCriterionLabel

rpc GetAdGroupCriterionLabel(GetAdGroupCriterionLabelRequest) returns (AdGroupCriterionLabel)

Returns the requested ad group criterion label in full detail.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

MutateAdGroupCriterionLabels

rpc MutateAdGroupCriterionLabels(MutateAdGroupCriterionLabelsRequest) returns (MutateAdGroupCriterionLabelsResponse)

Creates and removes ad group criterion labels. Operation statuses are returned.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

AdGroupCriterionService

Service to manage ad group criteria.

GetAdGroupCriterion

rpc GetAdGroupCriterion(GetAdGroupCriterionRequest) returns (AdGroupCriterion)

Returns the requested criterion in full detail.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

MutateAdGroupCriteria

rpc MutateAdGroupCriteria(MutateAdGroupCriteriaRequest) returns (MutateAdGroupCriteriaResponse)

Creates, updates, or removes criteria. Operation statuses are returned.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

AdGroupCriterionSimulationService

Service to fetch ad group criterion simulations.

GetAdGroupCriterionSimulation

rpc GetAdGroupCriterionSimulation(GetAdGroupCriterionSimulationRequest) returns (AdGroupCriterionSimulation)

Returns the requested ad group criterion simulation in full detail.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

AdGroupExtensionSettingService

Service to manage ad group extension settings.

GetAdGroupExtensionSetting

rpc GetAdGroupExtensionSetting(GetAdGroupExtensionSettingRequest) returns (AdGroupExtensionSetting)

Returns the requested ad group extension setting in full detail.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

MutateAdGroupExtensionSettings

rpc MutateAdGroupExtensionSettings(MutateAdGroupExtensionSettingsRequest) returns (MutateAdGroupExtensionSettingsResponse)

Creates, updates, or removes ad group extension settings. Operation statuses are returned.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

AdGroupFeedService

Service to manage ad group feeds.

GetAdGroupFeed

rpc GetAdGroupFeed(GetAdGroupFeedRequest) returns (AdGroupFeed)

Returns the requested ad group feed in full detail.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

MutateAdGroupFeeds

rpc MutateAdGroupFeeds(MutateAdGroupFeedsRequest) returns (MutateAdGroupFeedsResponse)

Creates, updates, or removes ad group feeds. Operation statuses are returned.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

AdGroupLabelService

Service to manage labels on ad groups.

GetAdGroupLabel

rpc GetAdGroupLabel(GetAdGroupLabelRequest) returns (AdGroupLabel)

Returns the requested ad group label in full detail.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

MutateAdGroupLabels

rpc MutateAdGroupLabels(MutateAdGroupLabelsRequest) returns (MutateAdGroupLabelsResponse)

Creates and removes ad group labels. Operation statuses are returned.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

AdGroupService

Service to manage ad groups.

GetAdGroup

rpc GetAdGroup(GetAdGroupRequest) returns (AdGroup)

Returns the requested ad group in full detail.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

MutateAdGroups

rpc MutateAdGroups(MutateAdGroupsRequest) returns (MutateAdGroupsResponse)

Creates, updates, or removes ad groups. Operation statuses are returned.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

AdGroupSimulationService

Service to fetch ad group simulations.

GetAdGroupSimulation

rpc GetAdGroupSimulation(GetAdGroupSimulationRequest) returns (AdGroupSimulation)

Returns the requested ad group simulation in full detail.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

AdParameterService

Service to manage ad parameters.

GetAdParameter

rpc GetAdParameter(GetAdParameterRequest) returns (AdParameter)

Returns the requested ad parameter in full detail.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

MutateAdParameters

rpc MutateAdParameters(MutateAdParametersRequest) returns (MutateAdParametersResponse)

Creates, updates, or removes ad parameters. Operation statuses are returned.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

AdScheduleViewService

Service to fetch ad schedule views.

GetAdScheduleView

rpc GetAdScheduleView(GetAdScheduleViewRequest) returns (AdScheduleView)

Returns the requested ad schedule view in full detail.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

AgeRangeViewService

Service to manage age range views.

GetAgeRangeView

rpc GetAgeRangeView(GetAgeRangeViewRequest) returns (AgeRangeView)

Returns the requested age range view in full detail.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

AssetService

Service to manage assets. Asset types can be created with AssetService are YoutubeVideoAsset, MediaBundleAsset and ImageAsset. TextAsset should be created with Ad inline.

GetAsset

rpc GetAsset(GetAssetRequest) returns (Asset)

Returns the requested asset in full detail.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

MutateAssets

rpc MutateAssets(MutateAssetsRequest) returns (MutateAssetsResponse)

Creates assets. Operation statuses are returned.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

BiddingStrategyService

Service to manage bidding strategies.

GetBiddingStrategy

rpc GetBiddingStrategy(GetBiddingStrategyRequest) returns (BiddingStrategy)

Returns the requested bidding strategy in full detail.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

MutateBiddingStrategies

rpc MutateBiddingStrategies(MutateBiddingStrategiesRequest) returns (MutateBiddingStrategiesResponse)

Creates, updates, or removes bidding strategies. Operation statuses are returned.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

BillingSetupService

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.

GetBillingSetup

rpc GetBillingSetup(GetBillingSetupRequest) returns (BillingSetup)

Returns a billing setup.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

MutateBillingSetup

rpc MutateBillingSetup(MutateBillingSetupRequest) returns (MutateBillingSetupResponse)

Creates a billing setup, or cancels an existing billing setup.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

CampaignAudienceViewService

Service to manage campaign audience views.

GetCampaignAudienceView

rpc GetCampaignAudienceView(GetCampaignAudienceViewRequest) returns (CampaignAudienceView)

Returns the requested campaign audience view in full detail.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

CampaignBidModifierService

Service to manage campaign bid modifiers.

GetCampaignBidModifier

rpc GetCampaignBidModifier(GetCampaignBidModifierRequest) returns (CampaignBidModifier)

Returns the requested campaign bid modifier in full detail.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

MutateCampaignBidModifiers

rpc MutateCampaignBidModifiers(MutateCampaignBidModifiersRequest) returns (MutateCampaignBidModifiersResponse)

Creates, updates, or removes campaign bid modifiers. Operation statuses are returned.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

CampaignBudgetService

Service to manage campaign budgets.

GetCampaignBudget

rpc GetCampaignBudget(GetCampaignBudgetRequest) returns (CampaignBudget)

Returns the requested Campaign Budget in full detail.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

MutateCampaignBudgets

rpc MutateCampaignBudgets(MutateCampaignBudgetsRequest) returns (MutateCampaignBudgetsResponse)

Creates, updates, or removes campaign budgets. Operation statuses are returned.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

CampaignCriterionService

Service to manage campaign criteria.

GetCampaignCriterion

rpc GetCampaignCriterion(GetCampaignCriterionRequest) returns (CampaignCriterion)

Returns the requested criterion in full detail.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

MutateCampaignCriteria

rpc MutateCampaignCriteria(MutateCampaignCriteriaRequest) returns (MutateCampaignCriteriaResponse)

Creates, updates, or removes criteria. Operation statuses are returned.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

CampaignCriterionSimulationService

Service to fetch campaign criterion simulations.

GetCampaignCriterionSimulation

rpc GetCampaignCriterionSimulation(GetCampaignCriterionSimulationRequest) returns (CampaignCriterionSimulation)

Returns the requested campaign criterion simulation in full detail.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

CampaignDraftService

Service to manage campaign drafts.

GetCampaignDraft

rpc GetCampaignDraft(GetCampaignDraftRequest) returns (CampaignDraft)

Returns the requested campaign draft in full detail.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

ListCampaignDraftAsyncErrors

rpc ListCampaignDraftAsyncErrors(ListCampaignDraftAsyncErrorsRequest) returns (ListCampaignDraftAsyncErrorsResponse)

Returns all errors that occurred during CampaignDraft promote. Throws an error if called before campaign draft is promoted. Supports standard list paging.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

MutateCampaignDrafts

rpc MutateCampaignDrafts(MutateCampaignDraftsRequest) returns (MutateCampaignDraftsResponse)

Creates, updates, or removes campaign drafts. Operation statuses are returned.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

PromoteCampaignDraft

rpc PromoteCampaignDraft(PromoteCampaignDraftRequest) returns (Operation)

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 to view the list of error reasons.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

CampaignExperimentService

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.

CreateCampaignExperiment

rpc CreateCampaignExperiment(CreateCampaignExperimentRequest) returns (Operation)

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.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

EndCampaignExperiment

rpc EndCampaignExperiment(EndCampaignExperimentRequest) returns (Empty)

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.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

GetCampaignExperiment

rpc GetCampaignExperiment(GetCampaignExperimentRequest) returns (CampaignExperiment)

Returns the requested campaign experiment in full detail.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

GraduateCampaignExperiment

rpc GraduateCampaignExperiment(GraduateCampaignExperimentRequest) returns (GraduateCampaignExperimentResponse)

Graduates a campaign experiment to a full campaign. The base and experiment campaigns will start running independently with their own budgets.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

ListCampaignExperimentAsyncErrors

rpc ListCampaignExperimentAsyncErrors(ListCampaignExperimentAsyncErrorsRequest) returns (ListCampaignExperimentAsyncErrorsResponse)

Returns all errors that occurred during CampaignExperiment create or promote (whichever occurred last). Supports standard list paging.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

MutateCampaignExperiments

rpc MutateCampaignExperiments(MutateCampaignExperimentsRequest) returns (MutateCampaignExperimentsResponse)

Updates campaign experiments. Operation statuses are returned.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

PromoteCampaignExperiment

rpc PromoteCampaignExperiment(PromoteCampaignExperimentRequest) returns (Operation)

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.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

CampaignExtensionSettingService

Service to manage campaign extension settings.

GetCampaignExtensionSetting

rpc GetCampaignExtensionSetting(GetCampaignExtensionSettingRequest) returns (CampaignExtensionSetting)

Returns the requested campaign extension setting in full detail.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

MutateCampaignExtensionSettings

rpc MutateCampaignExtensionSettings(MutateCampaignExtensionSettingsRequest) returns (MutateCampaignExtensionSettingsResponse)

Creates, updates, or removes campaign extension settings. Operation statuses are returned.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

CampaignFeedService

Service to manage campaign feeds.

GetCampaignFeed

rpc GetCampaignFeed(GetCampaignFeedRequest) returns (CampaignFeed)

Returns the requested campaign feed in full detail.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

MutateCampaignFeeds

rpc MutateCampaignFeeds(MutateCampaignFeedsRequest) returns (MutateCampaignFeedsResponse)

Creates, updates, or removes campaign feeds. Operation statuses are returned.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

CampaignLabelService

Service to manage labels on campaigns.

GetCampaignLabel

rpc GetCampaignLabel(GetCampaignLabelRequest) returns (CampaignLabel)

Returns the requested campaign-label relationship in full detail.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

MutateCampaignLabels

rpc MutateCampaignLabels(MutateCampaignLabelsRequest) returns (MutateCampaignLabelsResponse)

Creates and removes campaign-label relationships. Operation statuses are returned.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

CampaignService

Service to manage campaigns.

GetCampaign

rpc GetCampaign(GetCampaignRequest) returns (Campaign)

Returns the requested campaign in full detail.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

MutateCampaigns

rpc MutateCampaigns(MutateCampaignsRequest) returns (MutateCampaignsResponse)

Creates, updates, or removes campaigns. Operation statuses are returned.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

CampaignSharedSetService

Service to manage campaign shared sets.

GetCampaignSharedSet

rpc GetCampaignSharedSet(GetCampaignSharedSetRequest) returns (CampaignSharedSet)

Returns the requested campaign shared set in full detail.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

MutateCampaignSharedSets

rpc MutateCampaignSharedSets(MutateCampaignSharedSetsRequest) returns (MutateCampaignSharedSetsResponse)

Creates or removes campaign shared sets. Operation statuses are returned.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

CarrierConstantService

Service to fetch carrier constants.

GetCarrierConstant

rpc GetCarrierConstant(GetCarrierConstantRequest) returns (CarrierConstant)

Returns the requested carrier constant in full detail.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

ChangeStatusService

Service to fetch change statuses.

GetChangeStatus

rpc GetChangeStatus(GetChangeStatusRequest) returns (ChangeStatus)

Returns the requested change status in full detail.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

ClickViewService

Service to fetch click views.

GetClickView

rpc GetClickView(GetClickViewRequest) returns (ClickView)

Returns the requested click view in full detail.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

ConversionActionService

Service to manage conversion actions.

GetConversionAction

rpc GetConversionAction(GetConversionActionRequest) returns (ConversionAction)

Returns the requested conversion action.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

MutateConversionActions

rpc MutateConversionActions(MutateConversionActionsRequest) returns (MutateConversionActionsResponse)

Creates, updates or removes conversion actions. Operation statuses are returned.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

ConversionAdjustmentUploadService

Service to upload conversion adjustments.

UploadConversionAdjustments

rpc UploadConversionAdjustments(UploadConversionAdjustmentsRequest) returns (UploadConversionAdjustmentsResponse)

Processes the given conversion adjustments.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

ConversionUploadService

Service to upload conversions.

UploadCallConversions

rpc UploadCallConversions(UploadCallConversionsRequest) returns (UploadCallConversionsResponse)

Processes the given call conversions.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

UploadClickConversions

rpc UploadClickConversions(UploadClickConversionsRequest) returns (UploadClickConversionsResponse)

Processes the given click conversions.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

CustomInterestService

Service to manage custom interests.

GetCustomInterest

rpc GetCustomInterest(GetCustomInterestRequest) returns (CustomInterest)

Returns the requested custom interest in full detail.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

MutateCustomInterests

rpc MutateCustomInterests(MutateCustomInterestsRequest) returns (MutateCustomInterestsResponse)

Creates or updates custom interests. Operation statuses are returned.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

CustomerClientLinkService

Service to manage customer client links.

CustomerClientService

Service to get clients in a customer's hierarchy.

GetCustomerClient

rpc GetCustomerClient(GetCustomerClientRequest) returns (CustomerClient)

Returns the requested client in full detail.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

CustomerExtensionSettingService

Service to manage customer extension settings.

GetCustomerExtensionSetting

rpc GetCustomerExtensionSetting(GetCustomerExtensionSettingRequest) returns (CustomerExtensionSetting)

Returns the requested customer extension setting in full detail.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

MutateCustomerExtensionSettings

rpc MutateCustomerExtensionSettings(MutateCustomerExtensionSettingsRequest) returns (MutateCustomerExtensionSettingsResponse)

Creates, updates, or removes customer extension settings. Operation statuses are returned.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

CustomerFeedService

Service to manage customer feeds.

GetCustomerFeed

rpc GetCustomerFeed(GetCustomerFeedRequest) returns (CustomerFeed)

Returns the requested customer feed in full detail.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

MutateCustomerFeeds

rpc MutateCustomerFeeds(MutateCustomerFeedsRequest) returns (MutateCustomerFeedsResponse)

Creates, updates, or removes customer feeds. Operation statuses are returned.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

CustomerLabelService

Service to manage labels on customers.

GetCustomerLabel

rpc GetCustomerLabel(GetCustomerLabelRequest) returns (CustomerLabel)

Returns the requested customer-label relationship in full detail.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

MutateCustomerLabels

rpc MutateCustomerLabels(MutateCustomerLabelsRequest) returns (MutateCustomerLabelsResponse)

Creates and removes customer-label relationships. Operation statuses are returned.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

CustomerManagerLinkService

Service to manage customer-manager links.

CustomerNegativeCriterionService

Service to manage customer negative criteria.

GetCustomerNegativeCriterion

rpc GetCustomerNegativeCriterion(GetCustomerNegativeCriterionRequest) returns (CustomerNegativeCriterion)

Returns the requested criterion in full detail.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

MutateCustomerNegativeCriteria

rpc MutateCustomerNegativeCriteria(MutateCustomerNegativeCriteriaRequest) returns (MutateCustomerNegativeCriteriaResponse)

Creates or removes criteria. Operation statuses are returned.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

CustomerService

Service to manage customers.

CreateCustomerClient

rpc CreateCustomerClient(CreateCustomerClientRequest) returns (CreateCustomerClientResponse)

Creates a new client under manager. The new client customer is returned.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

GetCustomer

rpc GetCustomer(GetCustomerRequest) returns (Customer)

Returns the requested customer in full detail.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

ListAccessibleCustomers

rpc ListAccessibleCustomers(ListAccessibleCustomersRequest) returns (ListAccessibleCustomersResponse)

Returns resource names of customers directly accessible by the user authenticating the call.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

MutateCustomer

rpc MutateCustomer(MutateCustomerRequest) returns (MutateCustomerResponse)

Updates a customer. Operation statuses are returned.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

DetailPlacementViewService

Service to fetch Detail Placement views.

GetDetailPlacementView

rpc GetDetailPlacementView(GetDetailPlacementViewRequest) returns (DetailPlacementView)

Returns the requested Detail Placement view in full detail.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

DisplayKeywordViewService

Service to manage display keyword views.

GetDisplayKeywordView

rpc GetDisplayKeywordView(GetDisplayKeywordViewRequest) returns (DisplayKeywordView)

Returns the requested display keyword view in full detail.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

DomainCategoryService

Service to fetch domain categories.

GetDomainCategory

rpc GetDomainCategory(GetDomainCategoryRequest) returns (DomainCategory)

Returns the requested domain category.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

DynamicSearchAdsSearchTermViewService

Service to fetch dynamic search ads views.

GetDynamicSearchAdsSearchTermView

rpc GetDynamicSearchAdsSearchTermView(GetDynamicSearchAdsSearchTermViewRequest) returns (DynamicSearchAdsSearchTermView)

Returns the requested dynamic search ads search term view in full detail.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

ExpandedLandingPageViewService

Service to fetch expanded landing page views.

GetExpandedLandingPageView

rpc GetExpandedLandingPageView(GetExpandedLandingPageViewRequest) returns (ExpandedLandingPageView)

Returns the requested expanded landing page view in full detail.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

ExtensionFeedItemService

Service to manage extension feed items.

GetExtensionFeedItem

rpc GetExtensionFeedItem(GetExtensionFeedItemRequest) returns (ExtensionFeedItem)

Returns the requested extension feed item in full detail.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

MutateExtensionFeedItems

rpc MutateExtensionFeedItems(MutateExtensionFeedItemsRequest) returns (MutateExtensionFeedItemsResponse)

Creates, updates, or removes extension feed items. Operation statuses are returned.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

FeedItemService

Service to manage feed items.

GetFeedItem

rpc GetFeedItem(GetFeedItemRequest) returns (FeedItem)

Returns the requested feed item in full detail.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

MutateFeedItems

rpc MutateFeedItems(MutateFeedItemsRequest) returns (MutateFeedItemsResponse)

Creates, updates, or removes feed items. Operation statuses are returned.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

FeedItemTargetService

Service to manage feed item targets.

GetFeedItemTarget

rpc GetFeedItemTarget(GetFeedItemTargetRequest) returns (FeedItemTarget)

Returns the requested feed item targets in full detail.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

MutateFeedItemTargets

rpc MutateFeedItemTargets(MutateFeedItemTargetsRequest) returns (MutateFeedItemTargetsResponse)

Creates or removes feed item targets. Operation statuses are returned.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

FeedMappingService

Service to manage feed mappings.

GetFeedMapping

rpc GetFeedMapping(GetFeedMappingRequest) returns (FeedMapping)

Returns the requested feed mapping in full detail.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

MutateFeedMappings

rpc MutateFeedMappings(MutateFeedMappingsRequest) returns (MutateFeedMappingsResponse)

Creates or removes feed mappings. Operation statuses are returned.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

FeedPlaceholderViewService

Service to fetch feed placeholder views.

GetFeedPlaceholderView

rpc GetFeedPlaceholderView(GetFeedPlaceholderViewRequest) returns (FeedPlaceholderView)

Returns the requested feed placeholder view in full detail.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

FeedService

Service to manage feeds.

GetFeed

rpc GetFeed(GetFeedRequest) returns (Feed)

Returns the requested feed in full detail.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

MutateFeeds

rpc MutateFeeds(MutateFeedsRequest) returns (MutateFeedsResponse)

Creates, updates, or removes feeds. Operation statuses are returned.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

GenderViewService

Service to manage gender views.

GetGenderView

rpc GetGenderView(GetGenderViewRequest) returns (GenderView)

Returns the requested gender view in full detail.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

GeoTargetConstantService

Service to fetch geo target constants.

GetGeoTargetConstant

rpc GetGeoTargetConstant(GetGeoTargetConstantRequest) returns (GeoTargetConstant)

Returns the requested geo target constant in full detail.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

SuggestGeoTargetConstants

rpc SuggestGeoTargetConstants(SuggestGeoTargetConstantsRequest) returns (SuggestGeoTargetConstantsResponse)

Returns GeoTargetConstant suggestions by location name or by resource name.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

GeographicViewService

Service to manage geographic views.

GetGeographicView

rpc GetGeographicView(GetGeographicViewRequest) returns (GeographicView)

Returns the requested geographic view in full detail.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

GoogleAdsFieldService

Service to fetch Google Ads API fields.

GetGoogleAdsField

rpc GetGoogleAdsField(GetGoogleAdsFieldRequest) returns (GoogleAdsField)

Returns just the requested field.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

SearchGoogleAdsFields

rpc SearchGoogleAdsFields(SearchGoogleAdsFieldsRequest) returns (SearchGoogleAdsFieldsResponse)

Returns all fields that match the search query.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

GoogleAdsService

Service to fetch data and metrics across resources.

Mutate

rpc Mutate(MutateGoogleAdsRequest) returns (MutateGoogleAdsResponse)

Creates, 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.

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 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.

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.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

Search

rpc Search(SearchGoogleAdsRequest) returns (SearchGoogleAdsResponse)

Returns all rows that match the search query.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

GroupPlacementViewService

Service to fetch Group Placement views.

GetGroupPlacementView

rpc GetGroupPlacementView(GetGroupPlacementViewRequest) returns (GroupPlacementView)

Returns the requested Group Placement view in full detail.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

HotelGroupViewService

Service to manage Hotel Group Views.

GetHotelGroupView

rpc GetHotelGroupView(GetHotelGroupViewRequest) returns (HotelGroupView)

Returns the requested Hotel Group View in full detail.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

HotelPerformanceViewService

Service to manage Hotel Performance Views.

GetHotelPerformanceView

rpc GetHotelPerformanceView(GetHotelPerformanceViewRequest) returns (HotelPerformanceView)

Returns the requested Hotel Performance View in full detail.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

KeywordPlanAdGroupService

Service to manage Keyword Plan ad groups.

GetKeywordPlanAdGroup

rpc GetKeywordPlanAdGroup(GetKeywordPlanAdGroupRequest) returns (KeywordPlanAdGroup)

Returns the requested Keyword Plan ad group in full detail.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

MutateKeywordPlanAdGroups

rpc MutateKeywordPlanAdGroups(MutateKeywordPlanAdGroupsRequest) returns (MutateKeywordPlanAdGroupsResponse)

Creates, updates, or removes Keyword Plan ad groups. Operation statuses are returned.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

KeywordPlanCampaignService

Service to manage Keyword Plan campaigns.

GetKeywordPlanCampaign

rpc GetKeywordPlanCampaign(GetKeywordPlanCampaignRequest) returns (KeywordPlanCampaign)

Returns the requested Keyword Plan campaign in full detail.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

MutateKeywordPlanCampaigns

rpc MutateKeywordPlanCampaigns(MutateKeywordPlanCampaignsRequest) returns (MutateKeywordPlanCampaignsResponse)

Creates, updates, or removes Keyword Plan campaigns. Operation statuses are returned.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

KeywordPlanIdeaService

Service to generate keyword ideas.

GenerateKeywordIdeas

rpc GenerateKeywordIdeas(GenerateKeywordIdeasRequest) returns (GenerateKeywordIdeaResponse)

Returns a list of keyword ideas.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

KeywordPlanKeywordService

Service to manage Keyword Plan ad group keywords.

GetKeywordPlanKeyword

rpc GetKeywordPlanKeyword(GetKeywordPlanKeywordRequest) returns (KeywordPlanKeyword)

Returns the requested Keyword Plan keyword in full detail.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

MutateKeywordPlanKeywords

rpc MutateKeywordPlanKeywords(MutateKeywordPlanKeywordsRequest) returns (MutateKeywordPlanKeywordsResponse)

Creates, updates, or removes Keyword Plan keywords. Operation statuses are returned.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

KeywordPlanNegativeKeywordService

Service to manage Keyword Plan negative keywords.

GetKeywordPlanNegativeKeyword

rpc GetKeywordPlanNegativeKeyword(GetKeywordPlanNegativeKeywordRequest) returns (KeywordPlanNegativeKeyword)

Returns the requested plan in full detail.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

MutateKeywordPlanNegativeKeywords

rpc MutateKeywordPlanNegativeKeywords(MutateKeywordPlanNegativeKeywordsRequest) returns (MutateKeywordPlanNegativeKeywordsResponse)

Creates, updates, or removes Keyword Plan negative keywords. Operation statuses are returned.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

KeywordPlanService

Service to manage keyword plans.

GenerateForecastMetrics

rpc GenerateForecastMetrics(GenerateForecastMetricsRequest) returns (GenerateForecastMetricsResponse)

Returns the requested Keyword Plan forecasts.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

GenerateHistoricalMetrics

rpc GenerateHistoricalMetrics(GenerateHistoricalMetricsRequest) returns (GenerateHistoricalMetricsResponse)

Returns the requested Keyword Plan historical metrics.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

GetKeywordPlan

rpc GetKeywordPlan(GetKeywordPlanRequest) returns (KeywordPlan)

Returns the requested plan in full detail.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

MutateKeywordPlans

rpc MutateKeywordPlans(MutateKeywordPlansRequest) returns (MutateKeywordPlansResponse)

Creates, updates, or removes keyword plans. Operation statuses are returned.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

KeywordViewService

Service to manage keyword views.

GetKeywordView

rpc GetKeywordView(GetKeywordViewRequest) returns (KeywordView)

Returns the requested keyword view in full detail.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

LabelService

Service to manage labels.

GetLabel

rpc GetLabel(GetLabelRequest) returns (Label)

Returns the requested label in full detail.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

MutateLabels

rpc MutateLabels(MutateLabelsRequest) returns (MutateLabelsResponse)

Creates, updates, or removes labels. Operation statuses are returned.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

LandingPageViewService

Service to fetch landing page views.

GetLandingPageView

rpc GetLandingPageView(GetLandingPageViewRequest) returns (LandingPageView)

Returns the requested landing page view in full detail.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

LanguageConstantService

Service to fetch language constants.

GetLanguageConstant

rpc GetLanguageConstant(GetLanguageConstantRequest) returns (LanguageConstant)

Returns the requested language constant.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

LocationViewService

Service to fetch location views.

GetLocationView

rpc GetLocationView(GetLocationViewRequest) returns (LocationView)

Returns the requested location view in full detail.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

ManagedPlacementViewService

Service to manage Managed Placement views.

GetManagedPlacementView

rpc GetManagedPlacementView(GetManagedPlacementViewRequest) returns (ManagedPlacementView)

Returns the requested Managed Placement view in full detail.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

MediaFileService

Service to manage media files.

GetMediaFile

rpc GetMediaFile(GetMediaFileRequest) returns (MediaFile)

Returns the requested media file in full detail.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

MutateMediaFiles

rpc MutateMediaFiles(MutateMediaFilesRequest) returns (MutateMediaFilesResponse)

Creates media files. Operation statuses are returned.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

MerchantCenterLinkService

This service allows management of links between Google Ads and Google Merchant Center.

MobileAppCategoryConstantService

Service to fetch mobile app category constants.

GetMobileAppCategoryConstant

rpc GetMobileAppCategoryConstant(GetMobileAppCategoryConstantRequest) returns (MobileAppCategoryConstant)

Returns the requested mobile app category constant.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

MobileDeviceConstantService

Service to fetch mobile device constants.

GetMobileDeviceConstant

rpc GetMobileDeviceConstant(GetMobileDeviceConstantRequest) returns (MobileDeviceConstant)

Returns the requested mobile device constant in full detail.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

MutateJobService

Service to manage mutate jobs.

AddMutateJobOperations

rpc AddMutateJobOperations(AddMutateJobOperationsRequest) returns (AddMutateJobOperationsResponse)

Add operations to the mutate job.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

CreateMutateJob

rpc CreateMutateJob(CreateMutateJobRequest) returns (CreateMutateJobResponse)

Creates a mutate job.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

GetMutateJob

rpc GetMutateJob(GetMutateJobRequest) returns (MutateJob)

Returns the mutate job.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

ListMutateJobResults

rpc ListMutateJobResults(ListMutateJobResultsRequest) returns (ListMutateJobResultsResponse)

Returns the results of the mutate job. The job must be done. Supports standard list paging.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

RunMutateJob

rpc RunMutateJob(RunMutateJobRequest) returns (Operation)

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.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

OperatingSystemVersionConstantService

Service to fetch Operating System Version constants.

GetOperatingSystemVersionConstant

rpc GetOperatingSystemVersionConstant(GetOperatingSystemVersionConstantRequest) returns (OperatingSystemVersionConstant)

Returns the requested OS version constant in full detail.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

PaidOrganicSearchTermViewService

Service to fetch paid organic search term views.

GetPaidOrganicSearchTermView

rpc GetPaidOrganicSearchTermView(GetPaidOrganicSearchTermViewRequest) returns (PaidOrganicSearchTermView)

Returns the requested paid organic search term view in full detail.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

ParentalStatusViewService

Service to manage parental status views.

GetParentalStatusView

rpc GetParentalStatusView(GetParentalStatusViewRequest) returns (ParentalStatusView)

Returns the requested parental status view in full detail.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

PaymentsAccountService

Service to provide Payments accounts that can be used to set up consolidated billing.

ListPaymentsAccounts

rpc ListPaymentsAccounts(ListPaymentsAccountsRequest) returns (ListPaymentsAccountsResponse)

Returns all Payments accounts associated with all managers between the login customer ID and specified serving customer in the hierarchy, inclusive.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

ProductBiddingCategoryConstantService

Service to fetch Product Bidding Categories.

GetProductBiddingCategoryConstant

rpc GetProductBiddingCategoryConstant(GetProductBiddingCategoryConstantRequest) returns (ProductBiddingCategoryConstant)

Returns the requested Product Bidding Category in full detail.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

ProductGroupViewService

Service to manage product group views.

GetProductGroupView

rpc GetProductGroupView(GetProductGroupViewRequest) returns (ProductGroupView)

Returns the requested product group view in full detail.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

RecommendationService

Service to manage recommendations.

ApplyRecommendation

rpc ApplyRecommendation(ApplyRecommendationRequest) returns (ApplyRecommendationResponse)

Applies given recommendations with corresponding apply parameters.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

DismissRecommendation

rpc DismissRecommendation(DismissRecommendationRequest) returns (DismissRecommendationResponse)

Dismisses given recommendations.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

GetRecommendation

rpc GetRecommendation(GetRecommendationRequest) returns (Recommendation)

Returns the requested recommendation in full detail.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

RemarketingActionService

Service to manage remarketing actions.

GetRemarketingAction

rpc GetRemarketingAction(GetRemarketingActionRequest) returns (RemarketingAction)

Returns the requested remarketing action in full detail.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

MutateRemarketingActions

rpc MutateRemarketingActions(MutateRemarketingActionsRequest) returns (MutateRemarketingActionsResponse)

Creates or updates remarketing actions. Operation statuses are returned.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

SearchTermViewService

Service to manage search term views.

GetSearchTermView

rpc GetSearchTermView(GetSearchTermViewRequest) returns (SearchTermView)

Returns the attributes of the requested search term view.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

SharedCriterionService

Service to manage shared criteria.

GetSharedCriterion

rpc GetSharedCriterion(GetSharedCriterionRequest) returns (SharedCriterion)

Returns the requested shared criterion in full detail.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

MutateSharedCriteria

rpc MutateSharedCriteria(MutateSharedCriteriaRequest) returns (MutateSharedCriteriaResponse)

Creates or removes shared criteria. Operation statuses are returned.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

SharedSetService

Service to manage shared sets.

GetSharedSet

rpc GetSharedSet(GetSharedSetRequest) returns (SharedSet)

Returns the requested shared set in full detail.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

MutateSharedSets

rpc MutateSharedSets(MutateSharedSetsRequest) returns (MutateSharedSetsResponse)

Creates, updates, or removes shared sets. Operation statuses are returned.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

ShoppingPerformanceViewService

Service to fetch Shopping performance views.

GetShoppingPerformanceView

rpc GetShoppingPerformanceView(GetShoppingPerformanceViewRequest) returns (ShoppingPerformanceView)

Returns the requested Shopping performance view in full detail.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

TopicConstantService

Service to fetch topic constants.

GetTopicConstant

rpc GetTopicConstant(GetTopicConstantRequest) returns (TopicConstant)

Returns the requested topic constant in full detail.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

TopicViewService

Service to manage topic views.

GetTopicView

rpc GetTopicView(GetTopicViewRequest) returns (TopicView)

Returns the requested topic view in full detail.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

UserInterestService

Service to fetch Google Ads User Interest.

GetUserInterest

rpc GetUserInterest(GetUserInterestRequest) returns (UserInterest)

Returns the requested user interest in full detail

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

UserListService

Service to manage user lists.

GetUserList

rpc GetUserList(GetUserListRequest) returns (UserList)

Returns the requested user list.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

MutateUserLists

rpc MutateUserLists(MutateUserListsRequest) returns (MutateUserListsResponse)

Creates or updates user lists. Operation statuses are returned.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

VideoService

Service to manage videos.

GetVideo

rpc GetVideo(GetVideoRequest) returns (Video)

Returns the requested video in full detail.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

AccountBudgetProposalOperation

A single operation to propose the creation of a new account-level budget or edit/end/remove an existing one.

Fields
update_mask

FieldMask

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.

Union field operation. The mutate operation. operation can be only one of the following:
create

AccountBudgetProposal

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.

remove

string

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.

AdGroupAdLabelOperation

A single operation (create, remove) on an ad group ad label.

Fields
Union field operation. The mutate operation. operation can be only one of the following:
create

AdGroupAdLabel

Create operation: No resource name is expected for the new ad group ad label.

remove

string

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}

AdGroupAdOperation

A single operation (create, update, remove) on an ad group ad.

Fields
update_mask

FieldMask

FieldMask that determines which resource fields are modified in an update.

policy_validation_parameter

PolicyValidationParameter

Configuration for how policies are validated.

Union field operation. The mutate operation. operation can be only one of the following:
create

AdGroupAd

Create operation: No resource name is expected for the new ad.

update

AdGroupAd

Update operation: The ad is expected to have a valid resource name.

remove

string

Remove operation: A resource name for the removed ad is expected, in this format:

customers/{customer_id}/adGroupAds/{ad_group_id}~{ad_id}

AdGroupBidModifierOperation

A single operation (create, remove, update) on an ad group bid modifier.

Fields
update_mask

FieldMask

FieldMask that determines which resource fields are modified in an update.

Union field operation. The mutate operation. operation can be only one of the following:
create

AdGroupBidModifier

Create operation: No resource name is expected for the new ad group bid modifier.

update

AdGroupBidModifier

Update operation: The ad group bid modifier is expected to have a valid resource name.

remove

string

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}

AdGroupCriterionLabelOperation

A single operation (create, remove) on an ad group criterion label.

Fields
Union field operation. The mutate operation. operation can be only one of the following:
create

AdGroupCriterionLabel

Create operation: No resource name is expected for the new ad group label.

remove

string

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}

AdGroupCriterionOperation

A single operation (create, remove, update) on an ad group criterion.

Fields
update_mask

FieldMask

FieldMask that determines which resource fields are modified in an update.

exempt_policy_violation_keys[]

PolicyViolationKey

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.

Union field operation. The mutate operation. operation can be only one of the following:
create

AdGroupCriterion

Create operation: No resource name is expected for the new criterion.

update

AdGroupCriterion

Update operation: The criterion is expected to have a valid resource name.

remove

string

Remove operation: A resource name for the removed criterion is expected, in this format:

customers/{customer_id}/adGroupCriteria/{ad_group_id}~{criterion_id}

AdGroupExtensionSettingOperation

A single operation (create, update, remove) on an ad group extension setting.

Fields
update_mask

FieldMask

FieldMask that determines which resource fields are modified in an update.

Union field operation. The mutate operation. operation can be only one of the following:
create

AdGroupExtensionSetting

Create operation: No resource name is expected for the new ad group extension setting.

update

AdGroupExtensionSetting

Update operation: The ad group extension setting is expected to have a valid resource name.

remove

string

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}

AdGroupFeedOperation

A single operation (create, update, remove) on an ad group feed.

Fields
update_mask

FieldMask

FieldMask that determines which resource fields are modified in an update.

Union field operation. The mutate operation. operation can be only one of the following:
create

AdGroupFeed

Create operation: No resource name is expected for the new ad group feed.

update

AdGroupFeed

Update operation: The ad group feed is expected to have a valid resource name.

remove

string

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}

AdGroupLabelOperation

A single operation (create, remove) on an ad group label.

Fields
Union field operation. The mutate operation. operation can be only one of the following:
create

AdGroupLabel

Create operation: No resource name is expected for the new ad group label.

remove

string

Remove operation: A resource name for the ad group label being removed, in this format:

customers/{customer_id}/adGroupLabels/{ad_group_id}~{label_id}

AdGroupOperation

A single operation (create, update, remove) on an ad group.

Fields
update_mask

FieldMask

FieldMask that determines which resource fields are modified in an update.

Union field operation. The mutate operation. operation can be only one of the following:
create

AdGroup

Create operation: No resource name is expected for the new ad group.

update

AdGroup

Update operation: The ad group is expected to have a valid resource name.

remove

string

Remove operation: A resource name for the removed ad group is expected, in this format:

customers/{customer_id}/adGroups/{ad_group_id}

AdParameterOperation

A single operation (create, update, remove) on ad parameter.

Fields
update_mask

FieldMask

FieldMask that determines which resource fields are modified in an update.

Union field operation. The mutate operation. operation can be only one of the following:
create

AdParameter

Create operation: No resource name is expected for the new ad parameter.

update

AdParameter

Update operation: The ad parameter is expected to have a valid resource name.

remove

string

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}

AddMutateJobOperationsRequest

Request message for MutateJobService.AddMutateJobOperations

Fields
resource_name

string

The resource name of the MutateJob.

sequence_token

string

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.

mutate_operations[]

MutateOperation

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".

AddMutateJobOperationsResponse

Response message for MutateJobService.AddMutateJobOperations

Fields
total_operations

int64

The total number of operations added so far for this job.

next_sequence_token

string

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.

ApplyRecommendationOperation

Information about the operation to apply a recommendation and any parameters to customize it.

Fields
resource_name

string

The resource name of the recommendation to apply.

Union field apply_parameters. Parameters to use when applying the recommendation. apply_parameters can be only one of the following:
campaign_budget

CampaignBudgetParameters

Optional parameters to use when applying a campaign budget recommendation.

text_ad

TextAdParameters

Optional parameters to use when applying a text ad recommendation.

keyword

KeywordParameters

Optional parameters to use when applying keyword recommendation.

target_cpa_opt_in

TargetCpaOptInParameters

Optional parameters to use when applying target CPA opt-in recommendation.

callout_extension

CalloutExtensionParameters

Parameters to use when applying callout extension recommendation.

call_extension

CallExtensionParameters

Parameters to use when applying call extension recommendation.

move_unused_budget

MoveUnusedBudgetParameters

Parameters to use when applying move unused budget recommendation.

CallExtensionParameters

Parameters to use when applying call extension recommendation.

Fields
call_extensions[]

CallFeedItem

Call extensions to be added. This is a required field.

CalloutExtensionParameters

Parameters to use when applying callout extension recommendation.

Fields
callout_extensions[]

CalloutFeedItem

Callout extensions to be added. This is a required field.

CampaignBudgetParameters

Parameters to use when applying a campaign budget recommendation.

Fields
new_budget_amount_micros

Int64Value

New budget amount to set for target budget resource. This is a required field.

KeywordParameters

Parameters to use when applying keyword recommendation.

Fields
ad_group

StringValue

The ad group resource to add keyword to. This is a required field.

match_type

KeywordMatchType

The match type of the keyword. This is a required field.

cpc_bid_micros

Int64Value

Optional, CPC bid to set for the keyword. If not set, keyword will use bid based on bidding strategy used by target ad group.

MoveUnusedBudgetParameters

Parameters to use when applying move unused budget recommendation.

Fields
budget_micros_to_move

Int64Value

Budget amount to move from excess budget to constrained budget. This is a required field.

SitelinkExtensionParameters

Parameters to use when applying sitelink extension recommendation.

Fields

TargetCpaOptInParameters

Parameters to use when applying Target CPA recommendation.

Fields
target_cpa_micros

Int64Value

Average CPA to use for Target CPA bidding strategy. This is a required field.

new_campaign_budget_amount_micros

Int64Value

Optional, budget amount to set for the campaign.

TextAdParameters

Parameters to use when applying a text ad recommendation.

Fields
ad

Ad

New ad to add to recommended ad group. All necessary fields need to be set in this message. This is a required field.

ApplyRecommendationRequest

Request message for RecommendationService.ApplyRecommendation.

Fields
customer_id

string

The ID of the customer with the recommendation.

operations[]

ApplyRecommendationOperation

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.

partial_failure

bool

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.

ApplyRecommendationResponse

Response message for RecommendationService.ApplyRecommendation.

Fields
results[]

ApplyRecommendationResult

Results of operations to apply recommendations.

partial_failure_error

Status

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.

ApplyRecommendationResult

The result of applying a recommendation.

Fields
resource_name

string

Returned for successful applies.

AssetOperation

A single operation to create an asset. Supported asset types are YoutubeVideoAsset, MediaBundleAsset and ImageAsset. TextAsset should be created with Ad inline.

Fields
create

Asset

Create operation: No resource name is expected for the new asset.

BiddingStrategyOperation

A single operation (create, update, remove) on a bidding strategy.

Fields
update_mask

FieldMask

FieldMask that determines which resource fields are modified in an update.

Union field operation. The mutate operation. operation can be only one of the following:
create

BiddingStrategy

Create operation: No resource name is expected for the new bidding strategy.

update

BiddingStrategy

Update operation: The bidding strategy is expected to have a valid resource name.

remove

string

Remove operation: A resource name for the removed bidding strategy is expected, in this format:

customers/{customer_id}/biddingStrategies/{bidding_strategy_id}

BillingSetupOperation

A single operation on a billing setup, which describes the cancellation of an existing billing setup.

Fields
Union field operation. Only one of these operations can be set. "Update" operations are not supported. operation can be only one of the following:
create

BillingSetup

Creates a billing setup. No resource name is expected for the new billing setup.

remove

string

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}.

CallConversion

A call conversion.

Fields
caller_id

StringValue

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".

call_start_date_time

StringValue

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".

conversion_action

StringValue

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.

conversion_date_time

StringValue

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".

conversion_value

DoubleValue

The value of the conversion for the advertiser.

currency_code

StringValue

Currency associated with the conversion value. This is the ISO 4217 3-character currency code. For example: USD, EUR.

CallConversionResult

Identifying information for a successfully processed CallConversionUpload.

Fields
caller_id

StringValue

The caller id from which this call was placed. Caller id is expected to be in E.164 format with preceding '+' sign.

call_start_date_time

StringValue

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".

conversion_action

StringValue

Resource name of the conversion action associated with this conversion.

conversion_date_time

StringValue

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".

CampaignBidModifierOperation

A single operation (create, remove, update) on a campaign bid modifier.

Fields
update_mask

FieldMask

FieldMask that determines which resource fields are modified in an update.

Union field operation. The mutate operation. operation can be only one of the following:
create

CampaignBidModifier

Create operation: No resource name is expected for the new campaign bid modifier.

update

CampaignBidModifier

Update operation: The campaign bid modifier is expected to have a valid resource name.

remove

string

Remove operation: A resource name for the removed campaign bid modifier is expected, in this format:

customers/{customer_id}/CampaignBidModifiers/{campaign_id}~{criterion_id}

CampaignBudgetOperation

A single operation (create, update, remove) on a campaign budget.

Fields
update_mask

FieldMask

FieldMask that determines which resource fields are modified in an update.

Union field operation. The mutate operation. operation can be only one of the following:
create

CampaignBudget

Create operation: No resource name is expected for the new budget.

update

CampaignBudget

Update operation: The campaign budget is expected to have a valid resource name.

remove

string

Remove operation: A resource name for the removed budget is expected, in this format:

customers/{customer_id}/campaignBudgets/{budget_id}

CampaignCriterionOperation

A single operation (create, update, remove) on a campaign criterion.

Fields
update_mask

FieldMask

FieldMask that determines which resource fields are modified in an update.

Union field operation. The mutate operation. operation can be only one of the following:
create

CampaignCriterion

Create operation: No resource name is expected for the new criterion.

update

CampaignCriterion

Update operation: The criterion is expected to have a valid resource name.

remove

string

Remove operation: A resource name for the removed criterion is expected, in this format:

customers/{customer_id}/campaignCriteria/{campaign_id}~{criterion_id}

CampaignDraftOperation

A single operation (create, update, remove) on a campaign draft.

Fields
update_mask

FieldMask

FieldMask that determines which resource fields are modified in an update.

Union field operation. The mutate operation. operation can be only one of the following:
create

CampaignDraft

Create operation: No resource name is expected for the new campaign draft.

update

CampaignDraft

Update operation: The campaign draft is expected to have a valid resource name.

remove

string

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}

CampaignExperimentOperation

A single update operation on a campaign experiment.

Fields
update_mask

FieldMask

FieldMask that determines which resource fields are modified in an update.

Union field operation. The mutate operation. operation can be only one of the following:
update

CampaignExperiment

Update operation: The campaign experiment is expected to have a valid resource name.

remove

string

Remove operation: The campaign experiment is expected to have a valid resource name, in this format:

customers/{customer_id}/campaignExperiments/{campaign_experiment_id}

CampaignExtensionSettingOperation

A single operation (create, update, remove) on a campaign extension setting.

Fields
update_mask

FieldMask

FieldMask that determines which resource fields are modified in an update.

Union field operation. The mutate operation. operation can be only one of the following:
create

CampaignExtensionSetting

Create operation: No resource name is expected for the new campaign extension setting.

update

CampaignExtensionSetting

Update operation: The campaign extension setting is expected to have a valid resource name.

remove

string

Remove operation: A resource name for the removed campaign extension setting is expected, in this format:

customers/{customer_id}/campaignExtensionSettings/{campaign_id}~{extension_type}

CampaignFeedOperation

A single operation (create, update, remove) on a campaign feed.

Fields
update_mask

FieldMask

FieldMask that determines which resource fields are modified in an update.

Union field operation. The mutate operation. operation can be only one of the following:
create

CampaignFeed

Create operation: No resource name is expected for the new campaign feed.

update

CampaignFeed

Update operation: The campaign feed is expected to have a valid resource name.

remove

string

Remove operation: A resource name for the removed campaign feed is expected, in this format:

customers/{customer_id}/campaignFeeds/{campaign_id}~{feed_id}

CampaignLabelOperation

A single operation (create, remove) on a campaign-label relationship.

Fields
Union field operation. The mutate operation. operation can be only one of the following:
create

CampaignLabel

Create operation: No resource name is expected for the new campaign-label relationship.

remove

string

Remove operation: A resource name for the campaign-label relationship being removed, in this format:

customers/{customer_id}/campaignLabels/{campaign_id}~{label_id}

CampaignOperation

A single operation (create, update, remove) on a campaign.

Fields
update_mask

FieldMask

FieldMask that determines which resource fields are modified in an update.

Union field operation. The mutate operation. operation can be only one of the following:
create

Campaign

Create operation: No resource name is expected for the new campaign.

update

Campaign

Update operation: The campaign is expected to have a valid resource name.

remove

string

Remove operation: A resource name for the removed campaign is expected, in this format:

customers/{customer_id}/campaigns/{campaign_id}

CampaignSharedSetOperation

A single operation (create, remove) on an campaign shared set.

Fields
Union field operation. The mutate operation. operation can be only one of the following:
create

CampaignSharedSet

Create operation: No resource name is expected for the new campaign shared set.

remove

string

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}

ClickConversion

A click conversion.

Fields
gclid

StringValue

The Google click ID (gclid) associated with this conversion.

conversion_action

StringValue

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.

conversion_date_time

StringValue

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”.

conversion_value

DoubleValue

The value of the conversion for the advertiser.

currency_code

StringValue

Currency associated with the conversion value. This is the ISO 4217 3-character currency code. For example: USD, EUR.

order_id

StringValue

The order ID associated with the conversion. An order id can only be used for one conversion per conversion action.

external_attribution_data

ExternalAttributionData

Additional data about externally attributed conversions. This field is required for conversions with an externally attributed conversion action, but should not be set otherwise.

ClickConversionResult

Identifying information for a successfully processed ClickConversion.

Fields
gclid

StringValue

The Google Click ID (gclid) associated with this conversion.

conversion_action

StringValue

Resource name of the conversion action associated with this conversion.

conversion_date_time

StringValue

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”.

ConversionActionOperation

A single operation (create, update, remove) on a conversion action.

Fields
update_mask

FieldMask

FieldMask that determines which resource fields are modified in an update.

Union field operation. The mutate operation. operation can be only one of the following:
create

ConversionAction

Create operation: No resource name is expected for the new conversion action.

update

ConversionAction

Update operation: The conversion action is expected to have a valid resource name.

remove

string

Remove operation: A resource name for the removed conversion action is expected, in this format:

customers/{customer_id}/conversionActions/{conversion_action_id}

ConversionAdjustment

A conversion adjustment.

Fields
conversion_action

StringValue

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.

adjustment_date_time

StringValue

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".

adjustment_type

ConversionAdjustmentType

The adjustment type.

restatement_value

RestatementValue

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.

Union field conversion_identifier. Identifies the conversion to be adjusted. conversion_identifier can be only one of the following:
gclid_date_time_pair

GclidDateTimePair

Uniquely identifies a conversion that was reported without an order ID specified.

order_id

StringValue

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.

ConversionAdjustmentResult

Information identifying a successfully processed ConversionAdjustment.

Fields
conversion_action

StringValue

Resource name of the conversion action associated with this conversion adjustment.

adjustment_date_time

StringValue

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".

adjustment_type

ConversionAdjustmentType

The adjustment type.

Union field conversion_identifier. Identifies the conversion that was adjusted. conversion_identifier can be only one of the following:
gclid_date_time_pair

GclidDateTimePair

Uniquely identifies a conversion that was reported without an order ID specified.

order_id

StringValue

The order ID of the conversion that was adjusted.

CreateCampaignExperimentMetadata

Message used as metadata returned in Long Running Operations for CreateCampaignExperimentRequest

Fields
campaign_experiment

string

Resource name of campaign experiment created.

CreateCampaignExperimentRequest

Request message for CampaignExperimentService.CreateCampaignExperiment.

Fields
customer_id

string

The ID of the customer whose campaign experiment is being created.

campaign_experiment

CampaignExperiment

The campaign experiment to be created.

validate_only

bool

If true, the request is validated but not executed. Only errors are returned, not results.

CreateCustomerClientRequest

Request message for CustomerService.CreateCustomerClient.

Fields
customer_id

string

The ID of the Manager under whom client customer is being created.

customer_client

Customer

The new client customer to create. The resource name on this customer will be ignored.

CreateCustomerClientResponse

Response message for CreateCustomerClient mutate.

Fields
resource_name

string

The resource name of the newly created customer client.

CreateMutateJobRequest

Request message for [MutateJobService.CreateMutateJobRequest][]

Fields
customer_id

string

The ID of the customer for which to create a mutate job.

CreateMutateJobResponse

Response message for [MutateJobService.CreateMutateJobResponse][]

Fields
resource_name

string

The resource name of the MutateJob.

CustomInterestOperation

A single operation (create, update) on a custom interest.

Fields
update_mask

FieldMask

FieldMask that determines which resource fields are modified in an update.

Union field operation. The mutate operation. operation can be only one of the following:
create

CustomInterest

Create operation: No resource name is expected for the new custom interest.

update

CustomInterest

Update operation: The custom interest is expected to have a valid resource name.

CustomerClientLinkOperation

A single operation (create, update) on a CustomerClientLink.

Fields
update_mask

FieldMask

FieldMask that determines which resource fields are modified in an update.

Union field operation. The mutate operation. operation can be only one of the following:
create

CustomerClientLink

Create operation: No resource name is expected for the new link.

update

CustomerClientLink

Update operation: The link is expected to have a valid resource name.

CustomerExtensionSettingOperation

A single operation (create, update, remove) on a customer extension setting.

Fields
update_mask

FieldMask

FieldMask that determines which resource fields are modified in an update.

Union field operation. The mutate operation. operation can be only one of the following:
create

CustomerExtensionSetting

Create operation: No resource name is expected for the new customer extension setting.

update

CustomerExtensionSetting

Update operation: The customer extension setting is expected to have a valid resource name.

remove

string

Remove operation: A resource name for the removed customer extension setting is expected, in this format:

customers/{customer_id}/customerExtensionSettings/{extension_type}

CustomerFeedOperation

A single operation (create, update, remove) on a customer feed.

Fields
update_mask

FieldMask

FieldMask that determines which resource fields are modified in an update.

Union field operation. The mutate operation. operation can be only one of the following:
create

CustomerFeed

Create operation: No resource name is expected for the new customer feed.

update

CustomerFeed

Update operation: The customer feed is expected to have a valid resource name.

remove

string

Remove operation: A resource name for the removed customer feed is expected, in this format:

customers/{customer_id}/customerFeeds/{feed_id}

CustomerLabelOperation

A single operation (create, remove) on a customer-label relationship.

Fields
Union field operation. The mutate operation. operation can be only one of the following:
create

CustomerLabel

Create operation: No resource name is expected for the new customer-label relationship.

remove

string

Remove operation: A resource name for the customer-label relationship being removed, in this format:

customers/{customer_id}/customerLabels/{label_id}

CustomerManagerLinkOperation

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.

Fields
update_mask

FieldMask

FieldMask that determines which resource fields are modified in an update.

update

CustomerManagerLink

Update operation: The link is expected to have a valid resource name.

CustomerNegativeCriterionOperation

A single operation (create or remove) on a customer level negative criterion.

Fields
Union field operation. The mutate operation. operation can be only one of the following:
create

CustomerNegativeCriterion

Create operation: No resource name is expected for the new criterion.

remove

string

Remove operation: A resource name for the removed criterion is expected, in this format:

customers/{customer_id}/customerNegativeCriteria/{criterion_id}

CustomerOperation

A single update on a customer.

Fields
update

Customer

Mutate operation. Only updates are supported for customer.

update_mask

FieldMask

FieldMask that determines which resource fields are modified in an update.

DismissRecommendationRequest

Request message for RecommendationService.DismissRecommendation.

Fields
customer_id

string

The ID of the customer with the recommendation.

operations[]

DismissRecommendationOperation

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.

partial_failure

bool

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.

DismissRecommendationOperation

Operation to dismiss a single recommendation identified by resource_name.

Fields
resource_name

string

The resource name of the recommendation to dismiss.

DismissRecommendationResponse

Response message for RecommendationService.DismissRecommendation.

Fields
results[]

DismissRecommendationResult

Results of operations to dismiss recommendations.

partial_failure_error

Status

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.

DismissRecommendationResult

The result of dismissing a recommendation.

Fields
resource_name

string

Returned for successful dismissals.

EndCampaignExperimentRequest

Request message for CampaignExperimentService.EndCampaignExperiment.

Fields
campaign_experiment

string

The resource name of the campaign experiment to end.

ExtensionFeedItemOperation

A single operation (create, update, remove) on an extension feed item.

Fields
update_mask

FieldMask

FieldMask that determines which resource fields are modified in an update.

Union field operation. The mutate operation. operation can be only one of the following:
create

ExtensionFeedItem

Create operation: No resource name is expected for the new extension feed item.

update

ExtensionFeedItem

Update operation: The extension feed item is expected to have a valid resource name.

remove

string

Remove operation: A resource name for the removed extension feed item is expected, in this format:

customers/{customer_id}/extensionFeedItems/{feed_item_id}

ExternalAttributionData

Contains additional information about externally attributed conversions.

Fields
external_attribution_credit

DoubleValue

Represents the fraction of the conversion that is attributed to the Google Ads click.

external_attribution_model

StringValue

Specifies the attribution model name.

FeedItemOperation

A single operation (create, update, remove) on an feed item.

Fields
update_mask

FieldMask

FieldMask that determines which resource fields are modified in an update.

Union field operation. The mutate operation. operation can be only one of the following:
create

FeedItem

Create operation: No resource name is expected for the new feed item.

update

FeedItem

Update operation: The feed item is expected to have a valid resource name.

remove

string

Remove operation: A resource name for the removed feed item is expected, in this format:

customers/{customer_id}/feedItems/{feed_id}~{feed_item_id}

FeedItemTargetOperation

A single operation (create, remove) on an feed item target.

Fields
Union field operation. The mutate operation. operation can be only one of the following:
create

FeedItemTarget

Create operation: No resource name is expected for the new feed item target.

remove

string

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}

FeedMappingOperation

A single operation (create, remove) on a feed mapping.

Fields
Union field operation. The mutate operation. operation can be only one of the following:
create

FeedMapping

Create operation: No resource name is expected for the new feed mapping.

remove

string

Remove operation: A resource name for the removed feed mapping is expected, in this format:

customers/{customer_id}/feedMappings/{feed_id}~{feed_mapping_id}

FeedOperation

A single operation (create, update, remove) on an feed.

Fields
update_mask

FieldMask

FieldMask that determines which resource fields are modified in an update.

Union field operation. The mutate operation. operation can be only one of the following:
create

Feed

Create operation: No resource name is expected for the new feed.

update

Feed

Update operation: The feed is expected to have a valid resource name.

remove

string

Remove operation: A resource name for the removed feed is expected, in this format:

customers/{customer_id}/feeds/{feed_id}

ForecastMetrics

Forecast metrics.

Fields
impressions

DoubleValue

Impressions

ctr

DoubleValue

Ctr

average_cpc

Int64Value

AVG cpc

clicks

DoubleValue

Clicks

cost_micros

Int64Value

Cost

GclidDateTimePair

Uniquely identifies a conversion that was reported without an order ID specified.

Fields
gclid

StringValue

Google click ID (gclid) associated with the original conversion for this adjustment.

conversion_date_time

StringValue

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".

GenerateForecastMetricsRequest

Request message for KeywordPlanService.GenerateForecastMetrics.

Fields
keyword_plan

string

The resource name of the keyword plan to be forecasted.

GenerateForecastMetricsResponse

Response message for KeywordPlanService.GenerateForecastMetrics.

Fields
campaign_forecasts[]

KeywordPlanCampaignForecast

List of campaign forecasts. One maximum.

ad_group_forecasts[]

KeywordPlanAdGroupForecast

List of ad group forecasts.

keyword_forecasts[]

KeywordPlanKeywordForecast

List of keyword forecasts.

GenerateHistoricalMetricsRequest

Request message for KeywordPlanService.GenerateHistoricalMetrics.

Fields
keyword_plan

string

The resource name of the keyword plan of which historical metrics are requested.

GenerateHistoricalMetricsResponse

Response message for KeywordPlanService.GenerateHistoricalMetrics.

Fields
metrics[]

KeywordPlanKeywordHistoricalMetrics

List of keyword historical metrics.

GenerateKeywordIdeaResponse

Response message for [KeywordIdeaService.GenerateKeywordIdeas][].

Fields
results[]

GenerateKeywordIdeaResult

Results of generating keyword ideas.

GenerateKeywordIdeaResult

The result of generating keyword ideas.

Fields
text

StringValue

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.

keyword_idea_metrics

KeywordPlanHistoricalMetrics

The historical metrics for the keyword

GenerateKeywordIdeasRequest

Request message for [KeywordIdeaService.GenerateKeywordIdeas][].

Fields
customer_id

string

The ID of the customer with the recommendation.

language

StringValue

The resource name of the language to target. Required

geo_target_constants[]

StringValue

The resource names of the location to target. Max 10

keyword_plan_network

KeywordPlanNetwork

Targeting network.

Union field seed. The type of seed to generate keyword ideas. seed can be only one of the following:
keyword_and_url_seed

KeywordAndUrlSeed

A Keyword and a specific Url to generate ideas from e.g. cars, www.example.com/cars.

keyword_seed

KeywordSeed

A Keyword or phrase to generate ideas from, e.g. cars.

url_seed

UrlSeed

A specific url to generate ideas from, e.g. www.example.com/cars.

GeoTargetConstantSuggestion

A geo target constant suggestion.

Fields
locale

StringValue

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.

reach

Int64Value

Approximate user population that will be targeted, rounded to the nearest 100.

search_term

StringValue

If the request searched by location name, this is the location name that matched the geo target.

geo_target_constant

GeoTargetConstant

The GeoTargetConstant result.

geo_target_constant_parents[]

GeoTargetConstant

The list of parents of the geo target constant.

GetAccountBudgetProposalRequest

Request message for AccountBudgetProposalService.GetAccountBudgetProposal.

Fields
resource_name

string

The resource name of the account-level budget proposal to fetch.

GetAccountBudgetRequest

Request message for AccountBudgetService.GetAccountBudget.

Fields
resource_name

string

The resource name of the account-level budget to fetch.

GetAdGroupAdLabelRequest

Request message for AdGroupAdLabelService.GetAdGroupAdLabel.

Fields
resource_name

string

The resource name of the ad group ad label to fetch.

GetAdGroupAdRequest

Request message for AdGroupAdService.GetAdGroupAd.

Fields
resource_name

string

The resource name of the ad to fetch.

GetAdGroupAudienceViewRequest

Request message for [AdGroupAudienceViewService.GetAdGoupAudienceView][].

Fields
resource_name

string

The resource name of the ad group audience view to fetch.

GetAdGroupBidModifierRequest

Request message for AdGroupBidModifierService.GetAdGroupBidModifier.

Fields
resource_name

string

The resource name of the ad group bid modifier to fetch.

GetAdGroupCriterionLabelRequest

Request message for AdGroupCriterionLabelService.GetAdGroupCriterionLabel.

Fields
resource_name

string

The resource name of the ad group criterion label to fetch.

GetAdGroupCriterionRequest

Request message for AdGroupCriterionService.GetAdGroupCriterion.

Fields
resource_name

string

The resource name of the criterion to fetch.

GetAdGroupCriterionSimulationRequest

Request message for AdGroupCriterionSimulationService.GetAdGroupCriterionSimulation.

Fields
resource_name

string

The resource name of the ad group criterion simulation to fetch.

GetAdGroupExtensionSettingRequest

Request message for AdGroupExtensionSettingService.GetAdGroupExtensionSetting.

Fields
resource_name

string

The resource name of the ad group extension setting to fetch.

GetAdGroupFeedRequest

Request message for AdGroupFeedService.GetAdGroupFeed.

Fields
resource_name

string

The resource name of the ad group feed to fetch.

GetAdGroupLabelRequest

Request message for AdGroupLabelService.GetAdGroupLabel.

Fields
resource_name

string

The resource name of the ad group label to fetch.

GetAdGroupRequest

Request message for AdGroupService.GetAdGroup.

Fields
resource_name

string

The resource name of the ad group to fetch.

GetAdGroupSimulationRequest

Request message for AdGroupSimulationService.GetAdGroupSimulation.

Fields
resource_name

string

The resource name of the ad group simulation to fetch.

GetAdParameterRequest

Request message for AdParameterService.GetAdParameter

Fields
resource_name

string

The resource name of the ad parameter to fetch.

GetAdScheduleViewRequest

Request message for AdScheduleViewService.GetAdScheduleView.

Fields
resource_name

string

The resource name of the ad schedule view to fetch.

GetAgeRangeViewRequest

Request message for AgeRangeViewService.GetAgeRangeView.

Fields
resource_name

string

The resource name of the age range view to fetch.

GetAssetRequest

Request message for AssetService.GetAsset

Fields
resource_name

string

The resource name of the asset to fetch.

GetBiddingStrategyRequest

Request message for BiddingStrategyService.GetBiddingStrategy.

Fields
resource_name

string

The resource name of the bidding strategy to fetch.

GetBillingSetupRequest

Request message for BillingSetupService.GetBillingSetup.

Fields
resource_name

string

The resource name of the billing setup to fetch.

GetCampaignAudienceViewRequest

Request message for CampaignAudienceViewService.GetCampaignAudienceView.

Fields
resource_name

string

The resource name of the campaign audience view to fetch.

GetCampaignBidModifierRequest

Request message for CampaignBidModifierService.GetCampaignBidModifier.

Fields
resource_name

string

The resource name of the campaign bid modifier to fetch.

GetCampaignBudgetRequest

Request message for CampaignBudgetService.GetCampaignBudget.

Fields
resource_name

string

The resource name of the campaign budget to fetch.

GetCampaignCriterionRequest

Request message for CampaignCriterionService.GetCampaignCriterion.

Fields
resource_name

string

The resource name of the criterion to fetch.

GetCampaignCriterionSimulationRequest

Request message for CampaignCriterionSimulationService.GetCampaignCriterionSimulation.

Fields
resource_name

string

The resource name of the campaign criterion simulation to fetch.

GetCampaignDraftRequest

Request message for CampaignDraftService.GetCampaignDraft.

Fields
resource_name

string

The resource name of the campaign draft to fetch.

GetCampaignExperimentRequest

Request message for CampaignExperimentService.GetCampaignExperiment.

Fields
resource_name

string

The resource name of the campaign experiment to fetch.

GetCampaignExtensionSettingRequest

Request message for CampaignExtensionSettingService.GetCampaignExtensionSetting.

Fields
resource_name

string

The resource name of the campaign extension setting to fetch.

GetCampaignFeedRequest

Request message for CampaignFeedService.GetCampaignFeed.

Fields
resource_name

string

The resource name of the campaign feed to fetch.

GetCampaignLabelRequest

Request message for CampaignLabelService.GetCampaignLabel.

Fields
resource_name

string

The resource name of the campaign-label relationship to fetch.

GetCampaignRequest

Request message for CampaignService.GetCampaign.

Fields
resource_name

string

The resource name of the campaign to fetch.

GetCampaignSharedSetRequest

Request message for CampaignSharedSetService.GetCampaignSharedSet.

Fields
resource_name

string

The resource name of the campaign shared set to fetch.

GetCarrierConstantRequest

Request message for CarrierConstantService.GetCarrierConstant.

Fields
resource_name

string

Resource name of the carrier constant to fetch.

GetChangeStatusRequest

Request message for 'ChangeStatusService.GetChangeStatus'.

Fields
resource_name

string

The resource name of the change status to fetch.

GetClickViewRequest

Request message for ClickViewService.GetClickView.

Fields
resource_name

string

The resource name of the click view to fetch.

GetConversionActionRequest

Request message for ConversionActionService.GetConversionAction.

Fields
resource_name

string

The resource name of the conversion action to fetch.

GetCustomInterestRequest

Request message for CustomInterestService.GetCustomInterest.

Fields
resource_name

string

The resource name of the custom interest to fetch.

GetCustomerClientLinkRequest

Request message for CustomerClientLinkService.GetCustomerClientLink.

Fields
resource_name

string

The resource name of the customer client link to fetch.

GetCustomerClientRequest

Request message for CustomerClientService.GetCustomerClient.

Fields
resource_name

string

The resource name of the client to fetch.

GetCustomerExtensionSettingRequest

Request message for CustomerExtensionSettingService.GetCustomerExtensionSetting.

Fields
resource_name

string

The resource name of the customer extension setting to fetch.

GetCustomerFeedRequest

Request message for CustomerFeedService.GetCustomerFeed.

Fields
resource_name

string

The resource name of the customer feed to fetch.

GetCustomerLabelRequest

Request message for CustomerLabelService.GetCustomerLabel.

Fields
resource_name

string

The resource name of the customer-label relationship to fetch.

GetCustomerManagerLinkRequest

Request message for CustomerManagerLinkService.GetCustomerManagerLink.

Fields
resource_name

string

The resource name of the CustomerManagerLink to fetch.

GetCustomerNegativeCriterionRequest

Request message for CustomerNegativeCriterionService.GetCustomerNegativeCriterion.

Fields
resource_name

string

The resource name of the criterion to fetch.

GetCustomerRequest

Request message for CustomerService.GetCustomer.

Fields
resource_name

string

The resource name of the customer to fetch.

GetDetailPlacementViewRequest

Request message for DetailPlacementViewService.GetDetailPlacementView.

Fields
resource_name

string

The resource name of the Detail Placement view to fetch.

GetDisplayKeywordViewRequest

Request message for DisplayKeywordViewService.GetDisplayKeywordView.

Fields
resource_name

string

The resource name of the display keyword view to fetch.

GetDomainCategoryRequest

Request message for DomainCategoryService.GetDomainCategory.

Fields
resource_name

string

Resource name of the domain category to fetch.

GetDynamicSearchAdsSearchTermViewRequest

Request message for DynamicSearchAdsSearchTermViewService.GetDynamicSearchAdsSearchTermView.

Fields
resource_name

string

The resource name of the dynamic search ads search term view to fetch.

GetExpandedLandingPageViewRequest

Request message for ExpandedLandingPageViewService.GetExpandedLandingPageView.

Fields
resource_name

string

The resource name of the expanded landing page view to fetch.

GetExtensionFeedItemRequest

Request message for ExtensionFeedItemService.GetExtensionFeedItem.

Fields
resource_name

string

The resource name of the extension feed item to fetch.

GetFeedItemRequest

Request message for FeedItemService.GetFeedItem.

Fields
resource_name

string

The resource name of the feed item to fetch.

GetFeedItemTargetRequest

Request message for FeedItemTargetService.GetFeedItemTarget.

Fields
resource_name

string

The resource name of the feed item targets to fetch.

GetFeedMappingRequest

Request message for FeedMappingService.GetFeedMapping.

Fields
resource_name

string

The resource name of the feed mapping to fetch.

GetFeedPlaceholderViewRequest

Request message for FeedPlaceholderViewService.GetFeedPlaceholderView.

Fields
resource_name

string

The resource name of the feed placeholder view to fetch.

GetFeedRequest

Request message for FeedService.GetFeed.

Fields
resource_name

string

The resource name of the feed to fetch.

GetGenderViewRequest

Request message for GenderViewService.GetGenderView.

Fields
resource_name

string

The resource name of the gender view to fetch.

GetGeoTargetConstantRequest

Request message for GeoTargetConstantService.GetGeoTargetConstant.

Fields
resource_name

string

The resource name of the geo target constant to fetch.

GetGeographicViewRequest

Request message for GeographicViewService.GetGeographicView.

Fields
resource_name

string

The resource name of the geographic view to fetch.

GetGoogleAdsFieldRequest

Request message for GoogleAdsFieldService.GetGoogleAdsField.

Fields
resource_name

string

The resource name of the field to get.

GetGroupPlacementViewRequest

Request message for GroupPlacementViewService.GetGroupPlacementView.

Fields
resource_name

string

The resource name of the Group Placement view to fetch.

GetHotelGroupViewRequest

Request message for HotelGroupViewService.GetHotelGroupView.

Fields
resource_name

string

Resource name of the Hotel Group View to fetch.

GetHotelPerformanceViewRequest

Request message for HotelPerformanceViewService.GetHotelPerformanceView.

Fields
resource_name

string

Resource name of the Hotel Performance View to fetch.

GetKeywordPlanAdGroupRequest

Request message for KeywordPlanAdGroupService.GetKeywordPlanAdGroup.

Fields
resource_name

string

The resource name of the Keyword Plan ad group to fetch.

GetKeywordPlanCampaignRequest

Request message for KeywordPlanCampaignService.GetKeywordPlanCampaign.

Fields
resource_name

string

The resource name of the Keyword Plan campaign to fetch.

GetKeywordPlanKeywordRequest

Request message for KeywordPlanKeywordService.GetKeywordPlanKeyword.

Fields
resource_name

string

The resource name of the ad group keyword to fetch.

GetKeywordPlanNegativeKeywordRequest

Request message for KeywordPlanNegativeKeywordService.GetKeywordPlanNegativeKeyword.

Fields
resource_name

string

The resource name of the plan to fetch.

GetKeywordPlanRequest

Request message for KeywordPlanService.GetKeywordPlan.

Fields
resource_name

string

The resource name of the plan to fetch.

GetKeywordViewRequest

Request message for KeywordViewService.GetKeywordView.

Fields
resource_name

string

The resource name of the keyword view to fetch.

GetLabelRequest

Request message for LabelService.GetLabel.

Fields
resource_name

string

The resource name of the label to fetch.

GetLandingPageViewRequest

Request message for LandingPageViewService.GetLandingPageView.

Fields
resource_name

string

The resource name of the landing page view to fetch.

GetLanguageConstantRequest

Request message for LanguageConstantService.GetLanguageConstant.

Fields
resource_name

string

Resource name of the language constant to fetch.

GetLocationViewRequest

Request message for LocationViewService.GetLocationView.

Fields
resource_name

string

The resource name of the location view to fetch.

GetManagedPlacementViewRequest

Request message for ManagedPlacementViewService.GetManagedPlacementView.

Fields
resource_name

string

The resource name of the Managed Placement View to fetch.

GetMediaFileRequest

Request message for MediaFileService.GetMediaFile

Fields
resource_name

string

The resource name of the media file to fetch.

GetMerchantCenterLinkRequest

Request message for MerchantCenterLinkService.GetMerchantCenterLink.

Fields
resource_name

string

Resource name of the Merchant Center link.

GetMobileAppCategoryConstantRequest

Request message for MobileAppCategoryConstantService.GetMobileAppCategoryConstant.

Fields
resource_name

string

Resource name of the mobile app category constant to fetch.

GetMobileDeviceConstantRequest

Request message for MobileDeviceConstantService.GetMobileDeviceConstant.

Fields
resource_name

string

Resource name of the mobile device to fetch.

GetMutateJobRequest

Request message for MutateJobService.GetMutateJob

Fields
resource_name

string

The resource name of the MutateJob to get.

GetOperatingSystemVersionConstantRequest

Request message for OperatingSystemVersionConstantService.GetOperatingSystemVersionConstant.

Fields
resource_name

string

Resource name of the OS version to fetch.

GetPaidOrganicSearchTermViewRequest

Request message for PaidOrganicSearchTermViewService.GetPaidOrganicSearchTermView.

Fields
resource_name

string

The resource name of the paid organic search term view to fetch.

GetParentalStatusViewRequest

Request message for ParentalStatusViewService.GetParentalStatusView.

Fields
resource_name

string

The resource name of the parental status view to fetch.

GetProductBiddingCategoryConstantRequest

Request message for [ProductBiddingCategoryService.GetProductBiddingCategory][].

Fields
resource_name

string

Resource name of the Product Bidding Category to fetch.

GetProductGroupViewRequest

Request message for ProductGroupViewService.GetProductGroupView.

Fields
resource_name

string

The resource name of the product group view to fetch.

GetRecommendationRequest

Request message for RecommendationService.GetRecommendation.

Fields
resource_name

string

The resource name of the recommendation to fetch.

GetRemarketingActionRequest

Request message for RemarketingActionService.GetRemarketingAction.

Fields
resource_name

string

The resource name of the remarketing action to fetch.

GetSearchTermViewRequest

Request message for SearchTermViewService.GetSearchTermView.

Fields
resource_name

string

The resource name of the search term view to fetch.

GetSharedCriterionRequest

Request message for SharedCriterionService.GetSharedCriterion.

Fields
resource_name

string

The resource name of the shared criterion to fetch.

GetSharedSetRequest

Request message for SharedSetService.GetSharedSet.

Fields
resource_name

string

The resource name of the shared set to fetch.

GetShoppingPerformanceViewRequest

Request message for ShoppingPerformanceViewService.GetShoppingPerformanceView.

Fields
resource_name

string

The resource name of the Shopping performance view to fetch.

GetTopicConstantRequest

Request message for TopicConstantService.GetTopicConstant.

Fields
resource_name

string

Resource name of the Topic to fetch.

GetTopicViewRequest

Request message for TopicViewService.GetTopicView.

Fields
resource_name

string

The resource name of the topic view to fetch.

GetUserInterestRequest

Request message for UserInterestService.GetUserInterest.

Fields
resource_name

string

Resource name of the UserInterest to fetch.

GetUserListRequest

Request message for UserListService.GetUserList.

Fields
resource_name

string

The resource name of the user list to fetch.

GetVideoRequest

Request message for VideoService.GetVideo.

Fields
resource_name

string

The resource name of the video to fetch.

GoogleAdsRow

A returned row from the query.

Fields
account_budget

AccountBudget

The account budget in the query.

account_budget_proposal

AccountBudgetProposal

The account budget proposal referenced in the query.

ad_group

AdGroup

The ad group referenced in the query.

ad_group_ad

AdGroupAd

The ad referenced in the query.

ad_group_ad_label

AdGroupAdLabel

The ad group ad label referenced in the query.

ad_group_audience_view

AdGroupAudienceView

The ad group audience view referenced in the query.

ad_group_bid_modifier

AdGroupBidModifier

The bid modifier referenced in the query.

ad_group_criterion

AdGroupCriterion

The criterion referenced in the query.

ad_group_criterion_label

AdGroupCriterionLabel

The ad group criterion label referenced in the query.

ad_group_criterion_simulation

AdGroupCriterionSimulation

The ad group criterion simulation referenced in the query.

ad_group_extension_setting

AdGroupExtensionSetting

The ad group extension setting referenced in the query.

ad_group_feed

AdGroupFeed

The ad group feed referenced in the query.

ad_group_label

AdGroupLabel

The ad group label referenced in the query.

ad_group_simulation

AdGroupSimulation

The ad group simulation referenced in the query.

ad_parameter

AdParameter

The ad parameter referenced in the query.

age_range_view

AgeRangeView

The age range view referenced in the query.

ad_schedule_view

AdScheduleView

The ad schedule view referenced in the query.

domain_category

DomainCategory

The domain category referenced in the query.

asset

Asset

The asset referenced in the query.

bidding_strategy

BiddingStrategy

The bidding strategy referenced in the query.

billing_setup

BillingSetup

The billing setup referenced in the query.

campaign_budget

CampaignBudget

The campaign budget referenced in the query.

campaign

Campaign

The campaign referenced in the query.

campaign_audience_view

CampaignAudienceView

The campaign audience view referenced in the query.

campaign_bid_modifier

CampaignBidModifier

The campaign bid modifier referenced in the query.

campaign_criterion

CampaignCriterion

The campaign criterion referenced in the query.

campaign_criterion_simulation

CampaignCriterionSimulation

The campaign criterion simulation referenced in the query.

campaign_draft

CampaignDraft

The campaign draft referenced in the query.

campaign_experiment

CampaignExperiment

The campaign experiment referenced in the query.

campaign_extension_setting

CampaignExtensionSetting

The campaign extension setting referenced in the query.

campaign_feed

CampaignFeed

The campaign feed referenced in the query.

campaign_label

CampaignLabel

The campaign label referenced in the query.

campaign_shared_set

CampaignSharedSet

Campaign Shared Set referenced in AWQL query.

carrier_constant

CarrierConstant

The carrier constant referenced in the query.

change_status

ChangeStatus

The ChangeStatus referenced in the query.

conversion_action

ConversionAction

The conversion action referenced in the query.

click_view

ClickView

The ClickView referenced in the query.

custom_interest

CustomInterest

The CustomInterest referenced in the query.

customer

Customer

The customer referenced in the query.

customer_client

CustomerClient

The CustomerClient referenced in the query.

customer_extension_setting

CustomerExtensionSetting

The customer extension setting referenced in the query.

customer_feed

CustomerFeed

The customer feed referenced in the query.

customer_label

CustomerLabel

The customer label referenced in the query.

customer_negative_criterion

CustomerNegativeCriterion

The customer negative criterion referenced in the query.

detail_placement_view

DetailPlacementView

The detail placement view referenced in the query.

display_keyword_view

DisplayKeywordView

The display keyword view referenced in the query.

dynamic_search_ads_search_term_view

DynamicSearchAdsSearchTermView

The dynamic search ads search term view referenced in the query.

expanded_landing_page_view

ExpandedLandingPageView

The expanded landing page view referenced in the query.

extension_feed_item

ExtensionFeedItem

The extension feed item referenced in the query.

feed

Feed

The feed referenced in the query.

feed_item

FeedItem

The feed item referenced in the query.

feed_item_target

FeedItemTarget

The feed item target referenced in the query.

feed_mapping

FeedMapping

The feed mapping referenced in the query.

feed_placeholder_view

FeedPlaceholderView

The feed placeholder view referenced in the query.

gender_view

GenderView

The gender view referenced in the query.

geo_target_constant

GeoTargetConstant

The geo target constant referenced in the query.

geographic_view

GeographicView

The geographic view referenced in the query.

group_placement_view

GroupPlacementView

The group placement view referenced in the query.

hotel_group_view

HotelGroupView

The hotel group view referenced in the query.

hotel_performance_view

HotelPerformanceView

The hotel performance view referenced in the query.

keyword_view

KeywordView

The keyword view referenced in the query.

keyword_plan

KeywordPlan

The keyword plan referenced in the query.

keyword_plan_campaign

KeywordPlanCampaign

The keyword plan campaign referenced in the query.

keyword_plan_negative_keyword

KeywordPlanNegativeKeyword

The keyword plan negative keyword referenced in the query.

keyword_plan_ad_group

KeywordPlanAdGroup

The keyword plan ad group referenced in the query.

keyword_plan_keyword

KeywordPlanKeyword

The keyword plan keyword referenced in the query.

label

Label

The label referenced in the query.

landing_page_view

LandingPageView

The landing page view referenced in the query.

language_constant

LanguageConstant

The language constant referenced in the query.

location_view

LocationView

The location view referenced in the query.

managed_placement_view

ManagedPlacementView

The managed placement view referenced in the query.

media_file

MediaFile

The media file referenced in the query.

mobile_app_category_constant

MobileAppCategoryConstant

The mobile app category constant referenced in the query.

mobile_device_constant

MobileDeviceConstant

The mobile device constant referenced in the query.

mutate_job

MutateJob

The mutate job referenced in the query.

operating_system_version_constant

OperatingSystemVersionConstant

The operating system version constant referenced in the query.

paid_organic_search_term_view

PaidOrganicSearchTermView

The paid organic search term view referenced in the query.

parental_status_view

ParentalStatusView

The parental status view referenced in the query.

product_bidding_category_constant

ProductBiddingCategoryConstant

The Product Bidding Category referenced in the query.

product_group_view

ProductGroupView

The product group view referenced in the query.

recommendation

Recommendation

The recommendation referenced in the query.

search_term_view

SearchTermView

The search term view referenced in the query.

shared_criterion

SharedCriterion

The shared set referenced in the query.

shared_set

SharedSet

The shared set referenced in the query.

shopping_performance_view

ShoppingPerformanceView

The shopping performance view referenced in the query.

topic_view

TopicView

The topic view referenced in the query.

user_interest

UserInterest

The user interest referenced in the query.

user_list

UserList

The user list referenced in the query.

remarketing_action

RemarketingAction

The remarketing action referenced in the query.

topic_constant

TopicConstant

The topic constant referenced in the query.

video

Video

The video referenced in the query.

metrics

Metrics

The metrics.

segments

Segments

The segments.

GraduateCampaignExperimentRequest

Request message for CampaignExperimentService.GraduateCampaignExperiment.

Fields
campaign_experiment

string

The resource name of the campaign experiment to graduate.

campaign_budget

string

Resource name of the budget to attach to the campaign graduated from the experiment.

GraduateCampaignExperimentResponse

Response message for campaign experiment graduate.

Fields
graduated_campaign

string

The resource name of the campaign from the graduated experiment. This campaign is the same one as CampaignExperiment.experiment_campaign.

KeywordAndUrlSeed

Keyword And Url Seed

Fields
url

StringValue

The URL to crawl in order to generate keyword ideas.

keywords[]

StringValue

Requires at least one keyword.

KeywordPlanAdGroupForecast

An ad group forecast.

Fields
keyword_plan_ad_group

StringValue

The resource name of the Keyword Plan ad group related to the forecast.

customers/{customer_id}/keywordPlanAdGroups/{keyword_plan_ad_group_id}

ad_group_forecast

ForecastMetrics

The forecast for the Keyword Plan ad group.

KeywordPlanAdGroupOperation

A single operation (create, update, remove) on a Keyword Plan ad group.

Fields
update_mask

FieldMask

The FieldMask that determines which resource fields are modified in an update.

Union field operation. The mutate operation. operation can be only one of the following:
create

KeywordPlanAdGroup

Create operation: No resource name is expected for the new Keyword Plan ad group.

update

KeywordPlanAdGroup

Update operation: The Keyword Plan ad group is expected to have a valid resource name.

remove

string

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}

KeywordPlanCampaignForecast

A campaign forecast.

Fields
keyword_plan_campaign

StringValue

The resource name of the Keyword Plan campaign related to the forecast.

customers/{customer_id}/keywordPlanCampaigns/{keyword+plan_campaign_id}

campaign_forecast

ForecastMetrics

The forecast for the Keyword Plan campaign.

KeywordPlanCampaignOperation

A single operation (create, update, remove) on a Keyword Plan campaign.

Fields
update_mask

FieldMask

The FieldMask that determines which resource fields are modified in an update.

Union field operation. The mutate operation. operation can be only one of the following:
create

KeywordPlanCampaign

Create operation: No resource name is expected for the new Keyword Plan campaign.

update

KeywordPlanCampaign

Update operation: The Keyword Plan campaign is expected to have a valid resource name.

remove

string

Remove operation: A resource name for the removed Keyword Plan campaign is expected, in this format:

customers/{customer_id}/keywordPlanCampaigns/{keywordPlan_campaign_id}

KeywordPlanKeywordForecast

A keyword forecast.

Fields
keyword_plan_ad_group_keyword

StringValue

The resource name of the Keyword Plan keyword related to the forecast.

customers/{customer_id}/keywordPlanAdGroupKeywords/{keyword_plan_ad_group_keyword_id}

keyword_forecast

ForecastMetrics

The forecast for the Keyword Plan keyword.

KeywordPlanKeywordHistoricalMetrics

A keyword historical metrics.

Fields
search_query

StringValue

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'.

keyword_metrics

KeywordPlanHistoricalMetrics

The historical metrics for the query associated with one or more ad_group_keywords in the plan.

KeywordPlanKeywordOperation

A single operation (create, update, remove) on a Keyword Plan keyword.

Fields
update_mask

FieldMask

The FieldMask that determines which resource fields are modified in an update.

Union field operation. The mutate operation. operation can be only one of the following:
create

KeywordPlanKeyword

Create operation: No resource name is expected for the new Keyword Plan ad group keyword.

update

KeywordPlanKeyword

Update operation: The Keyword Plan keyword is expected to have a valid resource name.

remove

string

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}

KeywordPlanNegativeKeywordOperation

A single operation (create, update, remove) on a Keyword Plan negative keyword.

Fields
update_mask

FieldMask

The FieldMask that determines which resource fields are modified in an update.

Union field operation. The mutate operation. operation can be only one of the following:
create

KeywordPlanNegativeKeyword

Create operation: No resource name is expected for the new Keyword Plan negative keyword.

update

KeywordPlanNegativeKeyword

Update operation: The Keyword Plan negative keyword expected to have a valid resource name.

remove

string

Remove operation: A resource name for the removed Keyword Plan negative keywords expected in this format:

customers/{customer_id}/keywordPlanNegativeKeywords/{kp_negative_keyword_id}

KeywordPlanOperation

A single operation (create, update, remove) on a keyword plan.

Fields
update_mask

FieldMask

The FieldMask that determines which resource fields are modified in an update.

Union field operation. The mutate operation. operation can be only one of the following:
create

KeywordPlan

Create operation: No resource name is expected for the new keyword plan.

update

KeywordPlan

Update operation: The keyword plan is expected to have a valid resource name.

remove

string

Remove operation: A resource name for the removed keyword plan is expected in this format:

customers/{customer_id}/keywordPlans/{keyword_plan_id}

KeywordSeed

Keyword Seed

Fields
keywords[]

StringValue

Requires at least one keyword.

LabelOperation

A single operation (create, remove, update) on a label.

Fields
update_mask

FieldMask

FieldMask that determines which resource fields are modified in an update.

Union field operation. The mutate operation. operation can be only one of the following:
create

Label

Create operation: No resource name is expected for the new label.

update

Label

Update operation: The label is expected to have a valid resource name.

remove

string

Remove operation: A resource name for the label being removed, in this format:

customers/{customer_id}/labels/{label_id}

ListAccessibleCustomersRequest

Request message for CustomerService.ListAccessibleCustomers.

ListAccessibleCustomersResponse

Response message for CustomerService.ListAccessibleCustomers.

Fields
resource_names[]

string

Resource name of customers directly accessible by the user authenticating the call.

ListCampaignDraftAsyncErrorsRequest

Request message for CampaignDraftService.ListCampaignDraftAsyncErrors.

Fields
resource_name

string

The name of the campaign draft from which to retrieve the async errors.

page_token

string

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.

page_size

int32

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.

ListCampaignDraftAsyncErrorsResponse

Response message for CampaignDraftService.ListCampaignDraftAsyncErrors.

Fields
errors[]

Status

Details of the errors when performing the asynchronous operation.

next_page_token

string

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.

ListCampaignExperimentAsyncErrorsRequest

Request message for CampaignExperimentService.ListCampaignExperimentAsyncErrors.

Fields
resource_name

string

The name of the campaign experiment from which to retrieve the async errors.

page_token

string

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.

page_size

int32

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.

ListCampaignExperimentAsyncErrorsResponse

Response message for CampaignExperimentService.ListCampaignExperimentAsyncErrors.

Fields
errors[]

Status

Details of the errors when performing the asynchronous operation.

next_page_token

string

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.

ListMerchantCenterLinksRequest

Request message for MerchantCenterLinkService.ListMerchantCenterLinks.

Fields
customer_id

string

The ID of the customer onto which to apply the Merchant Center link list operation.

ListMerchantCenterLinksResponse

Response message for MerchantCenterLinkService.ListMerchantCenterLinks.

Fields

ListMutateJobResultsRequest

Request message for MutateJobService.ListMutateJobResults.

Fields
resource_name

string

The resource name of the MutateJob whose results are being listed.

page_token

string

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.

page_size

int32

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.

ListMutateJobResultsResponse

Response message for MutateJobService.ListMutateJobResults.

Fields
results[]

MutateJobResult

The list of rows that matched the query.

next_page_token

string

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.

ListPaymentsAccountsRequest

Request message for fetching all accessible Payments accounts.

Fields
customer_id

string

The ID of the customer to apply the PaymentsAccount list operation to.

ListPaymentsAccountsResponse

Response message for PaymentsAccountService.ListPaymentsAccounts.

Fields
payments_accounts[]

PaymentsAccount

The list of accessible Payments accounts.

MediaFileOperation

A single operation to create media file.

Fields
create

MediaFile

Create operation: No resource name is expected for the new media file.

MerchantCenterLinkOperation

A single update on a Merchant Center link.

Fields
update_mask

FieldMask

FieldMask that determines which resource fields are modified in an update.

Union field operation. The operation to perform operation can be only one of the following:
update

MerchantCenterLink

Update operation: The merchant center link is expected to have a valid resource name.

remove

string

Remove operation: A resource name for the removed merchant center link is expected, in this format:

customers/{customer_id}/merchantCenterLinks/{merchant_center_id}

MutateAccountBudgetProposalRequest

Request message for AccountBudgetProposalService.MutateAccountBudgetProposal.

Fields
customer_id

string

The ID of the customer.

operation

AccountBudgetProposalOperation

The operation to perform on an individual account-level budget proposal.

validate_only

bool

If true, the request is validated but not executed. Only errors are returned, not results.

MutateAccountBudgetProposalResponse

Response message for account-level budget mutate operations.

Fields
result

MutateAccountBudgetProposalResult

The result of the mutate.

MutateAccountBudgetProposalResult

The result for the account budget proposal mutate.

Fields
resource_name

string

Returned for successful operations.

MutateAdGroupAdLabelResult

The result for an ad group ad label mutate.

Fields
resource_name

string

Returned for successful operations.

MutateAdGroupAdLabelsRequest

Request message for AdGroupAdLabelService.MutateAdGroupAdLabels.

Fields
customer_id

string

ID of the customer whose ad group ad labels are being modified.

operations[]

AdGroupAdLabelOperation

The list of operations to perform on ad group ad labels.

partial_failure

bool

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.

validate_only

bool

If true, the request is validated but not executed. Only errors are returned, not results.

MutateAdGroupAdLabelsResponse

Response message for an ad group ad labels mutate.

Fields
partial_failure_error

Status

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.

results[]

MutateAdGroupAdLabelResult

All results for the mutate.

MutateAdGroupAdResult

The result for the ad mutate.

Fields
resource_name

string

The resource name returned for successful operations.

MutateAdGroupAdsRequest

Request message for AdGroupAdService.MutateAdGroupAds.

Fields
customer_id

string

The ID of the customer whose ads are being modified.

operations[]

AdGroupAdOperation

The list of operations to perform on individual ads.

partial_failure

bool

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.

validate_only

bool

If true, the request is validated but not executed. Only errors are returned, not results.

MutateAdGroupAdsResponse

Response message for an ad group ad mutate.

Fields
partial_failure_error

Status

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.

results[]

MutateAdGroupAdResult

All results for the mutate.

MutateAdGroupBidModifierResult

The result for the criterion mutate.

Fields
resource_name

string

Returned for successful operations.

MutateAdGroupBidModifiersRequest

Request message for AdGroupBidModifierService.MutateAdGroupBidModifiers.

Fields
customer_id

string

ID of the customer whose ad group bid modifiers are being modified.

operations[]

AdGroupBidModifierOperation

The list of operations to perform on individual ad group bid modifiers.

partial_failure

bool

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.

validate_only

bool

If true, the request is validated but not executed. Only errors are returned, not results.

MutateAdGroupBidModifiersResponse

Response message for ad group bid modifiers mutate.

Fields
partial_failure_error

Status

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.

results[]

MutateAdGroupBidModifierResult

All results for the mutate.

MutateAdGroupCriteriaRequest

Request message for AdGroupCriterionService.MutateAdGroupCriteria.

Fields
customer_id

string

ID of the customer whose criteria are being modified.

operations[]

AdGroupCriterionOperation

The list of operations to perform on individual criteria.

partial_failure

bool

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.

validate_only

bool

If true, the request is validated but not executed. Only errors are returned, not results.

MutateAdGroupCriteriaResponse

Response message for an ad group criterion mutate.

Fields
partial_failure_error

Status

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.

results[]

MutateAdGroupCriterionResult

All results for the mutate.

MutateAdGroupCriterionLabelResult

The result for an ad group criterion label mutate.

Fields
resource_name

string

Returned for successful operations.

MutateAdGroupCriterionLabelsRequest

Request message for AdGroupCriterionLabelService.MutateAdGroupCriterionLabels.

Fields
customer_id

string

ID of the customer whose ad group criterion labels are being modified.

operations[]

AdGroupCriterionLabelOperation

The list of operations to perform on ad group criterion labels.

partial_failure

bool

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.

validate_only

bool

If true, the request is validated but not executed. Only errors are returned, not results.

MutateAdGroupCriterionLabelsResponse

Response message for an ad group criterion labels mutate.

Fields
partial_failure_error

Status

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.

results[]

MutateAdGroupCriterionLabelResult

All results for the mutate.

MutateAdGroupCriterionResult

The result for the criterion mutate.

Fields
resource_name

string

Returned for successful operations.

MutateAdGroupExtensionSettingResult

The result for the ad group extension setting mutate.

Fields
resource_name

string

Returned for successful operations.

MutateAdGroupExtensionSettingsRequest

Request message for AdGroupExtensionSettingService.MutateAdGroupExtensionSettings.

Fields
customer_id

string

The ID of the customer whose ad group extension settings are being modified.

operations[]

AdGroupExtensionSettingOperation

The list of operations to perform on individual ad group extension settings.

partial_failure

bool

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.

validate_only

bool

If true, the request is validated but not executed. Only errors are returned, not results.

MutateAdGroupExtensionSettingsResponse

Response message for an ad group extension setting mutate.

Fields
partial_failure_error

Status

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.

results[]

MutateAdGroupExtensionSettingResult

All results for the mutate.

MutateAdGroupFeedResult

The result for the ad group feed mutate.

Fields
resource_name

string

Returned for successful operations.

MutateAdGroupFeedsRequest

Request message for AdGroupFeedService.MutateAdGroupFeeds.

Fields
customer_id

string

The ID of the customer whose ad group feeds are being modified.

operations[]

AdGroupFeedOperation

The list of operations to perform on individual ad group feeds.

partial_failure

bool

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.

validate_only

bool

If true, the request is validated but not executed. Only errors are returned, not results.

MutateAdGroupFeedsResponse

Response message for an ad group feed mutate.

Fields
partial_failure_error

Status

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.

results[]

MutateAdGroupFeedResult

All results for the mutate.

MutateAdGroupLabelResult

The result for an ad group label mutate.

Fields
resource_name

string

Returned for successful operations.

MutateAdGroupLabelsRequest

Request message for AdGroupLabelService.MutateAdGroupLabels.

Fields
customer_id

string

ID of the customer whose ad group labels are being modified.

operations[]

AdGroupLabelOperation

The list of operations to perform on ad group labels.

partial_failure

bool

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.

validate_only

bool

If true, the request is validated but not executed. Only errors are returned, not results.

MutateAdGroupLabelsResponse

Response message for an ad group labels mutate.

Fields
partial_failure_error

Status

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.

results[]

MutateAdGroupLabelResult

All results for the mutate.

MutateAdGroupResult

The result for the ad group mutate.

Fields
resource_name

string

Returned for successful operations.

MutateAdGroupsRequest

Request message for AdGroupService.MutateAdGroups.

Fields
customer_id

string

The ID of the customer whose ad groups are being modified.

operations[]

AdGroupOperation

The list of operations to perform on individual ad groups.

partial_failure

bool

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.

validate_only

bool

If true, the request is validated but not executed. Only errors are returned, not results.

MutateAdGroupsResponse

Response message for an ad group mutate.

Fields
partial_failure_error

Status

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.

results[]

MutateAdGroupResult

All results for the mutate.

MutateAdParameterResult

The result for the ad parameter mutate.

Fields
resource_name

string

The resource name returned for successful operations.

MutateAdParametersRequest

Request message for AdParameterService.MutateAdParameters

Fields
customer_id

string

The ID of the customer whose ad parameters are being modified.

operations[]

AdParameterOperation

The list of operations to perform on individual ad parameters.

partial_failure

bool

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.

validate_only

bool

If true, the request is validated but not executed. Only errors are returned, not results.

MutateAdParametersResponse

Response message for an ad parameter mutate.

Fields
partial_failure_error

Status

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.

results[]

MutateAdParameterResult

All results for the mutate.

MutateAssetResult

The result for the asset mutate.

Fields
resource_name

string

The resource name returned for successful operations.

MutateAssetsRequest

Request message for AssetService.MutateAssets

Fields
customer_id

string

The ID of the customer whose assets are being modified.

operations[]

AssetOperation

The list of operations to perform on individual assets.

MutateAssetsResponse

Response message for an asset mutate.

Fields
results[]

MutateAssetResult

All results for the mutate.

MutateBiddingStrategiesRequest

Request message for BiddingStrategyService.MutateBiddingStrategies.

Fields