package google.ads.googleads.v2.resources
Get desktop application:
View/edit binary Protocol Buffers messages
message
account_budget.proto:54An account-level budget. It contains information about the budget itself, as well as the most recently approved changes to the budget and proposed changes that are pending approval. The proposed changes that are pending approval, if any, are found in 'pending_proposal'. Effective details about the budget are found in fields prefixed 'approved_', 'adjusted_' and those without a prefix. Since some effective details may differ from what the user had originally requested (e.g. spending limit), these differences are juxtaposed via 'proposed_', 'approved_', and possibly 'adjusted_' fields. This resource is mutated using AccountBudgetProposal and cannot be mutated directly. A budget may have at most one pending proposal at any given time. It is read through pending_proposal. Once approved, a budget may be subject to adjustments, such as credit adjustments. Adjustments create differences between the 'approved' and 'adjusted' fields, which would otherwise be identical.
Used as response type in: services.AccountBudgetService.GetAccountBudget
Used as field type in:
string resource_name = 1
The resource name of the account-level budget. AccountBudget resource names have the form: `customers/{customer_id}/accountBudgets/{account_budget_id}`
optional id = 2
The ID of the account-level budget.
optional billing_setup = 3
The resource name of the billing setup associated with this account-level budget. BillingSetup resource names have the form: `customers/{customer_id}/billingSetups/{billing_setup_id}`
enums.AccountBudgetStatusEnum.AccountBudgetStatus status = 4
The status of this account-level budget.
optional name = 5
The name of the account-level budget.
optional proposed_start_date_time = 6
The proposed start time of the account-level budget in yyyy-MM-dd HH:mm:ss format. If a start time type of NOW was proposed, this is the time of request.
optional approved_start_date_time = 7
The approved start time of the account-level budget in yyyy-MM-dd HH:mm:ss format. For example, if a new budget is approved after the proposed start time, the approved start time is the time of approval.
optional total_adjustments_micros = 18
The total adjustments amount. An example of an adjustment is courtesy credits.
optional amount_served_micros = 19
The value of Ads that have been served, in micros. This includes overdelivery costs, in which case a credit might be automatically applied to the budget (see total_adjustments_micros).
optional purchase_order_number = 20
A purchase order number is a value that helps users reference this budget in their monthly invoices.
optional notes = 21
Notes associated with the budget.
optional pending_proposal = 22
The pending proposal to modify this budget, if applicable.
oneof proposed_end_time
The proposed end time of the account-level budget.
proposed_end_date_time = 8
The proposed end time in yyyy-MM-dd HH:mm:ss format.
enums.TimeTypeEnum.TimeType proposed_end_time_type = 9
The proposed end time as a well-defined type, e.g. FOREVER.
oneof approved_end_time
The approved end time of the account-level budget. For example, if a budget's end time is updated and the proposal is approved after the proposed end time, the approved end time is the time of approval.
approved_end_date_time = 10
The approved end time in yyyy-MM-dd HH:mm:ss format.
enums.TimeTypeEnum.TimeType approved_end_time_type = 11
The approved end time as a well-defined type, e.g. FOREVER.
oneof proposed_spending_limit
The proposed spending limit.
proposed_spending_limit_micros = 12
The proposed spending limit in micros. One million is equivalent to one unit.
enums.SpendingLimitTypeEnum.SpendingLimitType proposed_spending_limit_type = 13
The proposed spending limit as a well-defined type, e.g. INFINITE.
oneof approved_spending_limit
The approved spending limit. For example, if the amount already spent by the account exceeds the proposed spending limit at the time the proposal is approved, the approved spending limit is set to the amount already spent.
approved_spending_limit_micros = 14
The approved spending limit in micros. One million is equivalent to one unit. This will only be populated if the proposed spending limit is finite, and will always be greater than or equal to the proposed spending limit.
enums.SpendingLimitTypeEnum.SpendingLimitType approved_spending_limit_type = 15
The approved spending limit as a well-defined type, e.g. INFINITE. This will only be populated if the approved spending limit is INFINITE.
oneof adjusted_spending_limit
The spending limit after adjustments have been applied. Adjustments are stored in total_adjustments_micros. This value has the final say on how much the account is allowed to spend.
adjusted_spending_limit_micros = 16
The adjusted spending limit in micros. One million is equivalent to one unit. If the approved spending limit is finite, the adjusted spending limit may vary depending on the types of adjustments applied to this budget, if applicable. The different kinds of adjustments are described here: https://support.google.com/google-ads/answer/1704323 For example, a debit adjustment reduces how much the account is allowed to spend.
enums.SpendingLimitTypeEnum.SpendingLimitType adjusted_spending_limit_type = 17
The adjusted spending limit as a well-defined type, e.g. INFINITE. This will only be populated if the adjusted spending limit is INFINITE, which is guaranteed to be true if the approved spending limit is INFINITE.
message
account_budget.proto:57A pending proposal associated with the enclosing account-level budget, if applicable.
Used in:
optional account_budget_proposal = 1
The resource name of the proposal. AccountBudgetProposal resource names have the form: `customers/{customer_id}/accountBudgetProposals/{account_budget_proposal_id}`
enums.AccountBudgetProposalTypeEnum.AccountBudgetProposalType proposal_type = 2
The type of this proposal, e.g. END to end the budget associated with this proposal.
optional name = 3
The name to assign to the account-level budget.
optional start_date_time = 4
The start time in yyyy-MM-dd HH:mm:ss format.
optional purchase_order_number = 9
A purchase order number is a value that helps users reference this budget in their monthly invoices.
optional notes = 10
Notes associated with this budget.
optional creation_date_time = 11
The time when this account-level budget proposal was created. Formatted as yyyy-MM-dd HH:mm:ss.
oneof end_time
The end time of the account-level budget.
end_date_time = 5
The end time in yyyy-MM-dd HH:mm:ss format.
enums.TimeTypeEnum.TimeType end_time_type = 6
The end time as a well-defined type, e.g. FOREVER.
oneof spending_limit
The spending limit.
spending_limit_micros = 7
The spending limit in micros. One million is equivalent to one unit.
enums.SpendingLimitTypeEnum.SpendingLimitType spending_limit_type = 8
The spending limit as a well-defined type, e.g. INFINITE.
message
account_budget_proposal.proto:47An account-level budget proposal. All fields prefixed with 'proposed' may not necessarily be applied directly. For example, proposed spending limits may be adjusted before their application. This is true if the 'proposed' field has an 'approved' counterpart, e.g. spending limits. Please note that the proposal type (proposal_type) changes which fields are required and which must remain empty.
Used as response type in: services.AccountBudgetProposalService.GetAccountBudgetProposal
Used as field type in: ,
string resource_name = 1
The resource name of the proposal. AccountBudgetProposal resource names have the form: `customers/{customer_id}/accountBudgetProposals/{account_budget_proposal_id}`
optional id = 14
The ID of the proposal.
optional billing_setup = 2
The resource name of the billing setup associated with this proposal.
optional account_budget = 3
The resource name of the account-level budget associated with this proposal.
enums.AccountBudgetProposalTypeEnum.AccountBudgetProposalType proposal_type = 4
The type of this proposal, e.g. END to end the budget associated with this proposal.
enums.AccountBudgetProposalStatusEnum.AccountBudgetProposalStatus status = 15
The status of this proposal. When a new proposal is created, the status defaults to PENDING.
optional proposed_name = 5
The name to assign to the account-level budget.
optional approved_start_date_time = 20
The approved start date time in yyyy-mm-dd hh:mm:ss format.
optional proposed_purchase_order_number = 12
A purchase order number is a value that enables the user to help them reference this budget in their monthly invoices.
optional proposed_notes = 13
Notes associated with this budget.
optional creation_date_time = 16
The date time when this account-level budget proposal was created, which is not the same as its approval date time, if applicable.
optional approval_date_time = 17
The date time when this account-level budget was approved, if applicable.
oneof proposed_start_time
The proposed start date time of the account-level budget, which cannot be in the past.
proposed_start_date_time = 18
The proposed start date time in yyyy-mm-dd hh:mm:ss format.
enums.TimeTypeEnum.TimeType proposed_start_time_type = 7
The proposed start date time as a well-defined type, e.g. NOW.
oneof proposed_end_time
The proposed end date time of the account-level budget, which cannot be in the past.
proposed_end_date_time = 19
The proposed end date time in yyyy-mm-dd hh:mm:ss format.
enums.TimeTypeEnum.TimeType proposed_end_time_type = 9
The proposed end date time as a well-defined type, e.g. FOREVER.
oneof approved_end_time
The approved end date time of the account-level budget.
approved_end_date_time = 21
The approved end date time in yyyy-mm-dd hh:mm:ss format.
enums.TimeTypeEnum.TimeType approved_end_time_type = 22
The approved end date time as a well-defined type, e.g. FOREVER.
oneof proposed_spending_limit
The proposed spending limit.
proposed_spending_limit_micros = 10
The proposed spending limit in micros. One million is equivalent to one unit.
enums.SpendingLimitTypeEnum.SpendingLimitType proposed_spending_limit_type = 11
The proposed spending limit as a well-defined type, e.g. INFINITE.
oneof approved_spending_limit
The approved spending limit.
approved_spending_limit_micros = 23
The approved spending limit in micros. One million is equivalent to one unit.
enums.SpendingLimitTypeEnum.SpendingLimitType approved_spending_limit_type = 24
The approved spending limit as a well-defined type, e.g. INFINITE.
message
ad.proto:42An ad.
Used as response type in: services.AdService.GetAd
Used as field type in: , , ,
string resource_name = 37
The resource name of the ad. Ad resource names have the form: `customers/{customer_id}/ads/{ad_id}`
optional id = 1
The ID of the ad.
repeated final_urls = 2
The list of possible final URLs after all cross-domain redirects for the ad.
repeated final_app_urls = 35
A list of final app URLs that will be used on mobile if the user has the specific app installed.
repeated final_mobile_urls = 16
The list of possible final mobile URLs after all cross-domain redirects for the ad.
optional tracking_url_template = 12
The URL template for constructing a tracking URL.
optional final_url_suffix = 38
The suffix to use when constructing a final URL.
repeated url_custom_parameters = 10
The list of mappings that can be used to substitute custom parameter tags in a `tracking_url_template`, `final_urls`, or `mobile_final_urls`.
optional display_url = 4
The URL that appears in the ad description for some ad formats.
enums.AdTypeEnum.AdType type = 5
The type of ad.
optional added_by_google_ads = 19
Indicates if this ad was automatically added by Google Ads and not by a user. For example, this could happen when ads are automatically created as suggestions for new ads based on knowledge of how existing ads are performing.
enums.DeviceEnum.Device device_preference = 20
The device preference for the ad. You can only specify a preference for mobile devices. When this preference is set the ad will be preferred over other ads when being displayed on a mobile device. The ad can still be displayed on other device types, e.g. if no other ads are available. If unspecified (no device preference), all devices are targeted. This is only supported by some ad types.
repeated url_collections = 26
Additional URLs for the ad that are tagged with a unique identifier that can be referenced from other fields in the ad.
optional name = 23
The name of the ad. This is only used to be able to identify the ad. It does not need to be unique and does not affect the served ad.
enums.SystemManagedResourceSourceEnum.SystemManagedResourceSource system_managed_resource_source = 27
If this ad is system managed, then this field will indicate the source. This field is read-only.
oneof ad_data
Details pertinent to the ad type. Exactly one value must be set.
text_ad = 6
Details pertaining to a text ad.
expanded_text_ad = 7
Details pertaining to an expanded text ad.
call_only_ad = 13
Details pertaining to a call-only ad.
expanded_dynamic_search_ad = 14
Details pertaining to an Expanded Dynamic Search Ad. This type of ad has its headline, final URLs, and display URL auto-generated at serving time according to domain name specific information provided by `dynamic_search_ads_setting` linked at the campaign level.
hotel_ad = 15
Details pertaining to a hotel ad.
shopping_smart_ad = 17
Details pertaining to a Smart Shopping ad.
shopping_product_ad = 18
Details pertaining to a Shopping product ad.
gmail_ad = 21
Details pertaining to a Gmail ad.
image_ad = 22
Details pertaining to an Image ad.
video_ad = 24
Details pertaining to a Video ad.
responsive_search_ad = 25
Details pertaining to a responsive search ad.
legacy_responsive_display_ad = 28
Details pertaining to a legacy responsive display ad.
app_ad = 29
Details pertaining to an app ad.
legacy_app_install_ad = 30
Details pertaining to a legacy app install ad.
responsive_display_ad = 31
Details pertaining to a responsive display ad.
display_upload_ad = 33
Details pertaining to a display upload ad.
app_engagement_ad = 34
Details pertaining to an app engagement ad.
shopping_comparison_listing_ad = 36
Details pertaining to a Shopping Comparison Listing ad.
message
ad_group.proto:43An ad group.
Used as response type in: services.AdGroupService.GetAdGroup
Used as field type in: ,
string resource_name = 1
The resource name of the ad group. Ad group resource names have the form: `customers/{customer_id}/adGroups/{ad_group_id}`
optional id = 3
The ID of the ad group.
optional name = 4
The name of the ad group. This field is required and should not be empty when creating new ad groups. It must contain fewer than 255 UTF-8 full-width characters. It must not contain any null (code point 0x0), NL line feed (code point 0xA) or carriage return (code point 0xD) characters.
enums.AdGroupStatusEnum.AdGroupStatus status = 5
The status of the ad group.
enums.AdGroupTypeEnum.AdGroupType type = 12
The type of the ad group.
enums.AdGroupAdRotationModeEnum.AdGroupAdRotationMode ad_rotation_mode = 22
The ad rotation mode of the ad group.
optional base_ad_group = 18
For draft or experiment ad groups, this field is the resource name of the base ad group from which this ad group was created. If a draft or experiment ad group does not have a base ad group, then this field is null. For base ad groups, this field equals the ad group resource name. This field is read-only.
optional tracking_url_template = 13
The URL template for constructing a tracking URL.
repeated url_custom_parameters = 6
The list of mappings used to substitute custom parameter tags in a `tracking_url_template`, `final_urls`, or `mobile_final_urls`.
optional campaign = 10
The campaign to which the ad group belongs.
optional cpc_bid_micros = 14
The maximum CPC (cost-per-click) bid.
optional cpm_bid_micros = 15
The maximum CPM (cost-per-thousand viewable impressions) bid.
optional target_cpa_micros = 27
The target CPA (cost-per-acquisition).
optional cpv_bid_micros = 17
The CPV (cost-per-view) bid.
optional target_cpm_micros = 26
Average amount in micros that the advertiser is willing to pay for every thousand times the ad is shown.
optional target_roas = 30
The target ROAS (return-on-ad-spend) override. If the ad group's campaign bidding strategy is a standard Target ROAS strategy, then this field overrides the target ROAS specified in the campaign's bidding strategy. Otherwise, this value is ignored.
optional percent_cpc_bid_micros = 20
The percent cpc bid amount, expressed as a fraction of the advertised price for some good or service. The valid range for the fraction is [0,1) and the value stored here is 1,000,000 * [fraction].
optional explorer_auto_optimizer_setting = 21
Settings for the Display Campaign Optimizer, initially termed "Explorer".
enums.TargetingDimensionEnum.TargetingDimension display_custom_bid_dimension = 23
Allows advertisers to specify a targeting dimension on which to place absolute bids. This is only applicable for campaigns that target only the display network and not search.
optional final_url_suffix = 24
URL template for appending params to Final URL.
optional targeting_setting = 25
Setting for targeting related features.
optional effective_target_cpa_micros = 28
The effective target CPA (cost-per-acquisition). This field is read-only.
enums.BiddingSourceEnum.BiddingSource effective_target_cpa_source = 29
Source of the effective target CPA. This field is read-only.
optional effective_target_roas = 31
The effective target ROAS (return-on-ad-spend). This field is read-only.
enums.BiddingSourceEnum.BiddingSource effective_target_roas_source = 32
Source of the effective target ROAS. This field is read-only.
repeated labels = 33
The resource names of labels attached to this ad group.
message
ad_group_ad.proto:41An ad group ad.
Used as response type in: services.AdGroupAdService.GetAdGroupAd
Used as field type in: ,
string resource_name = 1
The resource name of the ad. Ad group ad resource names have the form: `customers/{customer_id}/adGroupAds/{ad_group_id}~{ad_id}`
enums.AdGroupAdStatusEnum.AdGroupAdStatus status = 3
The status of the ad.
optional ad_group = 4
The ad group to which the ad belongs.
optional ad = 5
The ad.
optional policy_summary = 6
Policy information for the ad.
enums.AdStrengthEnum.AdStrength ad_strength = 7
Overall ad strength for this ad group ad.
message
ad_group_ad_asset_view.proto:64Contains policy information for an ad group ad asset.
Used in:
repeated policy_topic_entries = 1
The list of policy findings for the ad group ad asset.
enums.PolicyReviewStatusEnum.PolicyReviewStatus review_status = 2
Where in the review process this ad group ad asset is.
enums.PolicyApprovalStatusEnum.PolicyApprovalStatus approval_status = 3
The overall approval status of this ad group ad asset, calculated based on the status of its individual policy topic entries.
message
ad_group_ad_asset_view.proto:40A link between an AdGroupAd and an Asset.
Used as response type in: services.AdGroupAdAssetViewService.GetAdGroupAdAssetView
Used as field type in:
string resource_name = 1
The resource name of the ad group ad asset view. Ad group ad asset view resource names have the form: `customers/{customer_id}/adGroupAdAssets/{AdGroupAdAsset.ad_group_id}~{AdGroupAdAsset.ad.ad_id}~{AdGroupAdAsset.asset_id}~{AdGroupAdAsset.asset_field_type}`
optional ad_group_ad = 5
The ad group ad to which the asset is linked.
optional asset = 6
The asset which is linked to the ad group ad.
enums.AssetFieldTypeEnum.AssetFieldType field_type = 2
Role that the asset takes in the ad.
optional policy_summary = 3
Policy information for the ad group ad asset.
enums.AssetPerformanceLabelEnum.AssetPerformanceLabel performance_label = 4
Performance of an asset linkage.
message
ad_group_ad_label.proto:35A relationship between an ad group ad and a label.
Used as response type in: services.AdGroupAdLabelService.GetAdGroupAdLabel
Used as field type in: ,
string resource_name = 1
The resource name of the ad group ad label. Ad group ad label resource names have the form: `customers/{customer_id}/adGroupAdLabels/{ad_group_id}~{ad_id}~{label_id}`
optional ad_group_ad = 2
The ad group ad to which the label is attached.
optional label = 3
The label assigned to the ad group ad.
message
ad_group_ad.proto:65Contains policy information for an ad.
Used in:
repeated policy_topic_entries = 1
The list of policy findings for this ad.
enums.PolicyReviewStatusEnum.PolicyReviewStatus review_status = 2
Where in the review process this ad is.
enums.PolicyApprovalStatusEnum.PolicyApprovalStatus approval_status = 3
The overall approval status of this ad, calculated based on the status of its individual policy topic entries.
message
ad_group_audience_view.proto:37An ad group audience view. Includes performance data from interests and remarketing lists for Display Network and YouTube Network ads, and remarketing lists for search ads (RLSA), aggregated at the audience level.
Used as response type in: services.AdGroupAudienceViewService.GetAdGroupAudienceView
Used as field type in:
string resource_name = 1
The resource name of the ad group audience view. Ad group audience view resource names have the form: `customers/{customer_id}/adGroupAudienceViews/{ad_group_id}~{criterion_id}`
message
ad_group_bid_modifier.proto:37Represents an ad group bid modifier.
Used as response type in: services.AdGroupBidModifierService.GetAdGroupBidModifier
Used as field type in: ,
string resource_name = 1
The resource name of the ad group bid modifier. Ad group bid modifier resource names have the form: `customers/{customer_id}/adGroupBidModifiers/{ad_group_id}~{criterion_id}`
optional ad_group = 2
The ad group to which this criterion belongs.
optional criterion_id = 3
The ID of the criterion to bid modify. This field is ignored for mutates.
optional bid_modifier = 4
The modifier for the bid when the criterion matches. The modifier must be in the range: 0.1 - 10.0. The range is 1.0 - 6.0 for PreferredContent. Use 0 to opt out of a Device type.
optional base_ad_group = 9
The base ad group from which this draft/trial adgroup bid modifier was created. If ad_group is a base ad group then this field will be equal to ad_group. If the ad group was created in the draft or trial and has no corresponding base ad group, then this field will be null. This field is readonly.
enums.BidModifierSourceEnum.BidModifierSource bid_modifier_source = 10
Bid modifier source.
oneof criterion
The criterion of this ad group bid modifier.
hotel_date_selection_type = 5
Criterion for hotel date selection (default dates vs. user selected).
hotel_advance_booking_window = 6
Criterion for number of days prior to the stay the booking is being made.
hotel_length_of_stay = 7
Criterion for length of hotel stay in nights.
hotel_check_in_day = 8
Criterion for day of the week the booking is for.
device = 11
A device criterion.
preferred_content = 12
A preferred content criterion.
message
ad_group_criterion.proto:43An ad group criterion.
Used as response type in: services.AdGroupCriterionService.GetAdGroupCriterion
Used as field type in: ,
string resource_name = 1
The resource name of the ad group criterion. Ad group criterion resource names have the form: `customers/{customer_id}/adGroupCriteria/{ad_group_id}~{criterion_id}`
optional criterion_id = 26
The ID of the criterion. This field is ignored for mutates.
enums.AdGroupCriterionStatusEnum.AdGroupCriterionStatus status = 3
The status of the criterion.
optional quality_info = 4
Information regarding the quality of the criterion.
optional ad_group = 5
The ad group to which the criterion belongs.
enums.CriterionTypeEnum.CriterionType type = 25
The type of the criterion.
optional negative = 31
Whether to target (`false`) or exclude (`true`) the criterion. This field is immutable. To switch a criterion from positive to negative, remove then re-add it.
enums.CriterionSystemServingStatusEnum.CriterionSystemServingStatus system_serving_status = 52
Serving status of the criterion.
enums.AdGroupCriterionApprovalStatusEnum.AdGroupCriterionApprovalStatus approval_status = 53
Approval status of the criterion.
optional bid_modifier = 44
The modifier for the bid when the criterion matches. The modifier must be in the range: 0.1 - 10.0. Most targetable criteria types support modifiers.
optional cpc_bid_micros = 16
The CPC (cost-per-click) bid.
optional cpm_bid_micros = 17
The CPM (cost-per-thousand viewable impressions) bid.
optional cpv_bid_micros = 24
The CPV (cost-per-view) bid.
optional percent_cpc_bid_micros = 33
The CPC bid amount, expressed as a fraction of the advertised price for some good or service. The valid range for the fraction is [0,1) and the value stored here is 1,000,000 * [fraction].
optional effective_cpc_bid_micros = 18
The effective CPC (cost-per-click) bid.
optional effective_cpm_bid_micros = 19
The effective CPM (cost-per-thousand viewable impressions) bid.
optional effective_cpv_bid_micros = 20
The effective CPV (cost-per-view) bid.
optional effective_percent_cpc_bid_micros = 34
The effective Percent CPC bid amount.
enums.BiddingSourceEnum.BiddingSource effective_cpc_bid_source = 21
Source of the effective CPC bid.
enums.BiddingSourceEnum.BiddingSource effective_cpm_bid_source = 22
Source of the effective CPM bid.
enums.BiddingSourceEnum.BiddingSource effective_cpv_bid_source = 23
Source of the effective CPV bid.
enums.BiddingSourceEnum.BiddingSource effective_percent_cpc_bid_source = 35
Source of the effective Percent CPC bid.
optional position_estimates = 10
Estimates for criterion bids at various positions.
repeated final_urls = 11
The list of possible final URLs after all cross-domain redirects for the ad.
repeated final_mobile_urls = 51
The list of possible final mobile URLs after all cross-domain redirects.
optional final_url_suffix = 50
URL template for appending params to final URL.
optional tracking_url_template = 13
The URL template for constructing a tracking URL.
repeated url_custom_parameters = 14
The list of mappings used to substitute custom parameter tags in a `tracking_url_template`, `final_urls`, or `mobile_final_urls`.
oneof criterion
The ad group criterion. Exactly one must be set.
keyword = 27
Keyword.
placement = 28
Placement.
mobile_app_category = 29
Mobile app category.
mobile_application = 30
Mobile application.
listing_group = 32
Listing group.
age_range = 36
Age range.
gender = 37
Gender.
income_range = 38
Income range.
parental_status = 39
Parental status.
user_list = 42
User List.
youtube_video = 40
YouTube Video.
youtube_channel = 41
YouTube Channel.
topic = 43
Topic.
user_interest = 45
User Interest.
webpage = 46
Webpage
app_payment_model = 47
App Payment Model.
custom_affinity = 48
Custom Affinity.
custom_intent = 49
Custom Intent.
message
ad_group_criterion.proto:63Estimates for criterion bids at various positions.
Used in:
optional first_page_cpc_micros = 1
The estimate of the CPC bid required for ad to be shown on first page of search results.
optional first_position_cpc_micros = 2
The estimate of the CPC bid required for ad to be displayed in first position, at the top of the first page of search results.
optional top_of_page_cpc_micros = 3
The estimate of the CPC bid required for ad to be displayed at the top of the first page of search results.
optional estimated_add_clicks_at_first_position_cpc = 4
Estimate of how many clicks per week you might get by changing your keyword bid to the value in first_position_cpc_micros.
optional estimated_add_cost_at_first_position_cpc = 5
Estimate of how your cost per week might change when changing your keyword bid to the value in first_position_cpc_micros.
message
ad_group_criterion.proto:45A container for ad group criterion quality information.
Used in:
optional quality_score = 1
The quality score. This field may not be populated if Google does not have enough information to determine a value.
enums.QualityScoreBucketEnum.QualityScoreBucket creative_quality_score = 2
The performance of the ad compared to other advertisers.
enums.QualityScoreBucketEnum.QualityScoreBucket post_click_quality_score = 3
The quality score of the landing page.
enums.QualityScoreBucketEnum.QualityScoreBucket search_predicted_ctr = 4
The click-through rate compared to that of other advertisers.
A relationship between an ad group criterion and a label.
Used as response type in: services.AdGroupCriterionLabelService.GetAdGroupCriterionLabel
Used as field type in: ,
string resource_name = 1
The resource name of the ad group criterion label. Ad group criterion label resource names have the form: `customers/{customer_id}/adGroupCriterionLabels/{ad_group_id}~{criterion_id}~{label_id}`
optional ad_group_criterion = 2
The ad group criterion to which the label is attached.
optional label = 3
The label assigned to the ad group criterion.
An ad group criterion simulation. Supported combinations of advertising channel type, criterion type, simulation type, and simulation modification method are detailed below respectively. DISPLAY KEYWORD CPC_BID UNIFORM SEARCH KEYWORD CPC_BID UNIFORM SHOPPING LISTING_GROUP CPC_BID UNIFORM
Used as response type in: services.AdGroupCriterionSimulationService.GetAdGroupCriterionSimulation
Used as field type in:
string resource_name = 1
The resource name of the ad group criterion simulation. Ad group criterion simulation resource names have the form: `customers/{customer_id}/adGroupCriterionSimulations/{ad_group_id}~{criterion_id}~{type}~{modification_method}~{start_date}~{end_date}`
optional ad_group_id = 2
AdGroup ID of the simulation.
optional criterion_id = 3
Criterion ID of the simulation.
enums.SimulationTypeEnum.SimulationType type = 4
The field that the simulation modifies.
enums.SimulationModificationMethodEnum.SimulationModificationMethod modification_method = 5
How the simulation modifies the field.
optional start_date = 6
First day on which the simulation is based, in YYYY-MM-DD format.
optional end_date = 7
Last day on which the simulation is based, in YYYY-MM-DD format.
oneof point_list
List of simulation points.
cpc_bid_point_list = 8
Simulation points if the simulation type is CPC_BID.
An ad group extension setting.
Used as response type in: services.AdGroupExtensionSettingService.GetAdGroupExtensionSetting
Used as field type in: ,
string resource_name = 1
The resource name of the ad group extension setting. AdGroupExtensionSetting resource names have the form: `customers/{customer_id}/adGroupExtensionSettings/{ad_group_id}~{extension_type}`
enums.ExtensionTypeEnum.ExtensionType extension_type = 2
The extension type of the ad group extension setting.
optional ad_group = 3
The resource name of the ad group. The linked extension feed items will serve under this ad group. AdGroup resource names have the form: `customers/{customer_id}/adGroups/{ad_group_id}`
repeated extension_feed_items = 4
The resource names of the extension feed items to serve under the ad group. ExtensionFeedItem resource names have the form: `customers/{customer_id}/extensionFeedItems/{feed_item_id}`
enums.ExtensionSettingDeviceEnum.ExtensionSettingDevice device = 5
The device for which the extensions will serve. Optional.
message
ad_group_feed.proto:38An ad group feed.
Used as response type in: services.AdGroupFeedService.GetAdGroupFeed
Used as field type in: ,
string resource_name = 1
The resource name of the ad group feed. Ad group feed resource names have the form: `customers/{customer_id}/adGroupFeeds/{ad_group_id}~{feed_id}
optional feed = 2
The feed being linked to the ad group.
optional ad_group = 3
The ad group being linked to the feed.
repeated enums.PlaceholderTypeEnum.PlaceholderType placeholder_types = 4
Indicates which placeholder types the feed may populate under the connected ad group. Required.
optional matching_function = 5
Matching function associated with the AdGroupFeed. The matching function is used to filter the set of feed items selected. Required.
enums.FeedLinkStatusEnum.FeedLinkStatus status = 6
Status of the ad group feed. This field is read-only.
message
ad_group_label.proto:35A relationship between an ad group and a label.
Used as response type in: services.AdGroupLabelService.GetAdGroupLabel
Used as field type in: ,
string resource_name = 1
The resource name of the ad group label. Ad group label resource names have the form: `customers/{customer_id}/adGroupLabels/{ad_group_id}~{label_id}`
optional ad_group = 2
The ad group to which the label is attached.
optional label = 3
The label assigned to the ad group.
message
ad_group_simulation.proto:49An ad group simulation. Supported combinations of advertising channel type, simulation type and simulation modification method is detailed below respectively. SEARCH CPC_BID DEFAULT SEARCH CPC_BID UNIFORM SEARCH TARGET_CPA UNIFORM DISPLAY CPC_BID DEFAULT DISPLAY CPC_BID UNIFORM DISPLAY TARGET_CPA UNIFORM VIDEO CPV_BID DEFAULT VIDEO CPV_BID UNIFORM
Used as response type in: services.AdGroupSimulationService.GetAdGroupSimulation
Used as field type in:
string resource_name = 1
The resource name of the ad group simulation. Ad group simulation resource names have the form: `customers/{customer_id}/adGroupSimulations/{ad_group_id}~{type}~{modification_method}~{start_date}~{end_date}`
optional ad_group_id = 2
Ad group id of the simulation.
enums.SimulationTypeEnum.SimulationType type = 3
The field that the simulation modifies.
enums.SimulationModificationMethodEnum.SimulationModificationMethod modification_method = 4
How the simulation modifies the field.
optional start_date = 5
First day on which the simulation is based, in YYYY-MM-DD format.
optional end_date = 6
Last day on which the simulation is based, in YYYY-MM-DD format
oneof point_list
List of simulation points.
cpc_bid_point_list = 8
Simulation points if the simulation type is CPC_BID.
cpv_bid_point_list = 10
Simulation points if the simulation type is CPV_BID.
target_cpa_point_list = 9
Simulation points if the simulation type is TARGET_CPA.
message
ad_parameter.proto:40An ad parameter that is used to update numeric values (such as prices or inventory levels) in any text line of an ad (including URLs). There can be a maximum of two AdParameters per ad group criterion. (One with parameter_index = 1 and one with parameter_index = 2.) In the ad the parameters are referenced by a placeholder of the form "{param#:value}". E.g. "{param1:$17}"
Used as response type in: services.AdParameterService.GetAdParameter
Used as field type in: ,
string resource_name = 1
The resource name of the ad parameter. Ad parameter resource names have the form: `customers/{customer_id}/adParameters/{ad_group_id}~{criterion_id}~{parameter_index}`
optional ad_group_criterion = 2
The ad group criterion that this ad parameter belongs to.
optional parameter_index = 3
The unique index of this ad parameter. Must be either 1 or 2.
optional insertion_text = 4
Numeric value to insert into the ad text. The following restrictions apply: - Can use comma or period as a separator, with an optional period or comma (respectively) for fractional values. For example, 1,000,000.00 and 2.000.000,10 are valid. - Can be prepended or appended with a currency symbol. For example, $99.99 is valid. - Can be prepended or appended with a currency code. For example, 99.99USD and EUR200 are valid. - Can use '%'. For example, 1.0% and 1,0% are valid. - Can use plus or minus. For example, -10.99 and 25+ are valid. - Can use '/' between two numbers. For example 4/1 and 0.95/0.45 are valid.
message
ad_schedule_view.proto:35An ad schedule view summarizes the performance of campaigns by AdSchedule criteria.
Used as response type in: services.AdScheduleViewService.GetAdScheduleView
Used as field type in:
string resource_name = 1
The resource name of the ad schedule view. AdSchedule view resource names have the form: `customers/{customer_id}/adScheduleViews/{campaign_id}~{criterion_id}`
message
age_range_view.proto:34An age range view.
Used as response type in: services.AgeRangeViewService.GetAgeRangeView
Used as field type in:
string resource_name = 1
The resource name of the age range view. Age range view resource names have the form: `customers/{customer_id}/ageRangeViews/{ad_group_id}~{criterion_id}`
message
asset.proto:38Asset is a part of an ad which can be shared across multiple ads. It can be an image (ImageAsset), a video (YoutubeVideoAsset), etc.
Used as response type in: services.AssetService.GetAsset
Used as field type in: ,
string resource_name = 1
The resource name of the asset. Asset resource names have the form: `customers/{customer_id}/assets/{asset_id}`
optional id = 2
The ID of the asset.
optional name = 3
Optional name of the asset.
enums.AssetTypeEnum.AssetType type = 4
Type of the asset.
oneof asset_data
The specific type of the asset.
youtube_video_asset = 5
A YouTube video asset.
media_bundle_asset = 6
A media bundle asset.
image_asset = 7
An image asset.
text_asset = 8
A text asset.
message
feed_mapping.proto:94Maps from feed attribute id to a placeholder or criterion field id.
Used in:
optional feed_attribute_id = 1
Feed attribute from which to map.
optional field_id = 2
The placeholder field ID. If a placeholder field enum is not published in the current API version, then this field will be populated and the field oneof will be empty. This field is read-only.
oneof field
Placeholder or criterion field to be populated using data from the above feed attribute. Required.
enums.SitelinkPlaceholderFieldEnum.SitelinkPlaceholderField sitelink_field = 3
Sitelink Placeholder Fields.
enums.CallPlaceholderFieldEnum.CallPlaceholderField call_field = 4
Call Placeholder Fields.
enums.AppPlaceholderFieldEnum.AppPlaceholderField app_field = 5
App Placeholder Fields.
enums.LocationPlaceholderFieldEnum.LocationPlaceholderField location_field = 6
Location Placeholder Fields. This field is read-only.
enums.AffiliateLocationPlaceholderFieldEnum.AffiliateLocationPlaceholderField affiliate_location_field = 7
Affiliate Location Placeholder Fields. This field is read-only.
enums.CalloutPlaceholderFieldEnum.CalloutPlaceholderField callout_field = 8
Callout Placeholder Fields.
enums.StructuredSnippetPlaceholderFieldEnum.StructuredSnippetPlaceholderField structured_snippet_field = 9
Structured Snippet Placeholder Fields.
enums.MessagePlaceholderFieldEnum.MessagePlaceholderField message_field = 10
Message Placeholder Fields.
enums.PricePlaceholderFieldEnum.PricePlaceholderField price_field = 11
Price Placeholder Fields.
enums.PromotionPlaceholderFieldEnum.PromotionPlaceholderField promotion_field = 12
Promotion Placeholder Fields.
enums.AdCustomizerPlaceholderFieldEnum.AdCustomizerPlaceholderField ad_customizer_field = 13
Ad Customizer Placeholder Fields
enums.DsaPageFeedCriterionFieldEnum.DsaPageFeedCriterionField dsa_page_feed_field = 14
Dynamic Search Ad Page Feed Fields.
enums.LocationExtensionTargetingCriterionFieldEnum.LocationExtensionTargetingCriterionField location_extension_targeting_field = 15
Location Target Fields.
enums.EducationPlaceholderFieldEnum.EducationPlaceholderField education_field = 16
Education Placeholder Fields
enums.FlightPlaceholderFieldEnum.FlightPlaceholderField flight_field = 17
Flight Placeholder Fields
enums.CustomPlaceholderFieldEnum.CustomPlaceholderField custom_field = 18
Custom Placeholder Fields
enums.HotelPlaceholderFieldEnum.HotelPlaceholderField hotel_field = 19
Hotel Placeholder Fields
enums.RealEstatePlaceholderFieldEnum.RealEstatePlaceholderField real_estate_field = 20
Real Estate Placeholder Fields
enums.TravelPlaceholderFieldEnum.TravelPlaceholderField travel_field = 21
Travel Placeholder Fields
enums.LocalPlaceholderFieldEnum.LocalPlaceholderField local_field = 22
Local Placeholder Fields
enums.JobPlaceholderFieldEnum.JobPlaceholderField job_field = 23
Job Placeholder Fields
message
bidding_strategy.proto:38A bidding strategy.
Used as response type in: services.BiddingStrategyService.GetBiddingStrategy
Used as field type in: ,
string resource_name = 1
The resource name of the bidding strategy. Bidding strategy resource names have the form: `customers/{customer_id}/biddingStrategies/{bidding_strategy_id}`
optional id = 3
The ID of the bidding strategy.
optional name = 4
The name of the bidding strategy. All bidding strategies within an account must be named distinctly. The length of this string should be between 1 and 255, inclusive, in UTF-8 bytes, (trimmed).
enums.BiddingStrategyStatusEnum.BiddingStrategyStatus status = 15
The status of the bidding strategy. This field is read-only.
enums.BiddingStrategyTypeEnum.BiddingStrategyType type = 5
The type of the bidding strategy. Create a bidding strategy by setting the bidding scheme. This field is read-only.
optional campaign_count = 13
The number of campaigns attached to this bidding strategy. This field is read-only.
optional non_removed_campaign_count = 14
The number of non-removed campaigns attached to this bidding strategy. This field is read-only.
oneof scheme
The bidding scheme. Only one can be set.
enhanced_cpc = 7
A bidding strategy that raises bids for clicks that seem more likely to lead to a conversion and lowers them for clicks where they seem less likely.
page_one_promoted = 8
A bidding strategy that sets max CPC bids to target impressions on page one or page one promoted slots on google.com. This field is deprecated. Creating a new bidding strategy with this field or attaching bidding strategies with this field to a campaign will fail. Mutates to strategies that already have this scheme populated are allowed.
target_cpa = 9
A bidding strategy that sets bids to help get as many conversions as possible at the target cost-per-acquisition (CPA) you set.
target_impression_share = 48
A bidding strategy that automatically optimizes towards a desired percentage of impressions.
target_outrank_share = 10
A bidding strategy that sets bids based on the target fraction of auctions where the advertiser should outrank a specific competitor. This field is deprecated. Creating a new bidding strategy with this field or attaching bidding strategies with this field to a campaign will fail. Mutates to strategies that already have this scheme populated are allowed.
target_roas = 11
A bidding strategy that helps you maximize revenue while averaging a specific target Return On Ad Spend (ROAS).
target_spend = 12
A bid strategy that sets your bids to help get as many clicks as possible within your budget.
message
billing_setup.proto:38A billing setup, which associates a payments account and an advertiser. A billing setup is specific to one advertiser.
Used as response type in: services.BillingSetupService.GetBillingSetup
Used as field type in: ,
string resource_name = 1
The resource name of the billing setup. BillingSetup resource names have the form: `customers/{customer_id}/billingSetups/{billing_setup_id}`
optional id = 2
The ID of the billing setup.
enums.BillingSetupStatusEnum.BillingSetupStatus status = 3
The status of the billing setup.
optional payments_account = 11
The resource name of the payments account associated with this billing setup. Payments resource names have the form: `customers/{customer_id}/paymentsAccounts/{payments_account_id}` When setting up billing, this is used to signup with an existing payments account (and then payments_account_info should not be set). When getting a billing setup, this and payments_account_info will be populated.
optional payments_account_info = 12
The payments account information associated with this billing setup. When setting up billing, this is used to signup with a new payments account (and then payments_account should not be set). When getting a billing setup, this and payments_account will be populated.
oneof start_time
When creating a new billing setup, this is when the setup should take effect. NOW is the only acceptable start time if the customer doesn't have any approved setups. When fetching an existing billing setup, this is the requested start time. However, if the setup was approved (see status) after the requested start time, then this is the approval time.
start_date_time = 9
The start date time in yyyy-MM-dd or yyyy-MM-dd HH:mm:ss format. Only a future time is allowed.
enums.TimeTypeEnum.TimeType start_time_type = 10
The start time as a type. Only NOW is allowed.
oneof end_time
When the billing setup ends / ended. This is either FOREVER or the start time of the next scheduled billing setup.
end_date_time = 13
The end date time in yyyy-MM-dd or yyyy-MM-dd HH:mm:ss format.
enums.TimeTypeEnum.TimeType end_time_type = 14
The end time as a type. The only possible value is FOREVER.
message
billing_setup.proto:40Container of payments account information for this billing.
Used in:
optional payments_account_id = 1
A 16 digit id used to identify the payments account associated with the billing setup. This must be passed as a string with dashes, e.g. "1234-5678-9012-3456".
optional payments_account_name = 2
The name of the payments account associated with the billing setup. This enables the user to specify a meaningful name for a payments account to aid in reconciling monthly invoices. This name will be printed in the monthly invoices.
optional payments_profile_id = 3
A 12 digit id used to identify the payments profile associated with the billing setup. This must be passed in as a string with dashes, e.g. "1234-5678-9012".
optional payments_profile_name = 4
The name of the payments profile associated with the billing setup.
optional secondary_payments_profile_id = 5
A secondary payments profile id present in uncommon situations, e.g. when a sequential liability agreement has been arranged.
message
customer.proto:92Call reporting setting for a customer.
Used in:
optional call_reporting_enabled = 1
Enable reporting of phone call events by redirecting them via Google System.
optional call_conversion_reporting_enabled = 2
Whether to enable call conversion reporting.
optional call_conversion_action = 9
Customer-level call conversion action to attribute a call conversion to. If not set a default conversion action is used. Only in effect when call_conversion_reporting_enabled is set to true.
message
campaign.proto:55A campaign.
Used as response type in: services.CampaignService.GetCampaign
Used as field type in: ,
string resource_name = 1
The resource name of the campaign. Campaign resource names have the form: `customers/{customer_id}/campaigns/{campaign_id}`
optional id = 3
The ID of the campaign.
optional name = 4
The name of the campaign. This field is required and should not be empty when creating new campaigns. It must not contain any null (code point 0x0), NL line feed (code point 0xA) or carriage return (code point 0xD) characters.
enums.CampaignStatusEnum.CampaignStatus status = 5
The status of the campaign. When a new campaign is added, the status defaults to ENABLED.
enums.CampaignServingStatusEnum.CampaignServingStatus serving_status = 21
The ad serving status of the campaign.
enums.AdServingOptimizationStatusEnum.AdServingOptimizationStatus ad_serving_optimization_status = 8
The ad serving optimization status of the campaign.
enums.AdvertisingChannelTypeEnum.AdvertisingChannelType advertising_channel_type = 9
The primary serving target for ads within the campaign. The targeting options can be refined in `network_settings`. This field is required and should not be empty when creating new campaigns. Can be set only when creating campaigns. After the campaign is created, the field can not be changed.
enums.AdvertisingChannelSubTypeEnum.AdvertisingChannelSubType advertising_channel_sub_type = 10
Optional refinement to `advertising_channel_type`. Must be a valid sub-type of the parent channel type. Can be set only when creating campaigns. After campaign is created, the field can not be changed.
optional tracking_url_template = 11
The URL template for constructing a tracking URL.
repeated url_custom_parameters = 12
The list of mappings used to substitute custom parameter tags in a `tracking_url_template`, `final_urls`, or `mobile_final_urls`.
optional real_time_bidding_setting = 39
Settings for Real-Time Bidding, a feature only available for campaigns targeting the Ad Exchange network.
optional network_settings = 14
The network settings for the campaign.
optional hotel_setting = 32
The hotel setting for the campaign.
optional dynamic_search_ads_setting = 33
The setting for controlling Dynamic Search Ads (DSA).
optional shopping_setting = 36
The setting for controlling Shopping campaigns.
optional targeting_setting = 43
Setting for targeting related features.
optional geo_target_type_setting = 47
The setting for ads geotargeting.
optional app_campaign_setting = 51
The setting related to App Campaign.
repeated labels = 53
The resource names of labels attached to this campaign.
enums.CampaignExperimentTypeEnum.CampaignExperimentType experiment_type = 17
The type of campaign: normal, draft, or experiment.
optional base_campaign = 28
The resource name of the base campaign of a draft or experiment campaign. For base campaigns, this is equal to `resource_name`. This field is read-only.
optional campaign_budget = 6
The budget of the campaign.
enums.BiddingStrategyTypeEnum.BiddingStrategyType bidding_strategy_type = 22
The type of bidding strategy. A bidding strategy can be created by setting either the bidding scheme to create a standard bidding strategy or the `bidding_strategy` field to create a portfolio bidding strategy. This field is read-only.
optional start_date = 19
The date when campaign started. This field must not be used in WHERE clauses.
optional end_date = 20
The date when campaign ended. This field must not be used in WHERE clauses.
optional final_url_suffix = 38
Suffix used to append query parameters to landing pages that are served with parallel tracking.
repeated frequency_caps = 40
A list that limits how often each user will see this campaign's ads.
enums.BrandSafetySuitabilityEnum.BrandSafetySuitability video_brand_safety_suitability = 42
3-Tier Brand Safety setting for the campaign.
optional vanity_pharma = 44
Describes how unbranded pharma ads will be displayed.
optional selective_optimization = 45
Selective optimization setting for this campaign, which includes a set of conversion actions to optimize this campaign towards.
optional tracking_setting = 46
Campaign level settings for tracking information.
enums.PaymentModeEnum.PaymentMode payment_mode = 52
Payment mode for the campaign.
oneof campaign_bidding_strategy
The bidding strategy for the campaign. Must be either portfolio (created via BiddingStrategy service) or standard, that is embedded into the campaign.
bidding_strategy = 23
Portfolio bidding strategy used by campaign.
commission = 49
Commission is an automatic bidding strategy in which the advertiser pays a certain portion of the conversion value.
manual_cpc = 24
Standard Manual CPC bidding strategy. Manual click-based bidding where user pays per click.
manual_cpm = 25
Standard Manual CPM bidding strategy. Manual impression-based bidding where user pays per thousand impressions.
manual_cpv = 37
A bidding strategy that pays a configurable amount per video view.
maximize_conversions = 30
Standard Maximize Conversions bidding strategy that automatically maximizes number of conversions given a daily budget.
maximize_conversion_value = 31
Standard Maximize Conversion Value bidding strategy that automatically sets bids to maximize revenue while spending your budget.
target_cpa = 26
Standard Target CPA bidding strategy that automatically sets bids to help get as many conversions as possible at the target cost-per-acquisition (CPA) you set.
target_impression_share = 48
Target Impression Share bidding strategy. An automated bidding strategy that sets bids to achieve a desired percentage of impressions.
target_roas = 29
Standard Target ROAS bidding strategy that automatically maximizes revenue while averaging a specific target return on ad spend (ROAS).
target_spend = 27
Standard Target Spend bidding strategy that automatically sets your bids to help get as many clicks as possible within your budget.
percent_cpc = 34
Standard Percent Cpc bidding strategy where bids are a fraction of the advertised price for some good or service.
target_cpm = 41
A bidding strategy that automatically optimizes cost per thousand impressions.
message
campaign.proto:104Campaign level settings for App Campaigns.
Used in:
enums.AppCampaignBiddingStrategyGoalTypeEnum.AppCampaignBiddingStrategyGoalType bidding_strategy_goal_type = 1
Represents the goal which the bidding strategy of this app campaign should optimize towards.
optional app_id = 2
A string that uniquely identifies a mobile application.
enums.AppCampaignAppStoreEnum.AppCampaignAppStore app_store = 3
The application store that distributes this specific app.
message
campaign.proto:88The setting for controlling Dynamic Search Ads (DSA).
Used in:
optional domain_name = 1
The Internet domain name that this setting represents, e.g., "google.com" or "www.google.com".
optional language_code = 2
The language code specifying the language of the domain, e.g., "en".
optional use_supplied_urls_only = 3
Whether the campaign uses advertiser supplied URLs exclusively.
repeated feeds = 5
The list of page feeds associated with the campaign.
message
campaign.proto:150Represents a collection of settings related to ads geotargeting.
Used in:
enums.PositiveGeoTargetTypeEnum.PositiveGeoTargetType positive_geo_target_type = 1
The setting used for positive geotargeting in this particular campaign.
enums.NegativeGeoTargetTypeEnum.NegativeGeoTargetType negative_geo_target_type = 2
The setting used for negative geotargeting in this particular campaign.
message
campaign.proto:75Campaign-level settings for hotel ads.
Used in:
optional hotel_center_id = 1
The linked Hotel Center account.
message
campaign.proto:57The network settings for the campaign.
Used in:
optional target_google_search = 1
Whether ads will be served with google.com search results.
optional target_search_network = 2
Whether ads will be served on partner sites in the Google Search Network (requires `target_google_search` to also be `true`).
optional target_content_network = 3
Whether ads will be served on specified placements in the Google Display Network. Placements are specified using the Placement criterion.
optional target_partner_search_network = 4
Whether ads will be served on the Google Partner Network. This is available only to some select Google partner accounts.
message
campaign.proto:82Selective optimization setting for this campaign, which includes a set of conversion actions to optimize this campaign towards.
Used in:
repeated conversion_actions = 1
The selected set of conversion actions for optimizing this campaign.
message
campaign.proto:119The setting for Shopping campaigns. Defines the universe of products that can be advertised by the campaign, and how this campaign interacts with other Shopping campaigns.
Used in:
optional merchant_id = 1
ID of the Merchant Center account. This field is required for create operations. This field is immutable for Shopping campaigns.
optional sales_country = 2
Sales country of products to include in the campaign. This field is required for Shopping campaigns. This field is immutable. This field is optional for non-Shopping campaigns, but it must be equal to 'ZZ' if set.
optional campaign_priority = 3
Priority of the campaign. Campaigns with numerically higher priorities take precedence over those with lower priorities. This field is required for Shopping campaigns, with values between 0 and 2, inclusive. This field is optional for Smart Shopping campaigns, but must be equal to 3 if set.
optional enable_local = 4
Whether to include local products.
message
campaign.proto:144Campaign level settings for tracking information.
Used in:
optional tracking_url = 1
The url used for dynamic tracking.
message
campaign.proto:159Describes how unbranded pharma ads will be displayed.
Used in:
enums.VanityPharmaDisplayUrlModeEnum.VanityPharmaDisplayUrlMode vanity_pharma_display_url_mode = 1
The display mode for vanity pharma URLs.
enums.VanityPharmaTextEnum.VanityPharmaText vanity_pharma_text = 2
The text that will be displayed in display URL of the text ad when website description is the selected display mode for vanity pharma URLs.
message
campaign_audience_view.proto:38A campaign audience view. Includes performance data from interests and remarketing lists for Display Network and YouTube Network ads, and remarketing lists for search ads (RLSA), aggregated by campaign and audience criterion. This view only includes audiences attached at the campaign level.
Used as response type in: services.CampaignAudienceViewService.GetCampaignAudienceView
Used as field type in:
string resource_name = 1
The resource name of the campaign audience view. Campaign audience view resource names have the form: `customers/{customer_id}/campaignAudienceViews/{campaign_id}~{criterion_id}`
message
campaign_bid_modifier.proto:36Represents a bid-modifiable only criterion at the campaign level.
Used as response type in: services.CampaignBidModifierService.GetCampaignBidModifier
Used as field type in: ,
string resource_name = 1
The resource name of the campaign bid modifier. Campaign bid modifier resource names have the form: `customers/{customer_id}/campaignBidModifiers/{campaign_id}~{criterion_id}`
optional campaign = 2
The campaign to which this criterion belongs.
optional criterion_id = 3
The ID of the criterion to bid modify. This field is ignored for mutates.
optional bid_modifier = 4
The modifier for the bid when the criterion matches.
oneof criterion
The criterion of this campaign bid modifier.
interaction_type = 5
Criterion for interaction type. Only supported for search campaigns.
message
campaign_budget.proto:39A campaign budget.
Used as response type in: services.CampaignBudgetService.GetCampaignBudget
Used as field type in: ,
string resource_name = 1
The resource name of the campaign budget. Campaign budget resource names have the form: `customers/{customer_id}/campaignBudgets/{budget_id}`
optional id = 3
The ID of the campaign budget. A campaign budget is created using the CampaignBudgetService create operation and is assigned a budget ID. A budget ID can be shared across different campaigns; the system will then allocate the campaign budget among different campaigns to get optimum results.
optional name = 4
The name of the campaign budget. When creating a campaign budget through CampaignBudgetService, every explicitly shared campaign budget must have a non-null, non-empty name. Campaign budgets that are not explicitly shared derive their name from the attached campaign's name. The length of this string must be between 1 and 255, inclusive, in UTF-8 bytes, (trimmed).
optional amount_micros = 5
The amount of the budget, in the local currency for the account. Amount is specified in micros, where one million is equivalent to one currency unit. Monthly spend is capped at 30.4 times this amount.
optional total_amount_micros = 10
The lifetime amount of the budget, in the local currency for the account. Amount is specified in micros, where one million is equivalent to one currency unit.
enums.BudgetStatusEnum.BudgetStatus status = 6
The status of this campaign budget. This field is read-only.
enums.BudgetDeliveryMethodEnum.BudgetDeliveryMethod delivery_method = 7
The delivery method that determines the rate at which the campaign budget is spent. Defaults to STANDARD if unspecified in a create operation.
optional explicitly_shared = 8
Specifies whether the budget is explicitly shared. Defaults to true if unspecified in a create operation. If true, the budget was created with the purpose of sharing across one or more campaigns. If false, the budget was created with the intention of only being used with a single campaign. The budget's name and status will stay in sync with the campaign's name and status. Attempting to share the budget with a second campaign will result in an error. A non-shared budget can become an explicitly shared. The same operation must also assign the budget a name. A shared campaign budget can never become non-shared.
optional reference_count = 9
The number of campaigns actively using the budget. This field is read-only.
optional has_recommended_budget = 11
Indicates whether there is a recommended budget for this campaign budget. This field is read-only.
optional recommended_budget_amount_micros = 12
The recommended budget amount. If no recommendation is available, this will be set to the budget amount. Amount is specified in micros, where one million is equivalent to one currency unit. This field is read-only.
enums.BudgetPeriodEnum.BudgetPeriod period = 13
Period over which to spend the budget. Defaults to DAILY if not specified.
optional recommended_budget_estimated_change_weekly_clicks = 14
The estimated change in weekly clicks if the recommended budget is applied. This field is read-only.
optional recommended_budget_estimated_change_weekly_cost_micros = 15
The estimated change in weekly cost in micros if the recommended budget is applied. One million is equivalent to one currency unit. This field is read-only.
optional recommended_budget_estimated_change_weekly_interactions = 16
The estimated change in weekly interactions if the recommended budget is applied. This field is read-only.
optional recommended_budget_estimated_change_weekly_views = 17
The estimated change in weekly views if the recommended budget is applied. This field is read-only.
enums.BudgetTypeEnum.BudgetType type = 18
The type of the campaign budget.
message
campaign_criterion.proto:38A campaign criterion.
Used as response type in: services.CampaignCriterionService.GetCampaignCriterion
Used as field type in: ,
string resource_name = 1
The resource name of the campaign criterion. Campaign criterion resource names have the form: `customers/{customer_id}/campaignCriteria/{campaign_id}~{criterion_id}`
optional campaign = 4
The campaign to which the criterion belongs.
optional criterion_id = 5
The ID of the criterion. This field is ignored during mutate.
optional bid_modifier = 14
The modifier for the bids when the criterion matches. The modifier must be in the range: 0.1 - 10.0. Most targetable criteria types support modifiers. Use 0 to opt out of a Device type.
optional negative = 7
Whether to target (`false`) or exclude (`true`) the criterion.
enums.CriterionTypeEnum.CriterionType type = 6
The type of the criterion.
enums.CampaignCriterionStatusEnum.CampaignCriterionStatus status = 35
The status of the criterion.
oneof criterion
The campaign criterion. Exactly one must be set.
keyword = 8
Keyword.
placement = 9
Placement.
mobile_app_category = 10
Mobile app category.
mobile_application = 11
Mobile application.
location = 12
Location.
device = 13
Device.
ad_schedule = 15
Ad Schedule.
age_range = 16
Age range.
gender = 17
Gender.
income_range = 18
Income range.
parental_status = 19
Parental status.
user_list = 22
User List.
youtube_video = 20
YouTube Video.
youtube_channel = 21
YouTube Channel.
proximity = 23
Proximity.
topic = 24
Topic.
listing_scope = 25
Listing scope.
language = 26
Language.
ip_block = 27
IpBlock.
content_label = 28
ContentLabel.
carrier = 29
Carrier.
user_interest = 30
User Interest.
webpage = 31
Webpage.
operating_system_version = 32
Operating system version.
mobile_device = 33
Mobile Device.
location_group = 34
Location Group
custom_affinity = 36
Custom Affinity.
A campaign criterion simulation. Supported combinations of advertising channel type, criterion ids, simulation type and simulation modification method is detailed below respectively. SEARCH 30000,30001,30002 BID_MODIFIER UNIFORM SHOPPING 30000,30001,30002 BID_MODIFIER UNIFORM DISPLAY 30001 BID_MODIFIER UNIFORM
Used as response type in: services.CampaignCriterionSimulationService.GetCampaignCriterionSimulation
Used as field type in:
string resource_name = 1
The resource name of the campaign criterion simulation. Campaign criterion simulation resource names have the form: `customers/{customer_id}/campaignCriterionSimulations/{campaign_id}~{criterion_id}~{type}~{modification_method}~{start_date}~{end_date}`
optional campaign_id = 2
Campaign ID of the simulation.
optional criterion_id = 3
Criterion ID of the simulation.
enums.SimulationTypeEnum.SimulationType type = 4
The field that the simulation modifies.
enums.SimulationModificationMethodEnum.SimulationModificationMethod modification_method = 5
How the simulation modifies the field.
optional start_date = 6
First day on which the simulation is based, in YYYY-MM-DD format.
optional end_date = 7
Last day on which the simulation is based, in YYYY-MM-DD format.
oneof point_list
List of simulation points.
bid_modifier_point_list = 8
Simulation points if the simulation type is BID_MODIFIER.
message
campaign_draft.proto:36A campaign draft.
Used as response type in: services.CampaignDraftService.GetCampaignDraft
Used as field type in: ,
string resource_name = 1
The resource name of the campaign draft. Campaign draft resource names have the form: `customers/{customer_id}/campaignDrafts/{base_campaign_id}~{draft_id}`
optional draft_id = 2
The ID of the draft. This field is read-only.
optional base_campaign = 3
The base campaign to which the draft belongs.
optional name = 4
The name of the campaign draft. This field is required and should not be empty when creating new campaign drafts. It must not contain any null (code point 0x0), NL line feed (code point 0xA) or carriage return (code point 0xD) characters.
optional draft_campaign = 5
Resource name of the Campaign that results from overlaying the draft changes onto the base campaign. This field is read-only.
enums.CampaignDraftStatusEnum.CampaignDraftStatus status = 6
The status of the campaign draft. This field is read-only. When a new campaign draft is added, the status defaults to PROPOSED.
optional has_experiment_running = 7
Whether there is an experiment based on this draft currently serving.
optional long_running_operation = 8
The resource name of the long-running operation that can be used to poll for completion of draft promotion. This is only set if the draft promotion is in progress or finished.
message
campaign_experiment.proto:38An A/B experiment that compares the performance of the base campaign (the control) and a variation of that campaign (the experiment).
Used as response type in: services.CampaignExperimentService.GetCampaignExperiment
Used as field type in: , ,
string resource_name = 1
The resource name of the campaign experiment. Campaign experiment resource names have the form: `customers/{customer_id}/campaignExperiments/{campaign_experiment_id}`
optional id = 2
The ID of the campaign experiment. This field is read-only.
optional campaign_draft = 3
The campaign draft with staged changes to the base campaign.
optional name = 4
The name of the campaign experiment. This field is required when creating new campaign experiments and must not conflict with the name of another non-removed campaign experiment or campaign. It must not contain any null (code point 0x0), NL line feed (code point 0xA) or carriage return (code point 0xD) characters.
optional description = 5
The description of the experiment.
optional traffic_split_percent = 6
Share of traffic directed to experiment as a percent (must be between 1 and 99 inclusive. Base campaign receives the remainder of the traffic (100 - traffic_split_percent). Required for create.
enums.CampaignExperimentTrafficSplitTypeEnum.CampaignExperimentTrafficSplitType traffic_split_type = 7
Determines the behavior of the traffic split.
optional experiment_campaign = 8
The experiment campaign, as opposed to the base campaign.
enums.CampaignExperimentStatusEnum.CampaignExperimentStatus status = 9
The status of the campaign experiment. This field is read-only.
optional long_running_operation = 10
The resource name of the long-running operation that can be used to poll for completion of experiment create or promote. The most recent long running operation is returned.
optional start_date = 11
Date when the campaign experiment starts. By default, the experiment starts now or on the campaign's start date, whichever is later. If this field is set, then the experiment starts at the beginning of the specified date in the customer's time zone. Cannot be changed once the experiment starts. Format: YYYY-MM-DD Example: 2019-03-14
optional end_date = 12
Date when the campaign experiment ends. By default, the experiment ends on the campaign's end date. If this field is set, then the experiment ends at the end of the specified date in the customer's time zone. Format: YYYY-MM-DD Example: 2019-04-18
A campaign extension setting.
Used as response type in: services.CampaignExtensionSettingService.GetCampaignExtensionSetting
Used as field type in: ,
string resource_name = 1
The resource name of the campaign extension setting. CampaignExtensionSetting resource names have the form: `customers/{customer_id}/campaignExtensionSettings/{campaign_id}~{extension_type}`
enums.ExtensionTypeEnum.ExtensionType extension_type = 2
The extension type of the customer extension setting.
optional campaign = 3
The resource name of the campaign. The linked extension feed items will serve under this campaign. Campaign resource names have the form: `customers/{customer_id}/campaigns/{campaign_id}`
repeated extension_feed_items = 4
The resource names of the extension feed items to serve under the campaign. ExtensionFeedItem resource names have the form: `customers/{customer_id}/extensionFeedItems/{feed_item_id}`
enums.ExtensionSettingDeviceEnum.ExtensionSettingDevice device = 5
The device for which the extensions will serve. Optional.
message
campaign_feed.proto:38A campaign feed.
Used as response type in: services.CampaignFeedService.GetCampaignFeed
Used as field type in: ,
string resource_name = 1
The resource name of the campaign feed. Campaign feed resource names have the form: `customers/{customer_id}/campaignFeeds/{campaign_id}~{feed_id}
optional feed = 2
The feed to which the CampaignFeed belongs.
optional campaign = 3
The campaign to which the CampaignFeed belongs.
repeated enums.PlaceholderTypeEnum.PlaceholderType placeholder_types = 4
Indicates which placeholder types the feed may populate under the connected campaign. Required.
optional matching_function = 5
Matching function associated with the CampaignFeed. The matching function is used to filter the set of feed items selected. Required.
enums.FeedLinkStatusEnum.FeedLinkStatus status = 6
Status of the campaign feed. This field is read-only.
message
campaign_label.proto:35Represents a relationship between a campaign and a label.
Used as response type in: services.CampaignLabelService.GetCampaignLabel
Used as field type in: ,
string resource_name = 1
Name of the resource. Campaign label resource names have the form: `customers/{customer_id}/campaignLabels/{campaign_id}~{label_id}`
optional campaign = 2
The campaign to which the label is attached.
optional label = 3
The label assigned to the campaign.
message
campaign_shared_set.proto:37CampaignSharedSets are used for managing the shared sets associated with a campaign.
Used as response type in: services.CampaignSharedSetService.GetCampaignSharedSet
Used as field type in: ,
string resource_name = 1
The resource name of the campaign shared set. Campaign shared set resource names have the form: `customers/{customer_id}/campaignSharedSets/{campaign_id}~{shared_set_id}`
optional campaign = 3
The campaign to which the campaign shared set belongs.
optional shared_set = 4
The shared set associated with the campaign. This may be a negative keyword shared set of another customer. This customer should be a manager of the other customer, otherwise the campaign shared set will exist but have no serving effect. Only negative keyword shared sets can be associated with Shopping campaigns. Only negative placement shared sets can be associated with Display mobile app campaigns.
enums.CampaignSharedSetStatusEnum.CampaignSharedSetStatus status = 2
The status of this campaign shared set. Read only.
message
carrier_constant.proto:35A carrier criterion that can be used in campaign targeting.
Used as response type in: services.CarrierConstantService.GetCarrierConstant
Used as field type in:
string resource_name = 1
The resource name of the carrier criterion. Carrier criterion resource names have the form: `carrierConstants/{criterion_id}`
optional id = 2
The ID of the carrier criterion.
optional name = 3
The full name of the carrier in English.
optional country_code = 4
The country code of the country where the carrier is located, e.g., "AR", "FR", etc.
message
change_status.proto:37Describes the status of returned resource.
Used as response type in: services.ChangeStatusService.GetChangeStatus
Used as field type in:
string resource_name = 1
The resource name of the change status. Change status resource names have the form: `customers/{customer_id}/changeStatus/{change_status_id}`
optional last_change_date_time = 3
Time at which the most recent change has occurred on this resource.
enums.ChangeStatusResourceTypeEnum.ChangeStatusResourceType resource_type = 4
Represents the type of the changed resource. This dictates what fields will be set. For example, for AD_GROUP, campaign and ad_group fields will be set.
optional campaign = 5
The Campaign affected by this change.
optional ad_group = 6
The AdGroup affected by this change.
enums.ChangeStatusOperationEnum.ChangeStatusOperation resource_status = 8
Represents the status of the changed resource.
optional ad_group_ad = 9
The AdGroupAd affected by this change.
optional ad_group_criterion = 10
The AdGroupCriterion affected by this change.
optional campaign_criterion = 11
The CampaignCriterion affected by this change.
optional feed = 12
The Feed affected by this change.
optional feed_item = 13
The FeedItem affected by this change.
optional ad_group_feed = 14
The AdGroupFeed affected by this change.
optional campaign_feed = 15
The CampaignFeed affected by this change.
optional ad_group_bid_modifier = 16
The AdGroupBidModifier affected by this change.
message
click_view.proto:38A click view with metrics aggregated at each click level, including both valid and invalid clicks. For non-Search campaigns, metrics.clicks represents the number of valid and invalid interactions.
Used as response type in: services.ClickViewService.GetClickView
Used as field type in:
string resource_name = 1
The resource name of the click view. Click view resource names have the form: `customers/{customer_id}/clickViews/{date (yyyy-MM-dd)}~{gclid}`
optional gclid = 2
The Google Click ID.
optional area_of_interest = 3
The location criteria matching the area of interest associated with the impression.
optional location_of_presence = 4
The location criteria matching the location of presence associated with the impression.
optional page_number = 5
Page number in search results where the ad was shown.
optional ad_group_ad = 7
The associated ad.
message
conversion_action.proto:42A conversion action.
Used as response type in: services.ConversionActionService.GetConversionAction
Used as field type in: ,
string resource_name = 1
The resource name of the conversion action. Conversion action resource names have the form: `customers/{customer_id}/conversionActions/{conversion_action_id}`
optional id = 2
The ID of the conversion action.
optional name = 3
The name of the conversion action. This field is required and should not be empty when creating new conversion actions.
enums.ConversionActionStatusEnum.ConversionActionStatus status = 4
The status of this conversion action for conversion event accrual.
enums.ConversionActionTypeEnum.ConversionActionType type = 5
The type of this conversion action.
enums.ConversionActionCategoryEnum.ConversionActionCategory category = 6
The category of conversions reported for this conversion action.
optional owner_customer = 7
The resource name of the conversion action owner customer, or null if this is a system-defined conversion action.
optional include_in_conversions_metric = 8
Whether this conversion action should be included in the "conversions" metric.
optional click_through_lookback_window_days = 9
The maximum number of days that may elapse between an interaction (e.g., a click) and a conversion event.
optional view_through_lookback_window_days = 10
The maximum number of days which may elapse between an impression and a conversion without an interaction.
optional value_settings = 11
Settings related to the value for conversion events associated with this conversion action.
enums.ConversionActionCountingTypeEnum.ConversionActionCountingType counting_type = 12
How to count conversion events for the conversion action.
optional attribution_model_settings = 13
Settings related to this conversion action's attribution model.
repeated tag_snippets = 14
The snippets used for tracking conversions.
optional phone_call_duration_seconds = 15
The phone call duration in seconds after which a conversion should be reported for this conversion action. The value must be between 0 and 10000, inclusive.
optional app_id = 16
App ID for an app conversion action.
message
conversion_action.proto:44Settings related to this conversion action's attribution model.
Used in:
enums.AttributionModelEnum.AttributionModel attribution_model = 1
The attribution model type of this conversion action.
enums.DataDrivenModelStatusEnum.DataDrivenModelStatus data_driven_model_status = 2
The status of the data-driven attribution model for the conversion action.
message
conversion_action.proto:55Settings related to the value for conversion events associated with this conversion action.
Used in:
optional default_value = 1
The value to use when conversion events for this conversion action are sent with an invalid, disallowed or missing value, or when this conversion action is configured to always use the default value.
optional default_currency_code = 2
The currency code to use when conversion events for this conversion action are sent with an invalid or missing currency code, or when this conversion action is configured to always use the default value.
optional always_use_default_value = 3
Controls whether the default value and default currency code are used in place of the value and currency code specified in conversion events for this conversion action.
message
customer.proto:108A collection of customer-wide settings related to Google Ads Conversion Tracking.
Used in:
optional conversion_tracking_id = 1
The conversion tracking id used for this account. This id is automatically assigned after any conversion tracking feature is used. If the customer doesn't use conversion tracking, this is 0. This field is read-only.
optional cross_account_conversion_tracking_id = 2
The conversion tracking id of the customer's manager. This is set when the customer is opted into cross account conversion tracking, and it overrides conversion_tracking_id. This field can only be managed through the Google Ads UI. This field is read-only.
message
custom_interest.proto:38A custom interest. This is a list of users by interest.
Used as response type in: services.CustomInterestService.GetCustomInterest
Used as field type in: ,
string resource_name = 1
The resource name of the custom interest. Custom interest resource names have the form: `customers/{customer_id}/customInterests/{custom_interest_id}`
optional id = 2
Id of the custom interest.
enums.CustomInterestStatusEnum.CustomInterestStatus status = 3
Status of this custom interest. Indicates whether the custom interest is enabled or removed.
optional name = 4
Name of the custom interest. It should be unique across the same custom affinity audience. This field is required for create operations.
enums.CustomInterestTypeEnum.CustomInterestType type = 5
Type of the custom interest, CUSTOM_AFFINITY or CUSTOM_INTENT. By default the type is set to CUSTOM_AFFINITY.
optional description = 6
Description of this custom interest audience.
repeated members = 7
List of custom interest members that this custom interest is composed of. Members can be added during CustomInterest creation. If members are presented in UPDATE operation, existing members will be overridden.
message
custom_interest.proto:72A member of custom interest audience. A member can be a keyword or url. It is immutable, that is, it can only be created or removed but not changed.
Used in:
enums.CustomInterestMemberTypeEnum.CustomInterestMemberType member_type = 1
The type of custom interest member, KEYWORD or URL.
optional parameter = 2
Keyword text when member_type is KEYWORD or URL string when member_type is URL.
message
customer.proto:36A customer.
Used as response type in: services.CustomerService.GetCustomer
Used as field type in: , ,
string resource_name = 1
The resource name of the customer. Customer resource names have the form: `customers/{customer_id}`
optional id = 3
The ID of the customer.
optional descriptive_name = 4
Optional, non-unique descriptive name of the customer.
optional currency_code = 5
The currency in which the account operates. A subset of the currency codes from the ISO 4217 standard is supported.
optional time_zone = 6
The local timezone ID of the customer.
optional tracking_url_template = 7
The URL template for constructing a tracking URL out of parameters.
optional final_url_suffix = 11
The URL template for appending params to the final URL
optional auto_tagging_enabled = 8
Whether auto-tagging is enabled for the customer.
optional has_partners_badge = 9
Whether the Customer has a Partners program badge. If the Customer is not associated with the Partners program, this will be false. For more information, see https://support.google.com/partners/answer/3125774.
optional manager = 12
Whether the customer is a manager.
optional test_account = 13
Whether the customer is a test account.
optional call_reporting_setting = 10
Call reporting setting for a customer.
optional conversion_tracking_setting = 14
Conversion tracking setting for a customer.
optional remarketing_setting = 15
Remarketing setting for a customer.
repeated enums.CustomerPayPerConversionEligibilityFailureReasonEnum.CustomerPayPerConversionEligibilityFailureReason pay_per_conversion_eligibility_failure_reasons = 16
Reasons why the customer is not eligible to use PaymentMode.CONVERSIONS. If the list is empty, the customer is eligible. This field is read-only.
message
customer_client.proto:37A link between the given customer and a client customer. CustomerClients only exist for manager customers. All direct and indirect client customers are included, as well as the manager itself.
Used as response type in: services.CustomerClientService.GetCustomerClient
Used as field type in:
string resource_name = 1
The resource name of the customer client. CustomerClient resource names have the form: `customers/{customer_id}/customerClients/{client_customer_id}`
optional client_customer = 3
The resource name of the client-customer which is linked to the given customer. Read only.
optional hidden = 4
Specifies whether this is a [hidden account](https://support.google.com/google-ads/answer/7519830). Read only.
optional level = 5
Distance between given customer and client. For self link, the level value will be 0. Read only.
optional time_zone = 6
Common Locale Data Repository (CLDR) string representation of the time zone of the client, e.g. America/Los_Angeles. Read only.
optional test_account = 7
Identifies if the client is a test account. Read only.
optional manager = 8
Identifies if the client is a manager. Read only.
optional descriptive_name = 9
Descriptive name for the client. Read only.
optional currency_code = 10
Currency code (e.g. 'USD', 'EUR') for the client. Read only.
optional id = 11
The ID of the client customer. Read only.
message
customer_client_link.proto:36Represents customer client link relationship.
Used as response type in: services.CustomerClientLinkService.GetCustomerClientLink
Used as field type in: ,
string resource_name = 1
Name of the resource. CustomerClientLink resource names have the form: `customers/{customer_id}/customerClientLinks/{client_customer_id}~{manager_link_id}`
optional client_customer = 3
The client customer linked to this customer.
optional manager_link_id = 4
This is uniquely identifies a customer client link. Read only.
enums.ManagerLinkStatusEnum.ManagerLinkStatus status = 5
This is the status of the link between client and manager.
optional hidden = 6
The visibility of the link. Users can choose whether or not to see hidden links in the AdWords UI. Default value is false
A customer extension setting.
Used as response type in: services.CustomerExtensionSettingService.GetCustomerExtensionSetting
Used as field type in: ,
string resource_name = 1
The resource name of the customer extension setting. CustomerExtensionSetting resource names have the form: `customers/{customer_id}/customerExtensionSettings/{extension_type}`
enums.ExtensionTypeEnum.ExtensionType extension_type = 2
The extension type of the customer extension setting.
repeated extension_feed_items = 3
The resource names of the extension feed items to serve under the customer. ExtensionFeedItem resource names have the form: `customers/{customer_id}/extensionFeedItems/{feed_item_id}`
enums.ExtensionSettingDeviceEnum.ExtensionSettingDevice device = 4
The device for which the extensions will serve. Optional.
message
customer_feed.proto:38A customer feed.
Used as response type in: services.CustomerFeedService.GetCustomerFeed
Used as field type in: ,
string resource_name = 1
The resource name of the customer feed. Customer feed resource names have the form: `customers/{customer_id}/customerFeeds/{feed_id}`
optional feed = 2
The feed being linked to the customer.
repeated enums.PlaceholderTypeEnum.PlaceholderType placeholder_types = 3
Indicates which placeholder types the feed may populate under the connected customer. Required.
optional matching_function = 4
Matching function associated with the CustomerFeed. The matching function is used to filter the set of feed items selected. Required.
enums.FeedLinkStatusEnum.FeedLinkStatus status = 5
Status of the customer feed. This field is read-only.
message
customer_label.proto:37Represents a relationship between a customer and a label. This customer may not have access to all the labels attached to it. Additional CustomerLabels may be returned by increasing permissions with login-customer-id.
Used as response type in: services.CustomerLabelService.GetCustomerLabel
Used as field type in: ,
string resource_name = 1
Name of the resource. Customer label resource names have the form: `customers/{customer_id}/customerLabels/{label_id}`
optional customer = 2
The resource name of the customer to which the label is attached. Read only.
optional label = 3
The resource name of the label assigned to the customer. Note: the Customer ID portion of the label resource name is not validated when creating a new CustomerLabel.
message
customer_manager_link.proto:36Represents customer-manager link relationship.
Used as response type in: services.CustomerManagerLinkService.GetCustomerManagerLink
Used as field type in: ,
string resource_name = 1
Name of the resource. CustomerManagerLink resource names have the form: `customers/{customer_id}/customerManagerLinks/{manager_customer_id}~{manager_link_id}`
optional manager_customer = 3
The manager customer linked to the customer.
optional manager_link_id = 4
ID of the customer-manager link. This field is read only.
enums.ManagerLinkStatusEnum.ManagerLinkStatus status = 5
Status of the link between the customer and the manager.
A negative criterion for exclusions at the customer level.
Used as response type in: services.CustomerNegativeCriterionService.GetCustomerNegativeCriterion
Used as field type in: ,
string resource_name = 1
The resource name of the customer negative criterion. Customer negative criterion resource names have the form: `customers/{customer_id}/customerNegativeCriteria/{criterion_id}`
optional id = 2
The ID of the criterion.
enums.CriterionTypeEnum.CriterionType type = 3
The type of the criterion.
oneof criterion
The customer negative criterion. Exactly one must be set.
content_label = 4
ContentLabel.
mobile_application = 5
MobileApplication.
mobile_app_category = 6
MobileAppCategory.
placement = 7
Placement.
youtube_video = 8
YouTube Video.
youtube_channel = 9
YouTube Channel.
message
detail_placement_view.proto:36A view with metrics aggregated by ad group and URL or YouTube video.
Used as response type in: services.DetailPlacementViewService.GetDetailPlacementView
Used as field type in:
string resource_name = 1
The resource name of the detail placement view. Detail placement view resource names have the form: `customers/{customer_id}/detailPlacementViews/{ad_group_id}~{base64_placement}`
optional placement = 2
The automatic placement string at detail level, e. g. website URL, mobile application ID, or a YouTube video ID.
optional display_name = 3
The display name is URL name for websites, YouTube video name for YouTube videos, and translated mobile app name for mobile apps.
optional group_placement_target_url = 4
URL of the group placement, e.g. domain, link to the mobile application in app store, or a YouTube channel URL.
optional target_url = 5
URL of the placement, e.g. website, link to the mobile application in app store, or a YouTube video URL.
enums.PlacementTypeEnum.PlacementType placement_type = 6
Type of the placement, e.g. Website, YouTube Video, and Mobile Application.
message
display_keyword_view.proto:34A display keyword view.
Used as response type in: services.DisplayKeywordViewService.GetDisplayKeywordView
Used as field type in:
string resource_name = 1
The resource name of the display keyword view. Display Keyword view resource names have the form: `customers/{customer_id}/displayKeywordViews/{ad_group_id}~{criterion_id}`
message
distance_view.proto:40A distance view with metrics aggregated by the user’s distance from an advertiser’s location extensions. Each DistanceBucket includes all impressions that fall within its distance and a single impression will contribute to the metrics for all DistanceBuckets that include the user’s distance.
Used as response type in: services.DistanceViewService.GetDistanceView
Used as field type in:
string resource_name = 1
The resource name of the distance view. Distance view resource names have the form: `customers/{customer_id}/distanceViews/1~{distance_bucket}`
enums.DistanceBucketEnum.DistanceBucket distance_bucket = 2
Grouping of user distance from location extensions.
optional metric_system = 3
True if the DistanceBucket is using the metric system, false otherwise.
message
domain_category.proto:38A category generated automatically by crawling a domain. If a campaign uses the DynamicSearchAdsSetting, then domain categories will be generated for the domain. The categories can be targeted using WebpageConditionInfo. See: https://support.google.com/google-ads/answer/2471185
Used as response type in: services.DomainCategoryService.GetDomainCategory
Used as field type in:
string resource_name = 1
The resource name of the domain category. Domain category resource names have the form: `customers/{customer_id}/domainCategories/{campaign_id}~{category_base64}~{language_code}`
optional campaign = 2
The campaign this category is recommended for.
optional category = 3
Recommended category for the website domain. e.g. if you have a website about electronics, the categories could be "cameras", "televisions", etc.
optional language_code = 4
The language code specifying the language of the website. e.g. "en" for English. The language can be specified in the DynamicSearchAdsSetting required for dynamic search ads. This is the language of the pages from your website that you want Google Ads to find, create ads for, and match searches with.
optional domain = 5
The domain for the website. The domain can be specified in the DynamicSearchAdsSetting required for dynamic search ads.
optional coverage_fraction = 6
Fraction of pages on your site that this category matches.
optional category_rank = 7
The position of this category in the set of categories. Lower numbers indicate a better match for the domain. null indicates not recommended.
optional has_children = 8
Indicates whether this category has sub-categories.
optional recommended_cpc_bid_micros = 9
The recommended cost per click for the category.
A dynamic search ads search term view.
Used as response type in: services.DynamicSearchAdsSearchTermViewService.GetDynamicSearchAdsSearchTermView
Used as field type in:
string resource_name = 1
The resource name of the dynamic search ads search term view. Dynamic search ads search term view resource names have the form: `customers/{customer_id}/dynamicSearchAdsSearchTermViews/{ad_group_id}~{search_term_fp}~{headline_fp}~{landing_page_fp}~{page_url_fp}`
optional search_term = 2
Search term This field is read-only.
optional headline = 3
The dynamically generated headline of the Dynamic Search Ad. This field is read-only.
optional landing_page = 4
The dynamically selected landing page URL of the impression. This field is read-only.
optional page_url = 5
The URL of page feed item served for the impression. This field is read-only.
A landing page view with metrics aggregated at the expanded final URL level.
Used as response type in: services.ExpandedLandingPageViewService.GetExpandedLandingPageView
Used as field type in:
string resource_name = 1
The resource name of the expanded landing page view. Expanded landing page view resource names have the form: `customers/{customer_id}/expandedLandingPageViews/{expanded_final_url_fingerprint}`
optional expanded_final_url = 2
The final URL that clicks are directed to.
message
extension_feed_item.proto:40An extension feed item.
Used as response type in: services.ExtensionFeedItemService.GetExtensionFeedItem
Used as field type in: ,
string resource_name = 1
The resource name of the extension feed item. Extension feed item resource names have the form: `customers/{customer_id}/extensionFeedItems/{feed_item_id}`
optional id = 24
The ID of this feed item. Read-only.
enums.ExtensionTypeEnum.ExtensionType extension_type = 13
The extension type of the extension feed item. This field is read-only.
optional start_date_time = 5
Start time in which this feed item is effective and can begin serving. The time is in the customer's time zone. The format is "YYYY-MM-DD HH:MM:SS". Examples: "2018-03-05 09:15:00" or "2018-02-01 14:34:30"
optional end_date_time = 6
End time in which this feed item is no longer effective and will stop serving. The time is in the customer's time zone. The format is "YYYY-MM-DD HH:MM:SS". Examples: "2018-03-05 09:15:00" or "2018-02-01 14:34:30"
repeated ad_schedules = 16
List of non-overlapping schedules specifying all time intervals for which the feed item may serve. There can be a maximum of 6 schedules per day.
enums.FeedItemTargetDeviceEnum.FeedItemTargetDevice device = 17
The targeted device.
optional targeted_geo_target_constant = 20
The targeted geo target constant.
optional targeted_keyword = 22
The targeted keyword.
enums.FeedItemStatusEnum.FeedItemStatus status = 4
Status of the feed item. This field is read-only.
oneof extension
Extension type.
sitelink_feed_item = 2
Sitelink extension.
structured_snippet_feed_item = 3
Structured snippet extension.
app_feed_item = 7
App extension.
call_feed_item = 8
Call extension.
callout_feed_item = 9
Callout extension.
text_message_feed_item = 10
Text message extension.
price_feed_item = 11
Price extension.
promotion_feed_item = 12
Promotion extension.
location_feed_item = 14
Location extension. Locations are synced from a GMB account into a feed. This field is read-only.
affiliate_location_feed_item = 15
Affiliate location extension. Feed locations are populated by Google Ads based on a chain ID. This field is read-only.
hotel_callout_feed_item = 23
Hotel Callout extension.
oneof serving_resource_targeting
Targeting at either the campaign or ad group level. Feed items that target a campaign or ad group will only serve with that resource.
targeted_campaign = 18
The targeted campaign.
targeted_ad_group = 19
The targeted ad group.
message
feed.proto:39A feed.
Used as response type in: services.FeedService.GetFeed
Used as field type in: ,
string resource_name = 1
The resource name of the feed. Feed resource names have the form: `customers/{customer_id}/feeds/{feed_id}`
optional id = 2
The ID of the feed. This field is read-only.
optional name = 3
Name of the feed. Required.
repeated attributes = 4
The Feed's attributes. Required on CREATE. Disallowed on UPDATE. Use attribute_operations to add new attributes.
repeated attribute_operations = 9
The list of operations changing the feed attributes. Attributes can only be added, not removed.
enums.FeedOriginEnum.FeedOrigin origin = 5
Specifies who manages the FeedAttributes for the Feed.
enums.FeedStatusEnum.FeedStatus status = 8
Status of the feed. This field is read-only.
oneof system_feed_generation_data
The system data for the Feed. This data specifies information for generating the feed items of the system generated feed.
places_location_feed_data = 6
Data used to configure a location feed populated from Google My Business Locations.
affiliate_location_feed_data = 7
Data used to configure an affiliate location feed populated with the specified chains.
message
feed.proto:90Data used to configure an affiliate location feed populated with the specified chains.
Used in:
repeated chain_ids = 1
The list of chains that the affiliate location feed will sync the locations from.
enums.AffiliateLocationFeedRelationshipTypeEnum.AffiliateLocationFeedRelationshipType relationship_type = 2
The relationship the chains have with the advertiser.
message
feed.proto:42Data used to configure a location feed populated from Google My Business Locations.
Used in:
optional oauth_info = 1
Required authentication token (from OAuth API) for the email. This field can only be specified in a create request. All its subfields are not selectable.
optional email_address = 2
Email address of a Google My Business account or email address of a manager of the Google My Business account. Required.
optional business_account_id = 10
Plus page ID of the managed business whose locations should be used. If this field is not set, then all businesses accessible by the user (specified by email_address) are used. This field is mutate-only and is not selectable.
optional business_name_filter = 4
Used to filter Google My Business listings by business name. If business_name_filter is set, only listings with a matching business name are candidates to be sync'd into FeedItems.
repeated category_filters = 5
Used to filter Google My Business listings by categories. If entries exist in category_filters, only listings that belong to any of the categories are candidates to be sync'd into FeedItems. If no entries exist in category_filters, then all listings are candidates for syncing.
repeated label_filters = 6
Used to filter Google My Business listings by labels. If entries exist in label_filters, only listings that has any of the labels set are candidates to be synchronized into FeedItems. If no entries exist in label_filters, then all listings are candidates for syncing.
message
feed.proto:44Data used for authorization using OAuth.
Used in:
optional http_method = 1
The HTTP method used to obtain authorization.
optional http_request_url = 2
The HTTP request URL used to obtain authorization.
optional http_authorization_header = 3
The HTTP authorization header used to obtain authorization.
message
feed.proto:144FeedAttributes define the types of data expected to be present in a Feed. A single FeedAttribute specifies the expected type of the FeedItemAttributes with the same FeedAttributeId. Optionally, a FeedAttribute can be marked as being part of a FeedItem's unique key.
Used in: ,
optional id = 1
ID of the attribute.
optional name = 2
The name of the attribute. Required.
enums.FeedAttributeTypeEnum.FeedAttributeType type = 3
Data type for feed attribute. Required.
optional is_part_of_key = 4
Indicates that data corresponding to this attribute is part of a FeedItem's unique key. It defaults to false if it is unspecified. Note that a unique key is not required in a Feed's schema, in which case the FeedItems must be referenced by their feed_item_id.
message
feed.proto:162Operation to be performed on a feed attribute list in a mutate.
Used in:
FeedAttributeOperation.Operator operator = 1
Type of list operation to perform.
optional value = 2
The feed attribute being added to the list.
The operator.
Used in:
UNSPECIFIED = 0
Unspecified.
UNKNOWN = 1
Used for return value only. Represents value unknown in this version.
ADD = 2
Add the attribute to the existing attributes.
message
feed_item.proto:47A feed item.
Used as response type in: services.FeedItemService.GetFeedItem
Used as field type in: ,
string resource_name = 1
The resource name of the feed item. Feed item resource names have the form: `customers/{customer_id}/feedItems/{feed_id}~{feed_item_id}`
optional feed = 2
The feed to which this feed item belongs.
optional id = 3
The ID of this feed item.
optional start_date_time = 4
Start time in which this feed item is effective and can begin serving. The time is in the customer's time zone. The format is "YYYY-MM-DD HH:MM:SS". Examples: "2018-03-05 09:15:00" or "2018-02-01 14:34:30"
optional end_date_time = 5
End time in which this feed item is no longer effective and will stop serving. The time is in the customer's time zone. The format is "YYYY-MM-DD HH:MM:SS". Examples: "2018-03-05 09:15:00" or "2018-02-01 14:34:30"
repeated attribute_values = 6
The feed item's attribute values.
enums.GeoTargetingRestrictionEnum.GeoTargetingRestriction geo_targeting_restriction = 7
Geo targeting restriction specifies the type of location that can be used for targeting.
repeated url_custom_parameters = 8
The list of mappings used to substitute custom parameter tags in a `tracking_url_template`, `final_urls`, or `mobile_final_urls`.
enums.FeedItemStatusEnum.FeedItemStatus status = 9
Status of the feed item. This field is read-only.
repeated policy_infos = 10
List of info about a feed item's validation and approval state for active feed mappings. There will be an entry in the list for each type of feed mapping associated with the feed, e.g. a feed with a sitelink and a call feed mapping would cause every feed item associated with that feed to have an entry in this list for both sitelink and call. This field is read-only.
message
feed_item.proto:97A feed item attribute value.
Used in:
optional feed_attribute_id = 1
Id of the feed attribute for which the value is associated with.
optional integer_value = 2
Int64 value. Should be set if feed_attribute_id refers to a feed attribute of type INT64.
optional boolean_value = 3
Bool value. Should be set if feed_attribute_id refers to a feed attribute of type BOOLEAN.
optional string_value = 4
String value. Should be set if feed_attribute_id refers to a feed attribute of type STRING, URL or DATE_TIME. For STRING the maximum length is 1500 characters. For URL the maximum length is 2076 characters. For DATE_TIME the format of the string must be the same as start and end time for the feed item.
optional double_value = 5
Double value. Should be set if feed_attribute_id refers to a feed attribute of type DOUBLE.
optional price_value = 6
Price value. Should be set if feed_attribute_id refers to a feed attribute of type PRICE.
repeated integer_values = 7
Repeated int64 value. Should be set if feed_attribute_id refers to a feed attribute of type INT64_LIST.
repeated boolean_values = 8
Repeated bool value. Should be set if feed_attribute_id refers to a feed attribute of type BOOLEAN_LIST.
repeated string_values = 9
Repeated string value. Should be set if feed_attribute_id refers to a feed attribute of type STRING_LIST, URL_LIST or DATE_TIME_LIST. For STRING_LIST and URL_LIST the total size of the list in bytes may not exceed 3000. For DATE_TIME_LIST the number of elements may not exceed 200. For STRING_LIST the maximum length of each string element is 1500 characters. For URL_LIST the maximum length is 2076 characters. For DATE_TIME the format of the string must be the same as start and end time for the feed item.
repeated double_values = 10
Repeated double value. Should be set if feed_attribute_id refers to a feed attribute of type DOUBLE_LIST.
message
feed_item.proto:150Policy, validation, and quality approval info for a feed item for the specified placeholder type.
Used in:
enums.PlaceholderTypeEnum.PlaceholderType placeholder_type_enum = 10
The placeholder type.
optional feed_mapping_resource_name = 2
The FeedMapping that contains the placeholder type.
enums.PolicyReviewStatusEnum.PolicyReviewStatus review_status = 3
Where the placeholder type is in the review process.
enums.PolicyApprovalStatusEnum.PolicyApprovalStatus approval_status = 4
The overall approval status of the placeholder type, calculated based on the status of its individual policy topic entries.
repeated policy_topic_entries = 5
The list of policy findings for the placeholder type.
enums.FeedItemValidationStatusEnum.FeedItemValidationStatus validation_status = 6
The validation status of the palceholder type.
repeated validation_errors = 7
List of placeholder type validation errors.
enums.FeedItemQualityApprovalStatusEnum.FeedItemQualityApprovalStatus quality_approval_status = 8
Placeholder type quality evaluation approval status.
repeated enums.FeedItemQualityDisapprovalReasonEnum.FeedItemQualityDisapprovalReason quality_disapproval_reasons = 9
List of placeholder type quality evaluation disapproval reasons.
message
feed_item_target.proto:38A feed item target.
Used as response type in: services.FeedItemTargetService.GetFeedItemTarget
Used as field type in: ,
string resource_name = 1
The resource name of the feed item target. Feed item target resource names have the form: `customers/{customer_id}/feedItemTargets/{feed_id}~{feed_item_id}~{feed_item_target_type}~{feed_item_target_id}`
optional feed_item = 2
The feed item to which this feed item target belongs.
enums.FeedItemTargetTypeEnum.FeedItemTargetType feed_item_target_type = 3
The target type of this feed item target. This field is read-only.
optional feed_item_target_id = 6
The ID of the targeted resource. This field is read-only.
oneof target
The targeted resource.
campaign = 4
The targeted campaign.
ad_group = 5
The targeted ad group.
keyword = 7
The targeted keyword.
geo_target_constant = 8
The targeted geo target constant resource name.
enums.FeedItemTargetDeviceEnum.FeedItemTargetDevice device = 9
The targeted device.
ad_schedule = 10
The targeted schedule.
message
feed_item.proto:182Stores a validation error and the set of offending feed attributes which together are responsible for causing a feed item validation error.
Used in:
errors.FeedItemValidationErrorEnum.FeedItemValidationError validation_error = 1
Error code indicating what validation error was triggered. The description of the error can be found in the 'description' field.
optional description = 2
The description of the validation error.
repeated feed_attribute_ids = 3
Set of feed attributes in the feed item flagged during validation. If empty, no specific feed attributes can be associated with the error (e.g. error across the entire feed item).
optional extra_info = 5
Any extra information related to this error which is not captured by validation_error and feed_attribute_id (e.g. placeholder field IDs when feed_attribute_id is not mapped). Note that extra_info is not localized.
message
feed_mapping.proto:59A feed mapping.
Used as response type in: services.FeedMappingService.GetFeedMapping
Used as field type in: ,
string resource_name = 1
The resource name of the feed mapping. Feed mapping resource names have the form: `customers/{customer_id}/feedMappings/{feed_id}~{feed_mapping_id}`
optional feed = 2
The feed of this feed mapping.
repeated attribute_field_mappings = 5
Feed attributes to field mappings. These mappings are a one-to-many relationship meaning that 1 feed attribute can be used to populate multiple placeholder fields, but 1 placeholder field can only draw data from 1 feed attribute. Ad Customizer is an exception, 1 placeholder field can be mapped to multiple feed attributes. Required.
enums.FeedMappingStatusEnum.FeedMappingStatus status = 6
Status of the feed mapping. This field is read-only.
oneof target
Feed mapping target. Can be either a placeholder or a criterion. For a given feed, the active FeedMappings must have unique targets. Required.
enums.PlaceholderTypeEnum.PlaceholderType placeholder_type = 3
The placeholder type of this mapping (i.e., if the mapping maps feed attributes to placeholder fields).
enums.FeedMappingCriterionTypeEnum.FeedMappingCriterionType criterion_type = 4
The criterion type of this mapping (i.e., if the mapping maps feed attributes to criterion fields).
message
feed_placeholder_view.proto:35A feed placeholder view.
Used as response type in: services.FeedPlaceholderViewService.GetFeedPlaceholderView
Used as field type in:
string resource_name = 1
The resource name of the feed placeholder view. Feed placeholder view resource names have the form: `customers/{customer_id}/feedPlaceholderViews/{placeholder_type}`
enums.PlaceholderTypeEnum.PlaceholderType placeholder_type = 2
The placeholder type of the feed placeholder view.
message
gender_view.proto:34A gender view.
Used as response type in: services.GenderViewService.GetGenderView
Used as field type in:
string resource_name = 1
The resource name of the gender view. Gender view resource names have the form: `customers/{customer_id}/genderViews/{ad_group_id}~{criterion_id}`
message
geo_target_constant.proto:36A geo target constant.
Used as response type in: services.GeoTargetConstantService.GetGeoTargetConstant
Used as field type in: ,
string resource_name = 1
The resource name of the geo target constant. Geo target constant resource names have the form: `geoTargetConstants/{geo_target_constant_id}`
optional id = 3
The ID of the geo target constant.
optional name = 4
Geo target constant English name.
optional country_code = 5
The ISO-3166-1 alpha-2 country code that is associated with the target.
optional target_type = 6
Geo target constant target type.
enums.GeoTargetConstantStatusEnum.GeoTargetConstantStatus status = 7
Geo target constant status.
optional canonical_name = 8
The fully qualified English name, consisting of the target's name and that of its parent and country.
message
geographic_view.proto:41A geographic view. Geographic View includes all metrics aggregated at the country level, one row per country. It reports metrics at either actual physical location of the user or an area of interest. If other segment fields are used, you may get more than one row per country.
Used as response type in: services.GeographicViewService.GetGeographicView
Used as field type in:
string resource_name = 1
The resource name of the geographic view. Geographic view resource names have the form: `customers/{customer_id}/geographicViews/{country_criterion_id}~{location_type}`
enums.GeoTargetingTypeEnum.GeoTargetingType location_type = 3
Type of the geo targeting of the campaign.
optional country_criterion_id = 4
Criterion Id for the country.
message
google_ads_field.proto:37A field or resource (artifact) used by GoogleAdsService.
Used as response type in: services.GoogleAdsFieldService.GetGoogleAdsField
Used as field type in:
string resource_name = 1
The resource name of the artifact. Artifact resource names have the form: `googleAdsFields/{name}`
optional name = 2
The name of the artifact.
enums.GoogleAdsFieldCategoryEnum.GoogleAdsFieldCategory category = 3
The category of the artifact.
optional selectable = 4
Whether the artifact can be used in a SELECT clause in search queries.
optional filterable = 5
Whether the artifact can be used in a WHERE clause in search queries.
optional sortable = 6
Whether the artifact can be used in a ORDER BY clause in search queries.
repeated selectable_with = 7
The names of all resources, segments, and metrics that are selectable with the described artifact.
repeated attribute_resources = 8
The names of all resources that are selectable with the described artifact. Fields from these resources do not segment metrics when included in search queries. This field is only set for artifacts whose category is RESOURCE.
repeated metrics = 9
At and beyond version V1 this field lists the names of all metrics that are selectable with the described artifact when it is used in the FROM clause. It is only set for artifacts whose category is RESOURCE. Before version V1 this field lists the names of all metrics that are selectable with the described artifact. It is only set for artifacts whose category is either RESOURCE or SEGMENT
repeated segments = 10
At and beyond version V1 this field lists the names of all artifacts, whether a segment or another resource, that segment metrics when included in search queries and when the described artifact is used in the FROM clause. It is only set for artifacts whose category is RESOURCE. Before version V1 this field lists the names of all artifacts, whether a segment or another resource, that segment metrics when included in search queries. It is only set for artifacts of category RESOURCE, SEGMENT or METRIC.
repeated enum_values = 11
Values the artifact can assume if it is a field of type ENUM. This field is only set for artifacts of category SEGMENT or ATTRIBUTE.
enums.GoogleAdsFieldDataTypeEnum.GoogleAdsFieldDataType data_type = 12
This field determines the operators that can be used with the artifact in WHERE clauses.
optional type_url = 13
The URL of proto describing the artifact's data type.
optional is_repeated = 14
Whether the field artifact is repeated.
message
group_placement_view.proto:36A group placement view.
Used as response type in: services.GroupPlacementViewService.GetGroupPlacementView
Used as field type in:
string resource_name = 1
The resource name of the group placement view. Group placement view resource names have the form: `customers/{customer_id}/groupPlacementViews/{ad_group_id}~{base64_placement}`
optional placement = 2
The automatic placement string at group level, e. g. web domain, mobile app ID, or a YouTube channel ID.
optional display_name = 3
Domain name for websites and YouTube channel name for YouTube channels.
optional target_url = 4
URL of the group placement, e.g. domain, link to the mobile application in app store, or a YouTube channel URL.
enums.PlacementTypeEnum.PlacementType placement_type = 5
Type of the placement, e.g. Website, YouTube Channel, Mobile Application.
message
hotel_group_view.proto:34A hotel group view.
Used as response type in: services.HotelGroupViewService.GetHotelGroupView
Used as field type in:
string resource_name = 1
The resource name of the hotel group view. Hotel Group view resource names have the form: `customers/{customer_id}/hotelGroupViews/{ad_group_id}~{criterion_id}`
message
hotel_performance_view.proto:34A hotel performance view.
Used as response type in: services.HotelPerformanceViewService.GetHotelPerformanceView
Used as field type in:
string resource_name = 1
The resource name of the hotel performance view. Hotel performance view resource names have the form: `customers/{customer_id}/hotelPerformanceView`
message
invoice.proto:39An invoice. All invoice information is snapshotted to match the PDF invoice. For invoices older than the launch of InvoiceService, the snapshotted information may not match the PDF invoice.
Used in:
string resource_name = 1
The resource name of the invoice. Multiple customers can share a given invoice, so multiple resource names may point to the same invoice. Invoice resource names have the form: `customers/{customer_id}/invoices/{invoice_id}`
optional id = 2
The ID of the invoice. It appears on the invoice PDF as "Invoice number".
enums.InvoiceTypeEnum.InvoiceType type = 3
The type of invoice.
optional billing_setup = 4
The resource name of this invoice’s billing setup. `customers/{customer_id}/billingSetups/{billing_setup_id}`
optional payments_account_id = 5
A 16 digit ID used to identify the payments account associated with the billing setup, e.g. "1234-5678-9012-3456". It appears on the invoice PDF as "Billing Account Number".
optional payments_profile_id = 6
A 12 digit ID used to identify the payments profile associated with the billing setup, e.g. "1234-5678-9012". It appears on the invoice PDF as "Billing ID".
optional issue_date = 7
The issue date in yyyy-mm-dd format. It appears on the invoice PDF as either "Issue date" or "Invoice date".
optional due_date = 8
The due date in yyyy-mm-dd format.
optional service_date_range = 9
The service period date range of this invoice. The end date is inclusive.
optional currency_code = 10
The currency code. All costs are returned in this currency. A subset of the currency codes derived from the ISO 4217 standard is supported.
optional invoice_level_adjustments_micros = 11
The total amount of invoice level adjustments. These adjustments are made on the invoice, not on a specific account budget.
optional subtotal_amount_micros = 12
The pretax subtotal amount, in micros. This equals the sum of the AccountBudgetSummary subtotal amounts, plus the invoice level adjustments.
optional tax_amount_micros = 13
The sum of all taxes on the invoice, in micros. This equals the sum of the AccountBudgetSummary tax amounts, plus taxes not associated with a specific account budget.
optional total_amount_micros = 14
The total amount, in micros. This equals the sum of the invoice subtotal amount and the invoice tax amount.
optional corrected_invoice = 15
The resource name of the original invoice corrected, wrote off, or canceled by this invoice, if applicable. If `corrected_invoice` is set, `replaced_invoices` will not be set. Invoice resource names have the form: `customers/{customer_id}/invoices/{invoice_id}`
repeated replaced_invoices = 16
The resource name of the original invoice(s) being rebilled or replaced by this invoice, if applicable. There might be multiple replaced invoices due to invoice consolidation. The replaced invoices may not belong to the same payments account. If `replaced_invoices` is set, `corrected_invoice` will not be set. Invoice resource names have the form: `customers/{customer_id}/invoices/{invoice_id}`
optional pdf_url = 17
The URL to a PDF copy of the invoice. Users need to pass in their OAuth token to request the PDF with this URL.
repeated account_budget_summaries = 18
The list of summarized account budget information associated with this invoice.
message
invoice.proto:41Represents a summarized account budget billable cost.
Used in:
optional customer = 1
The resource name of the customer associated with this account budget. This contains the customer ID, which appears on the invoice PDF as "Account ID". Customer resource names have the form: `customers/{customer_id}`
optional customer_descriptive_name = 2
The descriptive name of the account budget’s customer. It appears on the invoice PDF as "Account".
optional account_budget = 3
The resource name of the account budget associated with this summarized billable cost. AccountBudget resource names have the form: `customers/{customer_id}/accountBudgets/{account_budget_id}`
optional account_budget_name = 4
The name of the account budget. It appears on the invoice PDF as "Account budget".
optional purchase_order_number = 5
The purchase order number of the account budget. It appears on the invoice PDF as "Purchase order".
optional subtotal_amount_micros = 6
The pretax subtotal amount attributable to this budget during the service period, in micros.
optional tax_amount_micros = 7
The tax amount attributable to this budget during the service period, in micros.
optional total_amount_micros = 8
The total amount attributable to this budget during the service period, in micros. This equals the sum of the account budget subtotal amount and the account budget tax amount.
optional billable_activity_date_range = 9
The billable activity date range of the account budget, within the service date range of this invoice. The end date is inclusive. This can be different from the account budget's start and end time.
message
keyword_plan.proto:39A Keyword Planner plan. Max number of saved keyword plans: 10000. It's possible to remove plans if limit is reached.
Used as response type in: services.KeywordPlanService.GetKeywordPlan
Used as field type in: ,
string resource_name = 1
The resource name of the Keyword Planner plan. KeywordPlan resource names have the form: `customers/{customer_id}/keywordPlans/{kp_plan_id}`
optional id = 2
The ID of the keyword plan.
optional name = 3
The name of the keyword plan. This field is required and should not be empty when creating new keyword plans.
optional forecast_period = 4
The date period used for forecasting the plan.
message
keyword_plan_ad_group.proto:36A Keyword Planner ad group. Max number of keyword plan ad groups per plan: 200.
Used as response type in: services.KeywordPlanAdGroupService.GetKeywordPlanAdGroup
Used as field type in: ,
string resource_name = 1
The resource name of the Keyword Planner ad group. KeywordPlanAdGroup resource names have the form: `customers/{customer_id}/keywordPlanAdGroups/{kp_ad_group_id}`
optional keyword_plan_campaign = 2
The keyword plan campaign to which this ad group belongs.
optional id = 3
The ID of the keyword plan ad group.
optional name = 4
The name of the keyword plan ad group. This field is required and should not be empty when creating keyword plan ad group.
optional cpc_bid_micros = 5
A default ad group max cpc bid in micros in account currency for all biddable keywords under the keyword plan ad group. If not set, will inherit from parent campaign.
message
keyword_plan_campaign.proto:37A Keyword Plan campaign. Max number of keyword plan campaigns per plan allowed: 1.
Used as response type in: services.KeywordPlanCampaignService.GetKeywordPlanCampaign
Used as field type in: ,
string resource_name = 1
The resource name of the Keyword Plan campaign. KeywordPlanCampaign resource names have the form: `customers/{customer_id}/keywordPlanCampaigns/{kp_campaign_id}`
optional keyword_plan = 2
The keyword plan this campaign belongs to.
optional id = 3
The ID of the Keyword Plan campaign.
optional name = 4
The name of the Keyword Plan campaign. This field is required and should not be empty when creating Keyword Plan campaigns.
repeated language_constants = 5
The languages targeted for the Keyword Plan campaign. Max allowed: 1.
enums.KeywordPlanNetworkEnum.KeywordPlanNetwork keyword_plan_network = 6
Targeting network. This field is required and should not be empty when creating Keyword Plan campaigns.
optional cpc_bid_micros = 7
A default max cpc bid in micros, and in the account currency, for all ad groups under the campaign. This field is required and should not be empty when creating Keyword Plan campaigns.
repeated geo_targets = 8
The geo targets. Max number allowed: 20.
message
keyword_plan.proto:60The forecasting period associated with the keyword plan.
Used in:
oneof interval
Required. The date used for forecasting the Plan.
enums.KeywordPlanForecastIntervalEnum.KeywordPlanForecastInterval date_interval = 1
A future date range relative to the current date used for forecasting.
date_range = 2
The custom date range used for forecasting. The start and end dates must be in the future. Otherwise, an error will be returned when the forecasting action is performed. The start and end dates are inclusive.
message
keyword_plan_campaign.proto:80A geo target. Next ID: 3
Used in:
optional geo_target_constant = 1
Required. The resource name of the geo target.
message
keyword_plan_keyword.proto:37A Keyword Plan ad group keyword. Max number of keyword plan keywords per plan: 2500.
Used as response type in: services.KeywordPlanKeywordService.GetKeywordPlanKeyword
Used as field type in: ,
string resource_name = 1
The resource name of the Keyword Plan ad group keyword. KeywordPlanKeyword resource names have the form: `customers/{customer_id}/keywordPlanKeywords/{kp_ad_group_keyword_id}`
optional keyword_plan_ad_group = 2
The Keyword Plan ad group to which this keyword belongs.
optional id = 3
The ID of the Keyword Plan keyword.
optional text = 4
The keyword text.
enums.KeywordMatchTypeEnum.KeywordMatchType match_type = 5
The keyword match type.
optional cpc_bid_micros = 6
A keyword level max cpc bid in micros, in the account currency, that overrides the keyword plan ad group cpc bid.
A Keyword Plan negative keyword. Max number of keyword plan negative keywords per plan: 1000.
Used as response type in: services.KeywordPlanNegativeKeywordService.GetKeywordPlanNegativeKeyword
Used as field type in: ,
string resource_name = 1
The resource name of the Keyword Plan negative keyword. KeywordPlanNegativeKeyword resource names have the form: `customers/{customer_id}/keywordPlanNegativeKeywords/{kp_negative_keyword_id}`
optional keyword_plan_campaign = 2
The Keyword Plan campaign to which this negative keyword belongs.
optional id = 3
The ID of the Keyword Plan negative keyword.
optional text = 4
The keyword text.
enums.KeywordMatchTypeEnum.KeywordMatchType match_type = 5
The keyword match type.
message
keyword_view.proto:34A keyword view.
Used as response type in: services.KeywordViewService.GetKeywordView
Used as field type in:
string resource_name = 1
The resource name of the keyword view. Keyword view resource names have the form: `customers/{customer_id}/keywordViews/{ad_group_id}~{criterion_id}`
message
label.proto:35A label.
Used as response type in: services.LabelService.GetLabel
Used as field type in: ,
string resource_name = 1
Name of the resource. Label resource names have the form: `customers/{customer_id}/labels/{label_id}`
optional id = 2
Id of the label. Read only.
optional name = 3
The name of the label. This field is required and should not be empty when creating a new label. The length of this string should be between 1 and 80, inclusive.
enums.LabelStatusEnum.LabelStatus status = 4
Status of the label. Read only.
optional text_label = 5
A type of label displaying text on a colored background.
message
landing_page_view.proto:36A landing page view with metrics aggregated at the unexpanded final URL level.
Used as response type in: services.LandingPageViewService.GetLandingPageView
Used as field type in:
string resource_name = 1
The resource name of the landing page view. Landing page view resource names have the form: `customers/{customer_id}/landingPageViews/{unexpanded_final_url_fingerprint}`
optional unexpanded_final_url = 2
The advertiser-specified final URL.
message
language_constant.proto:35A language.
Used as response type in: services.LanguageConstantService.GetLanguageConstant
Used as field type in:
string resource_name = 1
The resource name of the language constant. Language constant resource names have the form: `languageConstants/{criterion_id}`
optional id = 2
The ID of the language constant.
optional code = 3
The language code, e.g. "en_US", "en_AU", "es", "fr", etc.
optional name = 4
The full name of the language in English, e.g., "English (US)", "Spanish", etc.
optional targetable = 5
Whether the language is targetable.
message
location_view.proto:35A location view summarizes the performance of campaigns by Location criteria.
Used as response type in: services.LocationViewService.GetLocationView
Used as field type in:
string resource_name = 1
The resource name of the location view. Location view resource names have the form: `customers/{customer_id}/locationViews/{campaign_id}~{criterion_id}`
message
managed_placement_view.proto:34A managed placement view.
Used as response type in: services.ManagedPlacementViewService.GetManagedPlacementView
Used as field type in:
string resource_name = 1
The resource name of the Managed Placement view. Managed placement view resource names have the form: `customers/{customer_id}/managedPlacementViews/{ad_group_id}~{criterion_id}`
message
media_file.proto:93Encapsulates an Audio.
Used in:
optional ad_duration_millis = 1
The duration of the Audio in milliseconds.
message
media_file.proto:87Represents a ZIP archive media the content of which contains HTML5 assets.
Used in:
optional data = 1
Raw zipped data.
message
media_file.proto:37A media file.
Used as response type in: services.MediaFileService.GetMediaFile
Used as field type in: ,
string resource_name = 1
The resource name of the media file. Media file resource names have the form: `customers/{customer_id}/mediaFiles/{media_file_id}`
optional id = 2
The ID of the media file.
enums.MediaTypeEnum.MediaType type = 5
Type of the media file.
enums.MimeTypeEnum.MimeType mime_type = 6
The mime type of the media file.
optional source_url = 7
The URL of where the original media file was downloaded from (or a file name). Only used for media of type AUDIO and IMAGE.
optional name = 8
The name of the media file. The name can be used by clients to help identify previously uploaded media.
optional file_size = 9
The size of the media file in bytes.
oneof mediatype
The specific type of the media file.
image = 3
Encapsulates an Image.
media_bundle = 4
A ZIP archive media the content of which contains HTML5 assets.
audio = 10
Encapsulates an Audio.
video = 11
Encapsulates a Video.
message
media_file.proto:81Encapsulates an Image.
Used in:
optional data = 1
Raw image data.
message
media_file.proto:99Encapsulates a Video.
Used in:
optional ad_duration_millis = 1
The duration of the Video in milliseconds.
optional youtube_video_id = 2
The YouTube video ID (as seen in YouTube URLs).
optional advertising_id_code = 3
The Advertising Digital Identification code for this video, as defined by the American Association of Advertising Agencies, used mainly for television commercials.
optional isci_code = 4
The Industry Standard Commercial Identifier code for this video, used mainly for television commercials.
message
merchant_center_link.proto:37A data sharing connection, proposed or in use, between a Google Ads Customer and a Merchant Center account.
Used as response type in: services.MerchantCenterLinkService.GetMerchantCenterLink
Used as field type in: ,
string resource_name = 1
The resource name of the merchant center link. Merchant center link resource names have the form: `customers/{customer_id}/merchantCenterLinks/{merchant_center_id}`
optional id = 3
The ID of the Merchant Center account. This field is readonly.
optional merchant_center_account_name = 4
The name of the Merchant Center account. This field is readonly.
enums.MerchantCenterLinkStatusEnum.MerchantCenterLinkStatus status = 5
The status of the link.
A mobile application category constant.
Used as response type in: services.MobileAppCategoryConstantService.GetMobileAppCategoryConstant
Used as field type in:
string resource_name = 1
The resource name of the mobile app category constant. Mobile app category constant resource names have the form: `mobileAppCategoryConstants/{mobile_app_category_id}`
optional id = 2
The ID of the mobile app category constant.
optional name = 3
Mobile app category name.
message
mobile_device_constant.proto:36A mobile device constant.
Used as response type in: services.MobileDeviceConstantService.GetMobileDeviceConstant
Used as field type in:
string resource_name = 1
The resource name of the mobile device constant. Mobile device constant resource names have the form: `mobileDeviceConstants/{criterion_id}`
optional id = 2
The ID of the mobile device constant.
optional name = 3
The name of the mobile device.
optional manufacturer_name = 4
The manufacturer of the mobile device.
optional operating_system_name = 5
The operating system of the mobile device.
enums.MobileDeviceTypeEnum.MobileDeviceType type = 6
The type of mobile device.
message
mutate_job.proto:38A list of mutates being processed asynchronously. The mutates are uploaded by the user. The mutates themselves aren’t readable and the results of the job can only be read using MutateJobService.ListMutateJobResults.
Used as response type in: services.MutateJobService.GetMutateJob
Used as field type in:
string resource_name = 1
The resource name of the mutate job. Mutate job resource names have the form: `customers/{customer_id}/mutateJobs/{mutate_job_id}`
optional id = 2
ID of this mutate job.
optional next_add_sequence_token = 3
The next sequence token to use when adding operations. Only set when the mutate job status is PENDING.
optional metadata = 4
Contains additional information about this mutate job.
enums.MutateJobStatusEnum.MutateJobStatus status = 5
Status of this mutate job.
optional long_running_operation = 6
The resource name of the long-running operation that can be used to poll for completion. Only set when the mutate job status is RUNNING or DONE.
message
mutate_job.proto:41Additional information about the mutate job. This message is also used as metadata returned in mutate job Long Running Operations.
Used in:
optional creation_date_time = 1
The time when this mutate job was created. Formatted as yyyy-mm-dd hh:mm:ss. Example: "2018-03-05 09:15:00"
optional completion_date_time = 2
The time when this mutate job was completed. Formatted as yyyy-MM-dd HH:mm:ss. Example: "2018-03-05 09:16:00"
optional estimated_completion_ratio = 3
The fraction (between 0.0 and 1.0) of mutates that have been processed. This is empty if the job hasn't started running yet.
optional operation_count = 4
The number of mutate operations in the mutate job.
optional executed_operation_count = 5
The number of mutate operations executed by the mutate job. Present only if the job has started running.
A mobile operating system version or a range of versions, depending on `operator_type`. List of available mobile platforms at https://developers.google.com/adwords/api/docs/appendix/codes-formats#mobile-platforms
Used as response type in: services.OperatingSystemVersionConstantService.GetOperatingSystemVersionConstant
Used as field type in:
string resource_name = 1
The resource name of the operating system version constant. Operating system version constant resource names have the form: `operatingSystemVersionConstants/{criterion_id}`
optional id = 2
The ID of the operating system version.
optional name = 3
Name of the operating system.
optional os_major_version = 4
The OS Major Version number.
optional os_minor_version = 5
The OS Minor Version number.
enums.OperatingSystemVersionOperatorTypeEnum.OperatingSystemVersionOperatorType operator_type = 6
Determines whether this constant represents a single version or a range of versions.
A paid organic search term view providing a view of search stats across ads and organic listings aggregated by search term at the ad group level.
Used as response type in: services.PaidOrganicSearchTermViewService.GetPaidOrganicSearchTermView
Used as field type in:
string resource_name = 1
The resource name of the search term view. Search term view resource names have the form: `customers/{customer_id}/paidOrganicSearchTermViews/{campaign_id}~ {ad_group_id}~{URL-base64 search term}`
optional search_term = 2
The search term.
message
parental_status_view.proto:34A parental status view.
Used as response type in: services.ParentalStatusViewService.GetParentalStatusView
Used as field type in:
string resource_name = 1
The resource name of the parental status view. Parental Status view resource names have the form: `customers/{customer_id}/parentalStatusViews/{ad_group_id}~{criterion_id}`
message
payments_account.proto:35A payments account, which can be used to set up billing for an Ads customer.
Used in:
string resource_name = 1
The resource name of the payments account. PaymentsAccount resource names have the form: `customers/{customer_id}/paymentsAccounts/{payments_account_id}`
optional payments_account_id = 2
A 16 digit ID used to identify a payments account.
optional name = 3
The name of the payments account.
optional currency_code = 4
The currency code of the payments account. A subset of the currency codes derived from the ISO 4217 standard is supported.
optional payments_profile_id = 5
A 12 digit ID used to identify the payments profile associated with the payments account.
optional secondary_payments_profile_id = 6
A secondary payments profile ID present in uncommon situations, e.g. when a sequential liability agreement has been arranged.
A Product Bidding Category.
Used as response type in: services.ProductBiddingCategoryConstantService.GetProductBiddingCategoryConstant
Used as field type in:
string resource_name = 1
The resource name of the product bidding category. Product bidding category resource names have the form: `productBiddingCategoryConstants/{country_code}~{level}~{id}`
optional id = 2
ID of the product bidding category. This ID is equivalent to the google_product_category ID as described in this article: https://support.google.com/merchants/answer/6324436.
optional country_code = 3
Two-letter upper-case country code of the product bidding category.
optional product_bidding_category_constant_parent = 4
Resource name of the parent product bidding category.
enums.ProductBiddingCategoryLevelEnum.ProductBiddingCategoryLevel level = 5
Level of the product bidding category.
enums.ProductBiddingCategoryStatusEnum.ProductBiddingCategoryStatus status = 6
Status of the product bidding category.
optional language_code = 7
Language code of the product bidding category.
optional localized_name = 8
Display value of the product bidding category localized according to language_code.
message
product_group_view.proto:34A product group view.
Used as response type in: services.ProductGroupViewService.GetProductGroupView
Used as field type in:
string resource_name = 1
The resource name of the product group view. Product group view resource names have the form: `customers/{customer_id}/productGroupViews/{ad_group_id}~{criterion_id}`
message
recommendation.proto:41A recommendation.
Used as response type in: services.RecommendationService.GetRecommendation
Used as field type in:
string resource_name = 1
The resource name of the recommendation. `customers/{customer_id}/recommendations/{recommendation_id}`
enums.RecommendationTypeEnum.RecommendationType type = 2
The type of recommendation.
optional impact = 3
The impact on account performance as a result of applying the recommendation.
optional campaign_budget = 5
The budget targeted by this recommendation. This will be set only when the recommendation affects a single campaign budget. This field will be set for the following recommendation types: CAMPAIGN_BUDGET, MOVE_UNUSED_BUDGET
optional campaign = 6
The campaign targeted by this recommendation. This will be set only when the recommendation affects a single campaign. This field will be set for the following recommendation types: CALL_EXTENSION, CALLOUT_EXTENSION, ENHANCED_CPC_OPT_IN, KEYWORD, KEYWORD_MATCH_TYPE, MAXIMIZE_CLICKS_OPT_IN, MAXIMIZE_CONVERSIONS_OPT_IN, OPTIMIZE_AD_ROTATION, SEARCH_PARTNERS_OPT_IN, SITELINK_EXTENSION, TARGET_CPA_OPT_IN, TEXT_AD
optional ad_group = 7
The ad group targeted by this recommendation. This will be set only when the recommendation affects a single ad group. This field will be set for the following recommendation types: KEYWORD, OPTIMIZE_AD_ROTATION, TEXT_AD
optional dismissed = 13
Whether the recommendation is dismissed or not.
oneof recommendation
The details of recommendation.
campaign_budget_recommendation = 4
The campaign budget recommendation.
keyword_recommendation = 8
The keyword recommendation.
text_ad_recommendation = 9
Add expanded text ad recommendation.
target_cpa_opt_in_recommendation = 10
The TargetCPA opt-in recommendation.
maximize_conversions_opt_in_recommendation = 11
The MaximizeConversions Opt-In recommendation.
enhanced_cpc_opt_in_recommendation = 12
The Enhanced Cost-Per-Click Opt-In recommendation.
search_partners_opt_in_recommendation = 14
The Search Partners Opt-In recommendation.
maximize_clicks_opt_in_recommendation = 15
The MaximizeClicks Opt-In recommendation.
optimize_ad_rotation_recommendation = 16
The Optimize Ad Rotation recommendation.
callout_extension_recommendation = 17
The Callout extension recommendation.
sitelink_extension_recommendation = 18
The Sitelink extension recommendation.
call_extension_recommendation = 19
The Call extension recommendation.
keyword_match_type_recommendation = 20
The keyword match type recommendation.
move_unused_budget_recommendation = 21
The move unused budget recommendation.
message
recommendation.proto:205The Call extension recommendation.
Used in:
repeated recommended_extensions = 1
Call extensions recommended to be added.
message
recommendation.proto:199The Callout extension recommendation.
Used in:
repeated recommended_extensions = 1
Callout extensions recommended to be added.
message
recommendation.proto:72The budget recommendation for budget constrained campaigns.
Used in: ,
optional current_budget_amount_micros = 1
The current budget amount in micros.
optional recommended_budget_amount_micros = 2
The recommended budget amount in micros.
repeated budget_options = 3
The budget amounts and associated impact estimates for some values of possible budget amounts.
message
recommendation.proto:74The impact estimates for a given budget amount.
Used in:
optional budget_amount_micros = 1
The budget amount for this option.
optional impact = 2
The impact estimate if budget is changed to amount specified in this option.
message
recommendation.proto:173The Enhanced Cost-Per-Click Opt-In recommendation.
Used in:
(message has no fields)
message
recommendation.proto:183The keyword match type recommendation.
Used in:
optional keyword = 1
The existing keyword where the match type should be more broad.
enums.KeywordMatchTypeEnum.KeywordMatchType recommended_match_type = 2
The recommended new match type.
message
recommendation.proto:95The keyword recommendation.
Used in:
optional keyword = 1
The recommended keyword.
optional recommended_cpc_bid_micros = 2
The recommended CPC (cost-per-click) bid.
message
recommendation.proto:192The Maximize Clicks opt-in recommendation.
Used in:
optional recommended_budget_amount_micros = 1
The recommended new budget amount. Only set if the current budget is too high.
message
recommendation.proto:162The Maximize Conversions Opt-In recommendation.
Used in:
optional recommended_budget_amount_micros = 1
The recommended new budget amount.
message
recommendation.proto:110The move unused budget recommendation.
Used in:
optional excess_campaign_budget = 1
The excess budget's resource_name.
optional budget_recommendation = 2
The recommendation for the constrained budget to increase.
message
recommendation.proto:168The Optimize Ad Rotation recommendation.
Used in:
(message has no fields)
message
recommendation.proto:44The impact of making the change as described in the recommendation. Some types of recommendations may not have impact information.
Used in: , ,
optional base_metrics = 1
Base metrics at the time the recommendation was generated.
optional potential_metrics = 2
Estimated metrics if the recommendation is applied.
message
recommendation.proto:54Weekly account performance metrics. For some recommendation types, these are averaged over the past 90-day period and hence can be fractional.
Used in:
optional impressions = 1
Number of ad impressions.
optional clicks = 2
Number of ad clicks.
optional cost_micros = 3
Cost (in micros) for advertising, in the local currency for the account.
optional conversions = 4
Number of conversions.
optional video_views = 5
Number of video views for a video ad campaign.
message
recommendation.proto:178The Search Partners Opt-In recommendation.
Used in:
(message has no fields)
message
recommendation.proto:104The Sitelink extension recommendation.
Used in:
repeated recommended_extensions = 1
Sitelink extensions recommended to be added.
message
recommendation.proto:134The Target CPA opt-in recommendation.
Used in:
repeated options = 1
The available goals and corresponding options for Target CPA strategy.
optional recommended_target_cpa_micros = 2
The recommended average CPA target. See required budget amount and impact of using this recommendation in options list.
message
recommendation.proto:136The Target CPA opt-in option with impact estimate.
Used in:
enums.TargetCpaOptInRecommendationGoalEnum.TargetCpaOptInRecommendationGoal goal = 1
The goal achieved by this option.
optional target_cpa_micros = 2
Average CPA target.
optional required_campaign_budget_amount_micros = 3
The minimum campaign budget, in local currency for the account, required to achieve the target CPA. Amount is specified in micros, where one million is equivalent to one currency unit.
optional impact = 4
The impact estimate if this option is selected.
message
recommendation.proto:119The text ad recommendation.
Used in:
optional ad = 1
Recommended ad.
optional creation_date = 2
Creation date of the recommended ad. YYYY-MM-DD format, e.g., 2018-04-17.
optional auto_apply_date = 3
Date, if present, is the earliest when the recommendation will be auto applied. YYYY-MM-DD format, e.g., 2018-04-17.
message
remarketing_action.proto:38A remarketing action. A snippet of JavaScript code that will collect the product id and the type of page people visited (product page, shopping cart page, purchase page, general site visit) on an advertiser's website.
Used as response type in: services.RemarketingActionService.GetRemarketingAction
Used as field type in: ,
string resource_name = 1
The resource name of the remarketing action. Remarketing action resource names have the form: `customers/{customer_id}/remarketingActions/{remarketing_action_id}`
optional id = 2
Id of the remarketing action.
optional name = 3
The name of the remarketing action. This field is required and should not be empty when creating new remarketing actions.
repeated tag_snippets = 4
The snippets used for tracking remarketing actions.
message
customer.proto:122Remarketing setting for a customer.
Used in:
optional google_global_site_tag = 1
The Google global site tag.
message
search_term_view.proto:37A search term view with metrics aggregated by search term at the ad group level.
Used as response type in: services.SearchTermViewService.GetSearchTermView
Used as field type in:
string resource_name = 1
The resource name of the search term view. Search term view resource names have the form: `customers/{customer_id}/searchTermViews/{campaign_id}~{ad_group_id}~{URL-base64_search_term}`
optional search_term = 2
The search term.
optional ad_group = 3
The ad group the search term served in.
enums.SearchTermTargetingStatusEnum.SearchTermTargetingStatus status = 4
Indicates whether the search term is currently one of your targeted or excluded keywords.
message
shared_criterion.proto:37A criterion belonging to a shared set.
Used as response type in: services.SharedCriterionService.GetSharedCriterion
Used as field type in: ,
string resource_name = 1
The resource name of the shared criterion. Shared set resource names have the form: `customers/{customer_id}/sharedCriteria/{shared_set_id}~{criterion_id}`
optional shared_set = 2
The shared set to which the shared criterion belongs.
optional criterion_id = 26
The ID of the criterion. This field is ignored for mutates.
enums.CriterionTypeEnum.CriterionType type = 4
The type of the criterion.
oneof criterion
The criterion. Exactly one must be set.
keyword = 3
Keyword.
youtube_video = 5
YouTube Video.
youtube_channel = 6
YouTube Channel.
placement = 7
Placement.
mobile_app_category = 8
Mobile App Category.
mobile_application = 9
Mobile application.
message
shared_set.proto:38SharedSets are used for sharing criterion exclusions across multiple campaigns.
Used as response type in: services.SharedSetService.GetSharedSet
Used as field type in: ,
string resource_name = 1
The resource name of the shared set. Shared set resource names have the form: `customers/{customer_id}/sharedSets/{shared_set_id}`
optional id = 2
The ID of this shared set. Read only.
enums.SharedSetTypeEnum.SharedSetType type = 3
The type of this shared set: each shared set holds only a single kind of resource. Required. Immutable.
optional name = 4
The name of this shared set. Required. Shared Sets must have names that are unique among active shared sets of the same type. The length of this string should be between 1 and 255 UTF-8 bytes, inclusive.
enums.SharedSetStatusEnum.SharedSetStatus status = 5
The status of this shared set. Read only.
optional member_count = 6
The number of shared criteria within this shared set. Read only.
optional reference_count = 7
The number of campaigns associated with this shared set. Read only.
Shopping performance view. Provides Shopping campaign statistics aggregated at several product dimension levels. Product dimension values from Merchant Center such as brand, category, custom attributes, product condition and product type will reflect the state of each dimension as of the date and time when the corresponding event was recorded.
Used as response type in: services.ShoppingPerformanceViewService.GetShoppingPerformanceView
Used as field type in:
string resource_name = 1
The resource name of the Shopping performance view. Shopping performance view resource names have the form: `customers/{customer_id}/shoppingPerformanceView`
message
topic_constant.proto:37Use topics to target or exclude placements in the Google Display Network based on the category into which the placement falls (for example, "Pets & Animals/Pets/Dogs").
Used as response type in: services.TopicConstantService.GetTopicConstant
Used as field type in:
string resource_name = 1
The resource name of the topic constant. topic constant resource names have the form: `topicConstants/{topic_id}`
optional id = 2
The ID of the topic.
optional topic_constant_parent = 3
Resource name of parent of the topic constant.
repeated path = 4
The category to target or exclude. Each subsequent element in the array describes a more specific sub-category. For example, {"Pets & Animals", "Pets", "Dogs"} represents the "Pets & Animals/Pets/Dogs" category. List of available topic categories at https://developers.google.com/adwords/api/docs/appendix/verticals
message
topic_view.proto:34A topic view.
Used as response type in: services.TopicViewService.GetTopicView
Used as field type in:
string resource_name = 1
The resource name of the topic view. Topic view resource names have the form: `customers/{customer_id}/topicViews/{ad_group_id}~{criterion_id}`
message
user_interest.proto:37A user interest: a particular interest-based vertical to be targeted.
Used as response type in: services.UserInterestService.GetUserInterest
Used as field type in:
string resource_name = 1
The resource name of the user interest. User interest resource names have the form: `customers/{customer_id}/userInterests/{user_interest_id}`
enums.UserInterestTaxonomyTypeEnum.UserInterestTaxonomyType taxonomy_type = 2
Taxonomy type of the user interest.
optional user_interest_id = 3
The ID of the user interest.
optional name = 4
The name of the user interest.
optional user_interest_parent = 5
The parent of the user interest.
optional launched_to_all = 6
True if the user interest is launched to all channels and locales.
repeated availabilities = 7
Availability information of the user interest.
message
user_list.proto:42A user list. This is a list of users a customer may target.
Used as response type in: services.UserListService.GetUserList
Used as field type in: ,
string resource_name = 1
The resource name of the user list. User list resource names have the form: `customers/{customer_id}/userLists/{user_list_id}`
optional id = 2
Id of the user list.
optional read_only = 3
A flag that indicates if a user may edit a list. Depends on the list ownership and list type. For example, external remarketing user lists are not editable. This field is read-only.
optional name = 4
Name of this user list. Depending on its access_reason, the user list name may not be unique (e.g. if access_reason=SHARED)
optional description = 5
Description of this user list.
enums.UserListMembershipStatusEnum.UserListMembershipStatus membership_status = 6
Membership status of this user list. Indicates whether a user list is open or active. Only open user lists can accumulate more users and can be targeted to.
optional integration_code = 7
An ID from external system. It is used by user list sellers to correlate IDs on their systems.
optional membership_life_span = 8
Number of days a user's cookie stays on your list since its most recent addition to the list. This field must be between 0 and 540 inclusive. However, for CRM based userlists, this field can be set to 10000 which means no expiration. It'll be ignored for logical_user_list.
optional size_for_display = 9
Estimated number of users in this user list, on the Google Display Network. This value is null if the number of users has not yet been determined. This field is read-only.
enums.UserListSizeRangeEnum.UserListSizeRange size_range_for_display = 10
Size range in terms of number of users of the UserList, on the Google Display Network. This field is read-only.
optional size_for_search = 11
Estimated number of users in this user list in the google.com domain. These are the users available for targeting in Search campaigns. This value is null if the number of users has not yet been determined. This field is read-only.
enums.UserListSizeRangeEnum.UserListSizeRange size_range_for_search = 12
Size range in terms of number of users of the UserList, for Search ads. This field is read-only.
enums.UserListTypeEnum.UserListType type = 13
Type of this list. This field is read-only.
enums.UserListClosingReasonEnum.UserListClosingReason closing_reason = 14
Indicating the reason why this user list membership status is closed. It is only populated on lists that were automatically closed due to inactivity, and will be cleared once the list membership status becomes open.
enums.AccessReasonEnum.AccessReason access_reason = 15
Indicates the reason this account has been granted access to the list. The reason can be SHARED, OWNED, LICENSED or SUBSCRIBED. This field is read-only.
enums.UserListAccessStatusEnum.UserListAccessStatus account_user_list_status = 16
Indicates if this share is still enabled. When a UserList is shared with the user this field is set to ENABLED. Later the userList owner can decide to revoke the share and make it DISABLED. The default value of this field is set to ENABLED.
optional eligible_for_search = 17
Indicates if this user list is eligible for Google Search Network.
optional eligible_for_display = 18
Indicates this user list is eligible for Google Display Network. This field is read-only.
oneof user_list
The user list. Exactly one must be set.
crm_based_user_list = 19
User list of CRM users provided by the advertiser.
similar_user_list = 20
User list which are similar to users from another UserList. These lists are readonly and automatically created by google.
rule_based_user_list = 21
User list generated by a rule.
logical_user_list = 22
User list that is a custom combination of user lists and user interests.
basic_user_list = 23
User list targeting as a collection of conversion or remarketing actions.
message
user_location_view.proto:40A user location view. User Location View includes all metrics aggregated at the country level, one row per country. It reports metrics at the actual physical location of the user by targeted or not targeted location. If other segment fields are used, you may get more than one row per country.
Used as response type in: services.UserLocationViewService.GetUserLocationView
Used as field type in:
string resource_name = 1
The resource name of the user location view. UserLocation view resource names have the form: `customers/{customer_id}/userLocationViews/{country_criterion_id}~{targeting_location}`
optional country_criterion_id = 2
Criterion Id for the country.
optional targeting_location = 3
Indicates whether location was targeted or not.
message
video.proto:35A video.
Used as response type in: services.VideoService.GetVideo
Used as field type in:
string resource_name = 1
The resource name of the video. Video resource names have the form: `customers/{customer_id}/videos/{video_id}`
optional id = 2
The ID of the video.
optional channel_id = 3
The owner channel id of the video.
optional duration_millis = 4
The duration of the video in milliseconds.
optional title = 5
The title of the video.