Package google.ads.googleads.v0.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. Please use BudgetOrderService until then: https://developers.google.com/adwords/api/docs/guides/budget-order

Mutates: The CREATE operation creates a new proposal. UPDATE operations aren't supported. The REMOVE operation cancels a pending proposal.

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.

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.

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.

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.

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.

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.

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.

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.

CampaignGroupService

Service to manage campaign groups.

GetCampaignGroup

rpc GetCampaignGroup(GetCampaignGroupRequest) returns (CampaignGroup)

Returns the requested campaign 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.

MutateCampaignGroups

rpc MutateCampaignGroups(MutateCampaignGroupsRequest) returns (MutateCampaignGroupsResponse)

Creates, updates, or removes campaign 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.

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.

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.

CustomerClientLinkService

Service to manage customer client links.

CustomerClientService

Service to manage customer clients in a manager hierarchy.

GetCustomerClient

rpc GetCustomerClient(GetCustomerClientRequest) returns (CustomerClient)

Returns the requested customer 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.

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.

CustomerManagerLinkService

Service to manage customer-manager links.

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.

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.

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.

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.

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.

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

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.

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.

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.

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.

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.

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.

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.

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.

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}

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.

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}

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}

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}

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.

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.

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.

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.

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.

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.

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

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}

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}

CampaignGroupOperation

A single operation (create, update, remove) on a campaign 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

CampaignGroup

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

update

CampaignGroup

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

remove

string

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

customers/{customer_id}/campaignGroups/{campaign_group_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}

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}

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.

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}

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.

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.

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.

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.

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}

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

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.

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.

GetAdGroupCriterionRequest

Request message for AdGroupCriterionService.GetAdGroupCriterion.

Fields
resource_name

string

The resource name of the criterion to fetch.

GetAdGroupFeedRequest

Request message for AdGroupFeedService.GetAdGroupFeed.

Fields
resource_name

string

The resource name of the ad group feed to fetch.

GetAdGroupRequest

Request message for AdGroupService.GetAdGroup.

Fields
resource_name

string

The resource name of the ad group to fetch.

GetAgeRangeViewRequest

Request message for AgeRangeViewService.GetAgeRangeView.

Fields
resource_name

string

The resource name of the age range view 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.

GetCampaignFeedRequest

Request message for CampaignFeedService.GetCampaignFeed.

Fields
resource_name

string

The resource name of the campaign feed to fetch.

GetCampaignGroupRequest

Request message for CampaignGroupService.GetCampaignGroup.

Fields
resource_name

string

The resource name of the campaign group 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.

GetConversionActionRequest

Request message for [ConversionActionService.GetConversionAction].

Fields
resource_name

string

The resource name of the conversion action 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 customer client to fetch.

GetCustomerFeedRequest

Request message for CustomerFeedService.GetCustomerFeed.

Fields
resource_name

string

The resource name of the customer feed to fetch.

GetCustomerManagerLinkRequest

Request message for CustomerManagerLinkService.GetCustomerManagerLink.

Fields
resource_name

string

The resource name of the CustomerManagerLink to fetch.

GetCustomerRequest

Request message for CustomerService.GetCustomer.

Fields
resource_name

string

The resource name of the customer to fetch.

GetDisplayKeywordViewRequest

Request message for DisplayKeywordViewService.GetDisplayKeywordView.

Fields
resource_name

string

The resource name of the display keyword view to fetch.

GetFeedItemRequest

Request message for FeedItemService.GetFeedItem.

Fields
resource_name

string

The resource name of the feed item to fetch.

GetFeedMappingRequest

Request message for FeedMappingService.GetFeedMapping.

Fields
resource_name

string

The resource name of the feed mapping 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.

GetGoogleAdsFieldRequest

Request message for GoogleAdsFieldService.GetGoogleAdsField.

Fields
resource_name

string

The resource name of the field to get.

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.

GetLanguageConstantRequest

Request message for LanguageConstantService.GetLanguageConstant.

Fields
resource_name

string

Resource name of the language constant 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.

GetParentalStatusViewRequest

Request message for ParentalStatusViewService.GetParentalStatusView.

Fields
resource_name

string

The resource name of the parental status view 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.

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.

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_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_feed

AdGroupFeed

The ad group feed referenced in the query.

age_range_view

AgeRangeView

The age range view 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_feed

CampaignFeed

The campaign feed referenced in the query.

campaign_group

CampaignGroup

