package google.ads.googleads.v22.resources
Get desktop application:
View/edit binary Protocol Buffers messages
Represents a view of BiddingStrategies owned by and shared with the customer. In contrast to BiddingStrategy, this resource includes strategies owned by managers of the customer and shared with this customer - in addition to strategies owned by this customer. This resource does not provide metrics and only exposes a limited subset of the BiddingStrategy attributes.
Used in:
string resource_name = 1
Output only. The resource name of the accessible bidding strategy. AccessibleBiddingStrategy resource names have the form: `customers/{customer_id}/accessibleBiddingStrategies/{bidding_strategy_id}`
int64 id = 2
Output only. The ID of the bidding strategy.
string name = 3
Output only. The name of the bidding strategy.
enums.BiddingStrategyTypeEnum.BiddingStrategyType type = 4
Output only. The type of the bidding strategy.
int64 owner_customer_id = 5
Output only. The ID of the Customer which owns the bidding strategy.
string owner_descriptive_name = 6
Output only. descriptive_name of the Customer which owns the bidding strategy.
oneof scheme
The bidding scheme. Only one can be set.
maximize_conversion_value = 7
Output only. An automated bidding strategy to help get the most conversion value for your campaigns while spending your budget.
maximize_conversions = 8
Output only. An automated bidding strategy to help get the most conversions for your campaigns while spending your budget.
target_cpa = 9
Output only. 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 = 10
Output only. A bidding strategy that automatically optimizes towards a chosen percentage of impressions.
target_roas = 11
Output only. A bidding strategy that helps you maximize revenue while averaging a specific target Return On Ad Spend (ROAS).
target_spend = 12
Output only. A bid strategy that sets your bids to help get as many clicks as possible within your budget.
An automated bidding strategy to help get the most conversion value for your campaigns while spending your budget.
Used in:
double target_roas = 1
Output only. The target return on ad spend (ROAS) option. If set, the bid strategy will maximize revenue while averaging the target return on ad spend. If the target ROAS is high, the bid strategy may not be able to spend the full budget. If the target ROAS is not set, the bid strategy will aim to achieve the highest possible ROAS for the budget.
An automated bidding strategy to help get the most conversions for your campaigns while spending your budget.
Used in:
int64 target_cpa_micros = 2
Output only. The target cost per acquisition (CPA) option. This is the average amount that you would like to spend per acquisition.
An automated bid strategy that sets bids to help get as many conversions as possible at the target cost-per-acquisition (CPA) you set.
Used in:
optional int64 target_cpa_micros = 1
Output only. Average CPA target. This target should be greater than or equal to minimum billable unit based on the currency for the account.
An automated bidding strategy that sets bids so that a certain percentage of search ads are shown at the top of the first page (or other targeted location).
Used in:
enums.TargetImpressionShareLocationEnum.TargetImpressionShareLocation location = 1
Output only. The targeted location on the search results page.
optional int64 location_fraction_micros = 2
The chosen fraction of ads to be shown in the targeted location in micros. For example, 1% equals 10,000.
optional int64 cpc_bid_ceiling_micros = 3
Output only. The highest CPC bid the automated bidding system is permitted to specify. This is a required field entered by the advertiser that sets the ceiling and specified in local micros.
An automated bidding strategy that helps you maximize revenue while averaging a specific target return on ad spend (ROAS).
Used in:
optional double target_roas = 1
Output only. The chosen revenue (based on conversion data) per unit of spend.
An automated bid strategy that sets your bids to help get as many clicks as possible within your budget.
Used in:
optional int64 target_spend_micros = 1
Output only. The spend target under which to maximize clicks. A TargetSpend bidder will attempt to spend the smaller of this value or the natural throttling spend amount. If not specified, the budget is used as the spend target. This field is deprecated and should no longer be used. See https://ads-developers.googleblog.com/2020/05/reminder-about-sunset-creation-of.html for details.
optional int64 cpc_bid_ceiling_micros = 2
Output only. Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy.
message
account_budget.proto:53An 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 (for example, spending limit), these differences are juxtaposed through '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 in:
string resource_name = 1
Output only. The resource name of the account-level budget. AccountBudget resource names have the form: `customers/{customer_id}/accountBudgets/{account_budget_id}`
optional int64 id = 23
Output only. The ID of the account-level budget.
optional string billing_setup = 24
Output only. 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
Output only. The status of this account-level budget.
optional string name = 25
Output only. The name of the account-level budget.
optional string proposed_start_date_time = 26
Output only. 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 string approved_start_date_time = 27
Output only. 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.
int64 total_adjustments_micros = 33
Output only. The total adjustments amount. An example of an adjustment is courtesy credits.
int64 amount_served_micros = 34
Output only. 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 string purchase_order_number = 35
Output only. A purchase order number is a value that helps users reference this budget in their monthly invoices.
optional string notes = 36
Output only. Notes associated with the budget.
optional pending_proposal = 22
Output only. The pending proposal to modify this budget, if applicable.
oneof proposed_end_time
The proposed end time of the account-level budget.
string proposed_end_date_time = 28
Output only. The proposed end time in yyyy-MM-dd HH:mm:ss format.
enums.TimeTypeEnum.TimeType proposed_end_time_type = 9
Output only. The proposed end time as a well-defined type, for example, 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.
string approved_end_date_time = 29
Output only. The approved end time in yyyy-MM-dd HH:mm:ss format.
enums.TimeTypeEnum.TimeType approved_end_time_type = 11
Output only. The approved end time as a well-defined type, for example, FOREVER.
oneof proposed_spending_limit
The proposed spending limit.
int64 proposed_spending_limit_micros = 30
Output only. The proposed spending limit in micros. One million is equivalent to one unit.
enums.SpendingLimitTypeEnum.SpendingLimitType proposed_spending_limit_type = 13
Output only. The proposed spending limit as a well-defined type, for example, 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.
int64 approved_spending_limit_micros = 31
Output only. 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
Output only. The approved spending limit as a well-defined type, for example, 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.
int64 adjusted_spending_limit_micros = 32
Output only. 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
Output only. The adjusted spending limit as a well-defined type, for example, 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:61A pending proposal associated with the enclosing account-level budget, if applicable.
Used in:
optional string account_budget_proposal = 12
Output only. 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
Output only. The type of this proposal, for example, END to end the budget associated with this proposal.
optional string name = 13
Output only. The name to assign to the account-level budget.
optional string start_date_time = 14
Output only. The start time in yyyy-MM-dd HH:mm:ss format.
optional string purchase_order_number = 17
Output only. A purchase order number is a value that helps users reference this budget in their monthly invoices.
optional string notes = 18
Output only. Notes associated with this budget.
optional string creation_date_time = 19
Output only. 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.
string end_date_time = 15
Output only. The end time in yyyy-MM-dd HH:mm:ss format.
enums.TimeTypeEnum.TimeType end_time_type = 6
Output only. The end time as a well-defined type, for example, FOREVER.
oneof spending_limit
The spending limit.
int64 spending_limit_micros = 16
Output only. The spending limit in micros. One million is equivalent to one unit.
enums.SpendingLimitTypeEnum.SpendingLimitType spending_limit_type = 8
Output only. The spending limit as a well-defined type, for example, INFINITE.
message
account_budget_proposal.proto:46An 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, for example, spending limits. Note that the proposal type (proposal_type) changes which fields are required and which must remain empty.
Used in: ,
string resource_name = 1
Immutable. The resource name of the proposal. AccountBudgetProposal resource names have the form: `customers/{customer_id}/accountBudgetProposals/{account_budget_proposal_id}`
optional int64 id = 25
Output only. The ID of the proposal.
optional string billing_setup = 26
Immutable. The resource name of the billing setup associated with this proposal.
optional string account_budget = 27
Immutable. The resource name of the account-level budget associated with this proposal.
enums.AccountBudgetProposalTypeEnum.AccountBudgetProposalType proposal_type = 4
Immutable. The type of this proposal, for example, END to end the budget associated with this proposal.
enums.AccountBudgetProposalStatusEnum.AccountBudgetProposalStatus status = 15
Output only. The status of this proposal. When a new proposal is created, the status defaults to PENDING.
optional string proposed_name = 28
Immutable. The name to assign to the account-level budget.
optional string approved_start_date_time = 30
Output only. The approved start date time in yyyy-mm-dd hh:mm:ss format.
optional string proposed_purchase_order_number = 35
Immutable. A purchase order number is a value that enables the user to help them reference this budget in their monthly invoices.
optional string proposed_notes = 36
Immutable. Notes associated with this budget.
optional string creation_date_time = 37
Output only. The date time when this account-level budget proposal was created, which is not the same as its approval date time, if applicable.
optional string approval_date_time = 38
Output only. 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.
string proposed_start_date_time = 29
Immutable. The proposed start date time in yyyy-mm-dd hh:mm:ss format.
enums.TimeTypeEnum.TimeType proposed_start_time_type = 7
Immutable. The proposed start date time as a well-defined type, for example, NOW.
oneof proposed_end_time
The proposed end date time of the account-level budget, which cannot be in the past.
string proposed_end_date_time = 31
Immutable. The proposed end date time in yyyy-mm-dd hh:mm:ss format.
enums.TimeTypeEnum.TimeType proposed_end_time_type = 9
Immutable. The proposed end date time as a well-defined type, for example, FOREVER.
oneof approved_end_time
The approved end date time of the account-level budget.
string approved_end_date_time = 32
Output only. The approved end date time in yyyy-mm-dd hh:mm:ss format.
enums.TimeTypeEnum.TimeType approved_end_time_type = 22
Output only. The approved end date time as a well-defined type, for example, FOREVER.
oneof proposed_spending_limit
The proposed spending limit.
int64 proposed_spending_limit_micros = 33
Immutable. The proposed spending limit in micros. One million is equivalent to one unit.
enums.SpendingLimitTypeEnum.SpendingLimitType proposed_spending_limit_type = 11
Immutable. The proposed spending limit as a well-defined type, for example, INFINITE.
oneof approved_spending_limit
The approved spending limit.
int64 approved_spending_limit_micros = 34
Output only. The approved spending limit in micros. One million is equivalent to one unit.
enums.SpendingLimitTypeEnum.SpendingLimitType approved_spending_limit_type = 24
Output only. The approved spending limit as a well-defined type, for example, INFINITE.
message
account_link.proto:36Represents the data sharing connection between a Google Ads account and another account
Used in: , ,
string resource_name = 1
Immutable. Resource name of the account link. AccountLink resource names have the form: `customers/{customer_id}/accountLinks/{account_link_id}`
optional int64 account_link_id = 8
Output only. The ID of the link. This field is read only.
enums.AccountLinkStatusEnum.AccountLinkStatus status = 3
The status of the link.
enums.LinkedAccountTypeEnum.LinkedAccountType type = 4
Output only. The type of the linked account.
oneof linked_account
An account linked to this Google Ads account.
third_party_app_analytics = 5
Immutable. A third party app analytics link.
message
ad.proto:41An ad.
Used in: , , , , , , , , , , , ,
string resource_name = 37
Immutable. The resource name of the ad. Ad resource names have the form: `customers/{customer_id}/ads/{ad_id}`
optional int64 id = 40
Output only. The ID of the ad.
repeated string final_urls = 41
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 string final_mobile_urls = 42
The list of possible final mobile URLs after all cross-domain redirects for the ad.
optional string tracking_url_template = 43
The URL template for constructing a tracking URL.
optional string final_url_suffix = 44
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`. For mutates, use url custom parameter operations.
optional string display_url = 45
The URL that appears in the ad description for some ad formats.
enums.AdTypeEnum.AdType type = 5
Output only. The type of ad.
optional bool added_by_google_ads = 46
Output only. 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, for example, 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 string name = 47
Immutable. 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. The name field is currently only supported for DisplayUploadAd, ImageAd, LegacyAppInstallAd, ShoppingComparisonListingAd, VideoAd, VideoResponsiveAd and DemandGen ads.
enums.SystemManagedResourceSourceEnum.SystemManagedResourceSource system_managed_resource_source = 27
Output only. 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
Immutable. Details pertaining to a text ad.
expanded_text_ad = 7
Details pertaining to an expanded text ad.
call_ad = 49
Details pertaining to a call ad.
expanded_dynamic_search_ad = 14
Immutable. 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.
image_ad = 22
Immutable. Details pertaining to an Image ad.
video_ad = 24
Details pertaining to a Video ad.
video_responsive_ad = 39
Details pertaining to a Video responsive 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
Immutable. Details pertaining to a legacy app install ad.
responsive_display_ad = 31
Details pertaining to a responsive display ad.
local_ad = 32
Details pertaining to a local 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.
smart_campaign_ad = 48
Details pertaining to a Smart campaign ad.
app_pre_registration_ad = 50
Details pertaining to an app pre-registration ad.
demand_gen_multi_asset_ad = 62
Details pertaining to a Demand Gen multi asset ad.
demand_gen_carousel_ad = 63
Details pertaining to a Demand Gen carousel ad.
demand_gen_video_responsive_ad = 64
Details pertaining to a Demand Gen video responsive ad.
demand_gen_product_ad = 61
Details pertaining to a Demand Gen product ad.
travel_ad = 54
Details pertaining to a travel ad.
message
ad_group.proto:47An ad group.
Used in: , , ,
string resource_name = 1
Immutable. The resource name of the ad group. Ad group resource names have the form: `customers/{customer_id}/adGroups/{ad_group_id}`
optional int64 id = 34
Output only. The ID of the ad group.
optional string name = 35
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
Immutable. The type of the ad group.
enums.AdGroupAdRotationModeEnum.AdGroupAdRotationMode ad_rotation_mode = 22
The ad rotation mode of the ad group.
optional string base_ad_group = 36
Output only. 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 string tracking_url_template = 37
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 string campaign = 38
Immutable. The campaign to which the ad group belongs.
optional int64 cpc_bid_micros = 39
The maximum CPC (cost-per-click) bid.
optional int64 effective_cpc_bid_micros = 57
Output only. Value will be same as that of the CPC (cost-per-click) bid value when the bidding strategy is one of manual cpc, enhanced cpc, page one promoted or target outrank share, otherwise the value will be null.
optional int64 cpm_bid_micros = 40
The maximum CPM (cost-per-thousand viewable impressions) bid.
optional int64 target_cpa_micros = 41
The target CPA (cost-per-acquisition). If the ad group's campaign bidding strategy is TargetCpa or MaximizeConversions (with its target_cpa field set), then this field overrides the target CPA specified in the campaign's bidding strategy. Otherwise, this value is ignored.
optional int64 cpv_bid_micros = 42
The CPV (cost-per-view) bid.
optional int64 target_cpm_micros = 43
Average amount in micros that the advertiser is willing to pay for every thousand times the ad is shown.
optional double target_roas = 44
The target ROAS (return-on-ad-spend) override. If the ad group's campaign bidding strategy is TargetRoas or MaximizeConversionValue (with its target_roas field set), then this field overrides the target ROAS specified in the campaign's bidding strategy. Otherwise, this value is ignored.
optional int64 percent_cpc_bid_micros = 45
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 int64 fixed_cpm_micros = 64
The fixed amount in micros that the advertiser pays for every thousand impressions of the ad.
optional int64 target_cpv_micros = 65
Average amount in micros that the advertiser is willing to pay for every ad view.
optional int64 target_cpc_micros = 68
Average amount in micros that the advertiser is willing to pay for every ad click. Overrides the target CPC configured at the campaign level.
bool optimized_targeting_enabled = 59
True if optimized targeting is enabled. Optimized Targeting is the replacement for Audience Expansion.
bool exclude_demographic_expansion = 67
When this value is true, demographics will be excluded from the types of targeting which are expanded when optimized_targeting_enabled is true. When optimized_targeting_enabled is false, this field is ignored. Default is false.
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 string final_url_suffix = 46
URL template for appending params to Final URL.
optional targeting_setting = 25
Setting for targeting related features.
optional audience_setting = 56
Immutable. Setting for audience related features.
optional int64 effective_target_cpa_micros = 47
Output only. The effective target CPA (cost-per-acquisition). This field is read-only.
enums.BiddingSourceEnum.BiddingSource effective_target_cpa_source = 29
Output only. Source of the effective target CPA. This field is read-only.
optional double effective_target_roas = 48
Output only. The effective target ROAS (return-on-ad-spend). This field is read-only.
enums.BiddingSourceEnum.BiddingSource effective_target_roas_source = 32
Output only. Source of the effective target ROAS. This field is read-only.
optional int64 effective_target_cpc = 69
Output only. The effective target CPC (cost-per-click). This field is read-only.
enums.BiddingSourceEnum.BiddingSource effective_target_cpc_source = 70
Output only. Source of the effective target CPC. This field is read-only.
repeated string labels = 49
Output only. The resource names of labels attached to this ad group.
repeated enums.AssetFieldTypeEnum.AssetFieldType excluded_parent_asset_field_types = 54
The asset field types that should be excluded from this ad group. Asset links with these field types will not be inherited by this ad group from the upper levels.
repeated enums.AssetSetTypeEnum.AssetSetType excluded_parent_asset_set_types = 58
The asset set types that should be excluded from this ad group. Asset set links with these types will not be inherited by this ad group from the upper levels. Location group types (GMB_DYNAMIC_LOCATION_GROUP, CHAIN_DYNAMIC_LOCATION_GROUP, and STATIC_LOCATION_GROUP) are child types of LOCATION_SYNC. Therefore, if LOCATION_SYNC is set for this field, all location group asset sets are not allowed to be linked to this ad group, and all Location Extension (LE) and Affiliate Location Extensions (ALE) will not be served under this ad group. Only LOCATION_SYNC is currently supported.
enums.AdGroupPrimaryStatusEnum.AdGroupPrimaryStatus primary_status = 62
Output only. Provides aggregated view into why an ad group is not serving or not serving optimally.
repeated enums.AdGroupPrimaryStatusReasonEnum.AdGroupPrimaryStatusReason primary_status_reasons = 63
Output only. Provides reasons for why an ad group is not serving or not serving optimally.
optional demand_gen_ad_group_settings = 91
Settings for Demand Gen ad groups.
optional video_ad_group_settings = 92
Settings for video ad groups.
optional ai_max_ad_group_setting = 71
Settings for AI Max feature in standard search adgroups.
message
ad_group.proto:124Settings for AI Max feature in standard search adgroups.
Used in:
optional bool disable_search_term_matching = 1
Disable search term matching for this adgroup when AI Max is enabled. Search term matching uses broad match, asset-based, and landing page-based technology to improve reach.
message
ad_group.proto:54Settings for the audience targeting.
Used in:
bool use_audience_grouped = 1
Immutable. If true, this ad group uses an Audience resource for audience targeting. If false, this ad group may use audience segment criteria instead.
message
ad_group.proto:62Settings for Demand Gen ad groups.
Used in:
optional channel_controls = 1
Channel controls for Demand Gen ad groups.
message
ad_group.proto:64Channel controls for Demand Gen ad groups.
Used in:
enums.DemandGenChannelConfigEnum.DemandGenChannelConfig channel_config = 1
Output only. Channel configuration reflecting which field in the oneof is populated.
oneof channel_configuration
Oneof between the different channel control configuration options.
enums.DemandGenChannelStrategyEnum.DemandGenChannelStrategy channel_strategy = 2
High level channel strategy.
selected_channels = 3
Explicitly selected channels. This field should be set with at least one true value when present.
message
ad_group.proto:67Explicitly selected channels for channel controls in Demand Gen ad groups.
Used in:
bool youtube_in_stream = 1
Whether to enable ads on the YouTube In-Stream channel.
bool youtube_in_feed = 2
Whether to enable ads on the YouTube In-Feed channel.
bool youtube_shorts = 3
Whether to enable ads on the YouTube Shorts channel.
bool discover = 4
Whether to enable ads on the Discover channel.
bool gmail = 5
Whether to enable ads on the Gmail channel.
bool display = 6
Whether to enable ads on the Display channel.
message
ad_group.proto:110Settings for video ad groups.
Used in:
optional video_ad_sequence = 1
The video ads sequence step settings containing step ID.
message
ad_group.proto:112The video ads sequence step settings containing step ID.
Used in:
int64 step_id = 1
The ID of this sequence step from an existing `campaign.video_campaign_settings.video_ad_sequence` definition. Only one Ad Group can point to a given `step_id`.
message
ad_group_ad.proto:44An ad group ad.
Used in: , , ,
string resource_name = 1
Immutable. 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 string ad_group = 9
Immutable. The ad group to which the ad belongs.
optional ad = 5
Immutable. The ad.
optional policy_summary = 6
Output only. Policy information for the ad.
enums.AdStrengthEnum.AdStrength ad_strength = 7
Output only. Overall ad strength for this ad group ad.
repeated string action_items = 13
Output only. A list of recommendations to improve the ad strength. For example, a recommendation could be "Try adding a few more unique headlines or unpinning some assets.".
repeated string labels = 10
Output only. The resource names of labels attached to this ad group ad.
enums.AdGroupAdPrimaryStatusEnum.AdGroupAdPrimaryStatus primary_status = 16
Output only. Provides aggregated view into why an ad group ad is not serving or not serving optimally.
repeated enums.AdGroupAdPrimaryStatusReasonEnum.AdGroupAdPrimaryStatusReason primary_status_reasons = 17
Output only. Provides reasons for why an ad group ad is not serving or not serving optimally.
repeated ad_group_ad_asset_automation_settings = 18
Settings that control the types of asset automation. See the AssetAutomationTypeEnum documentation for the default opt in/out behavior of each type.
message
ad_group_ad.proto:132Asset automation setting for an AdGroupAd.
Used in:
optional enums.AssetAutomationTypeEnum.AssetAutomationType asset_automation_type = 1
The asset automation type that this setting configures.
optional enums.AssetAutomationStatusEnum.AssetAutomationStatus asset_automation_status = 2
The opt-in/out status for the specified asset automation type.
A view on the usage of ad group ad asset combination. Now we only support AdGroupAdAssetCombinationView for Responsive Search Ads, with more ad types planned for the future.
Used in:
string resource_name = 1
Output only. The resource name of the ad group ad asset combination view. The combination ID is 128 bits long, where the upper 64 bits are stored in asset_combination_id_high, and the lower 64 bits are stored in asset_combination_id_low. AdGroupAd Asset Combination view resource names have the form: `customers/{customer_id}/adGroupAdAssetCombinationViews/{AdGroupAd.ad_group_id}~{AdGroupAd.ad.ad_id}~{AssetCombination.asset_combination_id_low}~{AssetCombination.asset_combination_id_high}`
repeated served_assets = 2
Output only. Served assets.
optional bool enabled = 3
Output only. The status between the asset combination and the latest version of the ad. If true, the asset combination is linked to the latest version of the ad. If false, it means the link once existed but has been removed and is no longer present in the latest version of the ad.
message
ad_group_ad_asset_view.proto:105Contains policy information for an ad group ad asset.
Used in:
repeated policy_topic_entries = 1
Output only. The list of policy findings for the ad group ad asset.
enums.PolicyReviewStatusEnum.PolicyReviewStatus review_status = 2
Output only. Where in the review process this ad group ad asset is.
enums.PolicyApprovalStatusEnum.PolicyApprovalStatus approval_status = 3
Output only. 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:42A link between an AdGroupAd and an Asset. AdGroupAdAssetView supports AppAds, Demand Gen campaigns, and Responsive Search Ads.
Used in:
string resource_name = 1
Output only. The resource name of the ad group ad asset view. Ad group ad asset view resource names have the form (Before V4): `customers/{customer_id}/adGroupAdAssets/{AdGroupAdAsset.ad_group_id}~{AdGroupAdAsset.ad.ad_id}~{AdGroupAdAsset.asset_id}~{AdGroupAdAsset.field_type}` Ad group ad asset view resource names have the form (Beginning from V4): `customers/{customer_id}/adGroupAdAssetViews/{AdGroupAdAsset.ad_group_id}~{AdGroupAdAsset.ad_id}~{AdGroupAdAsset.asset_id}~{AdGroupAdAsset.field_type}`
optional string ad_group_ad = 9
Output only. The ad group ad to which the asset is linked.
optional string asset = 10
Output only. The asset which is linked to the ad group ad.
enums.AssetFieldTypeEnum.AssetFieldType field_type = 2
Output only. Role that the asset takes in the ad.
optional bool enabled = 8
Output only. The status between the asset and the latest version of the ad. If true, the asset is linked to the latest version of the ad. If false, it means the link once existed but has been removed and is no longer present in the latest version of the ad.
optional policy_summary = 3
Output only. Policy information for the ad group ad asset.
enums.AssetPerformanceLabelEnum.AssetPerformanceLabel performance_label = 4
Output only. Performance of an asset linkage.
enums.ServedAssetFieldTypeEnum.ServedAssetFieldType pinned_field = 11
Output only. Pinned field.
enums.AssetSourceEnum.AssetSource source = 12
Output only. Source of the ad group ad asset.
message
ad_group_ad_label.proto:34A relationship between an ad group ad and a label.
Used in: ,
string resource_name = 1
Immutable. 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 string ad_group_ad = 4
Immutable. The ad group ad to which the label is attached.
optional string label = 5
Immutable. The label assigned to the ad group ad.
message
ad_group_ad.proto:116Contains policy information for an ad.
Used in:
repeated policy_topic_entries = 1
Output only. The list of policy findings for this ad.
enums.PolicyReviewStatusEnum.PolicyReviewStatus review_status = 2
Output only. Where in the review process this ad is.
enums.PolicyApprovalStatusEnum.PolicyApprovalStatus approval_status = 3
Output only. The overall approval status of this ad, calculated based on the status of its individual policy topic entries.
message
ad_group_asset.proto:40A link between an ad group and an asset.
Used in: , , ,
string resource_name = 1
Immutable. The resource name of the ad group asset. AdGroupAsset resource names have the form: `customers/{customer_id}/adGroupAssets/{ad_group_id}~{asset_id}~{field_type}`
string ad_group = 2
Required. Immutable. The ad group to which the asset is linked.
string asset = 3
Required. Immutable. The asset which is linked to the ad group.
enums.AssetFieldTypeEnum.AssetFieldType field_type = 4
Required. Immutable. Role that the asset takes under the linked ad group.
enums.AssetSourceEnum.AssetSource source = 6
Output only. Source of the adgroup asset link.
enums.AssetLinkStatusEnum.AssetLinkStatus status = 5
Status of the ad group asset.
enums.AssetLinkPrimaryStatusEnum.AssetLinkPrimaryStatus primary_status = 7
Output only. Provides the PrimaryStatus of this asset link. Primary status is meant essentially to differentiate between the plain "status" field, which has advertiser set values of enabled, paused, or removed. The primary status takes into account other signals (for assets its mainly policy and quality approvals) to come up with a more comprehensive status to indicate its serving state.
repeated primary_status_details = 8
Output only. Provides the details of the primary status and its associated reasons.
repeated enums.AssetLinkPrimaryStatusReasonEnum.AssetLinkPrimaryStatusReason primary_status_reasons = 9
Output only. Provides a list of reasons for why an asset is not serving or not serving at full capacity.
message
ad_group_asset_set.proto:36AdGroupAssetSet is the linkage between an ad group and an asset set. Creating an AdGroupAssetSet links an asset set with an ad group.
Used in: , ,
string resource_name = 1
Immutable. The resource name of the ad group asset set. Ad group asset set resource names have the form: `customers/{customer_id}/adGroupAssetSets/{ad_group_id}~{asset_set_id}`
string ad_group = 2
Immutable. The ad group to which this asset set is linked.
string asset_set = 3
Immutable. The asset set which is linked to the ad group.
enums.AssetSetLinkStatusEnum.AssetSetLinkStatus status = 4
Output only. The status of the ad group asset set. Read-only.
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 in:
string resource_name = 1
Output only. 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:36Represents an ad group bid modifier.
Used in: , , ,
string resource_name = 1
Immutable. 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 string ad_group = 13
Immutable. The ad group to which this criterion belongs.
optional int64 criterion_id = 14
Output only. The ID of the criterion to bid modify. This field is ignored for mutates.
optional double bid_modifier = 15
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 string base_ad_group = 16
Output only. 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
Output only. Bid modifier source.
oneof criterion
The criterion of this ad group bid modifier. Required in create operations starting in V5.
hotel_date_selection_type = 5
Immutable. Criterion for hotel date selection (default dates versus user selected).
hotel_advance_booking_window = 6
Immutable. Criterion for number of days prior to the stay the booking is being made.
hotel_length_of_stay = 7
Immutable. Criterion for length of hotel stay in nights.
hotel_check_in_day = 8
Immutable. Criterion for day of the week the booking is for.
device = 11
Immutable. A device criterion.
hotel_check_in_date_range = 17
Immutable. Criterion for a hotel check-in date range.
message
ad_group_criterion.proto:46An ad group criterion. The ad_group_criterion report only returns criteria that were explicitly added to the ad group.
Used in: , , ,
string resource_name = 1
Immutable. 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 int64 criterion_id = 56
Output only. The ID of the criterion. This field is ignored for mutates.
string display_name = 77
Output only. The display name of the criterion. This field is ignored for mutates.
enums.AdGroupCriterionStatusEnum.AdGroupCriterionStatus status = 3
The status of the criterion. This is the status of the ad group criterion entity, set by the client. Note: UI reports may incorporate additional information that affects whether a criterion is eligible to run. In some cases a criterion that's REMOVED in the API can still show as enabled in the UI. For example, campaigns by default show to users of all age ranges unless excluded. The UI will show each age range as "enabled", since they're eligible to see the ads; but AdGroupCriterion.status will show "removed", since no positive criterion was added.
optional quality_info = 4
Output only. Information regarding the quality of the criterion.
optional string ad_group = 57
Immutable. The ad group to which the criterion belongs.
enums.CriterionTypeEnum.CriterionType type = 25
Output only. The type of the criterion.
optional bool negative = 58
Immutable. 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
Output only. Serving status of the criterion.
enums.AdGroupCriterionApprovalStatusEnum.AdGroupCriterionApprovalStatus approval_status = 53
Output only. Approval status of the criterion.
repeated string disapproval_reasons = 59
Output only. List of disapproval reasons of the criterion. The different reasons for disapproving a criterion can be found here: https://support.google.com/adspolicy/answer/6008942 This field is read-only.
repeated string labels = 60
Output only. The resource names of labels attached to this ad group criterion.
optional double bid_modifier = 61
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 int64 cpc_bid_micros = 62
The CPC (cost-per-click) bid.
optional int64 cpm_bid_micros = 63
The CPM (cost-per-thousand viewable impressions) bid.
optional int64 cpv_bid_micros = 64
The CPV (cost-per-view) bid.
optional int64 percent_cpc_bid_micros = 65
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 int64 effective_cpc_bid_micros = 66
Output only. The effective CPC (cost-per-click) bid.
optional int64 effective_cpm_bid_micros = 67
Output only. The effective CPM (cost-per-thousand viewable impressions) bid.
optional int64 effective_cpv_bid_micros = 68
Output only. The effective CPV (cost-per-view) bid.
optional int64 effective_percent_cpc_bid_micros = 69
Output only. The effective Percent CPC bid amount.
enums.BiddingSourceEnum.BiddingSource effective_cpc_bid_source = 21
Output only. Source of the effective CPC bid.
enums.BiddingSourceEnum.BiddingSource effective_cpm_bid_source = 22
Output only. Source of the effective CPM bid.
enums.BiddingSourceEnum.BiddingSource effective_cpv_bid_source = 23
Output only. Source of the effective CPV bid.
enums.BiddingSourceEnum.BiddingSource effective_percent_cpc_bid_source = 35
Output only. Source of the effective Percent CPC bid.
optional position_estimates = 10
Output only. Estimates for criterion bids at various positions.
repeated string final_urls = 70
The list of possible final URLs after all cross-domain redirects for the ad.
repeated string final_mobile_urls = 71
The list of possible final mobile URLs after all cross-domain redirects.
optional string final_url_suffix = 72
URL template for appending params to final URL.
optional string tracking_url_template = 73
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`.
optional enums.AdGroupCriterionPrimaryStatusEnum.AdGroupCriterionPrimaryStatus primary_status = 85
Output only. The primary status for the ad group criterion.
repeated enums.AdGroupCriterionPrimaryStatusReasonEnum.AdGroupCriterionPrimaryStatusReason primary_status_reasons = 86
Output only. The primary status reasons for the ad group criterion.
oneof criterion
The ad group criterion. Exactly one must be set.
keyword = 27
Immutable. Keyword.
placement = 28
Immutable. Placement.
mobile_app_category = 29
Immutable. Mobile app category.
mobile_application = 30
Immutable. Mobile application.
listing_group = 32
Immutable. Listing group.
age_range = 36
Immutable. Age range.
gender = 37
Immutable. Gender.
income_range = 38
Immutable. Income range.
parental_status = 39
Immutable. Parental status.
user_list = 42
Immutable. User List.
youtube_video = 40
Immutable. YouTube Video.
youtube_channel = 41
Immutable. YouTube Channel.
topic = 43
Immutable. Topic.
user_interest = 45
Immutable. User Interest.
webpage = 46
Immutable. Webpage
app_payment_model = 47
Immutable. App Payment Model.
custom_affinity = 48
Immutable. Custom Affinity.
custom_intent = 49
Immutable. Custom Intent.
custom_audience = 74
Immutable. Custom Audience.
combined_audience = 75
Immutable. Combined Audience.
audience = 79
Immutable. Audience.
location = 82
Immutable. Location.
language = 83
Immutable. Language.
life_event = 84
Immutable. Life event campaign criterion.
video_lineup = 88
Immutable. Video lineup criterion.
extended_demographic = 90
Immutable. Extended demographic criterion.
brand_list = 89
Immutable. Brand list criterion.
message
ad_group_criterion.proto:77Estimates for criterion bids at various positions.
Used in:
optional int64 first_page_cpc_micros = 6
Output only. The estimate of the CPC bid required for ad to be shown on first page of search results.
optional int64 first_position_cpc_micros = 7
Output only. 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 int64 top_of_page_cpc_micros = 8
Output only. The estimate of the CPC bid required for ad to be displayed at the top of the first page of search results.
optional int64 estimated_add_clicks_at_first_position_cpc = 9
Output only. Estimate of how many clicks per week you might get by changing your keyword bid to the value in first_position_cpc_micros.
optional int64 estimated_add_cost_at_first_position_cpc = 10
Output only. 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:53A container for ad group criterion quality information.
Used in:
optional int32 quality_score = 5
Output only. 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
Output only. The performance of the ad compared to other advertisers.
enums.QualityScoreBucketEnum.QualityScoreBucket post_click_quality_score = 3
Output only. The quality score of the landing page.
enums.QualityScoreBucketEnum.QualityScoreBucket search_predicted_ctr = 4
Output only. The click-through rate compared to that of other advertisers.
A customizer value for the associated CustomizerAttribute at the AdGroupCriterion level.
Used in: , ,
string resource_name = 1
Immutable. The resource name of the ad group criterion customizer. Ad group criterion customizer resource names have the form: `customers/{customer_id}/adGroupCriterionCustomizers/{ad_group_id}~{criterion_id}~{customizer_attribute_id}`
optional string ad_group_criterion = 2
Immutable. The ad group criterion to which the customizer attribute is linked. It must be a keyword criterion.
string customizer_attribute = 3
Required. Immutable. The customizer attribute which is linked to the ad group criterion.
enums.CustomizerValueStatusEnum.CustomizerValueStatus status = 4
Output only. The status of the ad group criterion customizer.
optional value = 5
Required. The value to associate with the customizer attribute at this level. The value must be of the type specified for the CustomizerAttribute.
A relationship between an ad group criterion and a label.
Used in: ,
string resource_name = 1
Immutable. 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 string ad_group_criterion = 4
Immutable. The ad group criterion to which the label is attached.
optional string label = 5
Immutable. 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. Hotel AdGroupCriterion simulation operations starting in V5. 1. DISPLAY - KEYWORD - CPC_BID - UNIFORM 2. SEARCH - KEYWORD - CPC_BID - UNIFORM 3. SHOPPING - LISTING_GROUP - CPC_BID - UNIFORM 4. HOTEL - LISTING_GROUP - CPC_BID - UNIFORM 5. HOTEL - LISTING_GROUP - PERCENT_CPC_BID - UNIFORM
Used in:
string resource_name = 1
Output only. 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 int64 ad_group_id = 9
Output only. AdGroup ID of the simulation.
optional int64 criterion_id = 10
Output only. Criterion ID of the simulation.
enums.SimulationTypeEnum.SimulationType type = 4
Output only. The field that the simulation modifies.
enums.SimulationModificationMethodEnum.SimulationModificationMethod modification_method = 5
Output only. How the simulation modifies the field.
optional string start_date = 11
Output only. First day on which the simulation is based, in YYYY-MM-DD format.
optional string end_date = 12
Output only. 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
Output only. Simulation points if the simulation type is CPC_BID.
percent_cpc_bid_point_list = 13
Output only. Simulation points if the simulation type is PERCENT_CPC_BID.
message
ad_group_customizer.proto:35A customizer value for the associated CustomizerAttribute at the AdGroup level.
Used in: , ,
string resource_name = 1
Immutable. The resource name of the ad group customizer. Ad group customizer resource names have the form: `customers/{customer_id}/adGroupCustomizers/{ad_group_id}~{customizer_attribute_id}`
string ad_group = 2
Immutable. The ad group to which the customizer attribute is linked.
string customizer_attribute = 3
Required. Immutable. The customizer attribute which is linked to the ad group.
enums.CustomizerValueStatusEnum.CustomizerValueStatus status = 4
Output only. The status of the ad group customizer.
optional value = 5
Required. The value to associate with the customizer attribute at this level. The value must be of the type specified for the CustomizerAttribute.
message
ad_group_label.proto:34A relationship between an ad group and a label.
Used in: ,
string resource_name = 1
Immutable. 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 string ad_group = 4
Immutable. The ad group to which the label is attached.
optional string label = 5
Immutable. The label assigned to the ad group.
message
ad_group_simulation.proto:47An ad group simulation. Supported combinations of advertising channel type, simulation type and simulation modification method is detailed below respectively. 1. SEARCH - CPC_BID - DEFAULT 2. SEARCH - CPC_BID - UNIFORM 3. SEARCH - TARGET_CPA - UNIFORM 4. SEARCH - TARGET_ROAS - UNIFORM 5. DISPLAY - CPC_BID - DEFAULT 6. DISPLAY - CPC_BID - UNIFORM 7. DISPLAY - TARGET_CPA - UNIFORM
Used in:
string resource_name = 1
Output only. 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 int64 ad_group_id = 12
Output only. Ad group id of the simulation.
enums.SimulationTypeEnum.SimulationType type = 3
Output only. The field that the simulation modifies.
enums.SimulationModificationMethodEnum.SimulationModificationMethod modification_method = 4
Output only. How the simulation modifies the field.
optional string start_date = 13
Output only. First day on which the simulation is based, in YYYY-MM-DD format.
optional string end_date = 14
Output only. 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
Output only. Simulation points if the simulation type is CPC_BID.
cpv_bid_point_list = 10
Output only. Simulation points if the simulation type is CPV_BID.
target_cpa_point_list = 9
Output only. Simulation points if the simulation type is TARGET_CPA.
target_roas_point_list = 11
Output only. Simulation points if the simulation type is TARGET_ROAS.
message
ad_parameter.proto:39An 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}". For example, "{param1:$17}"
Used in: , ,
string resource_name = 1
Immutable. 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 string ad_group_criterion = 5
Immutable. The ad group criterion that this ad parameter belongs to.
optional int64 parameter_index = 6
Immutable. The unique index of this ad parameter. Must be either 1 or 2.
optional string insertion_text = 7
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 in:
string resource_name = 1
Output only. The resource name of the ad schedule view. AdSchedule view resource names have the form: `customers/{customer_id}/adScheduleViews/{campaign_id}~{criterion_id}`
message
asset_group.proto:127An action item to improve the ad strength of an asset group.
Used in:
enums.AdStrengthActionItemTypeEnum.AdStrengthActionItemType action_item_type = 1
Output only. The action item type.
oneof action_details
The details of this action item.
add_asset_details = 2
Output only. The action item details for action item type ADD_ASSET.
message
asset_group.proto:129The details of the asset to add.
Used in:
enums.AssetFieldTypeEnum.AssetFieldType asset_field_type = 1
Output only. The asset field type of the asset(s) to add.
optional int32 asset_count = 2
Output only. The number of assets to add.
optional enums.AssetCoverageVideoAspectRatioRequirementEnum.AssetCoverageVideoAspectRatioRequirement video_aspect_ratio_requirement = 3
Output only. For video field types, the required aspect ratio of the video. When unset and asset_field_type is YOUTUBE_VIDEO, the system recommends the advertiser upload any YouTube video, regardless of aspect ratio.
message
product_link.proto:114The identifier for the Advertising Partner Google Ads account.
Used in:
optional string customer = 1
Output only. The resource name of the advertising partner Google Ads account. This field is required and should not be empty when creating a new Advertising Partner link. It is unable to be modified after the creation of the link.
The identifier for the Advertising Partner Google Ads account.
Used in:
optional string customer = 1
Immutable. The resource name of the advertising partner Google Ads account. This field is read only.
message
age_range_view.proto:34An age range view.
Used in:
string resource_name = 1
Output only. 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}`
AiMaxSearchTermAdCombinationView Resource.
Used in:
string resource_name = 1
Output only. The resource name of the AI Max Search Term Ad Combination view AI Max Search Term Ad Combination view resource names have the form: `customers/{customer_id}/aiMaxSearchTermAdCombinationViews/{ad_group_id}~{URL-base64_search_term}~{URL-base64_landing_page}~{URL-base64_headline}`
optional string ad_group = 2
Output only. Ad group where the search term served.
optional string search_term = 3
Output only. The search term that triggered the ad. This field is read-only.
optional string landing_page = 4
Output only. The destination URL, which was dynamically generated. This field is read-only.
optional string headline = 5
Output only. The concatenated string containing headline assets for the ad. Up to three headline assets are concatenated, separated by " | ". This field is read-only.
An Android privacy shared key view for Google ad group key.
Used in:
string resource_name = 1
Output only. The resource name of the Android privacy shared key. Android privacy shared key resource names have the form: `customers/{customer_id}/androidPrivacySharedKeyGoogleAdGroups/{campaign_id}~{ad_group_id}~{android_privacy_interaction_type}~{android_privacy_network_type}~{android_privacy_interaction_date(yyyy-mm-dd)}`
int64 campaign_id = 2
Output only. The campaign ID used in the share key encoding.
enums.AndroidPrivacyInteractionTypeEnum.AndroidPrivacyInteractionType android_privacy_interaction_type = 3
Output only. The interaction type enum used in the share key encoding.
string android_privacy_interaction_date = 4
Output only. The interaction date used in the shared key encoding in the format of "YYYY-MM-DD" in UTC timezone.
enums.AndroidPrivacyNetworkTypeEnum.AndroidPrivacyNetworkType android_privacy_network_type = 5
Output only. The network type enum used in the share key encoding.
int64 ad_group_id = 6
Output only. The ad group ID used in the share key encoding.
string shared_ad_group_key = 7
Output only. 128 bit hex string of the encoded shared ad group key, including a '0x' prefix. This key can be used to do a bitwise OR operator with the aggregate conversion key to create a full aggregation key to retrieve the Aggregate API Report in Android Privacy Sandbox.
An Android privacy shared key view for Google campaign key.
Used in:
string resource_name = 1
Output only. The resource name of the Android privacy shared key. Android privacy shared key resource names have the form: `customers/{customer_id}/androidPrivacySharedKeyGoogleCampaigns/{campaign_id}~{android_privacy_interaction_type}~{android_privacy_interaction_date(yyyy-mm-dd)}`
int64 campaign_id = 2
Output only. The campaign ID used in the share key encoding.
enums.AndroidPrivacyInteractionTypeEnum.AndroidPrivacyInteractionType android_privacy_interaction_type = 3
Output only. The interaction type enum used in the share key encoding.
string android_privacy_interaction_date = 4
Output only. The interaction date used in the shared key encoding in the format of "YYYY-MM-DD" in UTC timezone.
string shared_campaign_key = 5
Output only. 128 bit hex string of the encoded shared campaign key, including a '0x' prefix. This key can be used to do a bitwise OR operator with the aggregate conversion key to create a full aggregation key to retrieve the Aggregate API Report in Android Privacy Sandbox.
An Android privacy shared key view for Google network type key.
Used in:
string resource_name = 1
Output only. The resource name of the Android privacy shared key. Android privacy shared key resource names have the form: `customers/{customer_id}/androidPrivacySharedKeyGoogleNetworkTypes/{campaign_id}~{android_privacy_interaction_type}~{android_privacy_network_type}~{android_privacy_interaction_date(yyyy-mm-dd)}`
int64 campaign_id = 2
Output only. The campaign ID used in the share key encoding.
enums.AndroidPrivacyInteractionTypeEnum.AndroidPrivacyInteractionType android_privacy_interaction_type = 3
Output only. The interaction type enum used in the share key encoding.
string android_privacy_interaction_date = 4
Output only. The interaction date used in the shared key encoding in the format of "YYYY-MM-DD" in UTC timezone.
enums.AndroidPrivacyNetworkTypeEnum.AndroidPrivacyNetworkType android_privacy_network_type = 5
Output only. The network type enum used in the share key encoding.
string shared_network_type_key = 6
Output only. 128 bit hex string of the encoded shared network type key, including a '0x' prefix. This key can be used to do a bitwise OR operator with the aggregate conversion key to create a full aggregation key to retrieve the Aggregate API Report in Android Privacy Sandbox.
message
asset.proto:45Asset is a part of an ad which can be shared across multiple ads. It can be an image (ImageAsset), a video (YoutubeVideoAsset), etc. Assets are immutable and cannot be removed. To stop an asset from serving, remove the asset from the entity that is using it.
Used in: , , , , , ,
string resource_name = 1
Immutable. The resource name of the asset. Asset resource names have the form: `customers/{customer_id}/assets/{asset_id}`
optional int64 id = 11
Output only. The ID of the asset.
optional string name = 12
Optional name of the asset.
enums.AssetTypeEnum.AssetType type = 4
Output only. Type of the asset.
repeated string final_urls = 14
A list of possible final URLs after all cross domain redirects.
repeated string final_mobile_urls = 16
A list of possible final mobile URLs after all cross domain redirects.
optional string tracking_url_template = 17
URL template for constructing a tracking URL.
repeated url_custom_parameters = 18
A list of mappings to be used for substituting URL custom parameter tags in the tracking_url_template, final_urls, and/or final_mobile_urls.
optional string final_url_suffix = 19
URL template for appending params to landing page URLs served with parallel tracking.
enums.AssetSourceEnum.AssetSource source = 38
Output only. Source of the asset.
optional policy_summary = 13
Output only. Policy information for the asset.
repeated field_type_policy_summaries = 40
Output only. Policy information for the asset for each FieldType.
oneof asset_data
The specific type of the asset.
youtube_video_asset = 5
Immutable. A YouTube video asset.
media_bundle_asset = 6
Immutable. A media bundle asset.
image_asset = 7
Output only. An image asset.
text_asset = 8
Immutable. A text asset.
lead_form_asset = 9
A lead form asset.
book_on_google_asset = 10
A book on google asset.
promotion_asset = 15
A promotion asset.
callout_asset = 20
A callout asset.
structured_snippet_asset = 21
A structured snippet asset.
sitelink_asset = 22
A sitelink asset.
page_feed_asset = 23
A page feed asset.
dynamic_education_asset = 24
A dynamic education asset.
mobile_app_asset = 25
A mobile app asset.
hotel_callout_asset = 26
A hotel callout asset.
call_asset = 27
A call asset.
price_asset = 28
A price asset.
call_to_action_asset = 29
Immutable. A call to action asset.
dynamic_real_estate_asset = 30
A dynamic real estate asset.
dynamic_custom_asset = 31
A dynamic custom asset.
dynamic_hotels_and_rentals_asset = 32
A dynamic hotels and rentals asset.
dynamic_flights_asset = 33
A dynamic flights asset.
demand_gen_carousel_card_asset = 50
Immutable. A Demand Gen carousel card asset.
dynamic_travel_asset = 35
A dynamic travel asset.
dynamic_local_asset = 36
A dynamic local asset.
dynamic_jobs_asset = 37
A dynamic jobs asset.
location_asset = 39
Output only. A location asset.
hotel_property_asset = 41
Immutable. A hotel property asset.
business_message_asset = 51
A business message asset.
app_deep_link_asset = 52
Immutable. An app deep link asset.
youtube_video_list_asset = 53
Immutable. A YouTube video list asset.
message
asset_group.proto:119Information about the asset coverage of an asset group.
Used in:
repeated ad_strength_action_items = 1
Output only. A list of action items to improve the ad strength of an asset group.
message
asset.proto:214Contains policy information for an asset under AssetFieldType context.
Used in:
optional enums.AssetFieldTypeEnum.AssetFieldType asset_field_type = 1
Output only. FieldType of this asset.
optional enums.AssetSourceEnum.AssetSource asset_source = 2
Output only. Source of this asset.
optional policy_summary_info = 3
Output only. Policy summary.
message
asset_field_type_view.proto:37An asset field type view. This view reports non-overcounted metrics for each asset field type when the asset is used as extension.
Used in:
string resource_name = 1
Output only. The resource name of the asset field type view. Asset field type view resource names have the form: `customers/{customer_id}/assetFieldTypeViews/{field_type}`
enums.AssetFieldTypeEnum.AssetFieldType field_type = 3
Output only. The asset field type of the asset field type view.
message
asset_group.proto:41An asset group. AssetGroupAsset is used to link an asset to the asset group. AssetGroupSignal is used to associate a signal to an asset group.
Used in: ,
string resource_name = 1
Immutable. The resource name of the asset group. Asset group resource names have the form: `customers/{customer_id}/assetGroups/{asset_group_id}`
int64 id = 9
Output only. The ID of the asset group.
string campaign = 2
Immutable. The campaign with which this asset group is associated. The asset which is linked to the asset group.
string name = 3
Required. Name of the asset group. Required. It must have a minimum length of 1 and maximum length of 128. It must be unique under a campaign.
repeated string final_urls = 4
A list of final URLs after all cross domain redirects. In performance max, by default, the urls are eligible for expansion unless opted out.
repeated string final_mobile_urls = 5
A list of final mobile URLs after all cross domain redirects. In performance max, by default, the urls are eligible for expansion unless opted out.
enums.AssetGroupStatusEnum.AssetGroupStatus status = 6
The status of the asset group.
enums.AssetGroupPrimaryStatusEnum.AssetGroupPrimaryStatus primary_status = 11
Output only. The primary status of the asset group. Provides insights into why an asset group is not serving or not serving optimally.
repeated enums.AssetGroupPrimaryStatusReasonEnum.AssetGroupPrimaryStatusReason primary_status_reasons = 12
Output only. Provides reasons into why an asset group is not serving or not serving optimally. It will be empty when the asset group is serving without issues.
string path1 = 7
First part of text that may appear appended to the url displayed in the ad.
string path2 = 8
Second part of text that may appear appended to the url displayed in the ad. This field can only be set when path1 is set.
enums.AdStrengthEnum.AdStrength ad_strength = 10
Output only. Overall ad strength of this asset group.
optional asset_coverage = 13
Output only. The asset coverage of this asset group.
message
asset_group_asset.proto:40AssetGroupAsset is the link between an asset and an asset group. Adding an AssetGroupAsset links an asset with an asset group.
Used in: ,
string resource_name = 1
Immutable. The resource name of the asset group asset. Asset group asset resource name have the form: `customers/{customer_id}/assetGroupAssets/{asset_group_id}~{asset_id}~{field_type}`
string asset_group = 2
Immutable. The asset group which this asset group asset is linking.
string asset = 3
Immutable. The asset which this asset group asset is linking.
enums.AssetFieldTypeEnum.AssetFieldType field_type = 4
The description of the placement of the asset within the asset group. For example: HEADLINE, YOUTUBE_VIDEO etc
enums.AssetLinkStatusEnum.AssetLinkStatus status = 5
The status of the link between an asset and asset group.
enums.AssetLinkPrimaryStatusEnum.AssetLinkPrimaryStatus primary_status = 8
Output only. Provides the PrimaryStatus of this asset link. Primary status is meant essentially to differentiate between the plain "status" field, which has advertiser set values of enabled, paused, or removed. The primary status takes into account other signals (for assets its mainly policy and quality approvals) to come up with a more comprehensive status to indicate its serving state.
repeated enums.AssetLinkPrimaryStatusReasonEnum.AssetLinkPrimaryStatusReason primary_status_reasons = 9
Output only. Provides a list of reasons for why an asset is not serving or not serving at full capacity.
repeated primary_status_details = 10
Output only. Provides the details of the primary status and its associated reasons.
optional policy_summary = 7
Output only. The policy information for this asset group asset.
enums.AssetSourceEnum.AssetSource source = 11
Output only. Source of the asset group asset.
Asset group asset combination data
Used in:
repeated asset_combination_served_assets = 1
Output only. Served assets.
AssetGroupListingGroupFilter represents a listing group filter tree node in an asset group.
Used in: , ,
string resource_name = 1
Immutable. The resource name of the asset group listing group filter. Asset group listing group filter resource name have the form: `customers/{customer_id}/assetGroupListingGroupFilters/{asset_group_id}~{listing_group_filter_id}`
string asset_group = 2
Immutable. The asset group which this asset group listing group filter is part of.
int64 id = 3
Output only. The ID of the ListingGroupFilter.
enums.ListingGroupFilterTypeEnum.ListingGroupFilterType type = 4
Immutable. Type of a listing group filter node.
enums.ListingGroupFilterListingSourceEnum.ListingGroupFilterListingSource listing_source = 9
Immutable. The source of listings filtered by this listing group filter.
optional case_value = 6
Dimension value with which this listing group is refining its parent. Undefined for the root group.
string parent_listing_group_filter = 7
Immutable. Resource name of the parent listing group subdivision. Null for the root listing group filter node.
optional path = 8
Output only. The path of dimensions defining this listing group filter.
An asset group product group view.
Used in:
string resource_name = 1
Output only. The resource name of the asset group product group view. Asset group product group view resource names have the form: `customers/{customer_id}/assetGroupProductGroupViews/{asset_group_id}~{listing_group_filter_id}`
string asset_group = 2
Output only. The asset group associated with the listing group filter.
string asset_group_listing_group_filter = 4
Output only. The resource name of the asset group listing group filter.
message
asset_group_signal.proto:37AssetGroupSignal represents a signal in an asset group. The existence of a signal tells the performance max campaign who's most likely to convert. Performance Max uses the signal to look for new people with similar or stronger intent to find conversions across Search, Display, Video, and more.
Used in: , ,
string resource_name = 1
Immutable. The resource name of the asset group signal. Asset group signal resource name have the form: `customers/{customer_id}/assetGroupSignals/{asset_group_id}~{signal_id}`
string asset_group = 2
Immutable. The asset group which this asset group signal belongs to.
enums.AssetGroupSignalApprovalStatusEnum.AssetGroupSignalApprovalStatus approval_status = 6
Output only. Approval status is the output value for search theme signal after Google ads policy review. When using Audience signal, this field is not used and will be absent.
repeated string disapproval_reasons = 7
Output only. Computed for SearchTheme signals. When using Audience signal, this field is not used and will be absent.
oneof signal
The signal of the asset group.
audience = 4
Immutable. The audience signal to be used by the performance max campaign.
search_theme = 5
Immutable. The search_theme signal to be used by the performance max campaign. Mutate errors of search_theme criterion includes AssetGroupSignalError.UNSPECIFIED AssetGroupSignalError.UNKNOWN AssetGroupSignalError.TOO_MANY_WORDS AssetGroupSignalError.SEARCH_THEME_POLICY_VIOLATION FieldError.REQUIRED StringFormatError.ILLEGAL_CHARS StringLengthError.TOO_LONG ResourceCountLimitExceededError.RESOURCE_LIMIT
A view on the usage of asset group asset top combinations.
Used in:
string resource_name = 1
Output only. The resource name of the asset group top combination view. AssetGroup Top Combination view resource names have the form: `"customers/{customer_id}/assetGroupTopCombinationViews/{asset_group_id}~{asset_combination_category}"
repeated asset_group_top_combinations = 2
Output only. The top combinations of assets that served together.
message
asset.proto:229Contains policy information for an asset.
Used in: ,
repeated policy_topic_entries = 1
Output only. The list of policy findings for this asset.
enums.PolicyReviewStatusEnum.PolicyReviewStatus review_status = 2
Output only. Where in the review process this asset is.
enums.PolicyApprovalStatusEnum.PolicyApprovalStatus approval_status = 3
Output only. The overall approval status of this asset, calculated based on the status of its individual policy topic entries.
message
asset_set.proto:36An asset set representing a collection of assets. Use AssetSetAsset to link an asset to the asset set.
Used in: , , ,
int64 id = 6
Output only. The ID of the asset set.
string resource_name = 1
Immutable. The resource name of the asset set. Asset set resource names have the form: `customers/{customer_id}/assetSets/{asset_set_id}`
string name = 2
Required. Name of the asset set. Required. It must have a minimum length of 1 and maximum length of 128.
enums.AssetSetTypeEnum.AssetSetType type = 3
Required. Immutable. The type of the asset set. Required.
enums.AssetSetStatusEnum.AssetSetStatus status = 4
Output only. The status of the asset set. Read-only.
optional merchant_center_feed = 5
Merchant ID and Feed Label from Google Merchant Center.
int64 location_group_parent_asset_set_id = 10
Immutable. Parent asset set ID for the asset set where the elements of this asset set come from. For example: the sync level location AssetSet id where the elements in LocationGroup AssetSet come from. This field is required and only applicable for Location Group typed AssetSet.
optional hotel_property_data = 11
Output only. For Performance Max for travel goals campaigns with a Hotel Center account link. Read-only.
oneof asset_set_source
Asset set data specific to each asset set type. Not all types have specific data.
location_set = 7
Location asset set data. This will be used for sync level location set. This can only be set if AssetSet's type is LOCATION_SYNC.
business_profile_location_group = 8
Business Profile location group asset set data.
chain_location_group = 9
Represents information about a Chain dynamic location group. Only applicable if the sync level AssetSet's type is LOCATION_SYNC and sync source is chain.
message
asset_set.proto:53For Performance Max for travel goals campaigns with a Hotel Center account link. Read-only.
Used in:
optional int64 hotel_center_id = 1
Output only. The hotel center ID of the partner.
optional string partner_name = 2
Output only. Name of the hotel partner.
message
asset_set.proto:43Merchant ID and Feed Label from Google Merchant Center.
Used in:
int64 merchant_id = 1
Required. Merchant ID from Google Merchant Center
optional string feed_label = 2
Optional. Feed Label from Google Merchant Center.
message
asset_set_asset.proto:34AssetSetAsset is the link between an asset and an asset set. Adding an AssetSetAsset links an asset with an asset set.
Used in: , , ,
string resource_name = 1
Immutable. The resource name of the asset set asset. Asset set asset resource names have the form: `customers/{customer_id}/assetSetAssets/{asset_set_id}~{asset_id}`
string asset_set = 2
Immutable. The asset set which this asset set asset is linking to.
string asset = 3
Immutable. The asset which this asset set asset is linking to.
enums.AssetSetAssetStatusEnum.AssetSetAssetStatus status = 4
Output only. The status of the asset set asset. Read-only.
message
asset_set_type_view.proto:38An asset set type view. This view reports non-overcounted metrics for each asset set type. Child asset set types are not included in this report. Their stats are aggregated under the parent asset set type.
Used in:
string resource_name = 1
Output only. The resource name of the asset set type view. Asset set type view resource names have the form: `customers/{customer_id}/assetSetTypeViews/{asset_set_type}`
enums.AssetSetTypeEnum.AssetSetType asset_set_type = 3
Output only. The asset set type of the asset set type view.
message
audience.proto:40Audience is an effective targeting option that lets you intersect different segment attributes, such as detailed demographics and affinities, to create audiences that represent sections of your target segments.
Used in: , ,
string resource_name = 1
Immutable. The resource name of the audience. Audience names have the form: `customers/{customer_id}/audiences/{audience_id}`
int64 id = 2
Output only. ID of the audience.
enums.AudienceStatusEnum.AudienceStatus status = 3
Output only. Status of this audience. Indicates whether the audience is enabled or removed.
optional string name = 10
Name of the audience. It should be unique across all audiences within the account. It must have a minimum length of 1 and maximum length of 255. Required when scope is not set or is set to CUSTOMER. Cannot be set or updated when scope is ASSET_GROUP.
string description = 5
Description of this audience.
repeated dimensions = 6
Positive dimensions specifying the audience composition.
optional exclusion_dimension = 7
Negative dimension specifying the audience composition.
enums.AudienceScopeEnum.AudienceScope scope = 8
Defines the scope this audience can be used in. By default, the scope is CUSTOMER. Audiences can be created with a scope of ASSET_GROUP for exclusive use by a single asset_group. Scope may change from ASSET_GROUP to CUSTOMER but not from CUSTOMER to ASSET_GROUP.
string asset_group = 9
Immutable. The asset group that this audience is scoped under. Must be set if and only if scope is ASSET_GROUP. Immutable after creation. If an audience with ASSET_GROUP scope is upgraded to CUSTOMER scope, this field will automatically be cleared.
A proto holding information specific to local services background check.
Used in:
optional string case_url = 1
Output only. URL to access background case.
optional string final_adjudication_date_time = 2
Output only. The timestamp when this background check case result was adjudicated. The format is "YYYY-MM-DD HH:MM:SS" in the Google Ads account's timezone. Examples: "2018-03-05 09:15:00" or "2018-02-01 14:34:30"
message
batch_job.proto:37A 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 BatchJobService.ListBatchJobResults.
Used in: ,
string resource_name = 1
Immutable. The resource name of the batch job. Batch job resource names have the form: `customers/{customer_id}/batchJobs/{batch_job_id}`
optional int64 id = 7
Output only. ID of this batch job.
optional string next_add_sequence_token = 8
Output only. The next sequence token to use when adding operations. Only set when the batch job status is PENDING.
optional metadata = 4
Output only. Contains additional information about this batch job.
enums.BatchJobStatusEnum.BatchJobStatus status = 5
Output only. Status of this batch job.
optional string long_running_operation = 9
Output only. The resource name of the long-running operation that can be used to poll for completion. Only set when the batch job status is RUNNING or DONE.
message
batch_job.proto:45Additional information about the batch job. This message is also used as metadata returned in batch job Long Running Operations.
Used in:
optional string creation_date_time = 8
Output only. The time when this batch job was created. Formatted as yyyy-mm-dd hh:mm:ss. Example: "2018-03-05 09:15:00"
optional string start_date_time = 7
Output only. The time when this batch job started running. Formatted as yyyy-mm-dd hh:mm:ss. Example: "2018-03-05 09:15:30"
optional string completion_date_time = 9
Output only. The time when this batch job was completed. Formatted as yyyy-MM-dd HH:mm:ss. Example: "2018-03-05 09:16:00"
optional double estimated_completion_ratio = 10
Output only. 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 int64 operation_count = 11
Output only. The number of mutate operations in the batch job.
optional int64 executed_operation_count = 12
Output only. The number of mutate operations executed by the batch job. Present only if the job has started running.
optional int32 execution_limit_seconds = 13
Immutable. The approximate upper bound for how long a batch job can be executed, in seconds. If the job runs more than the given upper bound, the job will be canceled.
message
bidding_data_exclusion.proto:40Represents a bidding data exclusion. Bidding data exclusions can be set in client accounts only, and cannot be used in manager accounts. See "About data exclusions" at https://support.google.com/google-ads/answer/10370710.
Used in: , ,
string resource_name = 1
Immutable. The resource name of the data exclusion. Data exclusion resource names have the form: `customers/{customer_id}/biddingDataExclusions/{data_exclusion_id}`
int64 data_exclusion_id = 2
Output only. The ID of the data exclusion.
enums.SeasonalityEventScopeEnum.SeasonalityEventScope scope = 3
The scope of the data exclusion.
enums.SeasonalityEventStatusEnum.SeasonalityEventStatus status = 4
Output only. The status of the data exclusion.
string start_date_time = 5
Required. The inclusive start time of the data exclusion in yyyy-MM-dd HH:mm:ss format. A data exclusion is backward looking and should be used for events that start in the past and end either in the past or future.
string end_date_time = 6
Required. The exclusive end time of the data exclusion in yyyy-MM-dd HH:mm:ss format. The length of [start_date_time, end_date_time) interval must be within (0, 14 days].
string name = 7
The name of the data exclusion. The name can be at most 255 characters.
string description = 8
The description of the data exclusion. The description can be at most 2048 characters.
repeated enums.DeviceEnum.Device devices = 9
If not specified, all devices will be included in this exclusion. Otherwise, only the specified targeted devices will be included in this exclusion.
repeated string campaigns = 10
The data exclusion will apply to the campaigns listed when the scope of this exclusion is CAMPAIGN. The maximum number of campaigns per event is 2000. Note: a data exclusion with both advertising_channel_types and campaign_ids is not supported.
repeated enums.AdvertisingChannelTypeEnum.AdvertisingChannelType advertising_channel_types = 11
The data_exclusion will apply to all the campaigns under the listed channels retroactively as well as going forward when the scope of this exclusion is CHANNEL. The supported advertising channel types are DISPLAY, SEARCH and SHOPPING. Note: a data exclusion with both advertising_channel_types and campaign_ids is not supported.
Represents a bidding seasonality adjustment. Cannot be used in manager accounts. See "About seasonality adjustments" at https://support.google.com/google-ads/answer/10369906.
Used in: , ,
string resource_name = 1
Immutable. The resource name of the seasonality adjustment. Seasonality adjustment resource names have the form: `customers/{customer_id}/biddingSeasonalityAdjustments/{seasonality_adjustment_id}`
int64 seasonality_adjustment_id = 2
Output only. The ID of the seasonality adjustment.
enums.SeasonalityEventScopeEnum.SeasonalityEventScope scope = 3
The scope of the seasonality adjustment.
enums.SeasonalityEventStatusEnum.SeasonalityEventStatus status = 4
Output only. The status of the seasonality adjustment.
string start_date_time = 5
Required. The inclusive start time of the seasonality adjustment in yyyy-MM-dd HH:mm:ss format. A seasonality adjustment is forward looking and should be used for events that start and end in the future.
string end_date_time = 6
Required. The exclusive end time of the seasonality adjustment in yyyy-MM-dd HH:mm:ss format. The length of [start_date_time, end_date_time) interval must be within (0, 14 days].
string name = 7
The name of the seasonality adjustment. The name can be at most 255 characters.
string description = 8
The description of the seasonality adjustment. The description can be at most 2048 characters.
repeated enums.DeviceEnum.Device devices = 9
If not specified, all devices will be included in this adjustment. Otherwise, only the specified targeted devices will be included in this adjustment.
double conversion_rate_modifier = 10
Conversion rate modifier estimated based on expected conversion rate changes. When this field is unset or set to 1.0 no adjustment will be applied to traffic. The allowed range is 0.1 to 10.0.
repeated string campaigns = 11
The seasonality adjustment will apply to the campaigns listed when the scope of this adjustment is CAMPAIGN. The maximum number of campaigns per event is 2000. Note: a seasonality adjustment with both advertising_channel_types and campaign_ids is not supported.
repeated enums.AdvertisingChannelTypeEnum.AdvertisingChannelType advertising_channel_types = 12
The seasonality adjustment will apply to all the campaigns under the listed channels retroactively as well as going forward when the scope of this adjustment is CHANNEL. The supported advertising channel types are DISPLAY, SEARCH and SHOPPING. Note: a seasonality adjustment with both advertising_channel_types and campaign_ids is not supported.
message
bidding_strategy.proto:37A bidding strategy.
Used in: , ,
string resource_name = 1
Immutable. The resource name of the bidding strategy. Bidding strategy resource names have the form: `customers/{customer_id}/biddingStrategies/{bidding_strategy_id}`
optional int64 id = 16
Output only. The ID of the bidding strategy.
optional string name = 17
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
Output only. The status of the bidding strategy. This field is read-only.
enums.BiddingStrategyTypeEnum.BiddingStrategyType type = 5
Output only. The type of the bidding strategy. Create a bidding strategy by setting the bidding scheme. This field is read-only.
string currency_code = 23
Immutable. The currency used by the bidding strategy (ISO 4217 three-letter code). For bidding strategies in manager customers, this currency can be set on creation and defaults to the manager customer's currency. For serving customers, this field cannot be set; all strategies in a serving customer implicitly use the serving customer's currency. In all cases the effective_currency_code field returns the currency used by the strategy.
optional string effective_currency_code = 20
Output only. The currency used by the bidding strategy (ISO 4217 three-letter code). For bidding strategies in manager customers, this is the currency set by the advertiser when creating the strategy. For serving customers, this is the customer's currency_code. Bidding strategy metrics are reported in this currency. This field is read-only.
int64 aligned_campaign_budget_id = 25
ID of the campaign budget that this portfolio bidding strategy is aligned with. When a portfolio and a campaign budget are aligned, that means that they are attached to the same set of campaigns. After a bidding strategy is aligned with a campaign budget, campaigns that are added to the bidding strategy must also use the aligned campaign budget.
optional int64 campaign_count = 18
Output only. The number of campaigns attached to this bidding strategy. This field is read-only.
optional int64 non_removed_campaign_count = 19
Output only. 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.
maximize_conversion_value = 21
An automated bidding strategy to help get the most conversion value for your campaigns while spending your budget.
maximize_conversions = 22
An automated bidding strategy to help get the most conversions for your campaigns while spending your budget.
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 chosen percentage of impressions.
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.
A bidding strategy simulation. Supported combinations of simulation type and simulation modification method are detailed below respectively. 1. TARGET_CPA - UNIFORM 2. TARGET_ROAS - UNIFORM
Used in:
string resource_name = 1
Output only. The resource name of the bidding strategy simulation. Bidding strategy simulation resource names have the form: `customers/{customer_id}/biddingStrategySimulations/{bidding_strategy_id}~{type}~{modification_method}~{start_date}~{end_date}`
int64 bidding_strategy_id = 2
Output only. Bidding strategy shared set id of the simulation.
enums.SimulationTypeEnum.SimulationType type = 3
Output only. The field that the simulation modifies.
enums.SimulationModificationMethodEnum.SimulationModificationMethod modification_method = 4
Output only. How the simulation modifies the field.
string start_date = 5
Output only. First day on which the simulation is based, in YYYY-MM-DD format.
string end_date = 6
Output only. Last day on which the simulation is based, in YYYY-MM-DD format
oneof point_list
List of simulation points.
target_cpa_point_list = 7
Output only. Simulation points if the simulation type is TARGET_CPA.
target_roas_point_list = 8
Output only. Simulation points if the simulation type is TARGET_ROAS.
message
billing_setup.proto:37A billing setup, which associates a payments account and an advertiser. A billing setup is specific to one advertiser.
Used in: ,
string resource_name = 1
Immutable. The resource name of the billing setup. BillingSetup resource names have the form: `customers/{customer_id}/billingSetups/{billing_setup_id}`
optional int64 id = 15
Output only. The ID of the billing setup.
enums.BillingSetupStatusEnum.BillingSetupStatus status = 3
Output only. The status of the billing setup.
optional string payments_account = 18
Immutable. 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
Immutable. 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.
string start_date_time = 16
Immutable. 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
Immutable. 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.
string end_date_time = 17
Output only. The end date time in yyyy-MM-dd or yyyy-MM-dd HH:mm:ss format.
enums.TimeTypeEnum.TimeType end_time_type = 14
Output only. The end time as a type. The only possible value is FOREVER.
message
billing_setup.proto:44Container of payments account information for this billing.
Used in:
optional string payments_account_id = 6
Output only. A 16 digit id used to identify the payments account associated with the billing setup. This must be passed as a string with dashes, for example, "1234-5678-9012-3456".
optional string payments_account_name = 7
Immutable. 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 string payments_profile_id = 8
Immutable. 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, for example, "1234-5678-9012".
optional string payments_profile_name = 9
Output only. The name of the payments profile associated with the billing setup.
optional string secondary_payments_profile_id = 10
Output only. A secondary payments profile id present in uncommon situations, for example, when a sequential liability agreement has been arranged.
A proto holding information specific to a local services business registration check.
Used in:
optional enums.LocalServicesBusinessRegistrationTypeEnum.LocalServicesBusinessRegistrationType registration_type = 3
Output only. The type of business registration check (number, document).
optional string check_id = 4
Output only. The id of the check, such as vat_tax_id, representing "VAT Tax ID" requirement.
optional enums.LocalServicesBusinessRegistrationCheckRejectionReasonEnum.LocalServicesBusinessRegistrationCheckRejectionReason rejection_reason = 5
Output only. Registration document rejection reason.
oneof business_registration
Registration information for the business registration. It will be one of the following forms based on the requirement from different countries.
registration_number = 1
Output only. Message storing government issued number for the business.
registration_document = 2
Output only. Message storing document info for the business.
A proto holding information specific to a local services business registration document.
Used in:
optional document_readonly = 1
Output only. The readonly field containing the information for an uploaded business registration document.
A proto holding information specific to a local services business registration number.
Used in:
optional string number = 1
Output only. Government-issued number for the business.
message
customer.proto:187Call reporting setting for a customer. Only mutable in an `update` operation.
Used in:
optional bool call_reporting_enabled = 10
Enable reporting of phone call events by redirecting them through Google System.
optional bool call_conversion_reporting_enabled = 11
Whether to enable call conversion reporting.
optional string call_conversion_action = 12
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
call_view.proto:38A call view that includes data for call tracking of call-only ads or call extensions.
Used in:
string resource_name = 1
Output only. The resource name of the call view. Call view resource names have the form: `customers/{customer_id}/callViews/{call_detail_id}`
string caller_country_code = 2
Output only. Country code of the caller.
string caller_area_code = 3
Output only. Area code of the caller. Null if the call duration is shorter than 15 seconds.
int64 call_duration_seconds = 4
Output only. The advertiser-provided call duration in seconds.
string start_call_date_time = 5
Output only. The advertiser-provided call start date time.
string end_call_date_time = 6
Output only. The advertiser-provided call end date time.
enums.CallTrackingDisplayLocationEnum.CallTrackingDisplayLocation call_tracking_display_location = 7
Output only. The call tracking display location.
enums.CallTypeEnum.CallType type = 8
Output only. The type of the call.
enums.GoogleVoiceCallStatusEnum.GoogleVoiceCallStatus call_status = 9
Output only. The status of the call.
message
campaign.proto:74A campaign.
Used in: , , ,
string resource_name = 1
Immutable. The resource name of the campaign. Campaign resource names have the form: `customers/{customer_id}/campaigns/{campaign_id}`
optional int64 id = 59
Output only. The ID of the campaign.
optional string name = 58
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.CampaignPrimaryStatusEnum.CampaignPrimaryStatus primary_status = 81
Output only. The primary status of the campaign. Provides insight into why a campaign is not serving or not serving optimally. Modification to the campaign and its related entities might take a while to be reflected in this status.
repeated enums.CampaignPrimaryStatusReasonEnum.CampaignPrimaryStatusReason primary_status_reasons = 82
Output only. The primary status reasons of the campaign. Provides insight into why a campaign is not serving or not serving optimally. These reasons are aggregated to determine an overall CampaignPrimaryStatus.
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
Output only. The ad serving status of the campaign.
enums.BiddingStrategySystemStatusEnum.BiddingStrategySystemStatus bidding_strategy_system_status = 78
Output only. The system status of the campaign's bidding strategy.
enums.AdServingOptimizationStatusEnum.AdServingOptimizationStatus ad_serving_optimization_status = 8
The ad serving optimization status of the campaign.
enums.AdvertisingChannelTypeEnum.AdvertisingChannelType advertising_channel_type = 9
Immutable. 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
Immutable. 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 string tracking_url_template = 60
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 local_services_campaign_settings = 75
The Local Services Campaign related settings.
optional travel_campaign_settings = 85
Settings for Travel campaign.
optional demand_gen_campaign_settings = 91
Settings for Demand Gen campaign.
optional video_campaign_settings = 94
Settings for Video campaign.
optional pmax_campaign_settings = 97
Settings for Performance Max campaign.
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
Immutable. 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 audience_setting = 73
Immutable. Setting for audience related features.
optional geo_target_type_setting = 47
The setting for ads geotargeting.
optional local_campaign_setting = 50
The setting for local campaign.
optional app_campaign_setting = 51
The setting related to App Campaign.
repeated string labels = 61
Output only. The resource names of labels attached to this campaign.
enums.CampaignExperimentTypeEnum.CampaignExperimentType experiment_type = 17
Output only. The type of campaign: normal, draft, or experiment.
optional string base_campaign = 56
Output only. 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 string campaign_budget = 62
The resource name of the campaign budget of the campaign.
enums.BiddingStrategyTypeEnum.BiddingStrategyType bidding_strategy_type = 22
Output only. 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.
string accessible_bidding_strategy = 71
Output only. Resource name of AccessibleBiddingStrategy, a read-only view of the unrestricted attributes of the attached portfolio bidding strategy identified by 'bidding_strategy'. Empty, if the campaign does not use a portfolio strategy. Unrestricted strategy attributes are available to all customers with whom the strategy is shared and are read from the AccessibleBiddingStrategy resource. In contrast, restricted attributes are only available to the owner customer of the strategy and their managers. Restricted attributes can only be read from the BiddingStrategy resource.
optional string start_date = 63
The date when campaign started in serving customer's timezone in YYYY-MM-DD format.
optional string campaign_group = 76
The resource name of the campaign group that this campaign belongs to.
optional string end_date = 64
The last day of the campaign in serving customer's timezone in YYYY-MM-DD format. On create, defaults to 2037-12-30, which means the campaign will run indefinitely. To set an existing campaign to run indefinitely, set this field to 2037-12-30.
optional string final_url_suffix = 65
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
Brand Safety setting at the individual campaign level. Allows for selecting an inventory type to show your ads on content that is the right fit for your brand. See https://support.google.com/google-ads/answer/7515513.
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. This feature only applies to app campaigns that use MULTI_CHANNEL as AdvertisingChannelType and APP_CAMPAIGN or APP_CAMPAIGN_FOR_ENGAGEMENT as AdvertisingChannelSubType.
optional optimization_goal_setting = 54
Optimization goal setting for this campaign, which includes a set of optimization goal types.
optional tracking_setting = 46
Output only. Campaign-level settings for tracking information.
enums.PaymentModeEnum.PaymentMode payment_mode = 52
Payment mode for the campaign.
optional double optimization_score = 66
Output only. Optimization score of the campaign. Optimization score is an estimate of how well a campaign is set to perform. It ranges from 0% (0.0) to 100% (1.0), with 100% indicating that the campaign is performing at full potential. This field is null for unscored campaigns. See "About optimization score" at https://support.google.com/google-ads/answer/9061546. This field is read-only.
repeated enums.AssetFieldTypeEnum.AssetFieldType excluded_parent_asset_field_types = 69
The asset field types that should be excluded from this campaign. Asset links with these field types will not be inherited by this campaign from the upper level.
repeated enums.AssetSetTypeEnum.AssetSetType excluded_parent_asset_set_types = 80
The asset set types that should be excluded from this campaign. Asset set links with these types will not be inherited by this campaign from the upper level. Location group types (GMB_DYNAMIC_LOCATION_GROUP, CHAIN_DYNAMIC_LOCATION_GROUP, and STATIC_LOCATION_GROUP) are child types of LOCATION_SYNC. Therefore, if LOCATION_SYNC is set for this field, all location group asset sets are not allowed to be linked to this campaign, and all Location Extension (LE) and Affiliate Location Extensions (ALE) will not be served under this campaign. Only LOCATION_SYNC is currently supported.
optional performance_max_upgrade = 77
Output only. Information about campaigns being upgraded to Performance Max.
optional string hotel_property_asset_set = 83
Immutable. The resource name for a set of hotel properties for Performance Max for travel goals campaigns.
optional enums.ListingTypeEnum.ListingType listing_type = 86
Immutable. Listing type of ads served for this campaign. Field is restricted for usage with Performance Max campaigns.
repeated asset_automation_settings = 88
Contains the opt-in/out status of each AssetAutomationType. See documentation of each asset automation type enum for default opt in/out behavior.
enums.CampaignKeywordMatchTypeEnum.CampaignKeywordMatchType keyword_match_type = 90
Keyword match type of Campaign. Set to BROAD to set broad matching for all keywords in a campaign.
optional bool brand_guidelines_enabled = 96
Immutable. Whether Brand Guidelines are enabled for this Campaign. Only applicable to Performance Max campaigns. If enabled, business name and logo assets must be linked as CampaignAssets instead of AssetGroupAssets. Writable only at campaign creation. Set to true to enable Brand Guidelines when creating a new Performance Max campaign. Immutable after creation. This field cannot be modified using standard update operations after the campaign has been created. For existing campaigns: To enable Brand Guidelines on a campaign after it has been created, use the CampaignService.EnablePMaxBrandGuidelines method, which is a separate operation. It is not possible to disable Brand Guidelines for an existing campaign. Incompatible with Travel Goals: This feature is not supported for Performance Max campaigns with Travel Goals. Attempting to set this field to true for a Travel Goals campaign will result in an error.
optional brand_guidelines = 98
These settings control how your brand appears in automatically generated assets and formats within this campaign. Note: These settings can only be used for Performance Max campaigns that have Brand Guidelines enabled.
optional third_party_integration_partners = 100
Third-Party integration partners.
optional ai_max_setting = 101
Settings for AI Max in search campaigns.
enums.EuPoliticalAdvertisingStatusEnum.EuPoliticalAdvertisingStatus contains_eu_political_advertising = 102
The advertiser should self-declare whether this campaign contains political advertising content targeted towards the European Union.
repeated enums.AssetSetTypeEnum.AssetSetType feed_types = 103
Output only. Types of feeds that are attached directly to this campaign.
oneof campaign_bidding_strategy
The bidding strategy for the campaign. Must be either portfolio (created through BiddingStrategy service) or standard, that is embedded into the campaign.
string bidding_strategy = 67
The resource name of the portfolio bidding strategy used by the campaign.
commission = 49
Commission is an automatic bidding strategy in which the advertiser pays a certain portion of the conversion value.
manual_cpa = 74
Standard Manual CPA bidding strategy. Manual bidding strategy that allows advertiser to set the bid per advertiser-specified action. Supported only for Local Services campaigns.
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 while spending your 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 chosen 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.
fixed_cpm = 92
A manual bidding strategy with a fixed CPM.
target_cpv = 93
An automated bidding strategy that sets bids to optimize performance given the target CPV you set.
target_cpc = 99
An automated bidding strategy that sets bids to help get as many clicks as possible at the target cost-per-click (CPC) you set.
message
campaign.proto:459Settings for AI Max in search campaigns.
Used in:
optional bool enable_ai_max = 1
Controls whether or not AI Max features are served for this campaign. Individual AI Max features are enabled or disabled by their respective settings. But if enable_ai_max is set to false or cleared, then no AI Max features will serve for this campaign, regardless of the other settings. Search Term Matching is enabled by default when AI Max is enabled, and can be disabled at the ad group level.
optional AiMaxSetting.AiMaxBundlingRequired bundling_required = 2
Output only. Indicates whether a search campaign has adopted AI Max before, and is required to have AI Max enabled to adopt campaign-level text asset automation and brand list targeting in all API versions.
Enum describing whether AI Max must be enabled to serve and update text asset automation and brand list features newly bundled with AI Max.
Used in:
UNSPECIFIED = 0
Not specified.
UNKNOWN = 1
Used for return value only. Represents value unknown in this version.
NOT_REQUIRED = 2
Search campaign is using text asset automation or brand list targeting, and AI Max is not required to be enabled to serve these features.
REQUIRED = 3
AI Max is required to be enabled for this search campaign to serve existing text asset automation and brand list targeting, or to add new text asset automation and brand list targeting settings.
message
campaign.proto:226Campaign-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 string app_id = 4
Immutable. A string that uniquely identifies a mobile application.
enums.AppCampaignAppStoreEnum.AppCampaignAppStore app_store = 3
Immutable. The application store that distributes this specific app.
message
campaign.proto:430Asset automation setting contains pair of AssetAutomationType and the asset automation opt-in/out status
Used in:
optional enums.AssetAutomationTypeEnum.AssetAutomationType asset_automation_type = 1
The asset automation type advertiser would like to opt-in/out.
optional enums.AssetAutomationStatusEnum.AssetAutomationStatus asset_automation_status = 2
The opt-in/out status of asset automation type.
message
campaign.proto:274Settings for the audience targeting.
Used in:
optional bool use_audience_grouped = 1
Immutable. If true, this campaign uses an Audience resource for audience targeting. If false, this campaign may use audience segment criteria instead.
message
campaign.proto:443Settings that control the visual appearance of your brand in a campaign's automatically generated assets and formats. Only applicable to Performance Max campaigns.
Used in:
string main_color = 1
The main brand color, entered as a hex code (e.g., #00ff00). You must provide the main_color if you provide an accent_color.
string accent_color = 2
The accent brand color, entered as a hex code (e.g., #00ff00). You must provide the accent_color if you provide a main_color.
string predefined_font_family = 3
The brand's font family. Must be one of the following Google Fonts (case sensitive): Open Sans, Roboto, Montserrat, Poppins, Lato, Oswald, Playfair Display, Roboto Slab.
message
campaign.proto:289Category bids in LocalServicesReportingCampaignSettings.
Used in:
optional string category_id = 1
Category for which the bid will be associated with. For example, xcat:service_area_business_plumber.
optional int64 manual_cpa_bid_micros = 2
Manual CPA bid for the category. Bid must be greater than the reserve price associated for that category. Value is in micros and in the advertiser's currency.
optional int64 target_cpa_bid_micros = 3
Target CPA bid for the category. Value is in micros and in the advertiser's currency.
message
campaign.proto:312Settings for Demand Gen campaign.
Used in:
optional bool upgraded_targeting = 1
Immutable. Specifies whether this campaign uses upgraded targeting options. When this field is set to `true`, you can use location and language targeting at the ad group level as opposed to the standard campaign-level targeting. This field defaults to `true`, and can only be set when creating a campaign.
message
campaign.proto:139The setting for controlling Dynamic Search Ads (DSA).
Used in:
string domain_name = 6
Required. The Internet domain name that this setting represents, for example, "google.com" or "www.google.com".
string language_code = 7
Required. The language code specifying the language of the domain, for example, "en".
optional bool use_supplied_urls_only = 8
Whether the campaign uses advertiser supplied URLs exclusively.
message
campaign.proto:208Represents 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:132Campaign-level settings for hotel ads.
Used in:
optional int64 hotel_center_id = 2
Immutable. The linked Hotel Center account.
message
campaign.proto:219Campaign setting for local campaigns.
Used in:
enums.LocationSourceTypeEnum.LocationSourceType location_source_type = 1
The location source type for this local campaign.
message
campaign.proto:283Settings for LocalServicesCampaign subresource.
Used in:
repeated category_bids = 1
Categorical level bids associated with MANUAL_CPA bidding strategy.
message
campaign.proto:108The network settings for the campaign.
Used in:
optional bool target_google_search = 5
Whether ads will be served with google.com search results.
optional bool target_search_network = 6
Whether ads will be served on partner sites in the Google Search Network (requires `target_google_search` to also be `true`).
optional bool target_content_network = 7
Whether ads will be served on specified placements in the Google Display Network. Placements are specified using the Placement criterion.
optional bool target_partner_search_network = 8
Whether ads will be served on the Google Partner Network. This is available only to some select Google partner accounts.
optional bool target_youtube = 9
Whether ads will be served on YouTube.
optional bool target_google_tv_network = 10
Whether ads will be served on the Google TV network.
message
campaign.proto:267Optimization goal setting for this campaign, which includes a set of optimization goal types.
Used in:
repeated enums.OptimizationGoalTypeEnum.OptimizationGoalType optimization_goal_types = 1
The list of optimization goal types.
message
campaign.proto:81Information about a campaign being upgraded to Performance Max.
Used in:
string performance_max_campaign = 1
Output only. The resource name of the Performance Max campaign the campaign is upgraded to.
string pre_upgrade_campaign = 2
Output only. The resource name of the legacy campaign upgraded to Performance Max.
enums.PerformanceMaxUpgradeStatusEnum.PerformanceMaxUpgradeStatus status = 3
Output only. The upgrade status of a campaign requested to be upgraded to Performance Max.
message
campaign.proto:417Settings for Performance Max campaigns.
Used in:
optional brand_targeting_overrides = 1
Overrides of brand targeting for various ad types.
message
campaign.proto:419Overrides of brand targeting for various ad types.
Used in:
optional bool ignore_exclusions_for_shopping_ads = 1
If true, brand exclusions are ignored for Shopping ads.
message
campaign.proto:257Selective optimization setting for this campaign, which includes a set of conversion actions to optimize this campaign towards. This feature only applies to app campaigns that use MULTI_CHANNEL as AdvertisingChannelType and APP_CAMPAIGN or APP_CAMPAIGN_FOR_ENGAGEMENT as AdvertisingChannelSubType.
Used in:
repeated string conversion_actions = 2
The selected set of resource names for conversion actions for optimizing this campaign.
message
campaign.proto:155The 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 int64 merchant_id = 5
ID of the Merchant Center account. This field is required for create operations. This field is immutable for Shopping campaigns.
string feed_label = 10
Feed label of products to include in the campaign. Only one of feed_label or sales_country can be set. If used instead of sales_country, the feed_label field accepts country codes in the same format for example: 'XX'. Otherwise can be any string used for feed label in Google Merchant Center.
optional int32 campaign_priority = 7
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 bool enable_local = 8
Whether to include local products.
bool use_vehicle_inventory = 9
Immutable. Whether to target Vehicle Listing inventory. This field is supported only in Smart Shopping Campaigns. For setting Vehicle Listing inventory in Performance Max campaigns, use `listing_type` instead.
repeated int64 advertising_partner_ids = 11
The list of Google Ads accounts IDs of advertising partners cooperating within the campaign. This feature is currently available only for accounts having an advertising partner link. Once set, the field is immutable. This feature is currently supported only for Performance Max, Shopping, Search and Demand Gen campaign types.
optional bool disable_product_feed = 12
Disable the optional product feed. This field is currently supported only for Demand Gen campaigns. See https://support.google.com/google-ads/answer/13721750 to learn more about this feature.
message
campaign.proto:201Campaign-level settings for tracking information.
Used in:
optional string tracking_url = 2
Output only. The url used for dynamic tracking.
message
campaign.proto:305Settings for Travel campaign.
Used in:
optional int64 travel_account_id = 1
Immutable. The Travel account ID associated with the Travel campaign.
message
campaign.proto:241Describes 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.proto:323Settings for Video campaign.
Used in:
optional video_ad_sequence = 4
Container for video ads sequencing definition.
oneof fluidity_control
Controls for defining video responsive ads behavior.
video_ad_inventory_control = 2
Inventory control for video responsive ads in reach campaigns.
video_ad_format_control = 3
Format-restricting control enabling usage of video responsive ads in format defined Video campaigns (for example, non-skippable).
message
campaign.proto:356Restrictions for non-skippable format.
Used in:
enums.NonSkippableMinDurationEnum.NonSkippableMinDuration min_duration = 1
The minimum allowed duration for non-skippable ads.
enums.NonSkippableMaxDurationEnum.NonSkippableMaxDuration max_duration = 2
The maximum allowed duration for non-skippable ads.
message
campaign.proto:346Format-restricting control enabling usage of video responsive ads in format defined Video campaigns (for example, non-skippable).
Used in:
enums.VideoAdFormatRestrictionEnum.VideoAdFormatRestriction format_restriction = 1
All contained responsive ads are expected to respect this restriction.
optional non_skippable_in_stream_restrictions = 2
Restrictions for non-skippable format.
message
campaign.proto:327For campaigns using video responsive ads inventory controls determine on which inventories the ads can be shown. This only applies for campaigns with the bidding strategies TARGET_CPM and FIXED_CPM.
Used in:
optional bool allow_in_stream = 1
Determine if video responsive ads can be used for in-stream video ads.
optional bool allow_in_feed = 2
Determine if video responsive ads can be used for in-feed video ads.
optional bool allow_shorts = 3
Determine if video responsive ads can be used as shorts format.
optional bool allow_non_skippable_in_stream = 4
Determine if video responsive ads can be used for non-skippable in-stream ads. This is only available for campaigns that allow mixing of non-skippable with other formats (Video reach campaign with Target Frequency bidding strategy goal).
message
campaign.proto:367Container for video ads sequencing definition.
Used in:
repeated steps = 1
The list of sequence steps and data associated with them.
enums.VideoAdSequenceMinimumDurationEnum.VideoAdSequenceMinimumDuration minimum_duration = 2
Users are eligible to repeat sequence after this period. Defaults to WEEK if not specified.
message
campaign.proto:378Information about a step within a video sequence.
Used in:
int64 video_ad_sequence_step_id = 1
The ID of this sequence step.
int64 asset_id = 2
The ID of the Asset for this step. The asset must be type YOUTUBE_VIDEO.
enums.AdGroupTypeEnum.AdGroupType ad_group_type = 3
The ad group type for this step (denoting the video format).
int64 previous_step_id = 4
The ID of the previous step. This field is required for all steps except the first one. It must point to a step that appears in the step definition list before this step.
enums.VideoAdSequenceInteractionTypeEnum.VideoAdSequenceInteractionType previous_step_interaction_type = 5
Type of interaction *on the previous step* required in order for the user to advance to this step. As with the previous step ID, it's required for every step except for the first one.
A campaign-level aggregate asset view that shows where the asset is linked, performamce of the asset and stats.
Used in:
string resource_name = 1
Output only. The resource name of the campaign aggregate asset view. Campaign aggregate asset view resource names have the form: `customers/{customer_id}/campaignAggregateAssetViews/{Campaign.campaign_id}~{Asset.asset_id}~{AssetLinkSource.asset_link_source}~{AssetFieldType.field_type}`
optional string campaign = 2
Output only. Campaign in which the asset served.
optional string asset = 3
Output only. The ID of the asset.
optional enums.AssetSourceEnum.AssetSource asset_source = 4
Output only. Source of the asset link.
optional enums.AssetFieldTypeEnum.AssetFieldType field_type = 5
Output only. FieldType of the asset.
message
campaign_asset.proto:40A link between a Campaign and an Asset.
Used in: , , ,
string resource_name = 1
Immutable. The resource name of the campaign asset. CampaignAsset resource names have the form: `customers/{customer_id}/campaignAssets/{campaign_id}~{asset_id}~{field_type}`
optional string campaign = 6
Immutable. The campaign to which the asset is linked.
optional string asset = 7
Immutable. The asset which is linked to the campaign.
enums.AssetFieldTypeEnum.AssetFieldType field_type = 4
Immutable. Role that the asset takes under the linked campaign. Required.
enums.AssetSourceEnum.AssetSource source = 8
Output only. Source of the campaign asset link.
enums.AssetLinkStatusEnum.AssetLinkStatus status = 5
Status of the campaign asset.
enums.AssetLinkPrimaryStatusEnum.AssetLinkPrimaryStatus primary_status = 9
Output only. Provides the PrimaryStatus of this asset link. Primary status is meant essentially to differentiate between the plain "status" field, which has advertiser set values of enabled, paused, or removed. The primary status takes into account other signals (for assets its mainly policy and quality approvals) to come up with a more comprehensive status to indicate its serving state.
repeated primary_status_details = 10
Output only. Provides the details of the primary status and its associated reasons.
repeated enums.AssetLinkPrimaryStatusReasonEnum.AssetLinkPrimaryStatusReason primary_status_reasons = 11
Output only. Provides a list of reasons for why an asset is not serving or not serving at full capacity.
message
campaign_asset_set.proto:36CampaignAssetSet is the linkage between a campaign and an asset set. Adding a CampaignAssetSet links an asset set with a campaign.
Used in: , , ,
string resource_name = 1
Immutable. The resource name of the campaign asset set. Asset set asset resource names have the form: `customers/{customer_id}/campaignAssetSets/{campaign_id}~{asset_set_id}`
string campaign = 2
Immutable. The campaign to which this asset set is linked.
string asset_set = 3
Immutable. The asset set which is linked to the campaign.
enums.AssetSetLinkStatusEnum.AssetSetLinkStatus status = 4
Output only. The status of the campaign asset set asset. Read-only.
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 in:
string resource_name = 1
Output only. 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:35Represents a bid-modifiable only criterion at the campaign level.
Used in: , ,
string resource_name = 1
Immutable. 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 string campaign = 6
Output only. The campaign to which this criterion belongs.
optional int64 criterion_id = 7
Output only. The ID of the criterion to bid modify. This field is ignored for mutates.
optional double bid_modifier = 8
The modifier for the bid when the criterion matches.
oneof criterion
The criterion of this campaign bid modifier. Required in create operations starting in V5.
interaction_type = 5
Immutable. Criterion for interaction type. Only supported for search campaigns.
message
campaign_budget.proto:38A campaign budget.
Used in: , , ,
string resource_name = 1
Immutable. The resource name of the campaign budget. Campaign budget resource names have the form: `customers/{customer_id}/campaignBudgets/{campaign_budget_id}`
optional int64 id = 19
Output only. 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 string name = 20
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 int64 amount_micros = 21
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 int64 total_amount_micros = 22
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
Output only. 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 bool explicitly_shared = 23
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 int64 reference_count = 24
Output only. The number of campaigns actively using the budget. This field is read-only.
optional bool has_recommended_budget = 25
Output only. Indicates whether there is a recommended budget for this campaign budget. This field is read-only.
optional int64 recommended_budget_amount_micros = 26
Output only. 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
Immutable. Period over which to spend the budget. Defaults to DAILY if not specified.
optional int64 recommended_budget_estimated_change_weekly_clicks = 27
Output only. The estimated change in weekly clicks if the recommended budget is applied. This field is read-only.
optional int64 recommended_budget_estimated_change_weekly_cost_micros = 28
Output only. 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 int64 recommended_budget_estimated_change_weekly_interactions = 29
Output only. The estimated change in weekly interactions if the recommended budget is applied. This field is read-only.
optional int64 recommended_budget_estimated_change_weekly_views = 30
Output only. The estimated change in weekly views if the recommended budget is applied. This field is read-only.
enums.BudgetTypeEnum.BudgetType type = 18
Immutable. The type of the campaign budget.
int64 aligned_bidding_strategy_id = 31
ID of the portfolio bidding strategy that this shared campaign budget is aligned with. When a bidding strategy and a campaign budget are aligned, they are attached to the same set of campaigns. After a campaign budget is aligned with a bidding strategy, campaigns that are added to the campaign budget must also use the aligned bidding strategy.
The biddability setting for the specified campaign only for all conversion actions with a matching category and origin.
Used in: ,
string resource_name = 1
Immutable. The resource name of the campaign conversion goal. Campaign conversion goal resource names have the form: `customers/{customer_id}/campaignConversionGoals/{campaign_id}~{category}~{origin}`
string campaign = 2
Immutable. The campaign with which this campaign conversion goal is associated.
enums.ConversionActionCategoryEnum.ConversionActionCategory category = 3
The conversion category of this campaign conversion goal.
enums.ConversionOriginEnum.ConversionOrigin origin = 4
The conversion origin of this campaign conversion goal.
bool biddable = 5
The biddability of the campaign conversion goal.
message
campaign_criterion.proto:37A campaign criterion.
Used in: , , ,
string resource_name = 1
Immutable. The resource name of the campaign criterion. Campaign criterion resource names have the form: `customers/{customer_id}/campaignCriteria/{campaign_id}~{criterion_id}`
optional string campaign = 37
Immutable. The campaign to which the criterion belongs.
optional int64 criterion_id = 38
Output only. The ID of the criterion. This field is ignored during mutate.
string display_name = 43
Output only. The display name of the criterion. This field is ignored for mutates.
optional float bid_modifier = 39
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 bool negative = 40
Immutable. Whether to target (`false`) or exclude (`true`) the criterion.
enums.CriterionTypeEnum.CriterionType type = 6
Output only. 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
Immutable. Keyword.
placement = 9
Immutable. Placement.
mobile_app_category = 10
Immutable. Mobile app category.
mobile_application = 11
Immutable. Mobile application.
location = 12
Immutable. Location.
device = 13
Immutable. Device.
ad_schedule = 15
Immutable. Ad Schedule.
age_range = 16
Immutable. Age range.
gender = 17
Immutable. Gender.
income_range = 18
Immutable. Income range.
parental_status = 19
Immutable. Parental status.
user_list = 22
Immutable. User List.
youtube_video = 20
Immutable. YouTube Video.
youtube_channel = 21
Immutable. YouTube Channel.
proximity = 23
Immutable. Proximity.
topic = 24
Immutable. Topic.
listing_scope = 25
Immutable. Listing scope.
language = 26
Immutable. Language.
ip_block = 27
Immutable. IpBlock.
content_label = 28
Immutable. ContentLabel.
carrier = 29
Immutable. Carrier.
user_interest = 30
Immutable. User Interest.
webpage = 31
Immutable. Webpage.
operating_system_version = 32
Immutable. Operating system version.
mobile_device = 33
Immutable. Mobile Device.
location_group = 34
Immutable. Location Group
custom_affinity = 36
Immutable. Custom Affinity.
custom_audience = 41
Immutable. Custom Audience
combined_audience = 42
Immutable. Combined Audience.
keyword_theme = 45
Immutable. Smart Campaign Keyword Theme.
local_service_id = 46
Immutable. GLS service campaign criterion.
brand_list = 47
Immutable. Brand list campaign criterion.
life_event = 48
Immutable. Life event campaign criterion.
webpage_list = 49
Immutable. Webpage list. This criterion is not publicly available.
video_lineup = 50
Immutable. Video lineup criterion.
extended_demographic = 52
Immutable. Extended demographic criterion.
message
campaign_customizer.proto:35A customizer value for the associated CustomizerAttribute at the Campaign level.
Used in: , ,
string resource_name = 1
Immutable. The resource name of the campaign customizer. Campaign customizer resource names have the form: `customers/{customer_id}/campaignCustomizers/{campaign_id}~{customizer_attribute_id}`
string campaign = 2
Immutable. The campaign to which the customizer attribute is linked.
string customizer_attribute = 3
Required. Immutable. The customizer attribute which is linked to the campaign.
enums.CustomizerValueStatusEnum.CustomizerValueStatus status = 4
Output only. The status of the campaign customizer.
optional value = 5
Required. The value to associate with the customizer attribute at this level. The value must be of the type specified for the CustomizerAttribute.
message
campaign_draft.proto:35A campaign draft.
Used in: , ,
string resource_name = 1
Immutable. The resource name of the campaign draft. Campaign draft resource names have the form: `customers/{customer_id}/campaignDrafts/{base_campaign_id}~{draft_id}`
optional int64 draft_id = 9
Output only. The ID of the draft. This field is read-only.
optional string base_campaign = 10
Immutable. The base campaign to which the draft belongs.
optional string name = 11
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 string draft_campaign = 12
Output only. 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
Output only. The status of the campaign draft. This field is read-only. When a new campaign draft is added, the status defaults to PROPOSED.
optional bool has_experiment_running = 13
Output only. Whether there is an experiment based on this draft currently serving.
optional string long_running_operation = 14
Output only. 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_goal_config.proto:34A link between a campaign and a goal enabling campaign-specific optimization.
Used in: ,
string resource_name = 1
Immutable. The resource name of the campaign goal config. campaign goal config resource names have the form: `customers/{customer_id}/campaignGoalConfigs/{campaign_id}~{goal_id}`
string campaign = 2
Immutable. The resource name of the campaign for this link.
string goal = 3
Immutable. The resource name of the goal this link is attached to.
enums.GoalTypeEnum.GoalType goal_type = 4
Output only. The goal type this link is attached to.
oneof campaign_goal_config_settings
The settings specific to this campaign goal config.
campaign_retention_settings = 5
Retention goal campaign settings.
message
campaign_group.proto:35A campaign group.
Used in: , ,
string resource_name = 1
Immutable. The resource name of the campaign group. Campaign group resource names have the form: `customers/{customer_id}/campaignGroups/{campaign_group_id}`
int64 id = 3
Output only. The ID of the campaign group.
string name = 4
The name of the campaign group. This field is required and should not be empty when creating new campaign groups. It must not contain any null (code point 0x0), NL line feed (code point 0xA) or carriage return (code point 0xD) characters.
enums.CampaignGroupStatusEnum.CampaignGroupStatus status = 5
The status of the campaign group. When a new campaign group is added, the status defaults to ENABLED.
message
campaign_label.proto:34Represents a relationship between a campaign and a label.
Used in: ,
string resource_name = 1
Immutable. Name of the resource. Campaign label resource names have the form: `customers/{customer_id}/campaignLabels/{campaign_id}~{label_id}`
optional string campaign = 4
Immutable. The campaign to which the label is attached.
optional string label = 5
Immutable. The label assigned to the campaign.
message
campaign_lifecycle_goal.proto:36Campaign level customer lifecycle goal settings.
Used in: ,
string resource_name = 1
Immutable. The resource name of the customer lifecycle goal of a campaign. `customers/{customer_id}/campaignLifecycleGoal/{campaign_id}`
string campaign = 2
Output only. The campaign where the goal is attached.
optional customer_acquisition_goal_settings = 3
Output only. The customer acquisition goal settings for the campaign. The customer acquisition goal is described in this article: https://support.google.com/google-ads/answer/12080169
This report provides a high-level view of search demand at the campaign level by grouping similar search terms into categories and showing their search volume. Historical data is available starting March 2023.
Used in:
string resource_name = 1
Output only. The resource name of the campaign level search term insight. Campaign level search term insight resource names have the form: `customers/{customer_id}/campaignSearchTermInsights/{campaign_id}~{category_id}`
optional string category_label = 2
Output only. The label for the search category. An empty string denotes the catch-all category for search terms that didn't fit into another category.
optional int64 id = 3
Output only. The ID of the insight.
optional int64 campaign_id = 4
Output only. The ID of the campaign.
This report provides granular performance data, including cost metrics, for each individual search term that triggered your ads.
Used in:
string resource_name = 1
Output only. The resource name of the campaign search term view. Campaign search term view resource names have the form: `customers/{customer_id}/campaignSearchTermViews/{campaign_id}~{URL-base64_search_term}`
optional string search_term = 2
Output only. The search term.
optional string campaign = 3
Output only. The campaign the search term served in.
CampaignSharedSets are used for managing the shared sets associated with a campaign.
Used in: , ,
string resource_name = 1
Immutable. 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 string campaign = 5
Immutable. The campaign to which the campaign shared set belongs.
optional string shared_set = 6
Immutable. 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
Output only. The status of this campaign shared set. Read only.
message
campaign_simulation.proto:56A campaign simulation. Supported combinations of advertising channel type, simulation type and simulation modification method is detailed below respectively. * SEARCH - CPC_BID - UNIFORM * SEARCH - CPC_BID - SCALING * SEARCH - TARGET_CPA - UNIFORM * SEARCH - TARGET_CPA - SCALING * SEARCH - TARGET_ROAS - UNIFORM * SEARCH - TARGET_IMPRESSION_SHARE - UNIFORM * SEARCH - BUDGET - UNIFORM * SHOPPING - BUDGET - UNIFORM * SHOPPING - TARGET_ROAS - UNIFORM * MULTI_CHANNEL - TARGET_CPA - UNIFORM * MULTI_CHANNEL - TARGET_ROAS - UNIFORM * DEMAND_GEN - TARGET_CPA - DEFAULT * DISPLAY - TARGET_CPA - UNIFORM * PERFORMANCE_MAX - TARGET_CPA - UNIFORM * PERFORMANCE_MAX - TARGET_ROAS - UNIFORM * PERFORMANCE_MAX - BUDGET - UNIFORM
Used in:
string resource_name = 1
Output only. The resource name of the campaign simulation. Campaign simulation resource names have the form: `customers/{customer_id}/campaignSimulations/{campaign_id}~{type}~{modification_method}~{start_date}~{end_date}`
int64 campaign_id = 2
Output only. Campaign id of the simulation.
enums.SimulationTypeEnum.SimulationType type = 3
Output only. The field that the simulation modifies.
enums.SimulationModificationMethodEnum.SimulationModificationMethod modification_method = 4
Output only. How the simulation modifies the field.
string start_date = 5
Output only. First day on which the simulation is based, in YYYY-MM-DD format.
string end_date = 6
Output only. Last day on which the simulation is based, in YYYY-MM-DD format
oneof point_list
List of simulation points.
cpc_bid_point_list = 7
Output only. Simulation points if the simulation type is CPC_BID.
target_cpa_point_list = 8
Output only. Simulation points if the simulation type is TARGET_CPA.
target_roas_point_list = 9
Output only. Simulation points if the simulation type is TARGET_ROAS.
target_impression_share_point_list = 10
Output only. Simulation points if the simulation type is TARGET_IMPRESSION_SHARE.
budget_point_list = 11
Output only. Simulation points if the simulation type is BUDGET.
message
carrier_constant.proto:34A carrier criterion that can be used in campaign targeting.
Used in:
string resource_name = 1
Output only. The resource name of the carrier criterion. Carrier criterion resource names have the form: `carrierConstants/{criterion_id}`
optional int64 id = 5
Output only. The ID of the carrier criterion.
optional string name = 6
Output only. The full name of the carrier in English.
optional string country_code = 7
Output only. The country code of the country where the carrier is located, for example, "AR", "FR", etc.
message
change_event.proto:56Describes the granular change of returned resources of certain resource types. Changes made through the UI or API in the past 30 days are included. Previous and new values of the changed fields are shown. ChangeEvent could have up to 3 minutes delay to reflect a new change.
Used in:
string resource_name = 1
Output only. The resource name of the change event. Change event resource names have the form: `customers/{customer_id}/changeEvents/{timestamp_micros}~{command_index}~{mutate_index}`
string change_date_time = 2
Output only. Time at which the change was committed on this resource.
enums.ChangeEventResourceTypeEnum.ChangeEventResourceType change_resource_type = 3
Output only. The type of the changed resource. This dictates what resource will be set in old_resource and new_resource.
string change_resource_name = 4
Output only. The Simply resource this change occurred on.
enums.ChangeClientTypeEnum.ChangeClientType client_type = 5
Output only. Where the change was made through.
string user_email = 6
Output only. The email of the user who made this change.
optional old_resource = 7
Output only. The old resource before the change. Only changed fields will be populated.
optional new_resource = 8
Output only. The new resource after the change. Only changed fields will be populated.
enums.ResourceChangeOperationEnum.ResourceChangeOperation resource_change_operation = 9
Output only. The operation on the changed resource.
optional changed_fields = 10
Output only. A list of fields that are changed in the returned resource.
string campaign = 11
Output only. The Campaign affected by this change.
string ad_group = 12
Output only. The AdGroup affected by this change.
string asset = 20
Output only. The Asset affected by this change.
message
change_event.proto:64A wrapper proto presenting all supported resources. Only the resource of the change_resource_type will be set.
Used in:
optional ad = 1
Output only. Set if change_resource_type == AD.
optional ad_group = 2
Output only. Set if change_resource_type == AD_GROUP.
optional ad_group_criterion = 3
Output only. Set if change_resource_type == AD_GROUP_CRITERION.
optional campaign = 4
Output only. Set if change_resource_type == CAMPAIGN.
optional campaign_budget = 5
Output only. Set if change_resource_type == CAMPAIGN_BUDGET.
optional ad_group_bid_modifier = 6
Output only. Set if change_resource_type == AD_GROUP_BID_MODIFIER.
optional campaign_criterion = 7
Output only. Set if change_resource_type == CAMPAIGN_CRITERION.
optional ad_group_ad = 12
Output only. Set if change_resource_type == AD_GROUP_AD.
optional asset = 13
Output only. Set if change_resource_type == ASSET.
optional customer_asset = 14
Output only. Set if change_resource_type == CUSTOMER_ASSET.
optional campaign_asset = 15
Output only. Set if change_resource_type == CAMPAIGN_ASSET.
optional ad_group_asset = 16
Output only. Set if change_resource_type == AD_GROUP_ASSET.
optional asset_set = 17
Output only. Set if change_resource_type == ASSET_SET.
optional asset_set_asset = 18
Output only. Set if change_resource_type == ASSET_SET_ASSET.
optional campaign_asset_set = 19
Output only. Set if change_resource_type == CAMPAIGN_ASSET_SET.
message
change_status.proto:37Describes the status of returned resource. ChangeStatus could have up to 3 minutes delay to reflect a new change.
Used in:
string resource_name = 1
Output only. The resource name of the change status. Change status resource names have the form: `customers/{customer_id}/changeStatus/{change_status_id}`
optional string last_change_date_time = 24
Output only. Time at which the most recent change has occurred on this resource.
enums.ChangeStatusResourceTypeEnum.ChangeStatusResourceType resource_type = 4
Output only. 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 string campaign = 17
Output only. The Campaign affected by this change.
optional string ad_group = 18
Output only. The AdGroup affected by this change.
enums.ChangeStatusOperationEnum.ChangeStatusOperation resource_status = 8
Output only. Represents the status of the changed resource.
optional string ad_group_ad = 25
Output only. The AdGroupAd affected by this change.
optional string ad_group_criterion = 26
Output only. The AdGroupCriterion affected by this change.
optional string campaign_criterion = 27
Output only. The CampaignCriterion affected by this change.
optional string ad_group_bid_modifier = 32
Output only. The AdGroupBidModifier affected by this change.
string shared_set = 33
Output only. The SharedSet affected by this change.
string campaign_shared_set = 34
Output only. The CampaignSharedSet affected by this change.
string asset = 35
Output only. The Asset affected by this change.
string customer_asset = 36
Output only. The CustomerAsset affected by this change.
string campaign_asset = 37
Output only. The CampaignAsset affected by this change.
string ad_group_asset = 38
Output only. The AdGroupAsset affected by this change.
string combined_audience = 40
Output only. The CombinedAudience affected by this change.
string asset_group = 41
Output only. The AssetGroup affected by this change.
string asset_set = 43
Output only. The AssetSet affected by this change.
string campaign_budget = 42
Output only. The CampaignBudget affected by this change.
string campaign_asset_set = 44
Output only. The CampaignAssetSet affected by this change.
A channel-level aggregate asset view that shows where the asset is linked, performamce of the asset and stats.
Used in:
string resource_name = 1
Output only. The resource name of the channel aggregate asset view. Channel aggregate asset view resource names have the form: `customers/{customer_id}/channelAggregateAssetViews/{ChannelAssetV2.advertising_channel_type}~{ChannelAssetV2.asset_id}~{ChannelAssetV2.asset_source}~{ChannelAssetV2.field_type}"`
optional enums.AdvertisingChannelTypeEnum.AdvertisingChannelType advertising_channel_type = 2
Output only. Channel in which the asset served.
optional string asset = 3
Output only. The ID of the asset.
optional enums.AssetSourceEnum.AssetSource asset_source = 4
Output only. Source of the asset link.
optional enums.AssetFieldTypeEnum.AssetFieldType field_type = 5
Output only. FieldType of the asset.
message
click_view.proto:41A 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. Queries including ClickView must have a filter limiting the results to one day and can be requested for dates back to 90 days before the time of the request.
Used in:
string resource_name = 1
Output only. The resource name of the click view. Click view resource names have the form: `customers/{customer_id}/clickViews/{date (yyyy-MM-dd)}~{gclid}`
optional string gclid = 8
Output only. The Google Click ID.
optional area_of_interest = 3
Output only. The location criteria matching the area of interest associated with the impression.
optional location_of_presence = 4
Output only. The location criteria matching the location of presence associated with the impression.
optional int64 page_number = 9
Output only. Page number in search results where the ad was shown.
optional string ad_group_ad = 10
Output only. The associated ad.
optional string campaign_location_target = 11
Output only. The associated campaign location target, if one exists.
optional string user_list = 12
Output only. The associated user list, if one exists.
string keyword = 13
Output only. The associated keyword, if one exists and the click corresponds to the SEARCH channel.
optional keyword_info = 14
Output only. Basic information about the associated keyword, if it exists.
message
combined_audience.proto:36Describe a resource for combined audiences which includes different audiences.
Used in:
string resource_name = 1
Immutable. The resource name of the combined audience. Combined audience names have the form: `customers/{customer_id}/combinedAudience/{combined_audience_id}`
int64 id = 2
Output only. ID of the combined audience.
enums.CombinedAudienceStatusEnum.CombinedAudienceStatus status = 3
Output only. Status of this combined audience. Indicates whether the combined audience is enabled or removed.
string name = 4
Output only. Name of the combined audience. It should be unique across all combined audiences.
string description = 5
Output only. Description of this combined audience.
message
local_services_lead.proto:108Fields containing consumer contact details.
Used in:
string phone_number = 1
Output only. Consumer phone number in E164 format.
string email = 2
Output only. Consumer email address.
string consumer_name = 3
Output only. Consumer name if consumer provided name from Message or Booking form on google.com
message
content_criterion_view.proto:34A content criterion view.
Used in:
string resource_name = 1
Output only. The resource name of the content criterion view. Content criterion view resource names have the form: `customers/{customer_id}/contentCriterionViews/{ad_group_id}~{criterion_id}`
message
conversion_action.proto:43A conversion action.
Used in: , ,
string resource_name = 1
Immutable. The resource name of the conversion action. Conversion action resource names have the form: `customers/{customer_id}/conversionActions/{conversion_action_id}`
optional int64 id = 21
Output only. The ID of the conversion action.
optional string name = 22
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
Immutable. The type of this conversion action.
enums.ConversionOriginEnum.ConversionOrigin origin = 30
Output only. The conversion origin of this conversion action.
optional bool primary_for_goal = 31
If a conversion action's primary_for_goal bit is false, the conversion action is non-biddable for all campaigns regardless of their customer conversion goal or campaign conversion goal. However, custom conversion goals do not respect primary_for_goal, so if a campaign has a custom conversion goal configured with a primary_for_goal = false conversion action, that conversion action is still biddable. By default, primary_for_goal will be true if not set. In V9, primary_for_goal can only be set to false after creation through an 'update' operation because it's not declared as optional.
enums.ConversionActionCategoryEnum.ConversionActionCategory category = 6
The category of conversions reported for this conversion action.
optional string owner_customer = 23
Output only. The resource name of the conversion action owner customer, or null if this is a system-defined conversion action.
optional bool include_in_conversions_metric = 24
Whether this conversion action should be included in the "conversions" metric.
optional int64 click_through_lookback_window_days = 25
The maximum number of days that may elapse between an interaction (for example, a click) and a conversion event.
optional int64 view_through_lookback_window_days = 26
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
Output only. The snippets used for tracking conversions.
optional int64 phone_call_duration_seconds = 27
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 string app_id = 28
App ID for an app conversion action.
enums.MobileAppVendorEnum.MobileAppVendor mobile_app_vendor = 17
Output only. Mobile app vendor for an app conversion action.
optional firebase_settings = 18
Output only. Firebase settings for Firebase conversion types.
optional third_party_app_analytics_settings = 19
Output only. Third Party App Analytics settings for third party conversion types.
optional google_analytics_4_settings = 34
Output only. Google Analytics 4 settings for Google Analytics 4 conversion types.
message
conversion_action.proto:50Settings 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
Output only. The status of the data-driven attribution model for the conversion action.
message
conversion_action.proto:91Settings related to a Firebase conversion action.
Used in:
optional string event_name = 3
Output only. The event name of a Firebase conversion.
optional string project_id = 4
Output only. The Firebase project ID of the conversion.
int64 property_id = 5
Output only. The GA property ID of the conversion.
string property_name = 6
Output only. The GA property name of the conversion.
message
conversion_action.proto:106Settings related to a Google Analytics 4 conversion action.
Used in:
string event_name = 1
Output only. The name of the GA 4 event.
string property_name = 2
Output only. The name of the GA 4 property.
int64 property_id = 3
Output only. The ID of the GA 4 property.
message
conversion_action.proto:82Settings related to a third party app analytics conversion action.
Used in:
optional string event_name = 2
Output only. The event name of a third-party app analytics conversion.
string provider_name = 3
Output only. Name of the third-party app analytics provider.
message
conversion_action.proto:64Settings related to the value for conversion events associated with this conversion action.
Used in:
optional double default_value = 4
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 string default_currency_code = 5
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 bool always_use_default_value = 6
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.
A conversion custom variable See "About custom variables for conversions" at https://support.google.com/google-ads/answer/9964350
Used in: , ,
string resource_name = 1
Immutable. The resource name of the conversion custom variable. Conversion custom variable resource names have the form: `customers/{customer_id}/conversionCustomVariables/{conversion_custom_variable_id}`
int64 id = 2
Output only. The ID of the conversion custom variable.
string name = 3
Required. The name of the conversion custom variable. Name should be unique. The maximum length of name is 100 characters. There should not be any extra spaces before and after.
string tag = 4
Required. Immutable. The tag of the conversion custom variable. It is used in the event snippet and sent to Google Ads along with conversion pings. For conversion uploads in Google Ads API, the resource name of the conversion custom variable is used. Tag should be unique. The maximum size of tag is 100 bytes. There should not be any extra spaces before and after. Currently only lowercase letters, numbers and underscores are allowed in the tag.
enums.ConversionCustomVariableStatusEnum.ConversionCustomVariableStatus status = 5
The status of the conversion custom variable for conversion event accrual.
string owner_customer = 6
Output only. The resource name of the customer that owns the conversion custom variable.
Conversion goal settings for a Campaign.
Used in: , ,
string resource_name = 1
Immutable. The resource name of the conversion goal campaign config. Conversion goal campaign config resource names have the form: `customers/{customer_id}/conversionGoalCampaignConfigs/{campaign_id}`
string campaign = 2
Immutable. The campaign with which this conversion goal campaign config is associated.
enums.GoalConfigLevelEnum.GoalConfigLevel goal_config_level = 3
The level of goal config the campaign is using.
string custom_conversion_goal = 4
The custom conversion goal the campaign is using for optimization.
message
customer.proto:206A collection of customer-wide settings related to Google Ads Conversion Tracking.
Used in:
optional int64 conversion_tracking_id = 3
Output only. The conversion tracking id used for this account. This id doesn't indicate whether the customer uses conversion tracking (conversion_tracking_status does). This field is read-only.
optional int64 cross_account_conversion_tracking_id = 4
Output only. 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.
bool accepted_customer_data_terms = 5
Output only. Whether the customer has accepted customer data terms. If using cross-account conversion tracking, this value is inherited from the manager. This field is read-only. For more information, see https://support.google.com/adspolicy/answer/7475709.
enums.ConversionTrackingStatusEnum.ConversionTrackingStatus conversion_tracking_status = 6
Output only. Conversion tracking status. It indicates whether the customer is using conversion tracking, and who is the conversion tracking owner of this customer. If this customer is using cross-account conversion tracking, the value returned will differ based on the `login-customer-id` of the request.
bool enhanced_conversions_for_leads_enabled = 7
Output only. Whether the customer is opted-in for enhanced conversions for leads. If using cross-account conversion tracking, this value is inherited from the manager. This field is read-only.
string google_ads_conversion_customer = 8
The resource name of the customer where conversions are created and managed. This field is read-only.
message
conversion_value_rule.proto:38A conversion value rule
Used in: , ,
string resource_name = 1
Immutable. The resource name of the conversion value rule. Conversion value rule resource names have the form: `customers/{customer_id}/conversionValueRules/{conversion_value_rule_id}`
int64 id = 2
Output only. The ID of the conversion value rule.
optional action = 3
Action applied when the rule is triggered.
optional geo_location_condition = 4
Condition for Geo location that must be satisfied for the value rule to apply.
optional device_condition = 5
Condition for device type that must be satisfied for the value rule to apply.
optional audience_condition = 6
Condition for audience that must be satisfied for the value rule to apply.
optional itinerary_condition = 9
Condition for itinerary that must be satisfied for the value rule to apply.
string owner_customer = 7
Output only. The resource name of the conversion value rule's owner customer. When the value rule is inherited from a manager customer, owner_customer will be the resource name of the manager whereas the customer in the resource_name will be of the requesting serving customer. ** Read-only **
enums.ConversionValueRuleStatusEnum.ConversionValueRuleStatus status = 8
The status of the conversion value rule.
message
conversion_value_rule.proto:45Action applied when rule is applied.
Used in:
enums.ValueRuleOperationEnum.ValueRuleOperation operation = 1
Specifies applied operation.
double value = 2
Specifies applied value.
message
conversion_value_rule.proto:85Condition on Audience dimension.
Used in:
repeated string user_lists = 1
User Lists.
repeated string user_interests = 2
User Interests.
message
conversion_value_rule.proto:78Condition on Device dimension.
Used in:
repeated enums.ValueRuleDeviceTypeEnum.ValueRuleDeviceType device_types = 1
Value for device type condition.
message
conversion_value_rule.proto:55Condition on Geo dimension.
Used in:
repeated string excluded_geo_target_constants = 1
Geo locations that advertisers want to exclude.
enums.ValueRuleGeoLocationMatchTypeEnum.ValueRuleGeoLocationMatchType excluded_geo_match_type = 2
Excluded Geo location match type.
repeated string geo_target_constants = 3
Geo locations that advertisers want to include.
enums.ValueRuleGeoLocationMatchTypeEnum.ValueRuleGeoLocationMatchType geo_match_type = 4
Included Geo location match type.
message
conversion_value_rule.proto:112Range for the number of days between the date of the booking and the start of the itinerary.
Used in:
optional int32 min_days = 3
Minimum number of days between the date of the booking the start date.
optional int32 max_days = 4
Maximum number of days between the date of the booking the start date.
message
conversion_value_rule.proto:98Condition on Itinerary dimension.
Used in:
optional advance_booking_window = 1
Range for the number of days between the date of the booking and the start of the itinerary.
optional travel_length = 2
Range for the itinerary length in number of nights.
optional travel_start_day = 3
The days of the week on which this itinerary's travel can start.
message
conversion_value_rule.proto:121Range for the itinerary length in number of nights.
Used in:
int32 min_nights = 1
Minimum number of nights between the start date and the end date.
int32 max_nights = 2
Maximum number of days between the start date and the end date.
message
conversion_value_rule.proto:130The days of the week on which an itinerary's travel can start.
Used in:
bool monday = 1
The travel can start on Monday.
bool tuesday = 2
The travel can start on Tuesday.
bool wednesday = 3
The travel can start on Wednesday.
bool thursday = 4
The travel can start on Thursday.
bool friday = 5
The travel can start on Friday.
bool saturday = 6
The travel can start on Saturday.
bool sunday = 7
The travel can start on Sunday.
A conversion value rule set
Used in: , ,
string resource_name = 1
Immutable. The resource name of the conversion value rule set. Conversion value rule set resource names have the form: `customers/{customer_id}/conversionValueRuleSets/{conversion_value_rule_set_id}`
int64 id = 2
Output only. The ID of the conversion value rule set.
repeated string conversion_value_rules = 3
Resource names of rules within the rule set.
repeated enums.ValueRuleSetDimensionEnum.ValueRuleSetDimension dimensions = 4
Defines dimensions for Value Rule conditions. The condition types of value rules within this value rule set must be of these dimensions. The first entry in this list is the primary dimension of the included value rules. When using value rule primary dimension segmentation, conversion values will be segmented into the values adjusted by value rules and the original values, if some value rules apply.
string owner_customer = 5
Output only. The resource name of the conversion value rule set's owner customer. When the value rule set is inherited from a manager customer, owner_customer will be the resource name of the manager whereas the customer in the resource_name will be of the requesting serving customer. ** Read-only **
enums.ValueRuleSetAttachmentTypeEnum.ValueRuleSetAttachmentType attachment_type = 6
Immutable. Defines the scope where the conversion value rule set is attached.
string campaign = 7
The resource name of the campaign when the conversion value rule set is attached to a campaign.
enums.ConversionValueRuleSetStatusEnum.ConversionValueRuleSetStatus status = 8
Output only. The status of the conversion value rule set. ** Read-only **
repeated enums.ConversionActionCategoryEnum.ConversionActionCategory conversion_action_categories = 9
Immutable. The conversion action categories of the conversion value rule set.
message
local_services_lead.proto:133Represents the credit details of a lead.
Used in:
enums.LocalServicesCreditStateEnum.CreditState credit_state = 1
Output only. Credit state of the lead.
string credit_state_last_update_date_time = 2
Output only. The date time when the credit state of the lead was last updated. The format is "YYYY-MM-DD HH:MM:SS" in the Google Ads account's timezone. Examples: "2018-03-05 09:15:00" or "2018-02-01 14:34:30"
message
currency_constant.proto:34A currency constant.
Used in:
string resource_name = 1
Output only. The resource name of the currency constant. Currency constant resource names have the form: `currencyConstants/{code}`
optional string code = 6
Output only. ISO 4217 three-letter currency code, for example, "USD"
optional string name = 7
Output only. Full English name of the currency.
optional string symbol = 8
Output only. Standard symbol for describing this currency, for example, '$' for US Dollars.
optional int64 billable_unit_micros = 9
Output only. The billable unit for this currency. Billed amounts should be multiples of this value.
message
custom_audience.proto:40A custom audience. This is a list of users by interest. The unique key of a custom audience consists of the following fields: name. Violating the unique key constraint produces error: CustomAudienceError.NAME_ALREADY_USED
Used in: ,
string resource_name = 1
Immutable. The resource name of the custom audience. Custom audience resource names have the form: `customers/{customer_id}/customAudiences/{custom_audience_id}`
int64 id = 2
Output only. ID of the custom audience.
enums.CustomAudienceStatusEnum.CustomAudienceStatus status = 3
Output only. Status of this custom audience. Indicates whether the custom audience is enabled or removed.
string name = 4
Name of the custom audience. It should be unique for all custom audiences created by a customer. This field is required for creating operations.
enums.CustomAudienceTypeEnum.CustomAudienceType type = 5
Type of the custom audience. ("INTEREST" OR "PURCHASE_INTENT" is not allowed for newly created custom audience but kept for existing audiences)
string description = 6
Description of this custom audience.
repeated members = 7
List of custom audience members that this custom audience is composed of. Members can be added during CustomAudience creation. If members are presented in UPDATE operation, existing members will be overridden.
message
custom_audience.proto:87A member of custom audience. A member can be a KEYWORD, URL, PLACE_CATEGORY or APP. It can only be created or removed but not changed.
Used in:
enums.CustomAudienceMemberTypeEnum.CustomAudienceMemberType member_type = 1
The type of custom audience member, KEYWORD, URL, PLACE_CATEGORY or APP.
oneof value
The CustomAudienceMember value. One field is populated depending on the member type.
string keyword = 2
A keyword or keyword phrase — at most 10 words and 80 characters. Languages with double-width characters such as Chinese, Japanese, or Korean, are allowed 40 characters, which describes the user's interests or actions.
string url = 3
An HTTP URL, protocol-included — at most 2048 characters, which includes contents users have interests in.
int64 place_category = 4
A place type described by a place category users visit.
string app = 5
A package name of Android apps which users installed such as com.google.example.
message
custom_conversion_goal.proto:33Custom conversion goal that can make arbitrary conversion actions biddable.
Used in: , ,
string resource_name = 1
Immutable. The resource name of the custom conversion goal. Custom conversion goal resource names have the form: `customers/{customer_id}/customConversionGoals/{goal_id}`
int64 id = 2
Immutable. The ID for this custom conversion goal.
string name = 3
The name for this custom conversion goal.
repeated string conversion_actions = 4
Conversion actions that the custom conversion goal makes biddable.
enums.CustomConversionGoalStatusEnum.CustomConversionGoalStatus status = 5
The status of the custom conversion goal.
message
custom_interest.proto:37A custom interest. This is a list of users by interest.
Used in: ,
string resource_name = 1
Immutable. The resource name of the custom interest. Custom interest resource names have the form: `customers/{customer_id}/customInterests/{custom_interest_id}`
optional int64 id = 8
Output only. 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 string name = 9
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 string description = 10
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:83A 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 string parameter = 3
Keyword text when member_type is KEYWORD or URL string when member_type is URL.
Fields in the submitted custom question
Used in:
string question_text = 1
Output only. Question text for custom question, maximum number of characters is 300.
string field_value = 2
Output only. Field value for custom question response, maximum number of characters is 70.
message
customer.proto:40A customer.
Used in: , , ,
string resource_name = 1
Immutable. The resource name of the customer. Customer resource names have the form: `customers/{customer_id}`
optional int64 id = 19
Output only. The ID of the customer.
optional string descriptive_name = 20
Optional, non-unique descriptive name of the customer.
optional string currency_code = 21
Immutable. The currency in which the account operates. A subset of the currency codes from the ISO 4217 standard is supported.
optional string time_zone = 22
Immutable. The local timezone ID of the customer.
optional string tracking_url_template = 23
The URL template for constructing a tracking URL out of parameters. Only mutable in an `update` operation.
optional string final_url_suffix = 24
The URL template for appending params to the final URL. Only mutable in an `update` operation.
optional bool auto_tagging_enabled = 25
Whether auto-tagging is enabled for the customer. Only mutable in an `update` operation.
optional bool has_partners_badge = 26
Output only. 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 bool manager = 27
Output only. Whether the customer is a manager.
optional bool test_account = 28
Output only. Whether the customer is a test account.
optional call_reporting_setting = 10
Call reporting setting for a customer. Only mutable in an `update` operation.
optional conversion_tracking_setting = 14
Conversion tracking setting for a customer.
optional remarketing_setting = 15
Output only. Remarketing setting for a customer.
repeated enums.CustomerPayPerConversionEligibilityFailureReasonEnum.CustomerPayPerConversionEligibilityFailureReason pay_per_conversion_eligibility_failure_reasons = 16
Output only. 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.
optional double optimization_score = 29
Output only. Optimization score of the customer. Optimization score is an estimate of how well a customer's campaigns are set to perform. It ranges from 0% (0.0) to 100% (1.0). This field is null for all manager customers, and for unscored non-manager customers. See "About optimization score" at https://support.google.com/google-ads/answer/9061546. This field is read-only.
double optimization_score_weight = 30
Output only. Optimization score weight of the customer. Optimization score weight can be used to compare/aggregate optimization scores across multiple non-manager customers. The aggregate optimization score of a manager is computed as the sum over all of their customers of `Customer.optimization_score * Customer.optimization_score_weight`. This field is 0 for all manager customers, and for unscored non-manager customers. This field is read-only.
enums.CustomerStatusEnum.CustomerStatus status = 36
Output only. The status of the customer.
optional bool location_asset_auto_migration_done = 38
Output only. True if feed based location has been migrated to asset based location.
optional bool image_asset_auto_migration_done = 39
Output only. True if feed based image has been migrated to asset based image.
optional string location_asset_auto_migration_done_date_time = 40
Output only. Timestamp of migration from feed based location to asset base location in yyyy-MM-dd HH:mm:ss format.
optional string image_asset_auto_migration_done_date_time = 41
Output only. Timestamp of migration from feed based image to asset base image in yyyy-MM-dd HH:mm:ss format.
optional customer_agreement_setting = 44
Output only. Customer Agreement Setting for a customer.
optional local_services_settings = 45
Output only. Settings for Local Services customer.
enums.BrandSafetySuitabilityEnum.BrandSafetySuitability video_brand_safety_suitability = 46
Output only. Brand Safety setting at the account level. Allows for selecting an inventory type to show your ads on content that is the right fit for your brand. See https://support.google.com/google-ads/answer/7515513.
optional video_customer = 54
Video specific information about a Customer.
message
campaign_lifecycle_goal.proto:68The customer acquisition goal settings for the campaign.
Used in:
enums.CustomerAcquisitionOptimizationModeEnum.CustomerAcquisitionOptimizationMode optimization_mode = 1
Output only. Customer acquisition optimization mode of this campaign.
optional value_settings = 2
Output only. Campaign specific values for the customer acquisition goal.
message
customer.proto:255Customer Agreement Setting for a customer.
Used in:
bool accepted_lead_form_terms = 1
Output only. Whether the customer has accepted lead form term of service.
message
customer_asset.proto:40A link between a customer and an asset.
Used in: , , ,
string resource_name = 1
Immutable. The resource name of the customer asset. CustomerAsset resource names have the form: `customers/{customer_id}/customerAssets/{asset_id}~{field_type}`
string asset = 2
Required. Immutable. The asset which is linked to the customer.
enums.AssetFieldTypeEnum.AssetFieldType field_type = 3
Required. Immutable. Role that the asset takes for the customer link.
enums.AssetSourceEnum.AssetSource source = 5
Output only. Source of the customer asset link.
enums.AssetLinkStatusEnum.AssetLinkStatus status = 4
Status of the customer asset.
enums.AssetLinkPrimaryStatusEnum.AssetLinkPrimaryStatus primary_status = 6
Output only. Provides the PrimaryStatus of this asset link. Primary status is meant essentially to differentiate between the plain "status" field, which has advertiser set values of enabled, paused, or removed. The primary status takes into account other signals (for assets its mainly policy and quality approvals) to come up with a more comprehensive status to indicate its serving state.
repeated primary_status_details = 7
Output only. Provides the details of the primary status and its associated reasons.
repeated enums.AssetLinkPrimaryStatusReasonEnum.AssetLinkPrimaryStatusReason primary_status_reasons = 8
Output only. Provides a list of reasons for why an asset is not serving or not serving at full capacity.
message
customer_asset_set.proto:36CustomerAssetSet is the linkage between a customer and an asset set. Adding a CustomerAssetSet links an asset set with a customer.
Used in: , ,
string resource_name = 1
Immutable. The resource name of the customer asset set. Asset set asset resource names have the form: `customers/{customer_id}/customerAssetSets/{asset_set_id}`
string asset_set = 2
Immutable. The asset set which is linked to the customer.
string customer = 3
Immutable. The customer to which this asset set is linked.
enums.AssetSetLinkStatusEnum.AssetSetLinkStatus status = 4
Output only. The status of the customer asset set asset. 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 in:
string resource_name = 1
Output only. The resource name of the customer client. CustomerClient resource names have the form: `customers/{customer_id}/customerClients/{client_customer_id}`
optional string client_customer = 12
Output only. The resource name of the client-customer which is linked to the given customer. Read only.
optional bool hidden = 13
Output only. Specifies whether this is a [hidden account](https://support.google.com/google-ads/answer/7519830). Read only.
optional int64 level = 14
Output only. Distance between given customer and client. For self link, the level value will be 0. Read only.
optional string time_zone = 15
Output only. Common Locale Data Repository (CLDR) string representation of the time zone of the client, for example, America/Los_Angeles. Read only.
optional bool test_account = 16
Output only. Identifies if the client is a test account. Read only.
optional bool manager = 17
Output only. Identifies if the client is a manager. Read only.
optional string descriptive_name = 18
Output only. Descriptive name for the client. Read only.
optional string currency_code = 19
Output only. Currency code (for example, 'USD', 'EUR') for the client. Read only.
optional int64 id = 20
Output only. The ID of the client customer. Read only.
repeated string applied_labels = 21
Output only. The resource names of the labels owned by the requesting customer that are applied to the client customer. Label resource names have the form: `customers/{customer_id}/labels/{label_id}`
enums.CustomerStatusEnum.CustomerStatus status = 22
Output only. The status of the client customer. Read only.
message
customer_client_link.proto:35Represents customer client link relationship.
Used in: ,
string resource_name = 1
Immutable. Name of the resource. CustomerClientLink resource names have the form: `customers/{customer_id}/customerClientLinks/{client_customer_id}~{manager_link_id}`
optional string client_customer = 7
Immutable. The client customer linked to this customer.
optional int64 manager_link_id = 8
Output only. 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 bool hidden = 9
The visibility of the link. Users can choose whether or not to see hidden links in the Google Ads UI. Default value is false
Biddability control for conversion actions with a matching category and origin.
Used in: ,
string resource_name = 1
Immutable. The resource name of the customer conversion goal. Customer conversion goal resource names have the form: `customers/{customer_id}/customerConversionGoals/{category}~{origin}`
enums.ConversionActionCategoryEnum.ConversionActionCategory category = 2
The conversion category of this customer conversion goal. Only conversion actions that have this category will be included in this goal.
enums.ConversionOriginEnum.ConversionOrigin origin = 3
The conversion origin of this customer conversion goal. Only conversion actions that have this conversion origin will be included in this goal.
bool biddable = 4
The biddability of the customer conversion goal.
message
customer_customizer.proto:35A customizer value for the associated CustomizerAttribute at the Customer level.
Used in: , ,
string resource_name = 1
Immutable. The resource name of the customer customizer. Customer customizer resource names have the form: `customers/{customer_id}/customerCustomizers/{customizer_attribute_id}`
string customizer_attribute = 2
Required. Immutable. The customizer attribute which is linked to the customer.
enums.CustomizerValueStatusEnum.CustomizerValueStatus status = 3
Output only. The status of the customer customizer attribute.
optional value = 4
Required. The value to associate with the customizer attribute at this level. The value must be of the type specified for the CustomizerAttribute.
message
customer_label.proto:36Represents 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 in: ,
string resource_name = 1
Immutable. Name of the resource. Customer label resource names have the form: `customers/{customer_id}/customerLabels/{label_id}`
optional string customer = 4
Output only. The resource name of the customer to which the label is attached. Read only.
optional string label = 5
Output only. 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_lifecycle_goal.proto:35Account level customer lifecycle goal settings.
Used in: ,
string resource_name = 1
Immutable. The resource name of the customer lifecycle goal. Customer lifecycle resource names have the form: `customers/{customer_id}/customerLifecycleGoal`
optional customer_acquisition_goal_value_settings = 3
Output only. Customer acquisition goal customer level value settings.
string owner_customer = 4
Output only. The resource name of the customer which owns the lifecycle goal.
message
customer_manager_link.proto:35Represents customer-manager link relationship.
Used in: ,
string resource_name = 1
Immutable. Name of the resource. CustomerManagerLink resource names have the form: `customers/{customer_id}/customerManagerLinks/{manager_customer_id}~{manager_link_id}`
optional string manager_customer = 6
Output only. The manager customer linked to the customer.
optional int64 manager_link_id = 7
Output only. 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 in: , ,
string resource_name = 1
Immutable. The resource name of the customer negative criterion. Customer negative criterion resource names have the form: `customers/{customer_id}/customerNegativeCriteria/{criterion_id}`
optional int64 id = 10
Output only. The ID of the criterion.
enums.CriterionTypeEnum.CriterionType type = 3
Output only. The type of the criterion.
oneof criterion
The customer negative criterion. Exactly one must be set.
content_label = 4
Immutable. ContentLabel.
mobile_application = 5
Immutable. MobileApplication.
mobile_app_category = 6
Immutable. MobileAppCategory.
placement = 7
Immutable. Placement.
youtube_video = 8
Immutable. YouTube Video.
youtube_channel = 9
Immutable. YouTube Channel.
negative_keyword_list = 11
Immutable. NegativeKeywordList.
ip_block = 12
Immutable. IPBLock
placement_list = 13
Immutable. PlacementList.
This report provides a high-level view of search demand at the customer level by grouping similar search terms into categories and showing their search volume. Historical data is available starting March 2023.
Used in:
string resource_name = 1
Output only. The resource name of the customer level search term insight. Customer level search term insight resource names have the form: `customers/{customer_id}/customerSearchTermInsights/{category_id}`
optional string category_label = 2
Output only. The label for the search category. An empty string denotes the catch-all category for search terms that didn't fit into another category.
optional int64 id = 3
Output only. The ID of the insight.
A CustomerSkAdNetworkConversionValueSchema.
Used in:
string resource_name = 1
Output only. The resource name of the schema. CustomerSkAdNetworkConversionValueSchema resource names have the form: customers/{customer_id}/customerSkAdNetworkConversionValueSchemas/{account_link_id}
optional schema = 2
Output only. The schema for the specified resource.
The CustomerLink specific SkAdNetworkConversionValueSchema.
Used in:
string app_id = 1
Required. Output only. Apple App Store app ID.
int32 measurement_window_hours = 2
Output only. A time window (measured in hours) post-install, after which the App Attribution Partner or advertiser stops calling [updateConversionValue] (https://developer.apple.com/documentation/storekit/skadnetwork/3566697-updateconversionvalue).
repeated fine_grained_conversion_value_mappings = 3
Output only. Fine grained conversion value mappings. For SkAdNetwork versions >= 4.0 that support multiple conversion windows, fine grained conversion value mappings are only applicable to the first postback.
repeated postback_mappings = 4
Output only. Per-postback conversion value mappings for postbacks in multiple conversion windows. Only applicable for SkAdNetwork versions >= 4.0.
Mappings for coarse grained conversion values.
Used in:
optional low_conversion_value_mapping = 1
Output only. Mapping for "low" coarse conversion value.
optional medium_conversion_value_mapping = 2
Output only. Mapping for "medium" coarse conversion value.
optional high_conversion_value_mapping = 3
Output only. Mapping for "high" coarse conversion value.
Represents mapping from one conversion value to one or more conversion events.
Used in: ,
int64 min_time_post_install_hours = 1
Output only. The minimum of the time range in which a user was last active during the measurement window.
int64 max_time_post_install_hours = 2
Output only. The maximum of the time range in which a user was last active during the measurement window.
repeated mapped_events = 3
Output only. The conversion value may be mapped to multiple events with various attributes.
Defines a Google conversion event that the conversion value is mapped to.
Used in:
string mapped_event_name = 1
Output only. Google event name represented by this conversion value.
string currency_code = 2
Output only. The reported currency for the event_revenue. ISO 4217 three-letter currency code, for example, "USD"
oneof revenue_rate
Either a range or specific value for event revenue.
event_revenue_range = 3
Output only. The event revenue range.
double event_revenue_value = 4
Output only. The specific event revenue value.
oneof event_rate
Either a range or specific value for event counter.
event_occurrence_range = 5
Output only. The event counter range.
int64 event_counter = 6
Output only. For specific event counter values.
Defines a range for event counter values.
Used in:
int64 min_event_count = 1
Output only. For event counter ranges, the minimum of the defined range. A value of 0 will be treated as unset.
int64 max_event_count = 2
Output only. For event counter ranges, the maximum of the defined range. A value of 0 will be treated as unset.
Defines a range for revenue values.
Used in:
double min_event_revenue = 3
Output only. For revenue ranges, the minimum value in `currency_code` for which this conversion value would be updated. A value of 0 will be treated as unset.
double max_event_revenue = 4
Output only. For revenue ranges, the maximum value in `currency_code` for which this conversion value would be updated. A value of 0 will be treated as unset.
Mappings for fine grained conversion value.
Used in:
int32 fine_grained_conversion_value = 1
Output only. Fine grained conversion value. Valid values are in the inclusive range [0,63].
optional conversion_value_mapping = 2
Output only. Conversion events the fine grained conversion value maps to.
Mappings for each postback in multiple conversion windows.
Used in:
int32 postback_sequence_index = 1
Output only. 0-based index that indicates the order of postback. Valid values are in the inclusive range [0,2].
optional coarse_grained_conversion_value_mappings = 2
Output only. Conversion value mappings for all coarse grained conversion values.
oneof lock_window_trigger
Event or conversion value used for locking conversion window.
enums.SkAdNetworkCoarseConversionValueEnum.SkAdNetworkCoarseConversionValue lock_window_coarse_conversion_value = 3
Output only. Coarse grained conversion value that triggers conversion window lock.
int32 lock_window_fine_conversion_value = 4
Output only. Fine grained conversion value that triggers conversion window lock.
string lock_window_event = 5
Output only. Event name that triggers conversion window lock.
message
customer_user_access.proto:35Represents the permission of a single user onto a single customer.
Used in: ,
string resource_name = 1
Immutable. Name of the resource. Resource names have the form: `customers/{customer_id}/customerUserAccesses/{user_id}`
int64 user_id = 2
Output only. User id of the user with the customer access. Read only field
optional string email_address = 3
Output only. Email address of the user. Read only field
enums.AccessRoleEnum.AccessRole access_role = 4
Access role of the user.
optional string access_creation_date_time = 6
Output only. The customer user access creation time. Read only field The format is "YYYY-MM-DD HH:MM:SS". Examples: "2018-03-05 09:15:00" or "2018-02-01 14:34:30"
optional string inviter_user_email_address = 7
Output only. The email address of the inviter user. Read only field
Represent an invitation to a new user on this customer account.
Used in: ,
string resource_name = 1
Immutable. Name of the resource. Resource names have the form: `customers/{customer_id}/customerUserAccessInvitations/{invitation_id}`
int64 invitation_id = 2
Output only. The ID of the invitation. This field is read-only.
enums.AccessRoleEnum.AccessRole access_role = 3
Immutable. Access role of the user.
string email_address = 4
Immutable. Email address the invitation was sent to. This can differ from the email address of the account that accepts the invite.
string creation_date_time = 5
Output only. Time invitation was created. This field is read-only. The format is "YYYY-MM-DD HH:MM:SS". Examples: "2018-03-05 09:15:00" or "2018-02-01 14:34:30"
enums.AccessInvitationStatusEnum.AccessInvitationStatus invitation_status = 6
Output only. Invitation status of the user.
message
customizer_attribute.proto:38A customizer attribute. Use CustomerCustomizer, CampaignCustomizer, AdGroupCustomizer, or AdGroupCriterionCustomizer to associate a customizer attribute and set its value at the customer, campaign, ad group, or ad group criterion level, respectively.
Used in: , ,
string resource_name = 1
Immutable. The resource name of the customizer attribute. Customizer Attribute resource names have the form: `customers/{customer_id}/customizerAttributes/{customizer_attribute_id}`
int64 id = 2
Output only. The ID of the customizer attribute.
string name = 3
Required. Immutable. Name of the customizer attribute. Required. It must have a minimum length of 1 and maximum length of 40. Name of an enabled customizer attribute must be unique (case insensitive).
enums.CustomizerAttributeTypeEnum.CustomizerAttributeType type = 4
Immutable. The type of the customizer attribute.
enums.CustomizerAttributeStatusEnum.CustomizerAttributeStatus status = 5
Output only. The status of the customizer attribute.
message
data_link.proto:35Represents the data sharing connection between a Google Ads customer and another product's data.
Used in: ,
string resource_name = 1
Immutable. Resource name of the product data link. DataLink resource names have the form: `customers/{customer_id}/datalinks/{product_link_id}~{data_link_id}}
optional int64 product_link_id = 2
Output only. The ID of the link. This field is read only.
optional int64 data_link_id = 3
Output only. The ID of the data link. This field is read only.
enums.DataLinkTypeEnum.DataLinkType type = 4
Output only. The type of the data.
enums.DataLinkStatusEnum.DataLinkStatus status = 5
Output only. The status of the data link.
oneof data_link_entity
Data linked to this account.
youtube_video = 6
Immutable. A data link to YouTube video.
message
product_link.proto:81The identifier for Data Partner account.
Used in:
optional int64 data_partner_id = 1
Immutable. The customer ID of the Data partner account. This field is required and should not be empty when creating a new data partner link. It is unable to be modified after the creation of the link.
A detail content suitability placement view.
Used in:
string resource_name = 1
Output only. The resource name of the detail content suitability placement view. Detail content suitability placement view resource names have the form: `customers/{customer_id}/detailContentSuitabilityPlacementViews/{placement_fingerprint}`
string display_name = 2
Output only. The display name is URL for websites, YouTube video name for YouTube videos, and translated mobile app name for mobile apps.
string placement = 3
Output only. The automatic placement string at detail level, for example. website url, mobile application id, or a YouTube video id.
enums.PlacementTypeEnum.PlacementType placement_type = 4
Output only. Represents the type of the placement, for example, Website, YouTubeVideo and MobileApplication.
string target_url = 5
Output only. URL of the placement, for example, website, link to the mobile application in app store, or a YouTube video URL.
message
detail_placement_view.proto:35A view with metrics aggregated by ad group and URL or YouTube video.
Used in:
string resource_name = 1
Output only. 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 string placement = 7
Output only. The automatic placement string at detail level, e. g. website URL, mobile application ID, or a YouTube video ID.
optional string display_name = 8
Output only. The display name is URL name for websites, YouTube video name for YouTube videos, and translated mobile app name for mobile apps.
optional string group_placement_target_url = 9
Output only. URL of the group placement, for example, domain, link to the mobile application in app store, or a YouTube channel URL.
optional string target_url = 10
Output only. URL of the placement, for example, website, link to the mobile application in app store, or a YouTube video URL.
enums.PlacementTypeEnum.PlacementType placement_type = 6
Output only. Type of the placement, for example, Website, YouTube Video, and Mobile Application.
message
detailed_demographic.proto:36A detailed demographic: a particular interest-based vertical to be targeted to reach users based on long-term life facts.
Used in:
string resource_name = 1
Output only. The resource name of the detailed demographic. Detailed demographic resource names have the form: `customers/{customer_id}/detailedDemographics/{detailed_demographic_id}`
int64 id = 2
Output only. The ID of the detailed demographic.
string name = 3
Output only. The name of the detailed demographic. For example,"Highest Level of Educational Attainment"
string parent = 4
Output only. The parent of the detailed_demographic.
bool launched_to_all = 5
Output only. True if the detailed demographic is launched to all channels and locales.
repeated availabilities = 6
Output only. Availability information of the detailed demographic.
message
display_keyword_view.proto:34A display keyword view.
Used in:
string resource_name = 1
Output only. 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:39A 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 in:
string resource_name = 1
Output only. 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
Output only. Grouping of user distance from location extensions.
optional bool metric_system = 4
Output only. True if the DistanceBucket is using the metric system, false otherwise.
message
domain_category.proto:37A 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 in:
string resource_name = 1
Output only. 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 string campaign = 10
Output only. The campaign this category is recommended for.
optional string category = 11
Output only. Recommended category for the website domain, for example, if you have a website about electronics, the categories could be "cameras", "televisions", etc.
optional string language_code = 12
Output only. The language code specifying the language of the website, for example, "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 string domain = 13
Output only. The domain for the website. The domain can be specified in the DynamicSearchAdsSetting required for dynamic search ads.
optional double coverage_fraction = 14
Output only. Fraction of pages on your site that this category matches.
optional int64 category_rank = 15
Output only. The position of this category in the set of categories. Lower numbers indicate a better match for the domain. null indicates not recommended.
optional bool has_children = 16
Output only. Indicates whether this category has sub-categories.
optional int64 recommended_cpc_bid_micros = 17
Output only. The recommended cost per click for the category.
A dynamic search ads search term view.
Used in:
string resource_name = 1
Output only. 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_fingerprint}~{headline_fingerprint}~{landing_page_fingerprint}~{page_url_fingerprint}`
optional string search_term = 9
Output only. Search term This field is read-only.
optional string headline = 10
Output only. The dynamically generated headline of the Dynamic Search Ad. This field is read-only.
optional string landing_page = 11
Output only. The dynamically selected landing page URL of the impression. This field is read-only.
optional string page_url = 12
Output only. The URL of page feed item served for the impression. This field is read-only.
optional bool has_negative_keyword = 13
Output only. True if query matches a negative keyword. This field is read-only.
optional bool has_matching_keyword = 14
Output only. True if query is added to targeted keywords. This field is read-only.
optional bool has_negative_url = 15
Output only. True if query matches a negative url. This field is read-only.
A landing page view with metrics aggregated at the expanded final URL level.
Used in:
string resource_name = 1
Output only. 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 string expanded_final_url = 3
Output only. The final URL that clicks are directed to.
message
experiment.proto:39A Google ads experiment for users to experiment changes on multiple campaigns, compare the performance, and apply the effective changes.
Used in: ,
string resource_name = 1
Immutable. The resource name of the experiment. Experiment resource names have the form: `customers/{customer_id}/experiments/{experiment_id}`
optional int64 experiment_id = 9
Output only. The ID of the experiment. Read only.
string name = 10
Required. The name of the experiment. It must have a minimum length of 1 and maximum length of 1024. It must be unique under a customer.
string description = 11
The description of the experiment. It must have a minimum length of 1 and maximum length of 2048.
string suffix = 12
For system managed experiments, the advertiser must provide a suffix during construction, in the setup stage before moving to initiated. The suffix will be appended to the in-design and experiment campaign names so that the name is base campaign name + suffix.
enums.ExperimentTypeEnum.ExperimentType type = 13
Required. The product/feature that uses this experiment.
enums.ExperimentStatusEnum.ExperimentStatus status = 14
The Advertiser-chosen status of this experiment.
optional string start_date = 15
Date when the 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. Format: YYYY-MM-DD Example: 2019-03-14
optional string end_date = 16
Date when the 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
repeated goals = 17
The goals of this experiment.
optional string long_running_operation = 18
Output only. The resource name of the long-running operation that can be used to poll for completion of experiment schedule or promote. The most recent long running operation is returned.
enums.AsyncActionStatusEnum.AsyncActionStatus promote_status = 19
Output only. The status of the experiment promotion process.
optional bool sync_enabled = 20
Immutable. Set to true if changes to base campaigns should be synced to the trial campaigns. Any changes made directly to trial campaigns will be preserved. This field can only be set when the experiment is being created.
message
experiment_arm.proto:35A Google ads experiment for users to experiment changes on multiple campaigns, compare the performance, and apply the effective changes.
Used in: , ,
string resource_name = 1
Immutable. The resource name of the experiment arm. Experiment arm resource names have the form: `customers/{customer_id}/experimentArms/{TrialArm.trial_id}~{TrialArm.trial_arm_id}`
string experiment = 8
Immutable. The experiment to which the ExperimentArm belongs.
string name = 3
Required. The name of the experiment arm. It must have a minimum length of 1 and maximum length of 1024. It must be unique under an experiment.
bool control = 4
Whether this arm is a control arm. A control arm is the arm against which the other arms are compared.
int64 traffic_split = 5
Traffic split of the trial arm. The value should be between 1 and 100 and must total 100 between the two trial arms.
repeated string campaigns = 6
List of campaigns in the trial arm. The max length is one.
repeated string in_design_campaigns = 7
Output only. The in design campaigns in the treatment experiment arm.
Details about the employee's medical Fellowship. Fellowship is a period of medical training that the professional undertakes after finishing their residency.
Used in:
optional string institution_name = 1
Output only. Name of the instutition at which the fellowship was completed.
optional int32 completion_year = 2
Output only. Year of completion.
FinalUrlExpansionAssetView Resource.
Used in:
string resource_name = 1
Output only. The resource name of the FinalUrlExpansionAsset.
optional string campaign = 2
Output only. Campaign in which the asset served.
optional string asset = 3
Output only. The ID of the asset.
enums.AssetFieldTypeEnum.AssetFieldType field_type = 4
Output only. The field type of the asset.
optional enums.AssetLinkStatusEnum.AssetLinkStatus status = 5
Output only. Status of the FinalUrlExpansionAsset.
string final_url = 6
Output only. Final URL of the FinalUrlExpansionAsset.
oneof level
Serving level of FinalUrlExpansionAsset.
string ad_group = 7
Output only. Ad Group in which FinalUrlExpansionAsset served.
string asset_group = 8
Output only. Asset Group in which FinalUrlExpansionAsset served.
message
gender_view.proto:37A gender view. The gender_view resource reflects the effective serving state, rather than what criteria were added. An ad group without gender criteria by default shows to all genders, so all genders appear in gender_view with stats.
Used in:
string resource_name = 1
Output only. 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:35A geo target constant.
Used in: ,
string resource_name = 1
Output only. The resource name of the geo target constant. Geo target constant resource names have the form: `geoTargetConstants/{geo_target_constant_id}`
optional int64 id = 10
Output only. The ID of the geo target constant.
optional string name = 11
Output only. Geo target constant English name.
optional string country_code = 12
Output only. The ISO-3166-1 alpha-2 country code that is associated with the target.
optional string target_type = 13
Output only. Geo target constant target type.
enums.GeoTargetConstantStatusEnum.GeoTargetConstantStatus status = 7
Output only. Geo target constant status.
optional string canonical_name = 14
Output only. The fully qualified English name, consisting of the target's name and that of its parent and country.
optional string parent_geo_target = 9
Output only. The resource name of the parent geo target constant. Geo target constant resource names have the form: `geoTargetConstants/{parent_geo_target_constant_id}`
message
geographic_view.proto:40A 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 in:
string resource_name = 1
Output only. 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
Output only. Type of the geo targeting of the campaign.
optional int64 country_criterion_id = 5
Output only. Criterion Id for the country.
message
goal.proto:35Representation of goals.
Used in: ,
string resource_name = 1
Immutable. The resource name of the goal. Goal resource names have the form: `customers/{customer_id}/goals/{goal_id}`
optional int64 goal_id = 2
Output only. The ID of this goal.
enums.GoalTypeEnum.GoalType goal_type = 3
Output only. The type of this goal.
optional string owner_customer = 4
Output only. The resource name of the goal owner customer.
enums.GoalOptimizationEligibilityEnum.GoalOptimizationEligibility optimization_eligibility = 6
Output only. Indicates if this goal is eligible for campaign optimization.
oneof goal_settings
The settings specific to this goal.
retention_goal_settings = 7
Retention goal settings.
message
google_ads_field.proto:36A field or resource (artifact) used by GoogleAdsService.
Used as response type in: services.GoogleAdsFieldService.GetGoogleAdsField
Used as field type in:
string resource_name = 1
Output only. The resource name of the artifact. Artifact resource names have the form: `googleAdsFields/{name}`
optional string name = 21
Output only. The name of the artifact.
enums.GoogleAdsFieldCategoryEnum.GoogleAdsFieldCategory category = 3
Output only. The category of the artifact.
optional bool selectable = 22
Output only. Whether the artifact can be used in a SELECT clause in search queries.
optional bool filterable = 23
Output only. Whether the artifact can be used in a WHERE clause in search queries.
optional bool sortable = 24
Output only. Whether the artifact can be used in a ORDER BY clause in search queries.
repeated string selectable_with = 25
Output only. The names of all resources, segments, and metrics that are selectable with the described artifact.
repeated string attribute_resources = 26
Output only. 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 string metrics = 27
Output only. 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.
repeated string segments = 28
Output only. 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.
repeated string enum_values = 29
Output only. 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
Output only. This field determines the operators that can be used with the artifact in WHERE clauses.
optional string type_url = 30
Output only. The URL of proto describing the artifact's data type.
optional bool is_repeated = 31
Output only. Whether the field artifact is repeated.
message
product_link.proto:90The identifier for Google Ads account.
Used in:
optional string customer = 1
Immutable. The resource name of the Google Ads account. This field is required and should not be empty when creating a new Google Ads link. It is unable to be modified after the creation of the link.
message
customer.proto:293Insurance status at geo + vertical level.
Used in:
optional int64 geo_criterion_id = 1
Output only. Geotarget criterion ID associated with the status. Can be on country or state/province geo level, depending on requirements and location. See https://developers.google.com/google-ads/api/data/geotargets for more information.
optional string category_id = 2
Output only. Service category associated with the status. For example, xcat:service_area_business_plumber. For more details see: https://developers.google.com/google-ads/api/data/codes-formats#local_services_ids
optional enums.LocalServicesVerificationStatusEnum.LocalServicesVerificationStatus verification_status = 3
Output only. Granular insurance status, per geo + vertical.
message
customer.proto:272License status at geo + vertical level.
Used in:
optional int64 geo_criterion_id = 1
Output only. Geotarget criterion ID associated with the status. Can be on country or state/province geo level, depending on requirements and location. See https://developers.google.com/google-ads/api/data/geotargets for more information.
optional string category_id = 2
Output only. Service category associated with the status. For example, xcat:service_area_business_plumber. For more details see: https://developers.google.com/google-ads/api/data/codes-formats#local_services_ids
optional enums.LocalServicesVerificationStatusEnum.LocalServicesVerificationStatus verification_status = 3
Output only. Granular license status, per geo + vertical.
A group content suitability placement view.
Used in:
string resource_name = 1
Output only. The resource name of the group content suitability placement view. Group content suitability placement view resource names have the form: `customers/{customer_id}/groupContentSuitabilityPlacementViews/{placement_fingerprint}`
string display_name = 2
Output only. The display name is URL for websites, YouTube video name for YouTube videos, and translated mobile app name for mobile apps.
string placement = 3
Output only. The automatic placement string at group level, for example. website url, mobile application id, or a YouTube video id.
enums.PlacementTypeEnum.PlacementType placement_type = 4
Output only. Represents the type of the placement, for example, Website, YouTubeVideo and MobileApplication.
string target_url = 5
Output only. URL of the placement, for example, website, link to the mobile application in app store, or a YouTube video URL.
message
group_placement_view.proto:35A group placement view.
Used in:
string resource_name = 1
Output only. 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 string placement = 6
Output only. The automatic placement string at group level, e. g. web domain, mobile app ID, or a YouTube channel ID.
optional string display_name = 7
Output only. Domain name for websites and YouTube channel name for YouTube channels.
optional string target_url = 8
Output only. URL of the group placement, for example, domain, link to the mobile application in app store, or a YouTube channel URL.
enums.PlacementTypeEnum.PlacementType placement_type = 5
Output only. Type of the placement, for example, Website, YouTube Channel, Mobile Application.
message
product_link_invitation.proto:86The identifier for Hotel account.
Used in:
int64 hotel_center_id = 1
Output only. The hotel center id of the hotel account. This field is read only
message
hotel_group_view.proto:34A hotel group view.
Used in:
string resource_name = 1
Output only. 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 in:
string resource_name = 1
Output only. The resource name of the hotel performance view. Hotel performance view resource names have the form: `customers/{customer_id}/hotelPerformanceView`
message
hotel_reconciliation.proto:37A hotel reconciliation. It contains conversion information from Hotel bookings to reconcile with advertiser records. These rows may be updated or canceled before billing through Bulk Uploads.
Used in:
string resource_name = 1
Immutable. The resource name of the hotel reconciliation. Hotel reconciliation resource names have the form: `customers/{customer_id}/hotelReconciliations/{commission_id}`
string commission_id = 2
Required. Output only. The commission ID is Google's ID for this booking. Every booking event is assigned a Commission ID to help you match it to a guest stay.
string order_id = 3
Output only. The order ID is the identifier for this booking as provided in the 'transaction_id' parameter of the conversion tracking tag.
string campaign = 11
Output only. The resource name for the Campaign associated with the conversion.
int64 hotel_center_id = 4
Output only. Identifier for the Hotel Center account which provides the rates for the Hotel campaign.
string hotel_id = 5
Output only. Unique identifier for the booked property, as provided in the Hotel Center feed. The hotel ID comes from the 'ID' parameter of the conversion tracking tag.
string check_in_date = 6
Output only. Check-in date recorded when the booking is made. If the check-in date is modified at reconciliation, the revised date will then take the place of the original date in this column. Format is YYYY-MM-DD.
string check_out_date = 7
Output only. Check-out date recorded when the booking is made. If the check-in date is modified at reconciliation, the revised date will then take the place of the original date in this column. Format is YYYY-MM-DD.
int64 reconciled_value_micros = 8
Required. Output only. Reconciled value is the final value of a booking as paid by the guest. If original booking value changes for any reason, such as itinerary changes or room upsells, the reconciled value should be the full final amount collected. If a booking is canceled, the reconciled value should include the value of any cancellation fees or non-refundable nights charged. Value is in millionths of the base unit currency. For example, $12.35 would be represented as 12350000. Currency unit is in the default customer currency.
bool billed = 9
Output only. Whether a given booking has been billed. Once billed, a booking can't be modified.
enums.HotelReconciliationStatusEnum.HotelReconciliationStatus status = 10
Required. Output only. Current status of a booking with regards to reconciliation and billing. Bookings should be reconciled within 45 days after the check-out date. Any booking not reconciled within 45 days will be billed at its original value.
message
income_range_view.proto:34An income range view.
Used in:
string resource_name = 1
Output only. The resource name of the income range view. Income range view resource names have the form: `customers/{customer_id}/incomeRangeViews/{ad_group_id}~{criterion_id}`
A proto holding information specific to a local services insurance.
Used in:
optional int64 amount_micros = 1
Output only. Insurance amount. This is measured in "micros" of the currency mentioned in the insurance document.
optional enums.LocalServicesInsuranceRejectionReasonEnum.LocalServicesInsuranceRejectionReason rejection_reason = 2
Output only. Insurance document's rejection reason.
optional insurance_document_readonly = 3
Output only. The readonly field containing the information for an uploaded insurance document.
optional string expiration_date_time = 4
Output only. The timestamp when this insurance expires. The format is "YYYY-MM-DD HH:MM:SS" in the Google Ads account's timezone. Examples: "2018-03-05 09:15:00" or "2018-02-01 14:34:30"
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
Output only. 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 string id = 25
Output only. The ID of the invoice. It appears on the invoice PDF as "Invoice number".
enums.InvoiceTypeEnum.InvoiceType type = 3
Output only. The type of invoice.
optional string billing_setup = 26
Output only. The resource name of this invoice's billing setup. `customers/{customer_id}/billingSetups/{billing_setup_id}`
optional string payments_account_id = 27
Output only. A 16 digit ID used to identify the payments account associated with the billing setup, for example, "1234-5678-9012-3456". It appears on the invoice PDF as "Billing Account Number".
optional string payments_profile_id = 28
Output only. A 12 digit ID used to identify the payments profile associated with the billing setup, for example, "1234-5678-9012". It appears on the invoice PDF as "Billing ID".
optional string issue_date = 29
Output only. The issue date in yyyy-mm-dd format. It appears on the invoice PDF as either "Issue date" or "Invoice date".
optional string due_date = 30
Output only. The due date in yyyy-mm-dd format.
optional service_date_range = 9
Output only. The service period date range of this invoice. The end date is inclusive.
optional string currency_code = 31
Output only. The currency code. All costs are returned in this currency. A subset of the currency codes derived from the ISO 4217 standard is supported.
int64 adjustments_subtotal_amount_micros = 19
Output only. The pretax subtotal amount of invoice level adjustments, in micros.
int64 adjustments_tax_amount_micros = 20
Output only. The sum of taxes on the invoice level adjustments, in micros.
int64 adjustments_total_amount_micros = 21
Output only. The total amount of invoice level adjustments, in micros.
int64 regulatory_costs_subtotal_amount_micros = 22
Output only. The pretax subtotal amount of invoice level regulatory costs, in micros.
int64 regulatory_costs_tax_amount_micros = 23
Output only. The sum of taxes on the invoice level regulatory costs, in micros.
int64 regulatory_costs_total_amount_micros = 24
Output only. The total amount of invoice level regulatory costs, in micros.
optional int64 export_charge_subtotal_amount_micros = 40
Output only. The pretax subtotal amount of invoice level export charges, in micros.
optional int64 export_charge_tax_amount_micros = 41
Output only. The sum of taxes on the invoice level export charges, in micros.
optional int64 export_charge_total_amount_micros = 42
Output only. The total amount of invoice level export charges, in micros.
optional int64 subtotal_amount_micros = 33
Output only. The pretax subtotal amount, in micros. This is equal to the sum of the AccountBudgetSummary subtotal amounts and Invoice.adjustments_subtotal_amount_micros.
optional int64 tax_amount_micros = 34
Output only. 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 int64 total_amount_micros = 35
Output only. The total amount, in micros. This equals the sum of Invoice.subtotal_amount_micros, Invoice.tax_amount_micros, Invoice.regulatory_costs_subtotal_amount_micros, and Invoice.export_charge_subtotal_amount_micros (which is separated into a separate line item starting with V14.1).
optional string corrected_invoice = 36
Output only. 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 string replaced_invoices = 37
Output only. 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 string pdf_url = 38
Output only. 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
Output only. The list of summarized account budget information associated with this invoice.
repeated account_summaries = 39
Output only. The list of summarized account information associated with this invoice.
message
invoice.proto:128Represents a summarized account budget billable cost.
Used in:
optional string customer = 10
Output only. 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 string customer_descriptive_name = 11
Output only. The descriptive name of the account budget's customer. It appears on the invoice PDF as "Account".
optional string account_budget = 12
Output only. 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 string account_budget_name = 13
Output only. The name of the account budget. It appears on the invoice PDF as "Account budget".
optional string purchase_order_number = 14
Output only. The purchase order number of the account budget. It appears on the invoice PDF as "Purchase order".
optional int64 subtotal_amount_micros = 15
Output only. The pretax subtotal amount attributable to this budget during the service period, in micros.
optional int64 tax_amount_micros = 16
Output only. The tax amount attributable to this budget during the service period, in micros.
optional int64 total_amount_micros = 17
Output only. 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
Output only. 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.
optional int64 served_amount_micros = 18
Output only. The pretax served amount attributable to this budget during the service period, in micros. This is only useful to reconcile invoice and delivery data.
optional int64 billed_amount_micros = 19
Output only. The pretax billed amount attributable to this budget during the service period, in micros. This does not account for any adjustments.
optional int64 overdelivery_amount_micros = 20
Output only. The pretax overdelivery amount attributable to this budget during the service period, in micros (negative value).
optional int64 invalid_activity_amount_micros = 21
Output only. The pretax invalid activity amount attributable to this budget in previous months, in micros (negative value).
repeated invalid_activity_summaries = 22
Output only. The list of summarized invalid activity credits with original linkages.
message
invoice.proto:46Represents a summarized view at account level.
Used in:
optional string customer = 1
Output only. The account associated with the account summary.
optional int64 billing_correction_subtotal_amount_micros = 2
Output only. Pretax billing correction subtotal amount, in micros.
optional int64 billing_correction_tax_amount_micros = 3
Output only. Tax on billing correction, in micros.
optional int64 billing_correction_total_amount_micros = 4
Output only. Total billing correction amount, in micros.
optional int64 coupon_adjustment_subtotal_amount_micros = 5
Output only. Pretax coupon adjustment subtotal amount, in micros.
optional int64 coupon_adjustment_tax_amount_micros = 6
Output only. Tax on coupon adjustment, in micros.
optional int64 coupon_adjustment_total_amount_micros = 7
Output only. Total coupon adjustment amount, in micros.
optional int64 excess_credit_adjustment_subtotal_amount_micros = 8
Output only. Pretax excess credit adjustment subtotal amount, in micros.
optional int64 excess_credit_adjustment_tax_amount_micros = 9
Output only. Tax on excess credit adjustment, in micros.
optional int64 excess_credit_adjustment_total_amount_micros = 10
Output only. Total excess credit adjustment amount, in micros.
optional int64 regulatory_costs_subtotal_amount_micros = 11
Output only. Pretax regulatory costs subtotal amount, in micros.
optional int64 regulatory_costs_tax_amount_micros = 12
Output only. Tax on regulatory costs, in micros.
optional int64 regulatory_costs_total_amount_micros = 13
Output only. Total regulatory costs amount, in micros.
optional int64 export_charge_subtotal_amount_micros = 17
Output only. Pretax export charge subtotal amount, in micros.
optional int64 export_charge_tax_amount_micros = 18
Output only. Tax on export charge, in micros.
optional int64 export_charge_total_amount_micros = 19
Output only. Total export charge amount, in micros.
optional int64 subtotal_amount_micros = 14
Output only. Total pretax subtotal amount attributable to the account during the service period, in micros.
optional int64 tax_amount_micros = 15
Output only. Total tax amount attributable to the account during the service period, in micros.
optional int64 total_amount_micros = 16
Output only. Total amount attributable to the account during the service period, in micros. This equals the sum of the subtotal_amount_micros and tax_amount_micros.
message
invoice.proto:209Details about the invalid activity for the invoice that contain additional details about invoice against which corrections are made.
Used in:
optional enums.MonthOfYearEnum.MonthOfYear original_month_of_service = 1
Output only. Original month of service related to this invalid activity credit.
optional string original_year_of_service = 2
Output only. Original year of service related to this invalid activity credit.
optional string original_invoice_id = 3
Output only. Original invoice number related to this invalid activity credit.
optional string original_account_budget_name = 4
Output only. Original account budget name related to this invalid activity credit.
optional string original_purchase_order_number = 5
Output only. Original purchase order number related to this invalid activity credit.
optional int64 amount_micros = 6
Output only. Invalid activity amount in micros.
message
keyword_plan.proto:38A Keyword Planner plan. Max number of saved keyword plans: 10000. It's possible to remove plans if limit is reached.
Used in: ,
string resource_name = 1
Immutable. The resource name of the Keyword Planner plan. KeywordPlan resource names have the form: `customers/{customer_id}/keywordPlans/{kp_plan_id}`
optional int64 id = 5
Output only. The ID of the keyword plan.
optional string name = 6
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:35A Keyword Planner ad group. Max number of keyword plan ad groups per plan: 200.
Used in: ,
string resource_name = 1
Immutable. The resource name of the Keyword Planner ad group. KeywordPlanAdGroup resource names have the form: `customers/{customer_id}/keywordPlanAdGroups/{kp_ad_group_id}`
optional string keyword_plan_campaign = 6
The keyword plan campaign to which this ad group belongs.
optional int64 id = 7
Output only. The ID of the keyword plan ad group.
optional string name = 8
The name of the keyword plan ad group. This field is required and should not be empty when creating keyword plan ad group.
optional int64 cpc_bid_micros = 9
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.
A Keyword Plan ad group keyword. Max number of keyword plan keywords per plan: 10000.
Used in: ,
string resource_name = 1
Immutable. The resource name of the Keyword Plan ad group keyword. KeywordPlanAdGroupKeyword resource names have the form: `customers/{customer_id}/keywordPlanAdGroupKeywords/{kp_ad_group_keyword_id}`
optional string keyword_plan_ad_group = 8
The Keyword Plan ad group to which this keyword belongs.
optional int64 id = 9
Output only. The ID of the Keyword Plan keyword.
optional string text = 10
The keyword text.
enums.KeywordMatchTypeEnum.KeywordMatchType match_type = 5
The keyword match type.
optional int64 cpc_bid_micros = 11
A keyword level max cpc bid in micros (for example, $1 = 1mm). The currency is the same as the account currency code. This will override any CPC bid set at the keyword plan ad group level. Not applicable for negative keywords. (negative = true) This field is Optional.
optional bool negative = 12
Immutable. If true, the keyword is negative.
message
keyword_plan_campaign.proto:36A Keyword Plan campaign. Max number of keyword plan campaigns per plan allowed: 1.
Used in: ,
string resource_name = 1
Immutable. The resource name of the Keyword Plan campaign. KeywordPlanCampaign resource names have the form: `customers/{customer_id}/keywordPlanCampaigns/{kp_campaign_id}`
optional string keyword_plan = 9
The keyword plan this campaign belongs to.
optional int64 id = 10
Output only. The ID of the Keyword Plan campaign.
optional string name = 11
The name of the Keyword Plan campaign. This field is required and should not be empty when creating Keyword Plan campaigns.
repeated string language_constants = 12
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 int64 cpc_bid_micros = 13
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.
A Keyword Plan Campaign keyword. Only negative keywords are supported for Campaign Keyword.
Used in: ,
string resource_name = 1
Immutable. The resource name of the Keyword Plan Campaign keyword. KeywordPlanCampaignKeyword resource names have the form: `customers/{customer_id}/keywordPlanCampaignKeywords/{kp_campaign_keyword_id}`
optional string keyword_plan_campaign = 8
The Keyword Plan campaign to which this negative keyword belongs.
optional int64 id = 9
Output only. The ID of the Keyword Plan negative keyword.
optional string text = 10
The keyword text.
enums.KeywordMatchTypeEnum.KeywordMatchType match_type = 5
The keyword match type.
optional bool negative = 11
Immutable. If true, the keyword is negative. Must be set to true. Only negative campaign keywords are supported.
message
keyword_plan.proto:69The 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. It cannot be greater than a year. 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:93A geo target.
Used in:
optional string geo_target_constant = 2
Required. The resource name of the geo target.
message
keyword_theme_constant.proto:34A Smart Campaign keyword theme constant.
Used in: , ,
string resource_name = 1
Output only. The resource name of the keyword theme constant. Keyword theme constant resource names have the form: `keywordThemeConstants/{keyword_theme_id}~{sub_keyword_theme_id}`
optional string country_code = 2
Output only. The ISO-3166 Alpha-2 country code of the constant, eg. "US". To display and query matching purpose, the keyword theme needs to be localized.
optional string language_code = 3
Output only. The ISO-639-1 language code with 2 letters of the constant, eg. "en". To display and query matching purpose, the keyword theme needs to be localized.
optional string display_name = 4
Output only. The display name of the keyword theme or sub keyword theme.
message
keyword_view.proto:34A keyword view.
Used in:
string resource_name = 1
Output only. 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:34A label.
Used in: , ,
string resource_name = 1
Immutable. Name of the resource. Label resource names have the form: `customers/{customer_id}/labels/{label_id}`
optional int64 id = 6
Output only. ID of the label. Read only.
optional string name = 7
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
Output only. 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:35A landing page view with metrics aggregated at the unexpanded final URL level.
Used in:
string resource_name = 1
Output only. 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 string unexpanded_final_url = 3
Output only. The advertiser-specified final URL.
message
language_constant.proto:34A language.
Used in:
string resource_name = 1
Output only. The resource name of the language constant. Language constant resource names have the form: `languageConstants/{criterion_id}`
optional int64 id = 6
Output only. The ID of the language constant.
optional string code = 7
Output only. The language code, for example, "en_US", "en_AU", "es", "fr", etc.
optional string name = 8
Output only. The full name of the language in English, for example, "English (US)", "Spanish", etc.
optional bool targetable = 9
Output only. Whether the language is targetable.
Data from lead form submissions.
Used in:
string resource_name = 1
Output only. The resource name of the lead form submission data. Lead form submission data resource names have the form: `customers/{customer_id}/leadFormSubmissionData/{lead_form_submission_data_id}`
string id = 2
Output only. ID of this lead form submission.
string asset = 3
Output only. Asset associated with the submitted lead form.
string campaign = 4
Output only. Campaign associated with the submitted lead form.
repeated lead_form_submission_fields = 5
Output only. Submission data associated with a lead form.
repeated custom_lead_form_submission_fields = 10
Output only. Submission data associated with a custom lead form.
string ad_group = 6
Output only. AdGroup associated with the submitted lead form.
string ad_group_ad = 7
Output only. AdGroupAd associated with the submitted lead form.
string gclid = 8
Output only. Google Click Id associated with the submissed lead form.
string submission_date_time = 9
Output only. The date and time at which the lead form was submitted. The format is "yyyy-mm-dd hh:mm:ss+|-hh:mm", for example, "2019-01-01 12:32:45-08:00".
Fields in the submitted lead form.
Used in:
enums.LeadFormFieldUserInputTypeEnum.LeadFormFieldUserInputType field_type = 1
Output only. Field type for lead form fields.
string field_value = 2
Output only. Field value for lead form fields.
A proto holding information specific to a local services license.
Used in:
optional string license_type = 1
Output only. License type / name.
optional string license_number = 2
Output only. License number.
optional string licensee_first_name = 3
Output only. First name of the licensee.
optional string licensee_last_name = 4
Output only. Last name of the licensee.
optional enums.LocalServicesLicenseRejectionReasonEnum.LocalServicesLicenseRejectionReason rejection_reason = 5
Output only. License rejection reason.
optional license_document_readonly = 6
Output only. The readonly field containing the information for an uploaded license document.
optional string expiration_date_time = 7
Output only. The timestamp when this license expires. The format is "YYYY-MM-DD HH:MM:SS" in the Google Ads account's timezone. Examples: "2018-03-05 09:15:00" or "2018-02-01 14:34:30"
message
life_event.proto:36A life event: a particular interest-based vertical to be targeted to reach users when they are in the midst of important life milestones.
Used in:
string resource_name = 1
Output only. The resource name of the life event. Life event resource names have the form: `customers/{customer_id}/lifeEvents/{life_event_id}`
int64 id = 2
Output only. The ID of the life event.
string name = 3
Output only. The name of the life event, for example,"Recently Moved"
string parent = 4
Output only. The parent of the life_event.
bool launched_to_all = 5
Output only. True if the life event is launched to all channels and locales.
repeated availabilities = 6
Output only. Availability information of the life event.
Listing dimensions for the asset group listing group filter.
Used in: ,
oneof dimension
Dimension of one of the types below is always present.
product_category = 10
Category of a product offer.
product_brand = 2
Brand of a product offer.
product_channel = 3
Locality of a product offer.
product_condition = 4
Condition of a product offer.
product_custom_attribute = 5
Custom attribute of a product offer.
product_item_id = 6
Item id of a product offer.
product_type = 7
Type of a product offer.
webpage = 9
Filters for URLs in a page feed and URLs from the advertiser web domain.
Brand of the product.
Used in:
optional string value = 1
String value of the product brand.
One element of a category at a certain level. Top-level categories are at level 1, their children at level 2, and so on. We currently support up to 5 levels. The user must specify a dimension type that indicates the level of the category. All cases of the same subdivision must have the same dimension type (category level).
Used in:
optional int64 category_id = 1
ID of the product category. This ID is equivalent to the google_product_category ID as described in this article: https://support.google.com/merchants/answer/6324436
enums.ListingGroupFilterProductCategoryLevelEnum.ListingGroupFilterProductCategoryLevel level = 2
Indicates the level of the category in the taxonomy.
Locality of a product offer.
Used in:
enums.ListingGroupFilterProductChannelEnum.ListingGroupFilterProductChannel channel = 1
Value of the locality.
Condition of a product offer.
Used in:
enums.ListingGroupFilterProductConditionEnum.ListingGroupFilterProductCondition condition = 1
Value of the condition.
Custom attribute of a product offer.
Used in:
optional string value = 1
String value of the product custom attribute.
enums.ListingGroupFilterCustomAttributeIndexEnum.ListingGroupFilterCustomAttributeIndex index = 2
Indicates the index of the custom attribute.
Item id of a product offer.
Used in:
optional string value = 1
Value of the id.
Type of a product offer.
Used in:
optional string value = 1
Value of the type.
enums.ListingGroupFilterProductTypeLevelEnum.ListingGroupFilterProductTypeLevel level = 2
Level of the type.
Filters for URLs in a page feed and URLs from the advertiser web domain. Several root nodes with this dimension are allowed in an asset group and their conditions are considered in OR.
Used in:
repeated conditions = 1
The webpage conditions are case sensitive and these are and-ed together when evaluated for filtering. All the conditions should be of same type. Example1: for URL1 = www.ads.google.com?ocid=1&euid=2 and URL2 = www.ads.google.com?ocid=1 and with "ocid" and "euid" as url_contains conditions, URL1 will be matched, but URL2 not. Example2 : If URL1 has Label1, Label2 and URL2 has Label2, Label3, then with Label1 and Label2 as custom_label conditions, URL1 will be matched but not URL2. With Label2 as the only custom_label condition then both URL1 and URL2 will be matched.
Matching condition for URL filtering.
Used in:
oneof condition
Condition for filtering the URLs.
string custom_label = 1
Filters the URLs in a page feed that have this custom label. A custom label can be added to a campaign by creating an AssetSet of type PAGE_FEED and linking it to the campaign using CampaignAssetSet.
string url_contains = 2
Filters the URLs in a page feed and the URLs from the advertiser web domain that contain this string.
The path defining of dimensions defining a listing group filter.
Used in:
repeated dimensions = 1
Output only. The complete path of dimensions through the listing group filter hierarchy (excluding the root node) to this listing group filter.
message
local_services_employee.proto:34A local services employee resource.
Used in:
string resource_name = 1
Immutable. The resource name of the Local Services Verification. Local Services Verification resource names have the form: `customers/{customer_id}/localServicesEmployees/{gls_employee_id}`
optional int64 id = 2
Output only. The ID of the employee.
string creation_date_time = 3
Output only. Timestamp of employee creation. The format is "YYYY-MM-DD HH:MM:SS" in the Google Ads account's timezone. Examples: "2018-03-05 09:15:00" or "2018-02-01 14:34:30"
enums.LocalServicesEmployeeStatusEnum.LocalServicesEmployeeStatus status = 4
Output only. Employee status, such as DELETED or ENABLED.
enums.LocalServicesEmployeeTypeEnum.LocalServicesEmployeeType type = 5
Output only. Employee type.
repeated university_degrees = 6
Output only. A list of degrees this employee has obtained, and wants to feature.
repeated residencies = 7
Output only. The institutions where the employee has completed their residency.
repeated fellowships = 8
Output only. The institutions where the employee has completed their fellowship.
optional string job_title = 9
Output only. Job title for this employee, such as "Senior partner" in legal verticals.
optional int32 year_started_practicing = 10
Output only. The year that this employee started practicing in this field.
repeated string languages_spoken = 11
Output only. Languages that the employee speaks, represented as language tags from https://developers.google.com/admin-sdk/directory/v1/languages
repeated string category_ids = 12
Output only. Category of the employee. A list of Local Services category IDs can be found at https://developers.google.com/google-ads/api/data/codes-formats#local_services_ids.
optional string national_provider_id_number = 13
Output only. NPI id associated with the employee.
optional string email_address = 14
Output only. Email address of the employee.
optional string first_name = 15
Output only. First name of the employee.
optional string middle_name = 16
Output only. Middle name of the employee.
optional string last_name = 17
Output only. Last name of the employee.
message
local_services_lead.proto:40Data from Local Services Lead. Contains details of Lead which is generated when user calls, messages or books service from advertiser. More info: https://ads.google.com/local-services-ads
Used in:
string resource_name = 1
Output only. The resource name of the local services lead data. Local Services Lead resource name have the form `customers/{customer_id}/localServicesLead/{local_services_lead_id}`
int64 id = 2
Output only. ID of this Lead.
string category_id = 3
Output only. Service category of the lead. For example: `xcat:service_area_business_hvac`, `xcat:service_area_business_real_estate_agent`, etc. For more details see: https://developers.google.com/google-ads/api/data/codes-formats#local_services_ids
string service_id = 4
Output only. Service for the category. For example: `buyer_agent`, `seller_agent` for the category of `xcat:service_area_business_real_estate_agent`.
optional contact_details = 5
Output only. Lead's contact details.
enums.LocalServicesLeadTypeEnum.LeadType lead_type = 6
Output only. Type of Local Services lead: phone, message, booking, etc.
enums.LocalServicesLeadStatusEnum.LeadStatus lead_status = 7
Output only. Current status of lead.
string creation_date_time = 8
Output only. The date time at which lead was created by Local Services Ads. The format is "YYYY-MM-DD HH:MM:SS" in the Google Ads account's timezone. Examples: "2018-03-05 09:15:00" or "2018-02-01 14:34:30"
string locale = 9
Output only. Language used by the Local Services provider linked to lead. See https://developers.google.com/google-ads/api/data/codes-formats#locales
optional note = 10
Output only. Note added by advertiser for the lead.
bool lead_charged = 11
Output only. True if the advertiser was charged for the lead.
optional credit_details = 12
Output only. Credit details of the lead.
bool lead_feedback_submitted = 13
Output only. True if the advertiser submitted feedback for the lead.
Data from Local Services Lead Conversation. Contains details of Lead Conversation which is generated when user calls, messages or books service from advertiser. These are appended to a Lead. More info: https://ads.google.com/local-services-ads
Used in:
string resource_name = 1
Output only. The resource name of the local services lead conversation data. Local Services Lead Conversation resource name have the form `customers/{customer_id}/localServicesLeadConversation/{local_services_lead_conversation_id}`
int64 id = 2
Output only. ID of this Lead Conversation.
enums.LocalServicesLeadConversationTypeEnum.ConversationType conversation_channel = 3
Output only. Type of GLS lead conversation, EMAIL, MESSAGE, PHONE_CALL, SMS, etc.
enums.LocalServicesParticipantTypeEnum.ParticipantType participant_type = 4
Output only. Type of participant in the lead conversation, ADVERTISER or CONSUMER.
string lead = 5
Output only. Resource name of Lead associated to the Lead Conversation.
string event_date_time = 6
Output only. The date time at which lead conversation was created by Local Services Ads. The format is "YYYY-MM-DD HH:MM:SS" in the Google Ads account's timezone. Examples: "2018-03-05 09:15:00" or "2018-02-01 14:34:30"
optional phone_call_details = 7
Output only. Details of phone call conversation in case of PHONE_CALL.
optional message_details = 8
Output only. Details of message conversation in case of EMAIL, MESSAGE or SMS.
message
customer.proto:261Settings for Local Services customer.
Used in:
repeated granular_license_statuses = 1
Output only. A read-only list of geo vertical level license statuses.
repeated granular_insurance_statuses = 2
Output only. A read-only list of geo vertical level insurance statuses.
A local services verification resource.
Used in:
string resource_name = 1
Immutable. The resource name of the Local Services Verification. Local Services Verification resource names have the form: `customers/{customer_id}/localServicesVerificationArtifacts/{verification_artifact_id}`
optional int64 id = 2
Output only. The ID of the verification artifact.
string creation_date_time = 3
Output only. The timestamp when this verification artifact was created. The format is "YYYY-MM-DD HH:MM:SS" in the Google Ads account's timezone. Examples: "2018-03-05 09:15:00" or "2018-02-01 14:34:30"
enums.LocalServicesVerificationArtifactStatusEnum.LocalServicesVerificationArtifactStatus status = 4
Output only. The status of the verification artifact.
enums.LocalServicesVerificationArtifactTypeEnum.LocalServicesVerificationArtifactType artifact_type = 5
Output only. The type of the verification artifact.
oneof artifact_data
The types of verification info.
background_check_verification_artifact = 6
Output only. A background check verification artifact.
insurance_verification_artifact = 7
Output only. An insurance verification artifact.
license_verification_artifact = 8
Output only. A license verification artifact.
business_registration_check_verification_artifact = 9
Output only. A business registration check verification artifact.
message
location_interest_view.proto:35A location interest view summarizes the performance of adgroup location interest criteria.
Used in:
string resource_name = 1
Output only. The resource name of the location interest view. Location interest view resource names have the form: `customers/{customer_id}/locationInterestViews/{campaign_id}~{ad_group_id}~{criterion_id}`
message
location_view.proto:37A location view summarizes the performance of campaigns by a Location criterion. If no Location criterion is set, no results are returned; instead, use geographic_view or user_location_view for visitor location data.
Used in:
string resource_name = 1
Output only. 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 in:
string resource_name = 1
Output only. 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:118Encapsulates an Audio.
Used in:
optional int64 ad_duration_millis = 2
Output only. The duration of the Audio in milliseconds.
message
media_file.proto:107Represents a ZIP archive media the content of which contains HTML5 assets.
Used in:
optional bytes data = 3
Immutable. Raw zipped data.
optional string url = 2
Output only. The url to access the uploaded zipped data. For example, https://tpc.googlesyndication.com/simgad/123 This field is read-only.
message
media_file.proto:36A media file.
Used in:
string resource_name = 1
Immutable. The resource name of the media file. Media file resource names have the form: `customers/{customer_id}/mediaFiles/{media_file_id}`
optional int64 id = 12
Output only. The ID of the media file.
enums.MediaTypeEnum.MediaType type = 5
Immutable. Type of the media file.
enums.MimeTypeEnum.MimeType mime_type = 6
Output only. The mime type of the media file.
optional string source_url = 13
Immutable. 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 string name = 14
Immutable. The name of the media file. The name can be used by clients to help identify previously uploaded media.
optional int64 file_size = 15
Output only. The size of the media file in bytes.
oneof mediatype
The specific type of the media file.
image = 3
Immutable. Encapsulates an Image.
media_bundle = 4
Immutable. A ZIP archive media the content of which contains HTML5 assets.
audio = 10
Output only. Encapsulates an Audio.
video = 11
Immutable. Encapsulates a Video.
message
media_file.proto:93Encapsulates an Image.
Used in:
optional bytes data = 4
Immutable. Raw image data.
optional string full_size_image_url = 2
Output only. The url to the full size version of the image.
optional string preview_size_image_url = 3
Output only. The url to the preview size version of the image.
message
media_file.proto:125Encapsulates a Video.
Used in:
optional int64 ad_duration_millis = 5
Output only. The duration of the Video in milliseconds.
optional string youtube_video_id = 6
Immutable. The YouTube video ID (as seen in YouTube URLs). Adding prefix "https://www.youtube.com/watch?v=" to this ID will get the YouTube streaming URL for this video.
optional string advertising_id_code = 7
Output only. The Advertising Digital Identification code for this video, as defined by the American Association of Advertising Agencies, used mainly for television commercials.
optional string isci_code = 8
Output only. The Industry Standard Commercial Identifier code for this video, used mainly for television commercials.
message
product_link.proto:104The identifier for Google Merchant Center account
Used in:
optional int64 merchant_center_id = 1
Immutable. The customer ID of the Google Merchant Center account. This field is required and should not be empty when creating a new Merchant Center link. It is unable to be modified after the creation of the link.
message
product_link_invitation.proto:93The identifier for Merchant Center Account.
Used in:
int64 merchant_center_id = 1
Output only. The Merchant Center id of the Merchant account. This field is read only
Represents details of text message in case of email, message or SMS.
Used in:
string text = 1
Output only. Textual content of the message.
repeated string attachment_urls = 2
Output only. URL to the SMS or email attachments. These URLs can be used to download the contents of the attachment by using the developer token.
A mobile application category constant.
Used in:
string resource_name = 1
Output only. The resource name of the mobile app category constant. Mobile app category constant resource names have the form: `mobileAppCategoryConstants/{mobile_app_category_id}`
optional int32 id = 4
Output only. The ID of the mobile app category constant.
optional string name = 5
Output only. Mobile app category name.
message
mobile_device_constant.proto:35A mobile device constant.
Used in:
string resource_name = 1
Output only. The resource name of the mobile device constant. Mobile device constant resource names have the form: `mobileDeviceConstants/{criterion_id}`
optional int64 id = 7
Output only. The ID of the mobile device constant.
optional string name = 8
Output only. The name of the mobile device.
optional string manufacturer_name = 9
Output only. The manufacturer of the mobile device.
optional string operating_system_name = 10
Output only. The operating system of the mobile device.
enums.MobileDeviceTypeEnum.MobileDeviceType type = 6
Output only. The type of mobile device.
message
local_services_lead.proto:122Represents a note added to a lead by the advertiser. Advertisers can edit notes, which will reset edit time and change description.
Used in:
string edit_date_time = 1
Output only. The date time when lead note was edited. The format is "YYYY-MM-DD HH:MM:SS" in the Google Ads account's timezone. Examples: "2018-03-05 09:15:00" or "2018-02-01 14:34:30"
string description = 2
Output only. Content of lead note.
Alert for offline conversion client summary.
Used in: ,
optional error = 1
Output only. Error for offline conversion client alert.
double error_percentage = 2
Output only. Percentage of the error, the range of this field should be [0, 1.0].
Possible errors for offline conversion client summary.
Used in:
oneof error_code
Error with description.
errors.CollectionSizeErrorEnum.CollectionSizeError collection_size_error = 1
Output only. Collection size error.
errors.ConversionAdjustmentUploadErrorEnum.ConversionAdjustmentUploadError conversion_adjustment_upload_error = 2
Output only. Conversion adjustment upload error.
errors.ConversionUploadErrorEnum.ConversionUploadError conversion_upload_error = 3
Output only. Conversion upload error.
errors.DateErrorEnum.DateError date_error = 4
Output only. Date error.
errors.DistinctErrorEnum.DistinctError distinct_error = 5
Output only. Distinct error.
errors.FieldErrorEnum.FieldError field_error = 6
Output only. Field error.
errors.MutateErrorEnum.MutateError mutate_error = 7
Output only. Mutate error.
errors.NotAllowlistedErrorEnum.NotAllowlistedError not_allowlisted_error = 8
Output only. Not allowlisted error.
errors.StringFormatErrorEnum.StringFormatError string_format_error = 9
Output only. String format error.
errors.StringLengthErrorEnum.StringLengthError string_length_error = 10
Output only. String length error.
Historical upload summary, grouped by upload date or job.
Used in: ,
int64 successful_count = 3
Output only. Total count of successful event.
int64 failed_count = 4
Output only. Total count of failed event.
int64 pending_count = 5
Output only. Total count of pending uploaded event.
oneof dimension_key
Dimension key for summary.
int64 job_id = 1
Output only. Dimension key for last N jobs.
string upload_date = 2
Output only. Dimension key for last N days.
Offline conversion upload summary at customer level.
Used in:
string resource_name = 1
Output only. The resource name of the offline conversion upload summary at customer level. Offline conversion upload client summary resource names have the form: `customers/{customer_id}/offlineConversionUploadClientSummaries/{client}`
enums.OfflineEventUploadClientEnum.OfflineEventUploadClient client = 2
Output only. Client type of the upload event.
enums.OfflineConversionDiagnosticStatusEnum.OfflineConversionDiagnosticStatus status = 3
Output only. Overall status for offline conversion client summary. Status is generated from most recent calendar day with upload stats.
int64 total_event_count = 4
Output only. Total count of uploaded events.
int64 successful_event_count = 5
Output only. Total count of successful uploaded events.
double success_rate = 6
Output only. Successful rate.
int64 pending_event_count = 11
Output only. Total count of pending uploaded events.
double pending_rate = 12
Output only. The ratio of total pending events to total events.
string last_upload_date_time = 7
Output only. Date for the latest upload batch. The format is "yyyy-mm-dd hh:mm:ss", and it's in the time zone of the Google Ads account.
repeated daily_summaries = 8
Output only. Summary of history stats by last N days.
repeated job_summaries = 9
Output only. Summary of history stats by last N jobs.
repeated alerts = 10
Output only. Details for each error code. Alerts are generated from most recent calendar day with upload stats.
Offline conversion upload summary at conversion action level.
Used in:
string resource_name = 1
Output only. The resource name of the offline conversion upload summary at conversion action level. Offline conversion upload conversion action summary resource names have the form: `customers/{customer_id}/offlineConversionUploadConversionActionSummaries/{conversion_action_id}~{client}`
enums.OfflineEventUploadClientEnum.OfflineEventUploadClient client = 2
Output only. Client type of the upload event.
int64 conversion_action_id = 3
Output only. Conversion action id.
string conversion_action_name = 4
Output only. The name of the conversion action.
enums.OfflineConversionDiagnosticStatusEnum.OfflineConversionDiagnosticStatus status = 5
Output only. Overall status for offline conversion upload conversion action summary. Status is generated from most recent calendar day with upload stats.
int64 total_event_count = 6
Output only. Total count of uploaded events.
int64 successful_event_count = 7
Output only. Total count of successful uploaded events.
int64 pending_event_count = 8
Output only. Total count of pending uploaded events.
string last_upload_date_time = 9
Output only. Date for the latest upload batch. The format is "yyyy-mm-dd hh:mm:ss", and it's in the time zone of the Google Ads account.
repeated daily_summaries = 10
Output only. Summary of history stats by last N days.
repeated job_summaries = 11
Output only. Summary of history stats by last N jobs.
repeated alerts = 12
Output only. Details for each error code. Alerts are generated from most recent calendar day with upload stats.
message
offline_user_data_job.proto:42A job containing offline user data of store visitors, or user list members that will be processed asynchronously. The uploaded data isn't readable and the processing results of the job can only be read using GoogleAdsService.Search/SearchStream.
Used in: ,
string resource_name = 1
Immutable. The resource name of the offline user data job. Offline user data job resource names have the form: `customers/{customer_id}/offlineUserDataJobs/{offline_user_data_job_id}`
optional int64 id = 9
Output only. ID of this offline user data job.
optional int64 external_id = 10
Immutable. User specified job ID.
enums.OfflineUserDataJobTypeEnum.OfflineUserDataJobType type = 4
Immutable. Type of the job.
enums.OfflineUserDataJobStatusEnum.OfflineUserDataJobStatus status = 5
Output only. Status of the job.
enums.OfflineUserDataJobFailureReasonEnum.OfflineUserDataJobFailureReason failure_reason = 6
Output only. Reason for the processing failure, if status is FAILED.
optional operation_metadata = 11
Output only. Metadata of offline user data job depicting match rate range.
oneof metadata
Metadata of the job.
customer_match_user_list_metadata = 7
Immutable. Metadata for data updates to a CRM-based user list.
store_sales_metadata = 8
Immutable. Metadata for store sales data update.
message
offline_user_data_job.proto:98Metadata of offline user data job.
Used in:
enums.OfflineUserDataJobMatchRateRangeEnum.OfflineUserDataJobMatchRateRange match_rate_range = 1
Output only. Match rate of the Customer Match user list upload. Describes the estimated match rate when the status of the job is "RUNNING" and final match rate when the final match rate is available after the status of the job is "SUCCESS/FAILED".
A mobile operating system version or a range of versions, depending on `operator_type`. List of available mobile platforms at https://developers.google.com/google-ads/api/reference/data/codes-formats#mobile-platforms
Used in:
string resource_name = 1
Output only. The resource name of the operating system version constant. Operating system version constant resource names have the form: `operatingSystemVersionConstants/{criterion_id}`
optional int64 id = 7
Output only. The ID of the operating system version.
optional string name = 8
Output only. Name of the operating system.
optional int32 os_major_version = 9
Output only. The OS Major Version number.
optional int32 os_minor_version = 10
Output only. The OS Minor Version number.
enums.OperatingSystemVersionOperatorTypeEnum.OperatingSystemVersionOperatorType operator_type = 6
Output only. 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 in:
string resource_name = 1
Output only. 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 string search_term = 3
Output only. The search term.
message
parental_status_view.proto:34A parental status view.
Used in:
string resource_name = 1
Output only. 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:34A payments account, which can be used to set up billing for an Ads customer.
Used in:
string resource_name = 1
Output only. The resource name of the payments account. PaymentsAccount resource names have the form: `customers/{customer_id}/paymentsAccounts/{payments_account_id}`
optional string payments_account_id = 8
Output only. A 16 digit ID used to identify a payments account.
optional string name = 9
Output only. The name of the payments account.
optional string currency_code = 10
Output only. The currency code of the payments account. A subset of the currency codes derived from the ISO 4217 standard is supported.
optional string payments_profile_id = 11
Output only. A 12 digit ID used to identify the payments profile associated with the payments account.
optional string secondary_payments_profile_id = 12
Output only. A secondary payments profile ID present in uncommon situations, for example, when a sequential liability agreement has been arranged.
optional string paying_manager_customer = 13
Output only. Paying manager of this payment account.
message
per_store_view.proto:36A per store view. This view provides per store impression reach and local action conversion stats for advertisers.
Used in:
string resource_name = 1
Output only. The resource name of the per store view. Per Store view resource names have the form: `customers/{customer_id}/perStoreViews/{place_id}`
string place_id = 2
Output only. The place ID of the per store view.
A view with impression metrics for Performance Max campaign placements.
Used in:
string resource_name = 1
Output only. The resource name of the Performance Max placement view. Performance Max placement view resource names have the form: `customers/{customer_id}/performanceMaxPlacementViews/{base_64_placement}`
optional string placement = 2
Output only. The default placement string, such as the website URL, mobile application ID, or a YouTube video ID.
optional string display_name = 3
Output only. The name displayed to represent the placement, such as the URL name for websites, YouTube video name for YouTube videos, and translated mobile app name for mobile apps.
optional string target_url = 4
Output only. URL of the placement, for example, website, link to the mobile application in app store, or a YouTube video URL.
enums.PlacementTypeEnum.PlacementType placement_type = 5
Output only. Type of the placement. Possible values for Performance Max placements are WEBSITE, MOBILE_APPLICATION, or YOUTUBE_VIDEO.
Represents details of a phone call conversation.
Used in:
int64 call_duration_millis = 1
Output only. The duration (in milliseconds) of the phone call (end to end).
string call_recording_url = 2
Output only. URL to the call recording audio file.
A Product Category.
Used in:
string resource_name = 1
Output only. The resource name of the product category. Product category resource names have the form: `productCategoryConstants/{level}~{category_id}`
int64 category_id = 2
Output only. The ID of the product category. This ID is equivalent to the google_product_category ID as described in this article: https://support.google.com/merchants/answer/6324436.
optional string product_category_constant_parent = 3
Output only. Resource name of the parent product category.
enums.ProductCategoryLevelEnum.ProductCategoryLevel level = 4
Output only. Level of the product category.
enums.ProductCategoryStateEnum.ProductCategoryState state = 5
Output only. State of the product category.
repeated localizations = 6
Output only. List of all available localizations of the product category.
Localization for the product category.
Used in:
string region_code = 1
Output only. Upper-case two-letter ISO 3166-1 country code of the localized category.
string language_code = 2
Output only. Two-letter ISO 639-1 language code of the localized category.
string value = 3
Output only. The name of the category in the specified locale.
message
product_group_view.proto:34A product group view.
Used in:
string resource_name = 1
Output only. 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
product_link.proto:34Represents the data sharing connection between a Google Ads customer and another product.
Used in: ,
string resource_name = 1
Immutable. Resource name of the product link. ProductLink resource names have the form: `customers/{customer_id}/productLinks/{product_link_id} `
optional int64 product_link_id = 2
Output only. The ID of the link. This field is read only.
enums.LinkedProductTypeEnum.LinkedProductType type = 3
Output only. The type of the linked product.
oneof linked_product
A product linked to this account.
data_partner = 4
Immutable. Data partner link.
google_ads = 5
Immutable. Google Ads link.
merchant_center = 12
Immutable. Google Merchant Center link.
advertising_partner = 13
Output only. Advertising Partner link.
message
product_link_invitation.proto:35Represents an invitation for data sharing connection between a Google Ads account and another account.
Used in: ,
string resource_name = 1
Immutable. The resource name of a product link invitation. Product link invitation resource names have the form: `customers/{customer_id}/productLinkInvitations/{product_link_invitation_id}`
int64 product_link_invitation_id = 2
Output only. The ID of the product link invitation. This field is read only.
enums.ProductLinkInvitationStatusEnum.ProductLinkInvitationStatus status = 3
Output only. The status of the product link invitation. This field is read only.
enums.LinkedProductTypeEnum.LinkedProductType type = 6
Output only. The type of the invited account. This field is read only and can be used for filtering invitations with {@code GoogleAdsService.SearchGoogleAdsRequest}.
oneof invited_account
An account invited to link to this Google Ads account.
hotel_center = 4
Output only. Hotel link invitation.
merchant_center = 5
Output only. Merchant Center link invitation.
advertising_partner = 7
Output only. Advertising Partner link invitation.
message
qualifying_question.proto:34Qualifying Questions for Lead Form.
Used in:
string resource_name = 1
Output only. The resource name of the qualifying question. 'qualifyingQuestions/{qualifyingQuestionId}'
int64 qualifying_question_id = 2
Output only. The id of the qualifying question.
string locale = 3
Output only. The locale of the qualifying question.
string text = 4
Output only. The qualifying question.
message
recommendation.proto:43A recommendation.
Used in: ,
string resource_name = 1
Immutable. The resource name of the recommendation. `customers/{customer_id}/recommendations/{recommendation_id}`
enums.RecommendationTypeEnum.RecommendationType type = 2
Output only. The type of recommendation.
optional impact = 3
Output only. The impact on account performance as a result of applying the recommendation.
optional string campaign_budget = 24
Output only. 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, FORECASTING_CAMPAIGN_BUDGET, MARGINAL_ROI_CAMPAIGN_BUDGET, MOVE_UNUSED_BUDGET
optional string campaign = 25
Output only. The campaign targeted by this recommendation. This field will be set for the following recommendation types: CALL_EXTENSION, CALLOUT_EXTENSION, ENHANCED_CPC_OPT_IN, USE_BROAD_MATCH_KEYWORD, KEYWORD, KEYWORD_MATCH_TYPE, UPGRADE_LOCAL_CAMPAIGN_TO_PERFORMANCE_MAX, MAXIMIZE_CLICKS_OPT_IN, MAXIMIZE_CONVERSIONS_OPT_IN, OPTIMIZE_AD_ROTATION, RESPONSIVE_SEARCH_AD, RESPONSIVE_SEARCH_AD_ASSET, SEARCH_PARTNERS_OPT_IN, DISPLAY_EXPANSION_OPT_IN, SITELINK_EXTENSION, TARGET_CPA_OPT_IN, TARGET_ROAS_OPT_IN, TEXT_AD, UPGRADE_SMART_SHOPPING_CAMPAIGN_TO_PERFORMANCE_MAX, RAISE_TARGET_CPA_BID_TOO_LOW, FORECASTING_SET_TARGET_ROAS, SHOPPING_ADD_AGE_GROUP, SHOPPING_ADD_COLOR, SHOPPING_ADD_GENDER, SHOPPING_ADD_SIZE, SHOPPING_ADD_GTIN, SHOPPING_ADD_MORE_IDENTIFIERS, SHOPPING_ADD_PRODUCTS_TO_CAMPAIGN, SHOPPING_FIX_DISAPPROVED_PRODUCTS, SHOPPING_MIGRATE_REGULAR_SHOPPING_CAMPAIGN_OFFERS_TO_PERFORMANCE_MAX, DYNAMIC_IMAGE_EXTENSION_OPT_IN, RAISE_TARGET_CPA, LOWER_TARGET_ROAS, FORECASTING_SET_TARGET_CPA, SET_TARGET_CPA, SET_TARGET_ROAS, MAXIMIZE_CONVERSION_VALUE_OPT_IN, IMPROVE_GOOGLE_TAG_COVERAGE, PERFORMANCE_MAX_FINAL_URL_OPT_IN
optional string ad_group = 26
Output only. 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, RESPONSIVE_SEARCH_AD, RESPONSIVE_SEARCH_AD_ASSET, TEXT_AD
optional bool dismissed = 27
Output only. Whether the recommendation is dismissed or not.
repeated string campaigns = 38
Output only. The campaigns targeted by this recommendation. This field will be set for the following recommendation types: CAMPAIGN_BUDGET, FORECASTING_CAMPAIGN_BUDGET, MARGINAL_ROI_CAMPAIGN_BUDGET and MOVE_UNUSED_BUDGET
oneof recommendation
The details of recommendation.
campaign_budget_recommendation = 4
Output only. The campaign budget recommendation.
forecasting_campaign_budget_recommendation = 22
Output only. The forecasting campaign budget recommendation.
keyword_recommendation = 8
Output only. The keyword recommendation.
text_ad_recommendation = 9
Output only. Add expanded text ad recommendation.
target_cpa_opt_in_recommendation = 10
Output only. The TargetCPA opt-in recommendation.
maximize_conversions_opt_in_recommendation = 11
Output only. The MaximizeConversions Opt-In recommendation.
enhanced_cpc_opt_in_recommendation = 12
Output only. The Enhanced Cost-Per-Click Opt-In recommendation.
search_partners_opt_in_recommendation = 14
Output only. The Search Partners Opt-In recommendation.
maximize_clicks_opt_in_recommendation = 15
Output only. The MaximizeClicks Opt-In recommendation.
optimize_ad_rotation_recommendation = 16
Output only. The Optimize Ad Rotation recommendation.
keyword_match_type_recommendation = 20
Output only. The keyword match type recommendation.
move_unused_budget_recommendation = 21
Output only. The move unused budget recommendation.
target_roas_opt_in_recommendation = 23
Output only. The Target ROAS opt-in recommendation.
responsive_search_ad_recommendation = 28
Output only. The add responsive search ad recommendation.
marginal_roi_campaign_budget_recommendation = 29
Output only. The marginal ROI campaign budget recommendation.
use_broad_match_keyword_recommendation = 30
Output only. The use broad match keyword recommendation.
responsive_search_ad_asset_recommendation = 31
Output only. The responsive search ad asset recommendation.
upgrade_smart_shopping_campaign_to_performance_max_recommendation = 32
Output only. The upgrade a Smart Shopping campaign to a Performance Max campaign recommendation.
responsive_search_ad_improve_ad_strength_recommendation = 33
Output only. The responsive search ad improve ad strength recommendation.
display_expansion_opt_in_recommendation = 34
Output only. The Display Expansion opt-in recommendation.
upgrade_local_campaign_to_performance_max_recommendation = 35
Output only. The upgrade a Local campaign to a Performance Max campaign recommendation.
raise_target_cpa_bid_too_low_recommendation = 36
Output only. The raise target CPA bid too low recommendation.
forecasting_set_target_roas_recommendation = 37
Output only. The forecasting set target ROAS recommendation.
callout_asset_recommendation = 39
Output only. The callout asset recommendation.
sitelink_asset_recommendation = 40
Output only. The sitelink asset recommendation.
call_asset_recommendation = 41
Output only. The call asset recommendation.
shopping_add_age_group_recommendation = 42
Output only. The shopping add age group recommendation.
shopping_add_color_recommendation = 43
Output only. The shopping add color recommendation.
shopping_add_gender_recommendation = 44
Output only. The shopping add gender recommendation.
shopping_add_gtin_recommendation = 45
Output only. The shopping add GTIN recommendation.
shopping_add_more_identifiers_recommendation = 46
Output only. The shopping add more identifiers recommendation.
shopping_add_size_recommendation = 47
Output only. The shopping add size recommendation.
shopping_add_products_to_campaign_recommendation = 48
Output only. The shopping add products to campaign recommendation.
shopping_fix_disapproved_products_recommendation = 49
Output only. The shopping fix disapproved products recommendation.
shopping_target_all_offers_recommendation = 50
Output only. The shopping target all offers recommendation.
shopping_fix_suspended_merchant_center_account_recommendation = 51
Output only. The shopping fix suspended Merchant Center account recommendation.
shopping_fix_merchant_center_account_suspension_warning_recommendation = 52
Output only. The shopping fix Merchant Center account suspension warning recommendation.
shopping_migrate_regular_shopping_campaign_offers_to_performance_max_recommendation = 53
Output only. The shopping migrate Regular Shopping Campaign offers to Performance Max recommendation.
dynamic_image_extension_opt_in_recommendation = 54
Output only. Recommendation to enable dynamic image extensions on the account, allowing Google to find the best images from ad landing pages and complement text ads.
raise_target_cpa_recommendation = 55
Output only. Recommendation to raise Target CPA.
lower_target_roas_recommendation = 56
Output only. Recommendation to lower Target ROAS.
performance_max_opt_in_recommendation = 57
Output only. The Performance Max Opt In recommendation.
improve_performance_max_ad_strength_recommendation = 58
Output only. The improve Performance Max ad strength recommendation.
migrate_dynamic_search_ads_campaign_to_performance_max_recommendation = 59
Output only. The Dynamic Search Ads to Performance Max migration recommendation.
forecasting_set_target_cpa_recommendation = 60
Output only. The forecasting set target CPA recommendation.
set_target_cpa_recommendation = 61
Output only. The set target CPA recommendation.
set_target_roas_recommendation = 62
Output only. The set target ROAS recommendation.
maximize_conversion_value_opt_in_recommendation = 63
Output only. The Maximize Conversion Value opt-in recommendation.
improve_google_tag_coverage_recommendation = 64
Output only. Recommendation to deploy Google Tag on more pages.
performance_max_final_url_opt_in_recommendation = 65
Output only. Recommendation to turn on Final URL expansion for your Performance Max campaigns.
refresh_customer_match_list_recommendation = 66
Output only. The refresh customer list recommendation.
custom_audience_opt_in_recommendation = 67
Output only. The custom audience opt in recommendation.
lead_form_asset_recommendation = 68
Output only. The lead form asset recommendation.
improve_demand_gen_ad_strength_recommendation = 69
Output only. The improve Demand Gen ad strength recommendation.
message
recommendation.proto:605Wrapper for information about a Google Ads account.
Used in:
int64 customer_id = 1
Output only. The customer ID of the account.
string descriptive_name = 2
Output only. The descriptive name of the account.
message
recommendation.proto:254The call asset recommendation.
Used in:
(message has no fields)
message
recommendation.proto:230The callout asset recommendation.
Used in:
repeated recommended_campaign_callout_assets = 1
Output only. New callout extension assets recommended at the campaign level.
repeated recommended_customer_callout_assets = 2
Output only. New callout extension assets recommended at the customer level.
message
recommendation.proto:517A campaign budget shared amongst various budget recommendation types.
Used in: ,
int64 current_amount_micros = 1
Output only. Current budget amount.
int64 recommended_new_amount_micros = 2
Output only. Recommended budget amount.
string new_start_date = 3
Output only. The date when the new budget would start being used. This field will be set for the following recommendation types: FORECASTING_SET_TARGET_ROAS , FORECASTING_SET_TARGET_CPA YYYY-MM-DD format, for example, 2018-04-17.
message
recommendation.proto:100The budget recommendation for budget constrained campaigns.
Used in: ,
optional int64 current_budget_amount_micros = 7
Output only. The current budget amount in micros.
optional int64 recommended_budget_amount_micros = 8
Output only. The recommended budget amount in micros.
repeated budget_options = 3
Output only. The budget amounts and associated impact estimates for some values of possible budget amounts.
message
recommendation.proto:102The impact estimates for a given budget amount.
Used in:
optional int64 budget_amount_micros = 3
Output only. The budget amount for this option.
optional impact = 2
Output only. The impact estimate if budget is changed to amount specified in this option.
message
recommendation.proto:614The Custom Audience Opt In recommendation.
Used in:
repeated keywords = 1
Output only. The list of keywords to use for custom audience creation.
message
recommendation.proto:368The Display Expansion opt-in recommendation.
Used in:
(message has no fields)
message
recommendation.proto:514Recommendation to enable dynamic image extensions on the account, allowing Google to find the best images from ad landing pages and complement text ads.
Used in:
(message has no fields)
message
recommendation.proto:213The Enhanced Cost-Per-Click Opt-In recommendation.
Used in:
(message has no fields)
message
recommendation.proto:554The set target CPA recommendations.
Used in:
int64 recommended_target_cpa_micros = 1
Output only. The recommended target CPA.
optional campaign_budget = 2
Output only. The campaign budget.
message
recommendation.proto:374The forecasting set target ROAS recommendation.
Used in:
double recommended_target_roas = 1
Output only. The recommended target ROAS (revenue per unit of spend). The value is between 0.01 and 1000.0, inclusive.
optional campaign_budget = 2
Output only. The campaign budget.
message
recommendation.proto:624The improve Demand Gen ad strength recommendation.
Used in:
string ad = 1
Output only. The resource name of the ad that can be improved.
enums.AdStrengthEnum.AdStrength ad_strength = 2
Output only. The current ad strength.
repeated string demand_gen_asset_action_items = 3
Output only. A list of recommendations to improve the ad strength.
message
recommendation.proto:568Recommendation to deploy Google Tag on more pages.
Used in:
(message has no fields)
message
recommendation.proto:537Recommendation to improve the asset group strength of a Performance Max campaign to an "Excellent" rating.
Used in:
string asset_group = 1
Output only. The asset group resource name.
enums.AdStrengthEnum.AdStrength ad_strength = 2
Output only. The current ad strength score of the asset group.
message
recommendation.proto:257The keyword match type recommendation.
Used in:
optional keyword = 1
Output only. The existing keyword where the match type should be more broad.
enums.KeywordMatchTypeEnum.KeywordMatchType recommended_match_type = 2
Output only. The recommended new match type.
message
recommendation.proto:128The keyword recommendation.
Used in:
optional keyword = 1
Output only. The recommended keyword.
repeated search_terms = 4
Output only. A list of search terms this keyword matches. The same search term may be repeated for multiple keywords.
optional int64 recommended_cpc_bid_micros = 3
Output only. The recommended CPC (cost-per-click) bid.
message
recommendation.proto:130Information about a search term as related to a keyword recommendation.
Used in:
string text = 1
Output only. The text of the search term.
int64 estimated_weekly_search_count = 2
Output only. Estimated number of historical weekly searches for this search term.
message
recommendation.proto:621The lead form asset recommendation.
Used in:
(message has no fields)
message
recommendation.proto:504Recommendation to lower Target ROAS.
Used in:
optional target_adjustment = 1
Output only. The relevant information describing the recommended target adjustment.
message
recommendation.proto:219The Maximize Clicks opt-in recommendation.
Used in:
optional int64 recommended_budget_amount_micros = 2
Output only. The recommended new budget amount. Only set if the current budget is too high.
message
recommendation.proto:565Recommendation to opt into Maximize Conversion Value bidding strategy.
Used in:
(message has no fields)
message
recommendation.proto:206The Maximize Conversions Opt-In recommendation.
Used in:
optional int64 recommended_budget_amount_micros = 2
Output only. The recommended new budget amount.
message
recommendation.proto:50The Merchant Center account details.
Used in: , , , , ,
int64 id = 1
Output only. The Merchant Center account ID.
string name = 2
Output only. The name of the Merchant Center account.
bool multi_client = 3
Output only. Whether the Merchant Center account is a Multi-Client account (MCA).
message
recommendation.proto:547The Dynamic Search Ads to Performance Max migration recommendation.
Used in:
string apply_link = 1
Output only. A link to the Google Ads UI where the customer can manually apply the recommendation.
message
recommendation.proto:269The move unused budget recommendation.
Used in:
optional string excess_campaign_budget = 3
Output only. The excess budget's resource_name.
optional budget_recommendation = 2
Output only. The recommendation for the constrained budget to increase.
message
recommendation.proto:227The Optimize Ad Rotation recommendation.
Used in:
(message has no fields)
message
recommendation.proto:572Recommendation to turn on Final URL expansion for your Performance Max campaigns.
Used in:
(message has no fields)
message
recommendation.proto:533The Performance Max Opt In recommendation.
Used in:
(message has no fields)
message
recommendation.proto:355The raise target CPA bid too low recommendation.
Used in:
optional double recommended_target_multiplier = 1
Output only. A number greater than 1.0 indicating the factor by which we recommend the target CPA should be increased.
optional int64 average_target_cpa_micros = 2
Output only. The current average target CPA of the campaign, in micros of customer local currency.
message
recommendation.proto:491Recommendation to raise Target CPA.
Used in:
optional target_adjustment = 1
Output only. The relevant information describing the recommended target adjustment.
optional enums.AppBiddingGoalEnum.AppBiddingGoal app_bidding_goal = 2
Output only. Represents the goal towards which the bidding strategy should optimize. Only populated for App Campaigns.
message
recommendation.proto:64The 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
Output only. Base metrics at the time the recommendation was generated.
optional potential_metrics = 2
Output only. Estimated metrics if the recommendation is applied.
message
recommendation.proto:76Weekly account performance metrics. For some recommendation types, these are averaged over the past 90-day period and hence can be fractional.
Used in:
optional double impressions = 6
Output only. Number of ad impressions.
optional double clicks = 7
Output only. Number of ad clicks.
optional int64 cost_micros = 8
Output only. Cost (in micros) for advertising, in the local currency for the account.
optional double conversions = 9
Output only. Number of conversions.
optional double conversions_value = 11
Output only. Sum of the conversion value of the conversions.
optional double video_views = 10
Output only. Number of video views for a video ad campaign.
message
recommendation.proto:578The recommendation to update a customer list that hasn't been updated in the last 90 days. The customer receiving the recommendation is not necessarily the owner account. The owner account should update the customer list.
Used in:
int64 user_list_id = 1
Output only. The user list ID.
string user_list_name = 2
Output only. The name of the list.
int64 days_since_last_refresh = 3
Output only. Days since last refresh.
repeated top_spending_account = 4
Output only. The top spending account.
int64 targeting_accounts_count = 5
Output only. User lists can be shared with other accounts by the owner. targeting_accounts_count is the number of those accounts that can use it for targeting.
optional owner_account = 6
Output only. The owner account. This is the account that should update the customer list.
message
recommendation.proto:294The add responsive search ad asset recommendation.
Used in:
optional current_ad = 3
Output only. The current ad to be updated.
optional recommended_assets = 2
Output only. The recommended assets. This is populated only with the new headlines and/or descriptions, and is otherwise empty.
message
recommendation.proto:304The responsive search ad improve ad strength recommendation.
Used in:
optional current_ad = 1
Output only. The current ad to be updated.
optional recommended_ad = 2
Output only. The updated ad.
message
recommendation.proto:313The add responsive search ad recommendation.
Used in:
optional ad = 1
Output only. Recommended ad.
message
recommendation.proto:216The Search Partners Opt-In recommendation.
Used in:
(message has no fields)
message
recommendation.proto:436The shopping recommendation to add products to a Shopping Campaign Inventory.
Used in:
optional merchant = 1
Output only. The details of the Merchant Center account.
string feed_label = 2
Output only. The feed label for the campaign.
enums.ShoppingAddProductsToCampaignRecommendationEnum.Reason reason = 3
Output only. The reason why no products are attached to the campaign.
message
recommendation.proto:404The shopping recommendation to fix disapproved products in a Shopping Campaign Inventory.
Used in:
optional merchant = 1
Output only. The details of the Merchant Center account.
string feed_label = 2
Output only. The feed label for the campaign.
int64 products_count = 3
Output only. The number of products of the campaign.
int64 disapproved_products_count = 4
Output only. The numbers of products of the campaign that are disapproved.
message
recommendation.proto:451The shopping recommendation to fix Merchant Center account suspension issues.
Used in:
optional merchant = 1
Output only. The details of the Merchant Center account.
string feed_label = 2
Output only. The feed label of the campaign for which the suspension happened.
message
recommendation.proto:462The shopping recommendation to migrate Regular Shopping Campaign targeted offers to Performance Max campaigns.
Used in:
optional merchant = 1
Output only. The details of the Merchant Center account.
string feed_label = 2
Output only. The feed label of the offers targeted by the campaigns sharing this suggestion.
message
recommendation.proto:387The shopping recommendation to add an attribute to offers that are demoted because it is missing.
Used in:
optional merchant = 1
Output only. The details of the Merchant Center account.
string feed_label = 2
Output only. The campaign feed label.
int64 offers_count = 3
Output only. The number of online, servable offers.
int64 demoted_offers_count = 4
Output only. The number of online, servable offers that are demoted for missing attributes. Visit the Merchant Center for more details.
message
recommendation.proto:422The shopping recommendation to create a catch-all campaign that targets all offers.
Used in:
optional merchant = 1
Output only. The details of the Merchant Center account.
int64 untargeted_offers_count = 2
Output only. The number of untargeted offers.
string feed_label = 3
Output only. The offer feed label.
message
recommendation.proto:243The sitelink asset recommendation.
Used in:
repeated recommended_campaign_sitelink_assets = 1
Output only. New sitelink assets recommended at the campaign level.
repeated recommended_customer_sitelink_assets = 2
Output only. New sitelink assets recommended at the customer level.
message
recommendation.proto:473Information of a target adjustment recommendation.
Used in: ,
optional string shared_set = 1
Output only. The shared set resource name of the portfolio bidding strategy where the target is defined. Only populated if the recommendation is portfolio level.
double recommended_target_multiplier = 2
Output only. The factor by which we recommend the target to be adjusted by.
int64 current_average_target_micros = 3
Output only. The current average target of the campaign or portfolio targeted by this recommendation.
message
recommendation.proto:171The Target CPA opt-in recommendation.
Used in:
repeated options = 1
Output only. The available goals and corresponding options for Target CPA strategy.
optional int64 recommended_target_cpa_micros = 3
Output only. The recommended average CPA target. See required budget amount and impact of using this recommendation in options list.
message
recommendation.proto:173The Target CPA opt-in option with impact estimate.
Used in:
enums.TargetCpaOptInRecommendationGoalEnum.TargetCpaOptInRecommendationGoal goal = 1
Output only. The goal achieved by this option.
optional int64 target_cpa_micros = 5
Output only. Average CPA target.
optional int64 required_campaign_budget_amount_micros = 6
Output only. 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
Output only. The impact estimate if this option is selected.
message
recommendation.proto:280The Target ROAS opt-in recommendation.
Used in:
optional double recommended_target_roas = 1
Output only. The recommended target ROAS (revenue per unit of spend). The value is between 0.01 and 1000.0, inclusive.
optional int64 required_campaign_budget_amount_micros = 2
Output only. The minimum campaign budget, in local currency for the account, required to achieve the target ROAS. Amount is specified in micros, where one million is equivalent to one currency unit.
message
recommendation.proto:155The text ad recommendation.
Used in:
optional ad = 1
Output only. Recommended ad.
optional string creation_date = 4
Output only. Creation date of the recommended ad. YYYY-MM-DD format, for example, 2018-04-17.
optional string auto_apply_date = 5
Output only. Date, if present, is the earliest when the recommendation will be auto applied. YYYY-MM-DD format, for example, 2018-04-17.
message
recommendation.proto:371The Upgrade Local campaign to Performance Max campaign recommendation.
Used in:
(message has no fields)
message
recommendation.proto:345The upgrade a Smart Shopping campaign to a Performance Max campaign recommendation.
Used in:
int64 merchant_id = 1
Output only. ID of Merchant Center account.
string sales_country_code = 2
Output only. Country whose products from merchant's inventory should be included.
message
recommendation.proto:319The use broad match keyword recommendation.
Used in:
repeated keyword = 1
Output only. Sample of keywords to be expanded to Broad Match.
int64 suggested_keywords_count = 2
Output only. Total number of keywords to be expanded to Broad Match in the campaign.
int64 campaign_keywords_count = 3
Output only. Total number of keywords in the campaign.
bool campaign_uses_shared_budget = 4
Output only. Whether the associated campaign uses a shared budget.
int64 required_campaign_budget_amount_micros = 5
Output only. The budget recommended to avoid becoming budget constrained after applying the recommendation.
Recommendation Subscription resource
Used in: , ,
string resource_name = 1
Immutable. The resource name of the recommendation subscription. `customers/{customer_id}/recommendationSubscriptions/{recommendation_type}`
enums.RecommendationTypeEnum.RecommendationType type = 2
Required. Immutable. The type of recommendation subscribed to.
optional string create_date_time = 3
Output only. Time in seconds when the subscription was first created. The datetime is in the customer's time zone and in "yyyy-MM-dd HH:mm:ss" format.
optional string modify_date_time = 4
Output only. Contains the time in microseconds, when the Recommendation Subscription was last updated. The datetime is in the customer's time zone and in "yyyy-MM-dd HH:mm:ss.ssssss" format.
optional enums.RecommendationSubscriptionStatusEnum.RecommendationSubscriptionStatus status = 5
Required. Status of the subscription, either enabled or paused.
message
remarketing_action.proto:37A 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 in: ,
string resource_name = 1
Immutable. The resource name of the remarketing action. Remarketing action resource names have the form: `customers/{customer_id}/remarketingActions/{remarketing_action_id}`
optional int64 id = 5
Output only. Id of the remarketing action.
optional string name = 6
The name of the remarketing action. This field is required and should not be empty when creating new remarketing actions.
repeated tag_snippets = 4
Output only. The snippets used for tracking remarketing actions.
message
customer.proto:248Remarketing setting for a customer.
Used in:
optional string google_global_site_tag = 2
Output only. The Google tag.
Details about the employee's medical residency. Residency is a stage of graduate medical education in which a qualified medical professional practices under the supervision of a senior clinician.
Used in:
optional string institution_name = 1
Output only. Name of the institution at which the residency was completed.
optional int32 completion_year = 2
Output only. Year of completion.
message
search_term_view.proto:37A search term view with metrics aggregated by search term at the ad group level. This view does not include Performance Max data. If you are looking for Performance Max search term data, use the CampaignSearchTermView instead.
Used in:
string resource_name = 1
Output only. 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 string search_term = 5
Output only. The search term.
optional string ad_group = 6
Output only. The ad group the search term served in.
enums.SearchTermTargetingStatusEnum.SearchTermTargetingStatus status = 4
Output only. Indicates whether the search term is currently one of your targeted or excluded keywords.
A criterion belonging to a shared set.
Used in: , ,
string resource_name = 1
Immutable. The resource name of the shared criterion. Shared set resource names have the form: `customers/{customer_id}/sharedCriteria/{shared_set_id}~{criterion_id}`
optional string shared_set = 10
Immutable. The shared set to which the shared criterion belongs.
optional int64 criterion_id = 11
Output only. The ID of the criterion. This field is ignored for mutates.
enums.CriterionTypeEnum.CriterionType type = 4
Output only. The type of the criterion.
oneof criterion
The criterion. Exactly one must be set.
keyword = 3
Immutable. Keyword.
youtube_video = 5
Immutable. YouTube Video.
youtube_channel = 6
Immutable. YouTube Channel.
placement = 7
Immutable. Placement.
mobile_app_category = 8
Immutable. Mobile App Category.
mobile_application = 9
Immutable. Mobile application.
brand = 12
Immutable. Brand.
webpage = 13
Immutable. Webpage.
SharedSets are used for sharing criterion exclusions across multiple campaigns.
Used in: , ,
string resource_name = 1
Immutable. The resource name of the shared set. Shared set resource names have the form: `customers/{customer_id}/sharedSets/{shared_set_id}`
optional int64 id = 8
Output only. The ID of this shared set. Read only.
enums.SharedSetTypeEnum.SharedSetType type = 3
Immutable. The type of this shared set: each shared set holds only a single kind of resource. Required. Immutable.
optional string name = 9
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
Output only. The status of this shared set. Read only.
optional int64 member_count = 10
Output only. The number of shared criteria within this shared set. Read only.
optional int64 reference_count = 11
Output only. 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 in:
string resource_name = 1
Output only. The resource name of the Shopping performance view. Shopping performance view resource names have the form: `customers/{customer_id}/shoppingPerformanceView`
message
shopping_product.proto:75A shopping product from Google Merchant Center that can be advertised by campaigns. The resource returns currently existing products from Google Merchant Center accounts linked with the customer. A campaign includes a product by specifying its merchant id (or, if available, the Multi Client Account id of the merchant) in the `ShoppingSetting`, and can limit the inclusion to products having a specified feed label. Standard Shopping campaigns can also limit the inclusion through a `campaign_criterion.listing_scope`. Queries to this resource specify a scope: Account: - Filters on campaigns or ad groups are not specified. - All products from the linked Google Merchant Center accounts are returned. - Metrics and some fields (see the per-field documentation) are aggregated across all Shopping and Performance Max campaigns that include a product. Campaign: - An equality filter on `campaign` is specified. Supported campaign types are Shopping, Performance Max, Demand Gen, Video. - Only products that are included by the specified campaign are returned. - Metrics and some fields (see the per-field documentation) are restricted to the specified campaign. - Only the following metrics are supported for Demand Gen and Video campaigns: impressions, clicks, ctr. Ad group: - An equality filter on `ad group` and `campaign` is specified. Supported campaign types are Shopping, Demand Gen, Video. - Only products that are included by the specified campaign are returned. - Metrics and some fields (see the per-field documentation) are restricted to the specified ad group. - Only the following metrics are supported for Demand Gen and Video campaigns: impressions, clicks, ctr. Note that segmentation by date segments is not permitted and will return UNSUPPORTED_DATE_SEGMENTATION error. On the other hand, filtering on date segments is allowed.
Used in:
string resource_name = 1
Output only. The resource name of the shopping product. Shopping product resource names have the form: `customers/{customer_id}/shoppingProducts/{merchant_center_id}~{channel}~{language_code}~{feed_label}~{item_id}`
int64 merchant_center_id = 2
Output only. The id of the merchant that owns the product.
enums.ProductChannelEnum.ProductChannel channel = 3
Output only. The product channel describing the locality of the product.
string language_code = 4
Output only. The language code as provided by the merchant, in BCP 47 format.
string feed_label = 5
Output only. The product feed label as provided by the merchant.
string item_id = 6
Output only. The item id of the product as provided by the merchant.
optional int64 multi_client_account_id = 7
Output only. The id of the Multi Client Account of the merchant, if present.
optional string title = 8
Output only. The title of the product as provided by the merchant.
optional string brand = 9
Output only. The brand of the product as provided by the merchant.
optional int64 price_micros = 10
Output only. The price of the product in micros as provided by the merchant, in the currency specified in `currency_code` (e.g. $2.97 is reported as 2970000).
optional string currency_code = 11
Output only. The currency code as provided by the merchant, in ISO 4217 format.
optional enums.ProductChannelExclusivityEnum.ProductChannelExclusivity channel_exclusivity = 12
Output only. The channel exclusivity of the product as provided by the merchant.
optional enums.ProductConditionEnum.ProductCondition condition = 13
Output only. The condition of the product as provided by the merchant.
optional enums.ProductAvailabilityEnum.ProductAvailability availability = 14
Output only. The availability of the product as provided by the merchant.
repeated string target_countries = 15
Output only. Upper-case two-letter ISO 3166-1 code of the regions where the product is intended to be shown in ads.
optional string custom_attribute0 = 16
Output only. The custom attribute 0 of the product as provided by the merchant.
optional string custom_attribute1 = 17
Output only. The custom attribute 1 of the product as provided by the merchant.
optional string custom_attribute2 = 18
Output only. The custom attribute 2 of the product as provided by the merchant.
optional string custom_attribute3 = 19
Output only. The custom attribute 3 of the product as provided by the merchant.
optional string custom_attribute4 = 20
Output only. The custom attribute 4 of the product as provided by the merchant.
optional string category_level1 = 21
Output only. The category level 1 of the product.
optional string category_level2 = 22
Output only. The category level 2 of the product.
optional string category_level3 = 23
Output only. The category level 3 of the product.
optional string category_level4 = 24
Output only. The category level 4 of the product.
optional string category_level5 = 25
Output only. The category level 5 of the product.
optional string product_type_level1 = 26
Output only. The product type level 1 as provided by the merchant.
optional string product_type_level2 = 27
Output only. The product type level 2 as provided by the merchant.
optional string product_type_level3 = 28
Output only. The product type level 3 as provided by the merchant.
optional string product_type_level4 = 29
Output only. The product type level 4 as provided by the merchant.
optional string product_type_level5 = 30
Output only. The product type level 5 as provided by the merchant.
optional int64 effective_max_cpc_micros = 31
Output only. The effective maximum cost-per-click (effective max. CPC) of the product. This field is available only if the query specifies the campaign or ad group scope, and if the campaign uses manual bidding. The value is the highest bid set for the product in product groups across all enabled ad groups. It represents the most you're willing to pay for a click on the product. This field can take up to 24 hours to update.
enums.ProductStatusEnum.ProductStatus status = 32
Output only. The status that indicates whether the product can show in ads. The value of this field is restricted to the scope specified in the query, see the documentation of the resource. This field can take up to 24 hours to update.
repeated issues = 33
Output only. The list of issues affecting whether the product can show in ads. The value of this field is restricted to the scope specified in the query, see the documentation of the resource. This field can take up to 24 hours to update.
optional string campaign = 34
Output only. A campaign that includes the product. This field is selectable only in the campaign scope, which requires an equality filter on `campaign`.
optional string ad_group = 35
Output only. An ad group of a campaign that includes the product. This field is selectable only in the ad group scope, which requires an equality filter on `campaign` and `ad_group`.
message
shopping_product.proto:84An issue affecting whether a product can show in ads.
Used in:
string error_code = 1
Output only. The error code that identifies the issue.
enums.ProductIssueSeverityEnum.ProductIssueSeverity ads_severity = 2
Output only. The severity of the issue in Google Ads.
optional string attribute_name = 3
Output only. The name of the product's attribute, if any, that triggered the issue.
string description = 4
Output only. The short description of the issue in English.
string detail = 5
Output only. The detailed description of the issue in English.
string documentation = 6
Output only. The URL of the Help Center article for the issue.
repeated string affected_regions = 7
Output only. List of upper-case two-letter ISO 3166-1 codes of the regions affected by the issue. If empty, all regions are affected.
A Smart campaign search term view.
Used in:
string resource_name = 1
Output only. The resource name of the Smart campaign search term view. Smart campaign search term view resource names have the form: `customers/{customer_id}/smartCampaignSearchTermViews/{campaign_id}~{URL-base64_search_term}`
string search_term = 2
Output only. The search term.
string campaign = 3
Output only. The Smart campaign the search term served in.
message
smart_campaign_setting.proto:34Settings for configuring Smart campaigns.
Used in: , ,
string resource_name = 1
Immutable. The resource name of the Smart campaign setting. Smart campaign setting resource names have the form: `customers/{customer_id}/smartCampaignSettings/{campaign_id}`
string campaign = 2
Output only. The campaign to which these settings apply.
optional phone_number = 3
Phone number and country code.
string advertising_language_code = 7
The language code to advertise in from the set of [supported language codes] (https://developers.google.com/google-ads/api/reference/data/codes-formats#languages).
oneof landing_page
The landing page of this campaign.
string final_url = 8
The user-provided landing page URL for this Campaign.
ad_optimized_business_profile_setting = 9
Settings for configuring a business profile optimized for ads as this campaign's landing page. This campaign must be linked to a business profile to use this option. For more information on this feature, consult https://support.google.com/google-ads/answer/9827068.
oneof business_setting
The business setting of this campaign.
string business_name = 5
The name of the business.
string business_profile_location = 10
The resource name of a Business Profile location. Business Profile location resource names can be fetched through the Business Profile API and adhere to the following format: `locations/{locationId}`. See the [Business Profile API] (https://developers.google.com/my-business/reference/businessinformation/rest/v1/accounts.locations) for additional details.
message
smart_campaign_setting.proto:51Settings for configuring a business profile optimized for ads as this campaign's landing page.
Used in:
optional bool include_lead_form = 1
Enabling a lead form on your business profile enables prospective customers to contact your business by filling out a simple form, and you'll receive their information through email.
message
smart_campaign_setting.proto:41Phone number and country code in smart campaign settings.
Used in:
optional string phone_number = 1
Phone number of the smart campaign.
optional string country_code = 2
Upper-case, two-letter country code as defined by ISO-3166.
A targeting expansion view with metrics. Returns metrics for automated expansion over manual targeting.
Used in:
string resource_name = 1
Output only. The resource name of the targeting expansion view. Targeting expansion view resource names have the form: `customers/{customer_id}/targetingExpansionViews/{campaign_id}~{targeting_expansion_type}`
A data sharing connection, allowing the import of third party app analytics into a Google Ads Customer.
Used in:
string resource_name = 1
Immutable. The resource name of the third party app analytics link. Third party app analytics link resource names have the form: `customers/{customer_id}/thirdPartyAppAnalyticsLinks/{account_link_id}`
optional string shareable_link_id = 3
Output only. The shareable link ID that should be provided to the third party when setting up app analytics. This is able to be regenerated using regenerate method in the ThirdPartyAppAnalyticsLinkService.
message
account_link.proto:74The identifiers of a Third Party App Analytics Link.
Used in:
optional int64 app_analytics_provider_id = 4
Immutable. The ID of the app analytics provider. This field should not be empty when creating a new third party app analytics link. It is unable to be modified after the creation of the link.
optional string app_id = 5
Immutable. A string that uniquely identifies a mobile application from which the data was collected to the Google Ads API. For iOS, the ID string is the 9 digit string that appears at the end of an App Store URL (for example, "422689480" for "Gmail" whose App Store link is https://apps.apple.com/us/app/gmail-email-by-google/id422689480). For Android, the ID string is the application's package name (for example, "com.google.android.gm" for "Gmail" given Google Play link https://play.google.com/store/apps/details?id=com.google.android.gm) This field should not be empty when creating a new third party app analytics link. It is unable to be modified after the creation of the link.
enums.MobileAppVendorEnum.MobileAppVendor app_vendor = 3
Immutable. The vendor of the app. This field should not be empty when creating a new third party app analytics link. It is unable to be modified after the creation of the link.
message
topic_constant.proto:36Use 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 in:
string resource_name = 1
Output only. The resource name of the topic constant. topic constant resource names have the form: `topicConstants/{topic_id}`
optional int64 id = 5
Output only. The ID of the topic.
optional string topic_constant_parent = 6
Output only. Resource name of parent of the topic constant.
repeated string path = 7
Output only. 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/google-ads/api/reference/data/verticals
message
topic_view.proto:34A topic view.
Used in:
string resource_name = 1
Output only. The resource name of the topic view. Topic view resource names have the form: `customers/{customer_id}/topicViews/{ad_group_id}~{criterion_id}`
A travel activity group view.
Used in:
string resource_name = 1
Output only. The resource name of the travel activity group view. Travel Activity Group view resource names have the form: `customers/{customer_id}/travelActivityGroupViews/{ad_group_id}~{criterion_id}`
A travel activity performance view.
Used in:
string resource_name = 1
Output only. The resource name of the travel activity performance view. Travel Activity performance view resource names have the form: `customers/{customer_id}/travelActivityPerformanceView`
A list of degrees this employee has obtained, and wants to feature.
Used in:
optional string institution_name = 1
Output only. Name of the university at which the degree was obtained.
optional string degree = 2
Output only. Name of the degree obtained.
optional int32 graduation_year = 3
Output only. Year of graduation.
message
user_interest.proto:36A user interest: a particular interest-based vertical to be targeted.
Used in:
string resource_name = 1
Output only. 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
Output only. Taxonomy type of the user interest.
optional int64 user_interest_id = 8
Output only. The ID of the user interest.
optional string name = 9
Output only. The name of the user interest.
optional string user_interest_parent = 10
Output only. The parent of the user interest.
optional bool launched_to_all = 11
Output only. True if the user interest is launched to all channels and locales.
repeated availabilities = 7
Output only. Availability information of the user interest.
message
user_list.proto:41A user list. This is a list of users a customer may target.
Used in: ,
string resource_name = 1
Immutable. The resource name of the user list. User list resource names have the form: `customers/{customer_id}/userLists/{user_list_id}`
optional int64 id = 25
Output only. Id of the user list.
optional bool read_only = 26
Output only. An option 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 string name = 27
Name of this user list. Depending on its access_reason, the user list name may not be unique (for example, if access_reason=SHARED)
optional string description = 28
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 string integration_code = 29
An ID from external system. It is used by user list sellers to correlate IDs on their systems.
optional int64 membership_life_span = 30
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. Beginning on April 7, 2025, using a value of 10000 to indicate no expiration will no longer be supported. This field is ignored for logical_user_list and rule_based_user_list types. Membership to lists of these types depends on the rules defined by the lists.
optional int64 size_for_display = 31
Output only. 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
Output only. Size range in terms of number of users of the UserList, on the Google Display Network. This field is read-only.
optional int64 size_for_search = 32
Output only. 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
Output only. Size range in terms of number of users of the UserList, for Search ads. This field is read-only.
enums.UserListTypeEnum.UserListType type = 13
Output only. 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
Output only. 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 bool eligible_for_search = 33
Indicates if this user list is eligible for Google Search Network.
optional bool eligible_for_display = 34
Output only. Indicates this user list is eligible for Google Display Network. This field is read-only.
optional int32 match_rate_percentage = 24
Output only. Indicates match rate for Customer Match lists. The range of this field is [0-100]. This will be null for other list types or when it's not possible to calculate the match rate. 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
Output only. 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.
lookalike_user_list = 36
Immutable. Lookalike User List.
message
user_list_customer_type.proto:33A user list customer type
Used in: ,
string resource_name = 1
Immutable. The resource name of the user list customer type User list customer type resource names have the form: `customers/{customer_id}/userListCustomerTypes/{user_list_id}~{customer_type_category}`
string user_list = 2
Immutable. The resource name for the user list this user list customer type is associated with
enums.UserListCustomerTypeCategoryEnum.UserListCustomerTypeCategory customer_type_category = 3
Immutable. The user list customer type category
message
user_location_view.proto:39A 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 in:
string resource_name = 1
Output only. 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 int64 country_criterion_id = 4
Output only. Criterion Id for the country.
optional bool targeting_location = 5
Output only. Indicates whether location was targeted or not.
message
video.proto:34A video.
Used in:
string resource_name = 1
Output only. The resource name of the video. Video resource names have the form: `customers/{customer_id}/videos/{video_id}`
optional string id = 6
Output only. The ID of the video.
optional string channel_id = 7
Output only. The owner channel id of the video.
optional int64 duration_millis = 8
Output only. The duration of the video in milliseconds.
optional string title = 9
Output only. The title of the video.
message
customer.proto:314Video specific information about a Customer.
Used in:
optional third_party_integration_partners = 1
Third Party integration partners.
message
webpage_view.proto:34A webpage view.
Used in:
string resource_name = 1
Output only. The resource name of the webpage view. Webpage view resource names have the form: `customers/{customer_id}/webpageViews/{ad_group_id}~{criterion_id}`
message
data_link.proto:78The identifier for YouTube video
Used in:
optional string channel_id = 1
Immutable. The ID of the hosting channel of the video. This is a string value with “UC” prefix. For example, "UCK8sQmJBp8GCxrOtXWBpyEA".
optional string video_id = 2
Immutable. The ID of the video associated with the video link. This is the 11 character string value used in the YouTube video URL. For example, video ID is jV1vkHv4zq8 from the YouTube video URL "https://www.youtube.com/watch?v=jV1vkHv4zq8&t=2s".