package google.ads.googleads.v0.common
Get desktop application:
View/edit binary Protocol Buffers messages
message
criteria.proto:268Represents an AdSchedule criterion. AdSchedule is specified as the day of the week and a time interval within which ads will be shown. No more than six AdSchedules can be added for the same day.
Used in:
enums.MinuteOfHourEnum.MinuteOfHour start_minute = 1
Minutes after the start hour at which this schedule starts. This field is required for CREATE operations and is prohibited on UPDATE operations.
enums.MinuteOfHourEnum.MinuteOfHour end_minute = 2
Minutes after the end hour at which this schedule ends. The schedule is exclusive of the end minute. This field is required for CREATE operations and is prohibited on UPDATE operations.
optional start_hour = 3
Starting hour in 24 hour time. This field must be between 0 and 23, inclusive. This field is required for CREATE operations and is prohibited on UPDATE operations.
optional end_hour = 4
Ending hour in 24 hour time; 24 signifies end of the day. This field must be between 0 and 24, inclusive. This field is required for CREATE operations and is prohibited on UPDATE operations.
enums.DayOfWeekEnum.DayOfWeek day_of_week = 5
Day of the week the schedule applies to. This field is required for CREATE operations and is prohibited on UPDATE operations.
message
criteria.proto:378Address for proximity criterion.
Used in:
optional postal_code = 1
Postal code.
optional province_code = 2
Province or state code.
optional country_code = 3
Country code.
optional province_name = 4
Province or state name.
optional street_address = 5
Street address line 1.
optional street_address2 = 6
Street address line 2. This field is write-only. It is only used for calculating the longitude and latitude of an address when geo_point is empty.
optional city_name = 7
Name of the city.
message
criteria.proto:304An age range criterion.
Used in: ,
enums.AgeRangeTypeEnum.AgeRangeType type = 1
Type of the age range.
message
ad_type_infos.proto:137A call-only ad.
Used in:
optional country_code = 1
The country code in the ad.
optional phone_number = 2
The phone number in the ad.
optional business_name = 3
The business name in the ad.
optional description1 = 4
The first line of the ad's description.
optional description2 = 5
The second line of the ad's description.
optional call_tracked = 6
Whether to enable call tracking for the creative. Enabling call tracking also enables call conversions.
optional disable_call_conversion = 7
Whether to disable call conversion for the creative. If set to `true`, disables call conversions even when `call_tracked` is `true`. If `call_tracked` is `false`, this field is ignored.
optional phone_number_verification_url = 8
The URL to be used for phone number verification.
optional conversion_action = 9
The conversion action to attribute a call conversion to. If not set a default conversion action is used. This field only has effect if call_tracked is set to true. Otherwise this field is ignored.
enums.CallConversionReportingStateEnum.CallConversionReportingState conversion_reporting_state = 10
The call conversion behavior of this call only ad. It can use its own call conversion setting, inherit the account level setting, or be disabled.
message
criteria.proto:440Represents a Carrier Criterion.
Used in:
optional carrier_constant = 1
The Carrier constant resource name.
message
criteria.proto:434Content Label for category exclusion.
Used in:
enums.ContentLabelTypeEnum.ContentLabelType type = 1
Content label type, required for CREATE operations.
Information of category availability, per advertising channel.
Used in:
optional channel = 1
Channel types and subtypes that are available to the category.
repeated locale = 2
Locales that are available to the category for the channel.
Information of advertising channel type and subtypes a category is available in.
Used in:
enums.CriterionCategoryChannelAvailabilityModeEnum.CriterionCategoryChannelAvailabilityMode availability_mode = 1
Format of the channel availability. Can be ALL_CHANNELS (the rest of the fields will not be set), CHANNEL_TYPE (only advertising_channel_type type will be set, the category is available to all sub types under it) or CHANNEL_TYPE_AND_SUBTYPES (advertising_channel_type, advertising_channel_sub_type, and include_default_channel_sub_type will all be set).
enums.AdvertisingChannelTypeEnum.AdvertisingChannelType advertising_channel_type = 2
Channel type the category is available to.
repeated enums.AdvertisingChannelSubTypeEnum.AdvertisingChannelSubType advertising_channel_sub_type = 3
Channel subtypes under the channel type the category is available to.
optional include_default_channel_sub_type = 4
Whether default channel sub type is included. For example, advertising_channel_type being DISPLAY and include_default_channel_sub_type being false means that the default display campaign where channel sub type is not set is not included in this availability configuration.
Information about which locales a category is available in.
Used in:
enums.CriterionCategoryLocaleAvailabilityModeEnum.CriterionCategoryLocaleAvailabilityMode availability_mode = 1
Format of the locale availability. Can be LAUNCHED_TO_ALL (both country and language will be empty), COUNTRY (only country will be set), LANGUAGE (only language wil be set), COUNTRY_AND_LANGUAGE (both country and language will be set).
optional country_code = 2
Code of the country.
optional language_code = 3
Code of the language.
message
user_lists.proto:41UserList of CRM users provided by the advertiser.
Used in:
optional app_id = 1
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 (e.g., "476943146" for "Flood-It! 2" whose App Store link is http://itunes.apple.com/us/app/flood-it!-2/id476943146). For Android, the ID string is the application's package name (e.g., "com.labpixies.colordrips" for "Color Drips" given Google Play link https://play.google.com/store/apps/details?id=com.labpixies.colordrips). Required when creating CrmBasedUserList for uploading mobile advertising IDs.
enums.CustomerMatchUploadKeyTypeEnum.CustomerMatchUploadKeyType upload_key_type = 2
Matching key type of the list. Mixed data types are not allowed on the same list. This field is required for an ADD operation.
enums.UserListCrmDataSourceTypeEnum.UserListCrmDataSourceType data_source_type = 3
Data source of the list. Default value is FIRST_PARTY. Only whitelisted customers can create third party sourced crm lists.
message
custom_parameter.proto:33A mapping that can be used by custom parameter tags in a `tracking_url_template`, `final_urls`, or `mobile_final_urls`.
Used in: , , , ,
optional key = 1
The key matching the parameter tag name.
optional value = 2
The value to be substituted.
message
dates.proto:32A date range.
Used in:
optional start_date = 1
The start date, in yyyy-mm-dd format.
optional end_date = 2
The end date, in yyyy-mm-dd format.
message
criteria.proto:75A device criterion.
Used in: ,
enums.DeviceEnum.Device type = 1
Type of the device.
message
ad_type_infos.proto:244Data for display call to action. The call to action is a piece of the ad that prompts the user to do something. Like clicking a link or making a phone call.
Used in:
optional text = 1
Text for the display-call-to-action.
optional text_color = 2
Text color for the display-call-to-action in hexadecimal, e.g. #ffffff for white.
message
ad_type_infos.proto:71A dynamic search ad.
Used in:
optional description1 = 1
The first line of the ad's description.
optional description2 = 2
The second line of the ad's description.
message
bidding.proto:35An automated 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.
Used in:
(message has no fields)
message
ad_type_infos.proto:177An expanded dynamic search ad.
Used in:
optional description = 1
The description of the ad.
message
ad_type_infos.proto:47An expanded text ad.
Used in:
optional headline_part1 = 1
The first part of the ad's headline.
optional headline_part2 = 2
The second part of the ad's headline.
optional headline_part3 = 6
The third part of the ad's headline.
optional description = 3
The description of the ad.
optional description2 = 7
The second description of the ad.
optional path1 = 4
The text that can appear alongside the ad's displayed URL.
optional path2 = 5
Additional text that can appear alongside the ad's displayed URL.
Settings for the <a href="https://support.google.com/google-ads/answer/190596"> Display Campaign Optimizer</a>, initially termed "Explorer".
Used in:
optional opt_in = 1
Indicates whether the optimizer is turned on.
message
frequency_cap.proto:36A rule specifying the maximum number of times an ad (or some set of ads) can be shown to a user over a particular time period.
Used in:
optional key = 1
The key of a particular frequency cap. There can be no more than one frequency cap with the same key.
optional cap = 2
Maximum number of events allowed during the time range by this cap.
message
frequency_cap.proto:47A group of fields used as keys for a frequency cap. There can be no more than one frequency cap with the same key.
Used in:
enums.FrequencyCapLevelEnum.FrequencyCapLevel level = 1
The level on which the cap is to be applied (e.g. ad group ad, ad group). The cap is applied to all the entities of this level.
enums.FrequencyCapEventTypeEnum.FrequencyCapEventType event_type = 3
The type of event that the cap applies to (e.g. impression).
enums.FrequencyCapTimeUnitEnum.FrequencyCapTimeUnit time_unit = 2
Unit of time the cap is defined at (e.g. day, week).
optional time_length = 4
Number of time units the cap lasts.
message
criteria.proto:310A gender criterion.
Used in: ,
enums.GenderTypeEnum.GenderType type = 1
Type of the gender.
message
criteria.proto:369Geo point for proximity criterion.
Used in:
optional longitude_in_micro_degrees = 1
Micro degrees for the longitude.
optional latitude_in_micro_degrees = 2
Micro degrees for the latitude.
message
ad_type_infos.proto:198A Gmail ad.
Used in:
optional teaser = 1
The Gmail teaser.
optional header_image = 2
The MediaFile resource name of the header image. Valid image types are GIF, JPEG and PNG. The minimum size is 300x100 pixels and the aspect ratio must be between 3:1 and 5:1 (+-1%).
optional marketing_image = 3
The MediaFile resource name of the marketing image. Valid image types are GIF, JPEG and PNG. The image must either be landscape with a minimum size of 600x314 pixels and aspect ratio of 600:314 (+-1%) or square with a minimum size of 300x300 pixels and aspect ratio of 1:1 (+-1%)
optional marketing_image_headline = 4
Headline of the marketing image.
optional marketing_image_description = 5
Description of the marketing image.
optional marketing_image_display_call_to_action = 6
Display-call-to-action of the marketing image.
Gmail teaser data. The teaser is a small header that acts as an invitation to view the rest of the ad (the body).
Used in:
optional headline = 1
Headline of the teaser.
optional description = 2
Description of the teaser.
optional business_name = 3
Business name of the advertiser.
optional logo_image = 4
The MediaFile resource name of the logo image. Valid image types are GIF, JPEG and PNG. The minimum size is 144x144 pixels and the aspect ratio must be 1:1 (+-1%).
message
ad_type_infos.proto:183A hotel ad.
Used in:
(message has no fields)
message
criteria.proto:233Criterion for number of days prior to the stay the booking is being made.
Used in:
optional min_days = 1
Low end of the number of days prior to the stay.
optional max_days = 2
High end of the number of days prior to the stay.
message
criteria.proto:251Criterion for day of the week the booking is for.
Used in:
enums.DayOfWeekEnum.DayOfWeek day_of_week = 1
The day of the week.
message
criteria.proto:179City the hotel is located in.
Used in:
optional city_criterion = 1
The Geo Target Constant resource name.
message
criteria.proto:161Class of the hotel as a number of stars 1 to 5.
Used in:
optional value = 1
Long value of the hotel class.
message
criteria.proto:167Country or Region the hotel is located in.
Used in:
optional country_region_criterion = 1
The Geo Target Constant resource name.
message
criteria.proto:227Criterion for hotel date selection (default dates vs. user selected).
Used in:
enums.HotelDateSelectionTypeEnum.HotelDateSelectionType type = 1
Type of the hotel date selection
message
criteria.proto:155Advertiser-specific hotel ID.
Used in:
optional value = 1
String value of the hotel ID.
message
criteria.proto:242Criterion for length of hotel stay in nights.
Used in:
optional min_nights = 1
Low end of the number of nights in the stay.
optional max_nights = 2
High end of the number of nights in the stay.
message
criteria.proto:173State the hotel is located in.
Used in:
optional state_criterion = 1
The Geo Target Constant resource name.
message
ad_type_infos.proto:254An image ad.
Used in:
optional pixel_width = 4
Width in pixels of the full size image.
optional pixel_height = 5
Height in pixels of the full size image.
optional image_url = 6
URL of the full size image.
optional preview_pixel_width = 7
Width in pixels of the preview size image.
optional preview_pixel_height = 8
Height in pixels of the preview size image.
optional preview_image_url = 9
URL of the preview size image.
enums.MimeTypeEnum.MimeType mime_type = 10
The mime type of the image.
optional name = 11
The name of the image. If the image was created from a MediaFile, this is the MediaFile's name. If the image was created from bytes, this is empty.
oneof image
The image to create the ImageAd from. This can be specified in one of two ways. 1. An existing MediaFile resource. 2. The raw image data as bytes.
media_file = 1
The MediaFile resource to use for the image.
data = 2
Raw image data as bytes.
message
criteria.proto:316An income range criterion.
Used in: ,
enums.IncomeRangeTypeEnum.IncomeRangeType type = 1
Type of the income range.
message
criteria.proto:257Criterion for Interaction Type.
Used in:
enums.InteractionTypeEnum.InteractionType type = 1
The interaction type.
message
criteria.proto:428An IpBlock criterion used for IP exclusions. We allow: - IPv4 and IPv6 addresses - individual addresses (192.168.0.1) - masks for individual addresses (192.168.0.1/32) - masks for Class C networks (192.168.0.1/24)
Used in:
optional ip_address = 1
The IP address of this IP block.
message
criteria.proto:51A keyword criterion.
Used in: , , ,
optional text = 1
The text of the keyword (at most 80 characters and 10 words).
enums.KeywordMatchTypeEnum.KeywordMatchType match_type = 2
The match type of the keyword.
message
keyword_plan_common.proto:33Historical metrics.
Used in: ,
optional avg_monthly_searches = 1
Average monthly searches for the past 12 months.
enums.KeywordPlanCompetitionLevelEnum.KeywordPlanCompetitionLevel competition = 2
The competition level for the query.
message
criteria.proto:418A language criterion.
Used in:
optional language_constant = 1
The language constant resource name.
message
criteria.proto:149Brand of the listing.
Used in:
optional value = 1
String value of the listing brand.
message
criteria.proto:185Listing custom attribute.
Used in:
optional value = 1
String value of the listing custom attribute.
enums.ListingCustomAttributeIndexEnum.ListingCustomAttributeIndex index = 2
Indicates the index of the custom attribute.
message
criteria.proto:107Listing dimensions for listing group criterion.
Used in: ,
oneof dimension
Dimension of one of the types below is always present.
listing_brand = 1
Brand of the listing.
hotel_id = 2
Advertiser-specific hotel ID.
hotel_class = 3
Class of the hotel as a number of stars 1 to 5.
hotel_country_region = 4
Country or Region the hotel is located in.
hotel_state = 5
State the hotel is located in.
hotel_city = 6
City the hotel is located in.
listing_custom_attribute = 7
Listing custom attribute.
product_channel = 8
Locality of a product offer.
product_channel_exclusivity = 9
Availability of a product offer.
product_condition = 10
Condition of a product offer.
product_offer_id = 11
Id of a product offer.
product_type = 12
Type of a product offer.
message
criteria.proto:87A listing group criterion.
Used in:
enums.ListingGroupTypeEnum.ListingGroupType type = 1
Type of the listing group.
optional case_value = 2
Dimension value with which this listing group is refining its parent. Undefined for the root group.
optional parent_ad_group_criterion = 3
Resource name of ad group criterion which is the parent listing group subdivision. Null for the root group.
message
criteria.proto:101A listing scope criterion.
Used in:
repeated dimensions = 2
Scope of the campaign criterion.
message
criteria.proto:69A location criterion.
Used in:
optional geo_target_constant = 1
The geo target constant resource name.
message
bidding.proto:40Manual click-based bidding where user pays per click.
Used in:
optional enhanced_cpc_enabled = 1
Whether bids are to be enhanced based on conversion optimizer data.
message
bidding.proto:46Manual impression-based bidding where user pays per thousand impressions.
Used in:
(message has no fields)
message
bidding.proto:51View based bidding where user pays per video view.
Used in:
(message has no fields)
message
matching_function.proto:34Matching function associated with a CustomerFeed, CampaignFeed, or AdGroupFeed. The matching function is used to filter the set of feed items selected.
Used in: , ,
optional function_string = 1
String representation of the Function. Examples: 1) IDENTITY(true) or IDENTITY(false). All or none feed items serve. 2) EQUALS(CONTEXT.DEVICE,"Mobile") 3) IN(FEED_ITEM_ID,{1000001,1000002,1000003}) 4) CONTAINS_ANY(FeedAttribute[12345678,0],{"Mars cruise","Venus cruise"}) 5) AND(IN(FEED_ITEM_ID,{10001,10002}),EQUALS(CONTEXT.DEVICE,"Mobile")) See https: //developers.google.com/adwords/api/docs/guides/feed-matching-functions Note that because multiple strings may represent the same underlying function (whitespace and single versus double quotation marks, for example), the value returned may not be identical to the string sent in a mutate request.
message
bidding.proto:63An automated bidding strategy which tries to maximize conversion value given a daily budget.
Used in:
optional target_roas = 1
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.
message
bidding.proto:57An automated bidding strategy that sets bids to help get the most conversions for your campaign while spending your budget.
Used in:
(message has no fields)
message
metrics.proto:32Metrics data.
Used in:
optional all_conversions_from_interactions_rate = 65
All conversions from interactions (as oppose to view through conversions) divided by the number of ad interactions.
optional all_conversions_value = 66
The total value of all conversions.
optional all_conversions = 7
The total number of conversions. This includes "Conversions" plus conversions that have their "Include in Conversions" setting unchecked.
optional all_conversions_value_per_cost = 62
The value of all conversions divided by the total cost of ad interactions (such as clicks for text ads or views for video ads).
optional all_conversions_from_interactions_value_per_interaction = 67
The value of all conversions from interactions divided by the total number of interactions.
optional average_cost = 8
The average amount you pay per interaction. This amount is the total cost of your ads divided by the total number of interactions.
optional average_cpc = 9
The total cost of all clicks divided by the total number of clicks received.
optional average_cpm = 10
Average cost-per-thousand impressions (CPM).
optional average_cpv = 11
The average amount you pay each time someone views your ad. The average CPV is defined by the total cost of all ad views divided by the number of views.
optional average_position = 13
Your ad's position relative to those of other advertisers.
optional benchmark_ctr = 77
An indication on how other advertisers' Shopping ads for similar products are performing based on how often people who see their ad click on it.
optional bounce_rate = 15
Percentage of clicks where the user only visited a single page on your site. Imported from Google Analytics.
optional clicks = 19
The number of clicks.
optional content_budget_lost_impression_share = 20
The estimated percent of times that your ad was eligible to show on the Display Network but didn't because your budget was too low. Note: Content budget lost impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001.
optional content_impression_share = 21
The impressions you've received on the Display Network divided by the estimated number of impressions you were eligible to receive. Note: Content impression share is reported in the range of 0.1 to 1. Any value below 0.1 is reported as 0.0999.
optional conversion_last_received_request_date_time = 73
The last date/time a conversion tag for this conversion action successfully fired and was seen by Google Ads. This firing event may not have been the result of an attributable conversion (e.g. because the tag was fired from a browser that did not previously click an ad from an appropriate advertiser). The date/time is in the customer's time zone.
optional conversion_last_conversion_date = 74
The date of the most recent conversion for this conversion action. The date is in the customer's time zone.
optional content_rank_lost_impression_share = 22
The estimated percentage of impressions on the Display Network that your ads didn't receive due to poor Ad Rank. Note: Content rank lost impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001.
optional conversions_from_interactions_rate = 69
Conversions from interactions divided by the number of ad interactions (such as clicks for text ads or views for video ads).
optional conversions_value = 70
The total value of conversions.
optional conversions_value_per_cost = 71
The value of conversions divided by the cost of ad interactions.
optional conversions_from_interactions_value_per_interaction = 72
The value of conversions from interactions divided by the number of ad interactions.
optional conversions = 25
The number of conversions. This only includes conversion actions which have "Include in Conversions" checked.
optional cost_micros = 26
The sum of your cost-per-click (CPC) and cost-per-thousand impressions (CPM) costs during this period.
optional cost_per_all_conversions = 68
The cost of ad interactions divided by all conversions.
optional cost_per_conversion = 28
The cost of ad interactions divided by conversions.
optional cross_device_conversions = 29
Conversions from when a customer clicks on a Google Ads ad on one device, then converts on a different device or browser. Cross-device conversions are already included in all_conversions.
optional ctr = 30
The number of clicks your ad receives (Clicks) divided by the number of times your ad is shown (Impressions).
optional engagement_rate = 31
How often people engage with your ad after it's shown to them. This is the number of ad expansions divided by the number of times your ad is shown.
optional engagements = 32
The number of engagements. An engagement occurs when a viewer expands your Lightbox ad. Also, in the future, other ad types may support engagement metrics.
optional hotel_average_lead_value_micros = 75
Average lead value of hotel.
optional impressions = 37
Count of how often your ad has appeared on a search results page or website on the Google Network.
optional interaction_rate = 38
How often people interact with your ad after it is shown to them. This is the number of interactions divided by the number of times your ad is shown.
optional interactions = 39
The number of interactions. An interaction is the main user action associated with an ad format-clicks for text and shopping ads, views for video ads, and so on.
optional invalid_click_rate = 40
The percentage of clicks filtered out of your total number of clicks (filtered + non-filtered clicks) during the reporting period.
optional invalid_clicks = 41
Number of clicks Google considers illegitimate and doesn't charge you for.
optional percent_new_visitors = 42
Percentage of first-time sessions (from people who had never visited your site before). Imported from Google Analytics.
optional phone_calls = 43
Number of offline phone calls.
optional phone_impressions = 44
Number of offline phone impressions.
optional phone_through_rate = 45
Number of phone calls received (phone_calls) divided by the number of times your phone number is shown (phone_impressions).
optional relative_ctr = 46
Your clickthrough rate (Ctr) divided by the average clickthrough rate of all advertisers on the websites that show your ads. Measures how your ads perform on Display Network sites compared to other ads on the same sites.
optional search_absolute_top_impression_share = 78
The percentage of the customer's Shopping ad impressions that are shown in the most prominent Shopping position. See <a href="https://support.google.com/adwords/answer/7501826">this Merchant Center article</a> for details. Any value below 0.1 is reported as 0.0999.
optional search_budget_lost_impression_share = 47
The estimated percent of times that your ad was eligible to show on the Search Network but didn't because your budget was too low. Note: Search budget lost impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001.
optional search_exact_match_impression_share = 49
The impressions you've received divided by the estimated number of impressions you were eligible to receive on the Search Network for search terms that matched your keywords exactly (or were close variants of your keyword), regardless of your keyword match types. Note: Search exact match impression share is reported in the range of 0.1 to 1. Any value below 0.1 is reported as 0.0999.
optional search_impression_share = 50
The impressions you've received on the Search Network divided by the estimated number of impressions you were eligible to receive. Note: Search impression share is reported in the range of 0.1 to 1. Any value below 0.1 is reported as 0.0999.
optional search_rank_lost_impression_share = 51
The estimated percentage of impressions on the Search Network that your ads didn't receive due to poor Ad Rank. Note: Search rank lost impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001.
optional value_per_all_conversions = 52
The value of all conversions divided by the number of all conversions.
optional value_per_conversion = 53
The value of conversions divided by the number of conversions.
optional video_quartile_100_rate = 54
Percentage of impressions where the viewer watched all of your video.
optional video_quartile_25_rate = 55
Percentage of impressions where the viewer watched 25% of your video.
optional video_quartile_50_rate = 56
Percentage of impressions where the viewer watched 50% of your video.
optional video_quartile_75_rate = 57
Percentage of impressions where the viewer watched 75% of your video.
optional video_view_rate = 58
The number of views your TrueView video ad receives divided by its number of impressions, including thumbnail impressions for TrueView in-display ads.
optional video_views = 59
The number of times your video ads were viewed.
optional view_through_conversions = 60
The total number of view-through conversions. These happen when a customer sees an image or rich media ad, then later completes a conversion on your site without interacting with (e.g., clicking on) another ad.
message
bidding.proto:74An automated bidding strategy which sets CPC bids to target impressions on page one, or page one promoted slots on google.com.
Used in:
enums.PageOnePromotedStrategyGoalEnum.PageOnePromotedStrategyGoal strategy_goal = 1
The strategy goal of where impressions are desired to be shown on search result pages.
optional cpc_bid_ceiling_micros = 2
Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy.
optional bid_modifier = 3
Bid multiplier to be applied to the relevant bid estimate (depending on the `strategy_goal`) in determining a keyword's new CPC bid.
optional only_raise_cpc_bids = 4
Whether the strategy should always follow bid estimate changes, or only increase. If false, always sets a keyword's new bid to the current bid estimate. If true, only updates a keyword's bid if the current bid estimate is greater than the current bid.
optional raise_cpc_bid_when_budget_constrained = 5
Whether the strategy is allowed to raise bids when the throttling rate of the budget it is serving out of rises above a threshold.
optional raise_cpc_bid_when_quality_score_is_low = 6
Whether the strategy is allowed to raise bids on keywords with lower-range quality scores.
message
criteria.proto:322A parental status criterion.
Used in: ,
enums.ParentalStatusTypeEnum.ParentalStatusType type = 1
Type of the parental status.
message
bidding.proto:182A bidding strategy where bids are a fraction of the advertised price for some good or service.
Used in:
optional cpc_bid_ceiling_micros = 1
Maximum bid limit that can be set by the bid strategy. This is an optional field entered by the advertiser and specified in local micros. Note: A zero value is interpreted in the same way as having bid_ceiling undefined.
optional enhanced_cpc_enabled = 2
Adjusts the bid for each auction upward or downward, depending on the likelihood of a conversion. Individual bids may exceed cpc_bid_ceiling_micros, but the average bid amount for a campaign should not.
message
criteria.proto:61A placement criterion. This can be used to modify bids for sites when targeting the content network.
Used in: , ,
optional url = 1
URL of the placement. For example, "http://www.domain.com".
message
policy.proto:156Describes the effect on serving that a policy topic entry will have. Next Id: 5
Used in:
oneof value
Specific information about the constraint.
country_constraint_list = 1
Countries where the resource cannot serve.
reseller_constraint = 2
Reseller constraint.
certificate_missing_in_country_list = 3
Countries where a certificate is required for serving.
certificate_domain_mismatch_in_country_list = 4
Countries where the resource's domain is not covered by the certificates associated with it.
message
policy.proto:180Indicates that a resource's ability to serve in a particular country is constrained. Next Id: 2
Used in:
optional country_criterion = 1
Geo target constant resource name of the country in which serving is constrained.
message
policy.proto:160A list of countries where a resource's serving is constrained. Next Id: 3
Used in:
optional total_targeted_countries = 1
Total number of countries targeted by the resource.
repeated countries = 2
Countries in which serving is restricted.
message
policy.proto:172Indicates that a policy topic was constrained due to disapproval of the website for reseller purposes. Next Id: 1
Used in:
(message has no fields)
message
policy.proto:70Policy finding attached to a resource (e.g. alcohol policy associated with a site that sells alcohol). Each PolicyTopicEntry has a topic that indicates the specific ads policy the entry is about and a type to indicate the effect that the entry will have on serving. It may optionally have one or more evidences that indicate the reason for the finding. It may also optionally have one or more constraints that provide details about how serving may be restricted. Next tag: 5
Used in: ,
optional topic = 1
Policy topic this finding refers to. For example, "ALCOHOL", "TRADEMARKS_IN_AD_TEXT", or "DESTINATION_NOT_WORKING". The set of possible policy topics is not fixed for a particular API version and may change at any time.
enums.PolicyTopicEntryTypeEnum.PolicyTopicEntryType type = 2
Describes the negative or positive effect this policy will have on serving.
repeated evidences = 3
Additional information that explains policy finding (e.g. the brand name for a trademark finding).
repeated constraints = 4
Indicates how serving of this resource may be affected (e.g. not serving in a country).
message
policy.proto:92Additional information that explains a policy finding. Next Id: 8
Used in:
oneof value
Specific evidence information depending on the evidence type.
http_code = 2
HTTP code returned when the final URL was crawled.
website_list = 3
List of websites linked with this resource.
text_list = 4
List of evidence found in the text of a resource.
language_code = 5
The language the resource was detected to be written in. This is an IETF language tag such as "en-US".
destination_text_list = 6
The text in the destination of the resource that is causing a policy finding.
destination_mismatch = 7
Mismatch between the destinations of a resource's URLs.
message
policy.proto:124Evidence of mismatches between the URLs of a resource. Next Id: 2
Used in:
repeated enums.PolicyTopicEvidenceDestinationMismatchUrlTypeEnum.PolicyTopicEvidenceDestinationMismatchUrlType url_types = 1
The set of URLs that did not match each other.
message
policy.proto:116A list of strings found in a destination page that caused a policy finding. Next Id: 2
Used in:
repeated destination_texts = 1
List of text found in the resource's destination page.
message
policy.proto:96A list of fragments of text that violated a policy. Next Id: 2
Used in:
repeated texts = 1
The fragments of text from the resource that caused the policy finding.
message
policy.proto:107A list of websites that caused a policy finding. Used for ONE_WEBSITE_PER_AD_GROUP policy topic, for example. In case there are more than five websites, only the top five (those that appear in resources the most) will be listed here. Next Id: 2
Used in:
repeated websites = 1
Websites that caused the policy finding.
message
policy.proto:48Parameter for controlling how policy checking is done.
Used in:
repeated ignorable_policy_topics = 1
The list of policy topics that should not cause a PolicyFindingError to be reported. This field is currently only compatible with Enhanced Text Ad. It corresponds to the PolicyTopicEntry.topic field. Resources violating these policies will be saved, but will not be eligible to serve. They may begin serving at a later time due to a change in policies, re-review of the resource, or a change in advertiser certificates.
message
policy.proto:35Key of the violation. The key is used for referring to a violation when filing an exemption request.
Used in:
optional policy_name = 1
Unique ID of the violated policy.
optional violating_text = 2
The text that violates the policy if specified. Otherwise, refers to the policy in general (e.g., when requesting to be exempt from the whole policy). If not specified for criterion exemptions, the whole policy is implied. Must be specified for ad exemptions.
message
criteria.proto:81A preferred content criterion.
Used in:
enums.PreferredContentTypeEnum.PreferredContentType type = 2
Type of the preferred content.
message
feed_common.proto:32Represents a price in a particular currency.
Used in:
optional currency_code = 1
Three-character ISO 4217 currency code.
optional amount_micros = 2
Amount in micros. One million is equivalent to one unit.
message
criteria.proto:200Availability of a product offer.
Used in:
enums.ProductChannelExclusivityEnum.ProductChannelExclusivity channel_exclusivity = 1
Value of the availability.
message
criteria.proto:194Locality of a product offer.
Used in:
enums.ProductChannelEnum.ProductChannel channel = 1
Value of the locality.
message
criteria.proto:206Condition of a product offer.
Used in:
enums.ProductConditionEnum.ProductCondition condition = 1
Value of the condition.
message
criteria.proto:212Id of a product offer.
Used in:
optional value = 1
Value of the id.
message
criteria.proto:218Type of a product offer.
Used in:
optional value = 1
Value of the type.
enums.ProductTypeLevelEnum.ProductTypeLevel level = 2
Level of the type.
message
criteria.proto:354A Proximity criterion. The geo point and radius determine what geographical area is included. The address is a description of the geo point that does not affect ad serving. There are two ways to create a proximity. First, by setting an address and radius. The geo point will be automatically computed. Second, by setting a geo point and radius. The address is an optional label that won't be validated.
Used in:
optional geo_point = 1
Latitude and longitude.
optional radius = 2
The radius of the proximity.
enums.ProximityRadiusUnitsEnum.ProximityRadiusUnits radius_units = 3
The unit of measurement of the radius. Default is KILOMETERS.
optional address = 4
Full address.
Settings for Real-Time Bidding, a feature only available for campaigns targeting the Ad Exchange network.
Used in:
optional opt_in = 1
Whether the campaign is opted in to real-time bidding.
message
ad_type_infos.proto:80A responsive display ad.
Used in:
optional short_headline = 1
The short version of the ad's headline.
optional long_headline = 2
The long version of the ad's headline.
optional description = 3
The description of the ad.
optional business_name = 4
The business name in the ad.
optional allow_flexible_color = 5
Advertiser's consent to allow flexible color. When true, the ad may be served with different color if necessary. When false, the ad will be served with the specified colors or a neutral color. The default value is true. Must be true if main_color and accent_color are not set.
optional accent_color = 6
The accent color of the ad in hexadecimal, e.g. #ffffff for white. If one of main_color and accent_color is set, the other is required as well.
optional main_color = 7
The main color of the ad in hexadecimal, e.g. #ffffff for white. If one of main_color and accent_color is set, the other is required as well.
optional call_to_action_text = 8
The call-to-action text for the ad.
optional logo_image = 9
The MediaFile resource name of the logo image used in the ad.
optional square_logo_image = 10
The MediaFile resource name of the square logo image used in the ad.
optional marketing_image = 11
The MediaFile resource name of the marketing image used in the ad.
optional square_marketing_image = 12
The MediaFile resource name of the square marketing image used in the ad.
enums.DisplayAdFormatSettingEnum.DisplayAdFormatSetting format_setting = 13
Specifies which format the ad will be served in. Default is ALL_FORMATS.
optional price_prefix = 14
Prefix before price. E.g. 'as low as'.
optional promo_text = 15
Promotion text used for dyanmic formats of responsive ads. For example 'Free two-day shipping'.
message
ad_type_infos.proto:193A standard Shopping ad.
Used in:
(message has no fields)
message
ad_type_infos.proto:188A Smart Shopping ad.
Used in:
(message has no fields)
message
user_lists.proto:35SimilarUserList is a list of users which are similar to users from another UserList. These lists are read-only and automatically created by Google.
Used in:
optional seed_user_list = 1
Seed UserList from which this list is derived.
message
tag_snippet.proto:34The site tag and event snippet pair for a TrackingCodeType.
Used in:
enums.TrackingCodeTypeEnum.TrackingCodeType type = 1
The type of the generated tag snippets for tracking conversions.
enums.TrackingCodePageFormatEnum.TrackingCodePageFormat page_format = 2
The format of the web page where the tracking tag and snippet will be installed, e.g. HTML.
optional global_site_tag = 3
The site tag that adds visitors to your basic remarketing lists and sets new cookies on your domain.
optional event_snippet = 4
The event snippet that works with the site tag to track actions that should be counted as conversions.
message
bidding.proto:105An 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 target_cpa_micros = 1
Average CPA target. This target should be greater than or equal to minimum billable unit based on the currency for the account.
optional cpc_bid_ceiling_micros = 2
Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy.
optional cpc_bid_floor_micros = 3
Minimum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy.
An automated bidding strategy that sets bids based on the target fraction of auctions where the advertiser should outrank a specific competitor.
Used in:
optional target_outrank_share_micros = 1
The target fraction of auctions where the advertiser should outrank the competitor. The advertiser outranks the competitor in an auction if either the advertiser appears above the competitor in the search results, or appears in the search results when the competitor does not. Value must be between 1 and 1000000, inclusive.
optional competitor_domain = 2
Competitor's visible domain URL.
optional cpc_bid_ceiling_micros = 3
Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy.
optional only_raise_cpc_bids = 4
Whether the strategy should always follow bid estimate changes, or only increase. If false, always set a keyword's new bid to the current bid estimate. If true, only updates a keyword's bid if the current bid estimate is greater than the current bid.
optional raise_cpc_bid_when_quality_score_is_low = 5
Whether the strategy is allowed to raise bids on keywords with lower-range quality scores.
message
bidding.proto:152An automated bidding strategy that helps you maximize revenue while averaging a specific target return on ad spend (ROAS).
Used in: ,
optional target_roas = 1
Required. The desired revenue (based on conversion data) per unit of spend. Value must be between 0.01 and 1000.0, inclusive.
optional cpc_bid_ceiling_micros = 2
Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy.
optional cpc_bid_floor_micros = 3
Minimum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy.
message
bidding.proto:168An automated bid strategy that sets your bids to help get as many clicks as possible within your budget.
Used in: ,
optional target_spend_micros = 1
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.
optional cpc_bid_ceiling_micros = 2
Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy.
message
ad_type_infos.proto:35A text ad.
Used in:
optional headline = 1
The headline of the ad.
optional description1 = 2
The first line of the ad's description.
optional description2 = 3
The second line of the ad's description.
message
criteria.proto:406A topic criterion. Use 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: ,
optional topic_constant = 1
The Topic Constant resource name.
repeated path = 2
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.
message
criteria.proto:446Represents a particular interest-based topic to be targeted.
Used in: ,
optional user_interest_category = 1
The UserInterest resource name.
message
criteria.proto:341A User List criterion. Represents a user list that is defined by the advertiser to be targeted.
Used in: ,
optional user_list = 1
The User List resource name.
message
value.proto:30A generic data container.
Used in:
oneof value
A value.
bool boolean_value = 1
A boolean.
int64 int64_value = 2
An int64.
float float_value = 3
A float.
double double_value = 4
A double.
string string_value = 5
A string.
message
criteria.proto:334A YouTube Channel criterion.
Used in: , ,
optional channel_id = 1
The YouTube uploader channel id or the channel code of a YouTube channel.
message
criteria.proto:328A YouTube Video criterion.
Used in: , ,
optional video_id = 1
YouTube video id as it appears on the YouTube watch page.