Campaign Group referenced in AWQL 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.

customer

Customer

The customer referenced in the query.

customer_client

CustomerClient

The CustomerClient referenced in the query.

customer_feed

CustomerFeed

The customer feed referenced in the query.

display_keyword_view

DisplayKeywordView

The display keyword view referenced in the query.

feed

Feed

The feed referenced in the query.

feed_item

FeedItem

The feed item referenced in the query.

feed_mapping

FeedMapping

The feed mapping 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.

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.

language_constant

LanguageConstant

The language constant referenced in the query.

managed_placement_view

ManagedPlacementView

The managed placement view referenced in the query.

parental_status_view

ParentalStatusView

The parental status view 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.

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.

topic_constant

TopicConstant

The topic constant referenced in the query.

video

Video

The video referenced in the query.

metrics

Metrics

The metrics.

ad_network_type

AdNetworkType

Ad network type.

date

StringValue

Date to which metrics apply. yyyy-MM-dd format, e.g., 2018-04-17.

day_of_week

DayOfWeek

Day of the week, e.g., MONDAY.

device

Device

Device to which metrics apply.

hotel_booking_window_days

Int64Value

Hotel booking window in days.

hotel_center_id

Int64Value

Hotel center ID.

hotel_check_in_date

StringValue

Hotel check-in date. Formatted as yyyy-MM-dd.

hotel_check_in_day_of_week

DayOfWeek

Hotel check-in day of week.

hotel_city

StringValue

Hotel city.

hotel_class

Int32Value

Hotel class.

hotel_country

StringValue

Hotel country.

hotel_date_selection_type

HotelDateSelectionType

Hotel date selection type.

hotel_length_of_stay

Int32Value

Hotel length of stay.

hotel_state

StringValue

Hotel state.

hour

Int32Value

Hour of day as a number between 0 and 23, inclusive.

month

StringValue

Month as represented by the date of the first day of a month. Formatted as yyyy-MM-dd.

month_of_year

MonthOfYear

Month of the year, e.g., January.

partner_hotel_id

StringValue

Partner hotel ID.

placeholder_type

PlaceholderType

Placeholder type. This is only used with feed item metrics.

quarter

StringValue

Quarter as represented by the date of the first day of a quarter. Uses the calendar year for quarters, e.g., the second quarter of 2018 starts on 2018-04-01. Formatted as yyyy-MM-dd.

search_term_match_type

SearchTermMatchType

Match type of the keyword that triggered the ad, including variants.

slot

Slot

Position of the ad.

week

StringValue

Week as defined as Monday through Sunday, and represented by the date of Monday. Formatted as yyyy-MM-dd.

year

Int32Value

Year, formatted as yyyy.

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.

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.

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.

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.

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.

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.

MutateAdGroupAdsResponse

Response message for an ad group ad mutate.

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

MutateAdGroupBidModifiersResponse

Response message for ad group bid modifiers mutate.

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

MutateAdGroupCriteriaResponse

Response message for an ad group criterion mutate.

Fields
results[]

MutateAdGroupCriterionResult

All results for the mutate.

MutateAdGroupCriterionResult

The result for the criterion mutate.

Fields
resource_name

string

Returned for successful operations.

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.

MutateAdGroupFeedsResponse

Response message for an ad group feed mutate.

Fields
results[]

MutateAdGroupFeedResult

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.

MutateAdGroupsResponse

Response message for an ad group mutate.

Fields
results[]

MutateAdGroupResult

All results for the mutate.

MutateBiddingStrategiesRequest

Request message for BiddingStrategyService.MutateBiddingStrategies.

Fields
customer_id

string

The ID of the customer whose bidding strategies are being modified.

operations[]

BiddingStrategyOperation

The list of operations to perform on individual bidding strategies.

MutateBiddingStrategiesResponse

Response message for bidding strategy mutate.

Fields
results[]

MutateBiddingStrategyResult

All results for the mutate.

MutateBiddingStrategyResult

The result for the bidding strategy mutate.

Fields
resource_name

string

Returned for successful operations.

MutateBillingSetupRequest

Request message for billing setup mutate operations.

Fields
customer_id

string

Id of the customer to apply the billing setup mutate operation to.

operation

BillingSetupOperation

The operation to perform.

MutateBillingSetupResponse

Response message for a billing setup operation.

Fields
result

MutateBillingSetupResult

A result that identifies the resource affected by the mutate request.

MutateBillingSetupResult

