Package google.ads.googleads.v0.services

Index

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

CustomerService

Service to manage customers.

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

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

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

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

GoogleAdsService

Service to fetch data and metrics across resources.

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

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

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

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

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.

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}

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.

operations[]

ApplyRecommendationOperation

The list of operations to apply recommendations.

ApplyRecommendationResponse

Response message for RecommendationService.ApplyRecommendation.

Fields
results[]

ApplyRecommendationResult

Results of operations to apply recommendations.

ApplyRecommendationResult

The result of applying a recommendation.

Fields
Union field result. One of the successfully applied recommendation resource name or error information will be set. result can be only one of the following:
resource_name

string

Returned for successful applies.

status

Status

Returned for failed operations.

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}

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}

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}

GetAdGroupAdRequest

Request message for AdGroupAdService.GetAdGroupAd.

Fields
resource_name

string

The resource name of the ad to fetch.

GetAdGroupBidModifierRequest

Request message for AdGroupCriterionService.GetAdGroupCriterion.

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.

GetAdGroupRequest

Request message for AdGroupService.GetAdGroup.

Fields
resource_name

string

The resource name of the ad group to fetch.

GetBiddingStrategyRequest

Request message for BiddingStrategyService.GetBiddingStrategy.

Fields
resource_name

string

The resource name of the bidding strategy 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.

GetCampaignRequest

Request message for CampaignService.GetCampaign.

Fields
resource_name

string

The resource name of the campaign to fetch.

GetCustomerRequest

Request message for CustomerService.GetCustomer.

Fields
resource_name

string

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

GetKeywordViewRequest

Request message for KeywordViewService.GetKeywordView.

Fields
resource_name

string

The resource name of the keyword view to fetch.

GetRecommendationRequest

Request message for RecommendationService.GetRecommendation.

Fields
resource_name

string

The resource name of the recommendation to fetch.

GoogleAdsRow

A returned row from the query.

Fields
ad_group

AdGroup

The ad group referenced in the query.

ad_group_ad

AdGroupAd

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

bidding_strategy

BiddingStrategy

The bidding strategy referenced in the query.

campaign_budget

CampaignBudget

The campaign budget referenced in the query.

campaign

Campaign

The campaign referenced in the query.

campaign_criterion

CampaignCriterion

The campaign criterion referenced in the query.

customer

Customer

The customer referenced in the query.

geo_target_constant

GeoTargetConstant

The geo target constant referenced in the query.

keyword_view

KeywordView

The keyword view referenced in the query.

recommendation

Recommendation

The recommendation 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

Platform to which metrics apply.

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.

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.

slot

Slot

Position of the ad.

week

StringValue

Week as defined as Monday through Sunday, and represented by the date of Monday.

year

Int32Value

Year, formatted as yyyy.

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

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.

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.

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.

MutateCampaignResult

The result for the campaign mutate.

Fields
resource_name

string

Returned for successful operations.

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.

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.

Send feedback about...

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