Result for a single billing setup mutate.

Fields
resource_name

string

Returned for successful operations.

MutateCampaignBidModifierResult

The result for the criterion mutate.

Fields
resource_name

string

Returned for successful operations.

MutateCampaignBidModifiersRequest

Request message for [CampaignBidModifierService.MutateCampaignBidModifier][].

Fields
customer_id

string

ID of the customer whose campaign bid modifiers are being modified.

operations[]

CampaignBidModifierOperation

The list of operations to perform on individual campaign bid modifiers.

MutateCampaignBidModifiersResponse

Response message for campaign bid modifiers mutate.

Fields
results[]

MutateCampaignBidModifierResult

All results for the mutate.

MutateCampaignBudgetResult

The result for the campaign budget mutate.

Fields
resource_name

string

Returned for successful operations.

MutateCampaignBudgetsRequest

Request message for CampaignBudgetService.MutateCampaignBudgets.

Fields
customer_id

string

The ID of the customer whose campaign budgets are being modified.

operations[]

CampaignBudgetOperation

The list of operations to perform on individual campaign budgets.

MutateCampaignBudgetsResponse

Response message for campaign budget mutate.

Fields
results[]

MutateCampaignBudgetResult

All results for the mutate.

MutateCampaignCriteriaRequest

Request message for CampaignCriterionService.MutateCampaignCriteria.

Fields
customer_id

string

The ID of the customer whose criteria are being modified.

operations[]

CampaignCriterionOperation

The list of operations to perform on individual criteria.

MutateCampaignCriteriaResponse

Response message for campaign criterion mutate.

Fields
results[]

MutateCampaignCriterionResult

All results for the mutate.

MutateCampaignCriterionResult

The result for the criterion mutate.

Fields
resource_name

string

Returned for successful operations.

MutateCampaignFeedResult

The result for the campaign feed mutate.

Fields
resource_name

string

Returned for successful operations.

MutateCampaignFeedsRequest

Request message for CampaignFeedService.MutateCampaignFeeds.

Fields
customer_id

string

The ID of the customer whose campaign feeds are being modified.

operations[]

CampaignFeedOperation

The list of operations to perform on individual campaign feeds.

MutateCampaignFeedsResponse

Response message for a campaign feed mutate.

Fields
results[]

MutateCampaignFeedResult

All results for the mutate.

MutateCampaignGroupResult

The result for the campaign group mutate.

Fields
resource_name

string

Returned for successful operations.

MutateCampaignGroupsRequest

Request message for CampaignGroupService.MutateCampaignGroups.

Fields
customer_id

string

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

operations[]

CampaignGroupOperation

The list of operations to perform on individual campaign groups.

MutateCampaignGroupsResponse

Response message for campaign group mutate.

Fields
results[]

MutateCampaignGroupResult

All results for the mutate.

MutateCampaignResult

The result for the campaign mutate.

Fields
resource_name

string

Returned for successful operations.

MutateCampaignSharedSetResult

The result for the campaign shared set mutate.

Fields
resource_name

string

Returned for successful operations.

MutateCampaignSharedSetsRequest

Request message for CampaignSharedSetService.MutateCampaignSharedSets.

Fields
customer_id

string

The ID of the customer whose campaign shared sets are being modified.

operations[]

CampaignSharedSetOperation

The list of operations to perform on individual campaign shared sets.

MutateCampaignSharedSetsResponse

Response message for a campaign shared set mutate.

Fields
results[]

MutateCampaignSharedSetResult

All results for the mutate.

MutateCampaignsRequest

Request message for CampaignService.MutateCampaigns.

Fields
customer_id

string

The ID of the customer whose campaigns are being modified.

operations[]

CampaignOperation

The list of operations to perform on individual campaigns.

MutateCampaignsResponse

Response message for campaign mutate.

Fields
results[]

MutateCampaignResult

All results for the mutate.

MutateConversionActionResult

The result for the conversion action mutate.

Fields
resource_name

string

Returned for successful operations.

MutateConversionActionsRequest

Request message for [ConversionActionService.MutateConversionActions].

Fields
customer_id

string

The ID of the customer whose conversion actions are being modified.

operations[]

ConversionActionOperation

The list of operations to perform on individual conversion actions.

MutateConversionActionsResponse

Response message for conversion action mutate.

Fields
results[]

MutateConversionActionResult

All results for the mutate.

MutateCustomerFeedResult

The result for the customer feed mutate.

Fields
resource_name

string

Returned for successful operations.

MutateCustomerFeedsRequest

Request message for CustomerFeedService.MutateCustomerFeeds.

Fields
customer_id

string

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

operations[]

CustomerFeedOperation

The list of operations to perform on individual customer feeds.

MutateCustomerFeedsResponse

Response message for a customer feed mutate.

Fields
results[]

MutateCustomerFeedResult

All results for the mutate.

MutateCustomerRequest

Request message for CustomerService.MutateCustomer.

Fields
customer_id

string

The ID of the customer being modified.

operation

CustomerOperation

The operation to perform on the customer

MutateCustomerResponse

Response message for customer mutate.

Fields
result

MutateCustomerResult

Result for the mutate.

MutateCustomerResult

The result for the customer mutate.

Fields
resource_name

string

Returned for successful operations.

MutateFeedItemResult

The result for the feed item mutate.

Fields
resource_name

string

Returned for successful operations.

MutateFeedItemsRequest

Request message for FeedItemService.MutateFeedItems.

Fields
customer_id

string

The ID of the customer whose feed items are being modified.

operations[]

FeedItemOperation

The list of operations to perform on individual feed items.

MutateFeedItemsResponse

Response message for an feed item mutate.

Fields
results[]

MutateFeedItemResult

All results for the mutate.

MutateFeedMappingResult

The result for the feed mapping mutate.

Fields
resource_name

string

Returned for successful operations.

MutateFeedMappingsRequest

Request message for FeedMappingService.MutateFeedMappings.

Fields
customer_id

string

The ID of the customer whose feed mappings are being modified.

operations[]

FeedMappingOperation

The list of operations to perform on individual feed mappings.

MutateFeedMappingsResponse

Response message for a feed mapping mutate.

Fields
results[]

MutateFeedMappingResult

All results for the mutate.

MutateFeedResult

The result for the feed mutate.

Fields
resource_name

string

Returned for successful operations.

MutateFeedsRequest

Request message for FeedService.MutateFeeds.

Fields
customer_id

string

The ID of the customer whose feeds are being modified.

operations[]

FeedOperation

The list of operations to perform on individual feeds.

MutateFeedsResponse

Response message for an feed mutate.

Fields
results[]

MutateFeedResult

All results for the mutate.

MutateGoogleAdsRequest

Request message for GoogleAdsService.Mutate.

Fields
customer_id

string

The ID of the customer whose resources are being modified.

mutate_operations[]

MutateOperation

The list of operations to perform on individual resources.

MutateGoogleAdsResponse

Response message for GoogleAdsService.Mutate.

Fields
mutate_operation_responses[]

MutateOperationResponse

All responses for the mutate.

MutateKeywordPlanAdGroupResult

The result for the Keyword Plan ad group mutate.

Fields
resource_name

string

Returned for successful operations.

MutateKeywordPlanAdGroupsRequest

Request message for KeywordPlanAdGroupService.MutateKeywordPlanAdGroups.

Fields
customer_id

string

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

operations[]

KeywordPlanAdGroupOperation

The list of operations to perform on individual Keyword Plan ad groups.

MutateKeywordPlanAdGroupsResponse

Response message for a Keyword Plan ad group mutate.

Fields
results[]

MutateKeywordPlanAdGroupResult

All results for the mutate.

MutateKeywordPlanCampaignResult

The result for the Keyword Plan campaign mutate.

Fields
resource_name

string

Returned for successful operations.

MutateKeywordPlanCampaignsRequest

Request message for KeywordPlanCampaignService.MutateKeywordPlanCampaigns.

Fields
customer_id

string

The ID of the customer whose Keyword Plan campaigns are being modified.

operations[]

KeywordPlanCampaignOperation

The list of operations to perform on individual Keyword Plan campaigns.

MutateKeywordPlanCampaignsResponse

Response message for a Keyword Plan campaign mutate.

Fields
results[]

MutateKeywordPlanCampaignResult

All results for the mutate.

MutateKeywordPlanKeywordResult

The result for the Keyword Plan keyword mutate.

Fields
resource_name

string

Returned for successful operations.

MutateKeywordPlanKeywordsRequest

Request message for KeywordPlanKeywordService.MutateKeywordPlanKeywords.

Fields
customer_id

string

The ID of the customer whose Keyword Plan keywords are being modified.

operations[]

KeywordPlanKeywordOperation

The list of operations to perform on individual Keyword Plan keywords.

MutateKeywordPlanKeywordsResponse

Response message for a Keyword Plan keyword mutate.

Fields
results[]

MutateKeywordPlanKeywordResult

All results for the mutate.

MutateKeywordPlanNegativeKeywordResult

The result for the Keyword Plan negative keyword mutate.

Fields
resource_name

string

Returned for successful operations.

MutateKeywordPlanNegativeKeywordsRequest

Request message for KeywordPlanNegativeKeywordService.MutateKeywordPlanNegativeKeywords.

Fields
customer_id

string

The ID of the customer whose negative keywords are being modified.

operations[]

KeywordPlanNegativeKeywordOperation

The list of operations to perform on individual Keyword Plan negative keywords.

MutateKeywordPlanNegativeKeywordsResponse

Response message for a Keyword Plan negative keyword mutate.

Fields
results[]

MutateKeywordPlanNegativeKeywordResult

All results for the mutate.

MutateKeywordPlansRequest

Request message for KeywordPlanService.MutateKeywordPlans.

Fields
customer_id

string

The ID of the customer whose keyword plans are being modified.

operations[]

KeywordPlanOperation

The list of operations to perform on individual keyword plans.

MutateKeywordPlansResponse

Response message for a keyword plan mutate.

Fields
results[]

MutateKeywordPlansResult

All results for the mutate.

MutateKeywordPlansResult

The result for the keyword plan mutate.

Fields
resource_name

string

Returned for successful operations.

MutateMediaFileResult

The result for the media file mutate.

Fields
resource_name

string

The resource name returned for successful operations.

MutateMediaFilesRequest

Request message for MediaFileService.MutateMediaFiles

Fields
customer_id

string

The ID of the customer whose media files are being modified.

operations[]

MediaFileOperation

The list of operations to perform on individual media file.

MutateMediaFilesResponse

Response message for a media file mutate.

Fields
results[]

MutateMediaFileResult

All results for the mutate.

MutateOperation

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

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

AdGroupAdOperation

An ad group ad mutate operation.

ad_group_bid_modifier_operation

AdGroupBidModifierOperation

An ad group bid modifier mutate operation.

ad_group_criterion_operation

AdGroupCriterionOperation

An ad group criterion mutate operation.

ad_group_operation

AdGroupOperation

An ad group mutate operation.

bidding_strategy_operation

BiddingStrategyOperation

A bidding strategy mutate operation.

campaign_bid_modifier_operation

CampaignBidModifierOperation

A campaign bid modifier mutate operation.

campaign_budget_operation

CampaignBudgetOperation

A campaign budget mutate operation.

campaign_group_operation

CampaignGroupOperation

A campaign group mutate operation.

campaign_operation

CampaignOperation

A campaign mutate operation.

campaign_shared_set_operation

CampaignSharedSetOperation

A campaign shared set mutate operation.

conversion_action_operation

ConversionActionOperation

A conversion action mutate operation.

campaign_criterion_operation

CampaignCriterionOperation

A campaign criterion mutate operation.

shared_criterion_operation

SharedCriterionOperation

A shared criterion mutate operation.

shared_set_operation

SharedSetOperation

A shared set mutate operation.

user_list_operation

UserListOperation

A user list mutate operation.

MutateOperationResponse

Response message for the resource mutate.

Fields
Union field response. The mutate response response can be only one of the following:
ad_group_ad_result

MutateAdGroupAdResult

The result for the ad group ad mutate.

ad_group_bid_modifier_result

MutateAdGroupBidModifierResult

The result for the ad group bid modifier mutate.

ad_group_criterion_result

MutateAdGroupCriterionResult

The result for the ad group criterion mutate.

ad_group_result

MutateAdGroupResult

The result for the ad group mutate.

bidding_strategy_result

MutateBiddingStrategyResult

The result for the bidding strategy mutate.

campaign_bid_modifier_result

MutateCampaignBidModifierResult

The result for the campaign bid modifier mutate.

campaign_budget_result

MutateCampaignBudgetResult

The result for the campaign budget mutate.

campaign_group_result

MutateCampaignGroupResult

The result for the campaign group mutate.

campaign_result

MutateCampaignResult

The result for the campaign mutate.

campaign_shared_set_result

MutateCampaignSharedSetResult

The result for the campaign shared set mutate.

conversion_action_result

MutateConversionActionResult

The result for the conversion action mutate.

campaign_criterion_result

MutateCampaignCriterionResult

The result for the campaign criterion mutate.

shared_criterion_result

MutateSharedCriterionResult

The result for the shared criterion mutate.

shared_set_result

MutateSharedSetResult

The result for the shared set mutate.

user_list_result

MutateUserListResult

The result for the user list mutate.

MutateSharedCriteriaRequest

Request message for SharedCriterionService.MutateSharedCriteria.

Fields
customer_id

string

The ID of the customer whose shared criteria are being modified.

operations[]

SharedCriterionOperation

The list of operations to perform on individual shared criteria.

MutateSharedCriteriaResponse

Response message for a shared criterion mutate.

Fields
results[]

MutateSharedCriterionResult

All results for the mutate.

MutateSharedCriterionResult

The result for the shared criterion mutate.

Fields
resource_name

string

Returned for successful operations.

MutateSharedSetResult

The result for the shared set mutate.

Fields
resource_name

string

Returned for successful operations.

MutateSharedSetsRequest

Request message for SharedSetService.MutateSharedSets.

Fields
customer_id

string

The ID of the customer whose shared sets are being modified.

operations[]

SharedSetOperation

The list of operations to perform on individual shared sets.

MutateSharedSetsResponse

Response message for a shared set mutate.

Fields
results[]

MutateSharedSetResult

All results for the mutate.

MutateUserListResult

The result for the user list mutate.

Fields
resource_name

string

Returned for successful operations.

MutateUserListsRequest

Request message for UserListService.MutateUserLists.

Fields
customer_id

string

The ID of the customer whose user lists are being modified.

operations[]

UserListOperation

The list of operations to perform on individual user lists.

MutateUserListsResponse

Response message for user list mutate.

Fields
results[]

MutateUserListResult

All results for the mutate.

SearchGoogleAdsFieldsRequest

Request message for GoogleAdsFieldService.SearchGoogleAdsFields.

Fields
query

string

The query string.

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 too large a page is requested, the server may decide to further limit the number of returned resources.

SearchGoogleAdsFieldsResponse

Response message for GoogleAdsFieldService.SearchGoogleAdsFields.

Fields
results[]

GoogleAdsField

The list of fields 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.

total_results_count

int64

Total number of results that match the query ignoring the LIMIT clause.

SearchGoogleAdsRequest

Request message for GoogleAdsService.Search.

Fields
customer_id

string

The ID of the customer being queried.

query

string

The query string.

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 too large a page is requested, the server may decide to further limit the number of returned resources.

SearchGoogleAdsResponse

Response message for GoogleAdsService.Search.

Fields
results[]

GoogleAdsRow

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.

total_results_count

int64

Total number of results that match the query ignoring the LIMIT clause.

field_mask

FieldMask

FieldMask that represents what fields were requested by the user.

SharedCriterionOperation

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

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

SharedCriterion

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

remove

string

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

customers/{customer_id}/sharedCriteria/{shared_set_id}_{criterion_id}

SharedSetOperation

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

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

SharedSet

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

update

SharedSet

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

remove

string

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

customers/{customer_id}/sharedSets/{shared_set_id}

SuggestGeoTargetConstantsRequest

Request message for [GeoTargetConstantService.SuggestGeoTargetConstantsRequest][].

Fields
locale

StringValue

If possible, returned geo targets are translated using this locale. If not, en is used by default. This is also used as a hint for returned geo targets.

country_code

StringValue

Returned geo targets are restricted to this country code.

Union field query. Required. A selector of geo target constants. query can be only one of the following:
location_names

LocationNames

The location names to search by. At most 25 names can be set.

geo_targets

GeoTargets

The geo target constant resource names to filter by.

GeoTargets

A list of geo target constant resource names.

Fields
geo_target_constants[]

StringValue

A list of geo target constant resource names.

LocationNames

A list of location names.

Fields
names[]

StringValue

A list of location names.

SuggestGeoTargetConstantsResponse

Response message for GeoTargetConstantService.SuggestGeoTargetConstants

Fields
geo_target_constant_suggestions[]

GeoTargetConstantSuggestion

Geo target constant suggestions.

UrlSeed

Url Seed

Fields
url

StringValue

The URL to crawl in order to generate keyword ideas.

UserListOperation

A single operation (create, update) on a user list.

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

UserList

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

update

UserList

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

remove

string

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

customers/{customer_id}/userLists/{user_list_id}

Send feedback about...

Google Ads API Beta
Google Ads API Beta
Need help? Visit our support page.