package google.ads.googleads.v2.common
Get desktop application:
View/edit binary Protocol Buffers messages
message
ad_asset.proto:48An image asset used inside an ad.
Used in: , ,
optional asset = 1
The Asset resource name of this image.
message
ad_asset.proto:60A media bundle asset used inside an ad.
Used in: ,
optional asset = 1
The Asset resource name of this media bundle.
message
criteria.proto:331Represents 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
ad_asset.proto:36A text asset used inside an ad.
Used in: , , ,
optional text = 1
Asset text.
enums.ServedAssetFieldTypeEnum.ServedAssetFieldType pinned_field = 2
The pinned field of the asset. This restricts the asset to only serve within this field. Multiple assets can be pinned to the same field. An asset that is unpinned or pinned to a different field will not serve in a field where some other asset has been pinned.
message
ad_asset.proto:54A video asset used inside an ad.
Used in: , ,
optional asset = 1
The Asset resource name of this video.
message
criteria.proto:441Address 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
extensions.proto:141Represents an affiliate location extension.
Used in:
optional business_name = 1
The name of the business.
optional address_line_1 = 2
Line 1 of the business address.
optional address_line_2 = 3
Line 2 of the business address.
optional city = 4
City of the business address.
optional province = 5
Province of the business address.
optional postal_code = 6
Postal code of the business address.
optional country_code = 7
Country code of the business address.
optional phone_number = 8
Phone number of the business.
optional chain_id = 9
Id of the retail chain that is advertised as a seller of your product.
optional chain_name = 10
Name of chain.
message
criteria.proto:367An age range criterion.
Used in: ,
enums.AgeRangeTypeEnum.AgeRangeType type = 1
Type of the age range.
message
ad_type_infos.proto:432An app ad.
Used in:
optional mandatory_ad_text = 1
An optional text asset that, if specified, must always be displayed when the ad is served.
repeated headlines = 2
List of text assets for headlines. When the ad serves the headlines will be selected from this list.
repeated descriptions = 3
List of text assets for descriptions. When the ad serves the descriptions will be selected from this list.
repeated images = 4
List of image assets that may be displayed with the ad.
repeated youtube_videos = 5
List of YouTube video assets that may be displayed with the ad.
repeated html5_media_bundles = 6
List of media bundle assets that may be used with the ad.
message
ad_type_infos.proto:459App engagement ads allow you to write text encouraging a specific action in the app, like checking in, making a purchase, or booking a flight. They allow you to send users to a specific part of your app where they can find what they're looking for easier and faster.
Used in:
repeated headlines = 1
List of text assets for headlines. When the ad serves the headlines will be selected from this list.
repeated descriptions = 2
List of text assets for descriptions. When the ad serves the descriptions will be selected from this list.
repeated images = 3
List of image assets that may be displayed with the ad.
repeated videos = 4
List of video assets that may be displayed with the ad.
message
extensions.proto:44Represents an App extension.
Used in:
optional link_text = 1
The visible text displayed when the link is rendered in an ad. This string must not be empty, and the length of this string should be between 1 and 25, inclusive.
optional app_id = 2
The store-specific ID for the target application. This string must not be empty.
enums.AppStoreEnum.AppStore app_store = 3
The application store that the target application belongs to. This field is required.
repeated final_urls = 4
A list of possible final URLs after all cross domain redirects. This list must not be empty.
repeated final_mobile_urls = 5
A list of possible final mobile URLs after all cross domain redirects.
optional tracking_url_template = 6
URL template for constructing a tracking URL. Default value is "{lpurl}".
repeated url_custom_parameters = 7
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 final_url_suffix = 8
URL template for appending params to landing page URLs served with parallel tracking.
message
criteria.proto:552An app payment model criterion.
Used in:
enums.AppPaymentModelTypeEnum.AppPaymentModelType type = 1
Type of the app payment model.
message
user_lists.proto:278User list targeting as a collection of conversions or remarketing actions.
Used in:
repeated actions = 1
Actions associated with this user list.
message
simulation.proto:59Projected metrics for a specific bid modifier amount.
Used in:
optional bid_modifier = 1
The simulated bid modifier upon which projected metrics are based.
optional biddable_conversions = 2
Projected number of biddable conversions. Only search advertising channel type supports this field.
optional biddable_conversions_value = 3
Projected total value of biddable conversions. Only search advertising channel type supports this field.
optional clicks = 4
Projected number of clicks.
optional cost_micros = 5
Projected cost in micros.
optional impressions = 6
Projected number of impressions.
optional top_slot_impressions = 7
Projected number of top slot impressions. Only search advertising channel type supports this field.
optional parent_biddable_conversions = 8
Projected number of biddable conversions for the parent resource. Only search advertising channel type supports this field.
optional parent_biddable_conversions_value = 9
Projected total value of biddable conversions for the parent resource. Only search advertising channel type supports this field.
optional parent_clicks = 10
Projected number of clicks for the parent resource.
optional parent_cost_micros = 11
Projected cost in micros for the parent resource.
optional parent_impressions = 12
Projected number of impressions for the parent resource.
optional parent_top_slot_impressions = 13
Projected number of top slot impressions for the parent resource. Only search advertising channel type supports this field.
optional parent_required_budget_micros = 14
Projected minimum daily budget that must be available to the parent resource to realize this simulation.
message
simulation.proto:35A container for simulation points for simulations of type BID_MODIFIER.
Used in:
repeated points = 1
Projected metrics for a series of bid modifier amounts.
message
extensions.proto:78Represents a Call extension.
Used in: , ,
optional phone_number = 1
The advertiser's phone number to append to the ad. This string must not be empty.
optional country_code = 2
Uppercase two-letter country code of the advertiser's phone number. This string must not be empty.
optional call_tracking_enabled = 3
Indicates whether call tracking is enabled. By default, call tracking is not enabled.
optional call_conversion_action = 4
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_tracking_enabled is set to true. Otherwise this field is ignored.
optional call_conversion_tracking_disabled = 5
If true, disable call conversion tracking. call_conversion_action should not be set if this is true. Optional.
enums.CallConversionReportingStateEnum.CallConversionReportingState call_conversion_reporting_state = 6
Enum value that indicates whether this call extension uses its own call conversion setting (or just have call conversion disabled), or following the account level setting.
message
ad_type_infos.proto:77A 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 headline1 = 11
First headline in the ad.
optional headline2 = 12
Second headline 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
extensions.proto:107Represents a callout extension.
Used in: , ,
optional callout_text = 1
The callout text. The length of this string should be between 1 and 25, inclusive.
message
criteria.proto:503Represents a Carrier Criterion.
Used in:
optional carrier_constant = 1
The Carrier constant resource name.
message
click_location.proto:35Location criteria associated with a click.
Used in:
optional city = 1
The city location criterion associated with the impression.
optional country = 2
The country location criterion associated with the impression.
optional metro = 3
The metro location criterion associated with the impression.
optional most_specific = 4
The most specific location criterion associated with the impression.
optional region = 5
The region location criterion associated with the impression.
message
user_lists.proto:171User lists defined by combining two rules, left operand and right operand. There are two operators: AND where left operand and right operand have to be true; AND_NOT where left operand is true but right operand is false.
Used in:
optional left_operand = 1
Left operand of the combined rule. This field is required and must be populated when creating new combined rule based user list.
optional right_operand = 2
Right operand of the combined rule. This field is required and must be populated when creating new combined rule based user list.
enums.UserListCombinedRuleOperatorEnum.UserListCombinedRuleOperator rule_operator = 3
Operator to connect the two operands. Required for creating a combined rule user list.
message
bidding.proto:38Commission is an automatic bidding strategy in which the advertiser pays a certain portion of the conversion value.
Used in:
optional commission_rate_micros = 1
Commission rate defines the portion of the conversion value that the advertiser will be billed. A commission rate of x should be passed into this field as (x * 1,000,000). For example, 106,000 represents a commission rate of 0.106 (10.6%).
message
criteria.proto:497Content Label for category exclusion.
Used in: ,
enums.ContentLabelTypeEnum.ContentLabelType type = 1
Content label type, required for CREATE operations.
message
simulation.proto:111Projected metrics for a specific CPC bid amount.
Used in:
optional cpc_bid_micros = 1
The simulated CPC bid upon which projected metrics are based.
optional biddable_conversions = 2
Projected number of biddable conversions.
optional biddable_conversions_value = 3
Projected total value of biddable conversions.
optional clicks = 4
Projected number of clicks.
optional cost_micros = 5
Projected cost in micros.
optional impressions = 6
Projected number of impressions.
optional top_slot_impressions = 7
Projected number of top slot impressions. Only search advertising channel type supports this field.
message
simulation.proto:41A container for simulation points for simulations of type CPC_BID.
Used in: ,
repeated points = 1
Projected metrics for a series of CPC bid amounts.
message
simulation.proto:136Projected metrics for a specific CPV bid amount.
Used in:
optional cpv_bid_micros = 1
The simulated CPV bid upon which projected metrics are based.
optional cost_micros = 2
Projected cost in micros.
optional impressions = 3
Projected number of impressions.
optional views = 4
Projected number of views.
message
simulation.proto:47A container for simulation points for simulations of type CPV_BID.
Used in:
repeated points = 1
Projected metrics for a series of CPV bid amounts.
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:51UserList 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
criteria.proto:565A custom affinity criterion. A criterion of this type is only targetable.
Used in: ,
optional custom_affinity = 1
The CustomInterest resource name.
message
criteria.proto:572A custom intent criterion. A criterion of this type is only targetable.
Used in:
optional custom_intent = 1
The CustomInterest resource name.
message
custom_parameter.proto:36A 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:35A date range.
Used in: , ,
optional start_date = 1
The start date, in yyyy-mm-dd format. This date is inclusive.
optional end_date = 2
The end date, in yyyy-mm-dd format. This date is inclusive.
message
user_lists.proto:189Visitors of a page during specific dates.
Used in:
optional rule = 1
Boolean rule that defines visitor of a page. Required for creating a date specific rule user list.
optional start_date = 2
Start date of users visit. If set to 2000-01-01, then the list includes all users before end_date. The date's format should be YYYY-MM-DD. Required for creating a data specific rule user list.
optional end_date = 3
End date of users visit. If set to 2037-12-30, then the list includes all users after start_date. The date's format should be YYYY-MM-DD. Required for creating a data specific rule user list.
message
criteria.proto:111A device criterion.
Used in: , , ,
enums.DeviceEnum.Device type = 1
Type of the device.
message
ad_type_infos.proto:207Data 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.
optional url_collection_id = 3
Identifies the url collection in the ad.url_collections field. If not set the url defaults to final_url.
message
ad_type_infos.proto:568A generic type of display ad. The exact ad format is controlled by the display_upload_product_type field, which determines what kinds of data need to be included with the ad.
Used in:
enums.DisplayUploadProductTypeEnum.DisplayUploadProductType display_upload_product_type = 1
The product type of this ad. See comments on the enum for details.
oneof media_asset
The asset data that makes up the ad.
media_bundle = 2
A media bundle asset to be used in the ad. For information about the media bundle for HTML5_UPLOAD_AD see https://support.google.com/google-ads/answer/1722096 Media bundles that are part of dynamic product types use a special format that needs to be created through the Google Web Designer. See https://support.google.com/webdesigner/answer/7543898 for more information.
message
bidding.proto:49An 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:123An expanded dynamic search ad.
Used in:
optional description = 1
The description of the ad.
optional description2 = 2
The second description of the ad.
message
ad_type_infos.proto:53An 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 Display Campaign Optimizer, initially named "Explorer". Learn more about [automatic targeting](https://support.google.com/google-ads/answer/190596).
Used in:
optional opt_in = 1
Indicates whether the optimizer is turned on.
message
user_lists.proto:209Visitors of a page. The page visit is defined by one boolean rule expression.
Used in:
optional rule = 1
Boolean rule that defines this user list. The rule consists of a list of rule item groups and each rule item group consists of a list of rule items. All the rule item groups are ORed or ANDed together for evaluation based on rule.rule_type. Required for creating an expression rule user list.
message
final_app_url.proto:36A URL for deep linking into an app for the given operating system.
Used in:
enums.AppUrlOperatingSystemTypeEnum.AppUrlOperatingSystemType os_type = 1
The operating system targeted by this URL. Required.
optional url = 2
The app deep link URL. Deep links specify a location in an app that corresponds to the content you'd like to show, and should be of the form {scheme}://{host_path} The scheme identifies which app to open. For your app, you can use a custom scheme that starts with the app's name. The host and path specify the unique location in the app where your content exists. Example: "exampleapp://productid_1234". Required.
message
frequency_cap.proto:39A 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:50A 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:373A gender criterion.
Used in: , , ,
enums.GenderTypeEnum.GenderType type = 1
Type of the gender.
message
criteria.proto:432Geo 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:154A 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.
repeated product_images = 7
Product images. Up to 15 images are supported.
repeated product_videos = 8
Product videos. Up to 7 videos are supported. At least one product video or a marketing image must be specified.
message
ad_type_infos.proto:188Gmail 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:132A hotel ad.
Used in:
(message has no fields)
message
criteria.proto:296Criterion 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
extensions.proto:350Represents a hotel callout extension.
Used in:
optional text = 1
The callout text. The length of this string should be between 1 and 25, inclusive.
optional language_code = 2
The language of the hotel callout text. IETF BCP 47 compliant language code.
message
criteria.proto:314Criterion 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:221City the hotel is located in.
Used in:
optional city_criterion = 1
The Geo Target Constant resource name.
message
criteria.proto:203Class 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:209Country or Region the hotel is located in.
Used in:
optional country_region_criterion = 1
The Geo Target Constant resource name.
message
criteria.proto:290Criterion 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:197Advertiser-specific hotel ID.
Used in:
optional value = 1
String value of the hotel ID.
message
criteria.proto:305Criterion 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:215State the hotel is located in.
Used in:
optional state_criterion = 1
The Geo Target Constant resource name.
message
ad_type_infos.proto:241An 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.
ad_id_to_copy_image_from = 3
An ad ID to copy the image from.
message
asset_types.proto:52An Image asset.
Used in:
optional data = 1
The raw bytes data of an image. This field is mutate only.
optional file_size = 2
File size of the image asset in bytes.
enums.MimeTypeEnum.MimeType mime_type = 3
MIME type of the image asset.
optional full_size = 4
Metadata for this image at its original size.
message
asset_types.proto:67Metadata for an image at a certain size, either original or resized.
Used in:
optional height_pixels = 1
Height of the image.
optional width_pixels = 2
Width of the image.
optional url = 3
A URL that returns the image with this height and width.
message
criteria.proto:379An income range criterion.
Used in: ,
enums.IncomeRangeTypeEnum.IncomeRangeType type = 1
Type of the income range.
message
criteria.proto:320Criterion for Interaction Type.
Used in:
enums.InteractionTypeEnum.InteractionType type = 1
The interaction type.
message
criteria.proto:491An 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
segments.proto:308A Keyword criterion segment.
Used in:
optional ad_group_criterion = 1
The AdGroupCriterion resource name.
optional info = 2
Keyword info.
message
criteria.proto:59A 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:36Historical 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:481A language criterion.
Used in:
optional language_constant = 1
The language constant resource name.
message
ad_type_infos.proto:476A legacy app install ad that only can be used by a few select customers.
Used in:
optional app_id = 1
The id of the mobile app.
enums.LegacyAppInstallAdAppStoreEnum.LegacyAppInstallAdAppStore app_store = 2
The app store the mobile app is available in.
optional headline = 3
The headline of the ad.
optional description1 = 4
The first description line of the ad.
optional description2 = 5
The second description line of the ad.
message
ad_type_infos.proto:375A legacy responsive display ad. Ads of this type are labeled 'Responsive ads' in the Google Ads UI.
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
criteria.proto:191Brand of the listing.
Used in:
optional value = 1
String value of the listing brand.
message
criteria.proto:227Listing 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:143Listing 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_bidding_category = 13
Bidding category of a product offer.
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_item_id = 11
Item id of a product offer.
product_type = 12
Type of a product offer.
unknown_listing_dimension = 14
Unknown dimension. Set when no other listing dimension is set.
message
criteria.proto:123A 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:137A listing scope criterion.
Used in:
repeated dimensions = 2
Scope of the campaign criterion.
message
extensions.proto:114Represents a location extension.
Used in:
optional business_name = 1
The name of the business.
optional address_line_1 = 2
Line 1 of the business address.
optional address_line_2 = 3
Line 2 of the business address.
optional city = 4
City of the business address.
optional province = 5
Province of the business address.
optional postal_code = 6
Postal code of the business address.
optional country_code = 7
Country code of the business address.
optional phone_number = 8
Phone number of the business.
message
criteria.proto:578A radius around a list of locations specified via a feed.
Used in:
optional feed = 1
Feed specifying locations for targeting. This is required and must be set in CREATE operations.
repeated geo_target_constants = 2
Geo target constant(s) restricting the scope of the geographic area within the feed. Currently only one geo target constant is allowed.
optional radius = 3
Distance in units specifying the radius around targeted locations. This is required and must be set in CREATE operations.
enums.LocationGroupRadiusUnitsEnum.LocationGroupRadiusUnits radius_units = 4
Unit of the radius, miles and meters supported currently. This is required and must be set in CREATE operations.
message
criteria.proto:105A location criterion.
Used in:
optional geo_target_constant = 1
The geo target constant resource name.
message
user_lists.proto:252Represents a user list that is a custom combination of user lists.
Used in:
repeated rules = 1
Logical list rules that define this user list. The rules are defined as a logical operator (ALL/ANY/NONE) and a list of user lists. All the rules are ANDed when they are evaluated. Required for creating a logical user list.
message
user_lists.proto:272Operand of logical user list that consists of a user list.
Used in:
optional user_list = 1
Resource name of a user list as an operand.
message
bidding.proto:54Manual 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:60Manual impression-based bidding where user pays per thousand impressions.
Used in:
(message has no fields)
message
bidding.proto:65View based bidding where user pays per video view.
Used in:
(message has no fields)
message
matching_function.proto:39Matching 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 no feed items served. 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")) For more details, visit 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.
enums.MatchingFunctionOperatorEnum.MatchingFunctionOperator operator = 4
Operator for a function.
repeated left_operands = 2
The operands on the left hand side of the equation. This is also the operand to be used for single operand expressions such as NOT.
repeated right_operands = 3
The operands on the right hand side of the equation.
message
bidding.proto:77An 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:71An 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
asset_types.proto:43A MediaBundle asset.
Used in:
optional data = 1
Media bundle (ZIP file) asset data. The format of the uploaded ZIP file depends on the ad field where it will be used. For more information on the format, see the documentation of the ad field where you plan on using the MediaBundleAsset. This field is mutate only.
message
metrics.proto:37Metrics data.
Used in:
optional absolute_top_impression_percentage = 95
The percent of your ad impressions that are shown as the very first ad above the organic search results.
optional active_view_cpm = 1
Average cost of viewable impressions (`active_view_impressions`).
optional active_view_ctr = 79
Active view measurable clicks divided by active view viewable impressions. This metric is reported only for display network.
optional active_view_impressions = 2
A measurement of how often your ad has become viewable on a Display Network site.
optional active_view_measurability = 96
The ratio of impressions that could be measured by Active View over the number of served impressions.
optional active_view_measurable_cost_micros = 3
The cost of the impressions you received that were measurable by Active View.
optional active_view_measurable_impressions = 4
The number of times your ads are appearing on placements in positions where they can be seen.
optional active_view_viewability = 97
The percentage of time when your ad appeared on an Active View enabled site (measurable impressions) and was viewable (viewable impressions).
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 only includes conversion actions which include_in_conversions_metric attribute is set to true.
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_click_to_call = 118
The number of times people clicked the "Call" button to call a store during or after clicking an ad. This number doesn't include whether or not calls were connected, or the duration of any calls. This metric applies to feed items only.
optional all_conversions_from_directions = 119
The number of times people clicked a "Get directions" button to navigate to a store after clicking an ad. This metric applies to feed items only.
optional all_conversions_from_interactions_value_per_interaction = 67
The value of all conversions from interactions divided by the total number of interactions.
optional all_conversions_from_menu = 120
The number of times people clicked a link to view a store's menu after clicking an ad. This metric applies to feed items only.
optional all_conversions_from_order = 121
The number of times people placed an order at a store after clicking an ad. This metric applies to feed items only.
optional all_conversions_from_other_engagement = 122
The number of other conversions (for example, posting a review or saving a location for a store) that occurred after people clicked an ad. This metric applies to feed items only.
optional all_conversions_from_store_visit = 123
Estimated number of times people visited a store after clicking an ad. This metric applies to feed items only.
optional all_conversions_from_store_website = 124
The number of times that people were taken to a store's URL after clicking an ad. This metric applies to feed items only.
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_cpe = 98
The average amount that you've been charged for an ad engagement. This amount is the total cost of all ad engagements divided by the total number of ad engagements.
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_page_views = 99
Average number of pages viewed per session.
optional average_time_on_site = 84
Total duration of all sessions (in seconds) / number of sessions. Imported from Google Analytics.
optional benchmark_average_max_cpc = 14
An indication of how other advertisers are bidding on similar products.
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 combined_clicks = 115
The number of times your ad or your site's listing in the unpaid results was clicked. See the help page at https://support.google.com/google-ads/answer/3097241 for details.
optional combined_clicks_per_query = 116
The number of times your ad or your site's listing in the unpaid results was clicked (combined_clicks) divided by combined_queries. See the help page at https://support.google.com/google-ads/answer/3097241 for details.
optional combined_queries = 117
The number of searches that returned pages from your site in the unpaid results or showed one of your text ads. See the help page at https://support.google.com/google-ads/answer/3097241 for details.
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). This only includes conversion actions which include_in_conversions_metric attribute is set to true.
optional conversions_value = 70
The total value of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true.
optional conversions_value_per_cost = 71
The value of conversions divided by the cost of ad interactions. This only includes conversion actions which include_in_conversions_metric attribute is set to true.
optional conversions_from_interactions_value_per_interaction = 72
The value of conversions from interactions divided by the number of ad interactions. This only includes conversion actions which include_in_conversions_metric attribute is set to true.
optional conversions = 25
The number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true.
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. This only includes conversion actions which include_in_conversions_metric attribute is set to true.
optional cost_per_current_model_attributed_conversion = 106
The cost of ad interactions divided by current model attributed conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true.
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 current_model_attributed_conversions = 101
Shows how your historic conversions data would look under the attribution model you've currently selected. This only includes conversion actions which include_in_conversions_metric attribute is set to true.
optional current_model_attributed_conversions_from_interactions_rate = 102
Current model attributed conversions from interactions divided by the number of ad interactions (such as clicks for text ads or views for video ads). This only includes conversion actions which include_in_conversions_metric attribute is set to true.
optional current_model_attributed_conversions_from_interactions_value_per_interaction = 103
The value of current model attributed conversions from interactions divided by the number of ad interactions. This only includes conversion actions which include_in_conversions_metric attribute is set to true.
optional current_model_attributed_conversions_value = 104
The total value of current model attributed conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true.
optional current_model_attributed_conversions_value_per_cost = 105
The value of current model attributed conversions divided by the cost of ad interactions. This only includes conversion actions which include_in_conversions_metric attribute is set to true.
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 hotel_price_difference_percentage = 129
The average price difference between the price offered by reporting hotel advertiser and the cheapest price offered by the competing advertiser.
enums.QualityScoreBucketEnum.QualityScoreBucket historical_creative_quality_score = 80
The creative historical quality score.
enums.QualityScoreBucketEnum.QualityScoreBucket historical_landing_page_quality_score = 81
The quality of historical landing page experience.
optional historical_quality_score = 82
The historical quality score.
enums.QualityScoreBucketEnum.QualityScoreBucket historical_search_predicted_ctr = 83
The historical search predicted click through rate (CTR).
optional gmail_forwards = 85
The number of times the ad was forwarded to someone else as a message.
optional gmail_saves = 86
The number of times someone has saved your Gmail ad to their inbox as a message.
optional gmail_secondary_clicks = 87
The number of clicks to the landing page on the expanded state of Gmail ads.
optional impressions_from_store_reach = 125
The number of times a store's location-based ad was shown. This metric applies to feed items only.
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.
repeated enums.InteractionEventTypeEnum.InteractionEventType interaction_event_types = 100
The types of payable and free interactions.
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 message_chats = 126
Number of message chats initiated for Click To Message impressions that were message tracking eligible.
optional message_impressions = 127
Number of Click To Message impressions that were message tracking eligible.
optional message_chat_rate = 128
Number of message chats initiated (message_chats) divided by the number of message impressions (message_impressions). Rate at which a user initiates a message chat from an ad impression with a messaging option and message tracking enabled. Note that this rate can be more than 1.0 for a given message impression.
optional mobile_friendly_clicks_percentage = 109
The percentage of mobile clicks that go to a mobile-friendly page.
optional organic_clicks = 110
The number of times someone clicked your site's listing in the unpaid results for a particular query. See the help page at https://support.google.com/google-ads/answer/3097241 for details.
optional organic_clicks_per_query = 111
The number of times someone clicked your site's listing in the unpaid results (organic_clicks) divided by the total number of searches that returned pages from your site (organic_queries). See the help page at https://support.google.com/google-ads/answer/3097241 for details.
optional organic_impressions = 112
The number of listings for your site in the unpaid search results. See the help page at https://support.google.com/google-ads/answer/3097241 for details.
optional organic_impressions_per_query = 113
The number of times a page from your site was listed in the unpaid search results (organic_impressions) divided by the number of searches returning your site's listing in the unpaid results (organic_queries). See the help page at https://support.google.com/google-ads/answer/3097241 for details.
optional organic_queries = 114
The total number of searches that returned your site's listing in the unpaid results. See the help page at https://support.google.com/google-ads/answer/3097241 for details.
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 or Search ad impressions that are shown in the most prominent Shopping position. See [this article](https://support.google.com/google-ads/answer/7501826) for details. Any value below 0.1 is reported as 0.0999.
optional search_budget_lost_absolute_top_impression_share = 88
The number estimating how often your ad wasn't the very first ad above the organic search results due to a low budget. Note: Search budget lost absolute top impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001.
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_budget_lost_top_impression_share = 89
The number estimating how often your ad didn't show anywhere above the organic search results due to a low budget. Note: Search budget lost top impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001.
optional search_click_share = 48
The number of clicks you've received on the Search Network divided by the estimated number of clicks you were eligible to receive. Note: Search click share is reported in the range of 0.1 to 1. Any value below 0.1 is reported as 0.0999.
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_absolute_top_impression_share = 90
The number estimating how often your ad wasn't the very first ad above the organic search results due to poor Ad Rank. Note: Search rank lost absolute top impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001.
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 search_rank_lost_top_impression_share = 91
The number estimating how often your ad didn't show anywhere above the organic search results due to poor Ad Rank. Note: Search rank lost top impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001.
optional search_top_impression_share = 92
The impressions you've received in the top location (anywhere above the organic search results) compared to the estimated number of impressions you were eligible to receive in the top location. Note: Search top impression share is reported in the range of 0.1 to 1. Any value below 0.1 is reported as 0.0999.
optional speed_score = 107
A measure of how quickly your page loads after clicks on your mobile ads. The score is a range from 1 to 10, 10 being the fastest.
optional top_impression_percentage = 93
The percent of your ad impressions that are shown anywhere above the organic search results.
optional valid_accelerated_mobile_pages_clicks_percentage = 108
The percentage of ad clicks to Accelerated Mobile Pages (AMP) landing pages that reach a valid AMP page.
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. This only includes conversion actions which include_in_conversions_metric attribute is set to true.
optional value_per_current_model_attributed_conversion = 94
The value of current model attributed conversions divided by the number of the conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true.
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
criteria.proto:77A mobile app category criterion.
Used in: , , ,
optional mobile_app_category_constant = 1
The mobile app category constant resource name.
message
criteria.proto:83A mobile application criterion.
Used in: , , ,
optional app_id = 2
A string that uniquely identifies a mobile application to Google Ads API. The format of this string is "{platform}-{platform_native_id}", where platform is "1" for iOS apps and "2" for Android apps, and where platform_native_id is the mobile application identifier native to the corresponding platform. For iOS, this native identifier 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, this native identifier 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). A well formed app id for Google Ads API would thus be "1-476943146" for iOS and "2-com.labpixies.colordrips" for Android. This field is required and must be set in CREATE operations.
optional name = 3
Name of this mobile application.
message
criteria.proto:558A mobile device criterion.
Used in:
optional mobile_device_constant = 1
The mobile device constant resource name.
message
feed_common.proto:35Represents 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
matching_function.proto:71An operand in a matching function.
Used in:
oneof function_argument_operand
Different operands that can be used in a matching function. Required.
constant_operand = 1
A constant operand in a matching function.
feed_attribute_operand = 2
This operand specifies a feed attribute in feed.
function_operand = 3
A function operand in a matching function. Used to represent nested functions.
request_context_operand = 4
An operand in a function referring to a value in the request context.
message
matching_function.proto:73A constant operand in a matching function.
Used in:
oneof constant_operand_value
Constant operand values. Required.
string_value = 1
String value of the operand if it is a string type.
long_value = 2
Int64 value of the operand if it is a int64 type.
boolean_value = 3
Boolean value of the operand if it is a boolean type.
double_value = 4
Double value of the operand if it is a double type.
message
matching_function.proto:92A feed attribute operand in a matching function. Used to represent a feed attribute in feed.
Used in:
optional feed_id = 1
The associated feed. Required.
optional feed_attribute_id = 2
Id of the referenced feed attribute. Required.
message
matching_function.proto:102A function operand in a matching function. Used to represent nested functions.
Used in:
optional matching_function = 1
The matching function held in this operand.
message
matching_function.proto:108An operand in a function referring to a value in the request context.
Used in:
enums.MatchingFunctionContextTypeEnum.MatchingFunctionContextType context_type = 1
Type of value to be referred in the request context.
message
criteria.proto:546Represents an operating system version to be targeted.
Used in:
optional operating_system_version_constant = 1
The operating system version constant resource name.
message
bidding.proto:89An automated bidding strategy which sets CPC bids to target impressions on page one, or page one promoted slots on google.com. This strategy is deprecated.
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:385A parental status criterion.
Used in: ,
enums.ParentalStatusTypeEnum.ParentalStatusType type = 1
Type of the parental status.
message
bidding.proto:222A 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:69A 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:185Describes the effect on serving that a policy topic entry will have.
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:203Indicates that a resource's ability to serve in a particular country is constrained.
Used in:
optional country_criterion = 1
Geo target constant resource name of the country in which serving is constrained.
message
policy.proto:187A list of countries where a resource's serving is constrained.
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:197Indicates that a policy topic was constrained due to disapproval of the website for reseller purposes.
Used in:
(message has no fields)
message
policy.proto:86Policy 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.
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:106Additional information that explains a policy finding.
Used in:
oneof value
Specific evidence information depending on the evidence type.
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.
destination_not_working = 8
Details when the destination is returning an HTTP error code or isn't functional in all locations for commonly used devices.
message
policy.proto:130Evidence of mismatches between the URLs of a resource.
Used in:
repeated enums.PolicyTopicEvidenceDestinationMismatchUrlTypeEnum.PolicyTopicEvidenceDestinationMismatchUrlType url_types = 1
The set of URLs that did not match each other.
message
policy.proto:137Evidence details when the destination is returning an HTTP error code or isn't functional in all locations for commonly used devices.
Used in:
optional expanded_url = 3
The full URL that didn't work.
enums.PolicyTopicEvidenceDestinationNotWorkingDeviceEnum.PolicyTopicEvidenceDestinationNotWorkingDevice device = 4
The type of device that failed to load the URL.
optional last_checked_date_time = 5
The time the URL was last checked. The format is "YYYY-MM-DD HH:MM:SS". Examples: "2018-03-05 09:15:00" or "2018-02-01 14:34:30"
oneof reason
Indicates the reason of the DESTINATION_NOT_WORKING policy finding.
enums.PolicyTopicEvidenceDestinationNotWorkingDnsErrorTypeEnum.PolicyTopicEvidenceDestinationNotWorkingDnsErrorType dns_error_type = 1
The type of DNS error.
http_error_code = 2
The HTTP error code.
message
policy.proto:124A list of strings found in a destination page that caused a policy finding.
Used in:
repeated destination_texts = 1
List of text found in the resource's destination page.
message
policy.proto:108A list of fragments of text that violated a policy.
Used in:
repeated texts = 1
The fragments of text from the resource that caused the policy finding.
message
policy.proto:117A 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.
Used in:
repeated websites = 1
Websites that caused the policy finding.
message
policy.proto:55Parameter for controlling how policy exemption is done. Ignorable policy topics are only usable with expanded text ads and responsive search ads. All other ad types must use policy violation keys.
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.
repeated exempt_policy_violation_keys = 2
The list of policy violation keys that should not cause a PolicyViolationError to be reported. Not all policy violations are exemptable, please refer to the is_exemptible field in the returned PolicyViolationError. Resources violating these polices 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:40Key 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:117A preferred content criterion.
Used in:
enums.PreferredContentTypeEnum.PreferredContentType type = 2
Type of the preferred content.
message
extensions.proto:196Represents a Price extension.
Used in:
enums.PriceExtensionTypeEnum.PriceExtensionType type = 1
Price extension type of this extension.
enums.PriceExtensionPriceQualifierEnum.PriceExtensionPriceQualifier price_qualifier = 2
Price qualifier for all offers of this price extension.
optional tracking_url_template = 3
Tracking URL template for all offers of this price extension.
optional language_code = 4
The code of the language used for this price extension.
repeated price_offerings = 5
The price offerings in this price extension.
optional final_url_suffix = 6
URL template for appending params to landing page URLs served with parallel tracking.
message
extensions.proto:218Represents one price offer in a price extension.
Used in:
optional header = 1
Header text of this offer.
optional description = 2
Description text of this offer.
optional price = 3
Price value of this offer.
enums.PriceExtensionPriceUnitEnum.PriceExtensionPriceUnit unit = 4
Price unit for this offer.
repeated final_urls = 5
A list of possible final URLs after all cross domain redirects.
repeated final_mobile_urls = 6
A list of possible final mobile URLs after all cross domain redirects.
message
criteria.proto:236Bidding category of a product offer.
Used in:
optional id = 1
ID of the product bidding category. This ID is equivalent to the google_product_category ID as described in this article: https://support.google.com/merchants/answer/6324436.
optional country_code = 2
Two-letter upper-case country code of the product bidding category. It must match the campaign.shopping_setting.sales_country field.
enums.ProductBiddingCategoryLevelEnum.ProductBiddingCategoryLevel level = 3
Level of the product bidding category.
message
criteria.proto:258Availability of a product offer.
Used in:
enums.ProductChannelExclusivityEnum.ProductChannelExclusivity channel_exclusivity = 1
Value of the availability.
message
criteria.proto:252Locality of a product offer.
Used in:
enums.ProductChannelEnum.ProductChannel channel = 1
Value of the locality.
message
criteria.proto:264Condition of a product offer.
Used in:
enums.ProductConditionEnum.ProductCondition condition = 1
Value of the condition.
message
ad_type_infos.proto:221Product image specific data.
Used in:
optional product_image = 1
The MediaFile resource name of the product image. Valid image types are GIF, JPEG and PNG. The minimum size is 300x300 pixels and the aspect ratio must be 1:1 (+-1%).
optional description = 2
Description of the product.
optional display_call_to_action = 3
Display-call-to-action of the product image.
message
criteria.proto:270Item id of a product offer.
Used in:
optional value = 1
Value of the id.
message
criteria.proto:276Type of a product offer.
Used in:
optional value = 1
Value of the type.
enums.ProductTypeLevelEnum.ProductTypeLevel level = 2
Level of the type.
message
ad_type_infos.proto:235Product video specific data.
Used in:
optional product_video = 1
The MediaFile resource name of a video which must be hosted on YouTube.
message
extensions.proto:239Represents a Promotion extension.
Used in:
optional promotion_target = 1
A freeform description of what the promotion is targeting. This field is required.
enums.PromotionExtensionDiscountModifierEnum.PromotionExtensionDiscountModifier discount_modifier = 2
Enum that modifies the qualification of the discount.
optional promotion_start_date = 7
Start date of when the promotion is eligible to be redeemed.
optional promotion_end_date = 8
End date of when the promotion is eligible to be redeemed.
enums.PromotionExtensionOccasionEnum.PromotionExtensionOccasion occasion = 9
The occasion the promotion was intended for. If an occasion is set, the redemption window will need to fall within the date range associated with the occasion.
repeated final_urls = 10
A list of possible final URLs after all cross domain redirects. This field is required.
repeated final_mobile_urls = 11
A list of possible final mobile URLs after all cross domain redirects.
optional tracking_url_template = 12
URL template for constructing a tracking URL.
repeated url_custom_parameters = 13
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 final_url_suffix = 14
URL template for appending params to landing page URLs served with parallel tracking.
optional language_code = 15
The language of the promotion. Represented as BCP 47 language tag.
oneof discount_type
Discount type, can be percentage off or amount off.
percent_off = 3
Percentage off discount in the promotion in micros. One million is equivalent to one percent. Either this or money_off_amount is required.
money_amount_off = 4
Money amount off for discount in the promotion. Either this or percent_off is required.
oneof promotion_trigger
Promotion trigger. Can be by promotion code or promo by eligible order amount.
promotion_code = 5
A code the user should use in order to be eligible for the promotion.
orders_over_amount = 6
The amount the total order needs to be for the user to be eligible for the promotion.
message
criteria.proto:417A 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:494A responsive display ad.
Used in:
repeated marketing_images = 1
Marketing images to be used in the ad. Valid image types are GIF, JPEG, and PNG. The minimum size is 600x314 and the aspect ratio must be 1.91:1 (+-1%). At least one marketing_image is required. Combined with square_marketing_images the maximum is 15.
repeated square_marketing_images = 2
Square marketing images to be used in the ad. Valid image types are GIF, JPEG, and PNG. The minimum size is 300x300 and the aspect ratio must be 1:1 (+-1%). At least one square marketing_image is required. Combined with marketing_images the maximum is 15.
repeated logo_images = 3
Logo images to be used in the ad. Valid image types are GIF, JPEG, and PNG. The minimum size is 512x128 and the aspect ratio must be 4:1 (+-1%). Combined with square_logo_images the maximum is 5.
repeated square_logo_images = 4
Square logo images to be used in the ad. Valid image types are GIF, JPEG, and PNG. The minimum size is 128x128 and the aspect ratio must be 1:1 (+-1%). Combined with square_logo_images the maximum is 5.
repeated headlines = 5
Short format headlines for the ad. The maximum length is 30 characters. At least 1 and max 5 headlines can be specified.
optional long_headline = 6
A required long format headline. The maximum length is 90 characters.
repeated descriptions = 7
Descriptive texts for the ad. The maximum length is 90 characters. At least 1 and max 5 headlines can be specified.
repeated youtube_videos = 8
Optional YouTube vidoes for the ad. A maximum of 5 videos can be specified.
optional business_name = 9
The advertiser/brand name. Maximum display width is 25.
optional main_color = 10
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 accent_color = 11
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 allow_flexible_color = 12
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 call_to_action_text = 13
The call-to-action text for the ad. Maximum display width is 30.
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'.
enums.DisplayAdFormatSettingEnum.DisplayAdFormatSetting format_setting = 16
Specifies which format the ad will be served in. Default is ALL_FORMATS.
message
ad_type_infos.proto:356A responsive search ad. Responsive search ads let you create an ad that adapts to show more text, and more relevant messages, to your customers. Enter multiple headlines and descriptions when creating a responsive search ad, and over time, Google Ads will automatically test different combinations and learn which combinations perform best. By adapting your ad's content to more closely match potential customers' search terms, responsive search ads may improve your campaign's performance. More information at https://support.google.com/google-ads/answer/7684791
Used in:
repeated headlines = 1
List of text assets for headlines. When the ad serves the headlines will be selected from this list.
repeated descriptions = 2
List of text assets for descriptions. When the ad serves the descriptions will be selected from this list.
optional path1 = 3
First part of text that may appear appended to the url displayed in the ad.
optional path2 = 4
Second part of text that may appear appended to the url displayed in the ad. This field can only be set when path1 is also set.
message
user_lists.proto:220Representation of a userlist that is generated by a rule.
Used in:
enums.UserListPrepopulationStatusEnum.UserListPrepopulationStatus prepopulation_status = 1
The status of pre-population. The field is default to NONE if not set which means the previous users will not be considered. If set to REQUESTED, past site visitors or app users who match the list definition will be included in the list (works on the Display Network only). This will only add past users from within the last 30 days, depending on the list's membership duration and the date when the remarketing tag is added. The status will be updated to FINISHED once request is processed, or FAILED if the request fails.
oneof rule_based_user_list
Subtypes of rule based user lists.
combined_rule_user_list = 2
User lists defined by combining two rules. There are two operators: AND, where the left and right operands have to be true; AND_NOT where left operand is true but right operand is false.
date_specific_rule_user_list = 3
Visitors of a page during specific dates. The visiting periods are defined as follows: Between start_date (inclusive) and end_date (inclusive); Before end_date (exclusive) with start_date = 2000-01-01; After start_date (exclusive) with end_date = 2037-12-30.
expression_rule_user_list = 4
Visitors of a page. The page visit is defined by one boolean rule expression.
message
segments.proto:56Segment only fields.
Used in:
enums.AdNetworkTypeEnum.AdNetworkType ad_network_type = 3
Ad network type.
enums.ClickTypeEnum.ClickType click_type = 26
Click type.
optional conversion_action = 52
Resource name of the conversion action.
enums.ConversionActionCategoryEnum.ConversionActionCategory conversion_action_category = 53
Conversion action category.
optional conversion_action_name = 54
Conversion action name.
optional conversion_adjustment = 27
This segments your conversion columns by the original conversion and conversion value vs. the delta if conversions were adjusted. False row has the data as originally stated; While true row has the delta between data now and the data as originally stated. Summing the two together results post-adjustment data.
enums.ConversionAttributionEventTypeEnum.ConversionAttributionEventType conversion_attribution_event_type = 2
Conversion attribution event type.
enums.ConversionLagBucketEnum.ConversionLagBucket conversion_lag_bucket = 50
An enum value representing the number of days between the impression and the conversion.
enums.ConversionOrAdjustmentLagBucketEnum.ConversionOrAdjustmentLagBucket conversion_or_adjustment_lag_bucket = 51
An enum value representing the number of days between the impression and the conversion or between the impression and adjustments to the conversion.
optional date = 4
Date to which metrics apply. yyyy-MM-dd format, e.g., 2018-04-17.
enums.DayOfWeekEnum.DayOfWeek day_of_week = 5
Day of the week, e.g., MONDAY.
enums.DeviceEnum.Device device = 1
Device to which metrics apply.
enums.ExternalConversionSourceEnum.ExternalConversionSource external_conversion_source = 55
External conversion source.
optional geo_target_airport = 65
Resource name of the geo target constant that represents an airport.
optional geo_target_canton = 76
Resource name of the geo target constant that represents a canton.
optional geo_target_city = 62
Resource name of the geo target constant that represents a city.
optional geo_target_country = 77
Resource name of the geo target constant that represents a country.
optional geo_target_county = 68
Resource name of the geo target constant that represents a county.
optional geo_target_district = 69
Resource name of the geo target constant that represents a district.
optional geo_target_metro = 63
Resource name of the geo target constant that represents a metro.
optional geo_target_most_specific_location = 72
Resource name of the geo target constant that represents the most specific location.
optional geo_target_postal_code = 71
Resource name of the geo target constant that represents a postal code.
optional geo_target_province = 75
Resource name of the geo target constant that represents a province.
optional geo_target_region = 64
Resource name of the geo target constant that represents a region.
optional geo_target_state = 67
Resource name of the geo target constant that represents a state.
optional hotel_booking_window_days = 6
Hotel booking window in days.
optional hotel_center_id = 7
Hotel center ID.
optional hotel_check_in_date = 8
Hotel check-in date. Formatted as yyyy-MM-dd.
enums.DayOfWeekEnum.DayOfWeek hotel_check_in_day_of_week = 9
Hotel check-in day of week.
optional hotel_city = 10
Hotel city.
optional hotel_class = 11
Hotel class.
optional hotel_country = 12
Hotel country.
enums.HotelDateSelectionTypeEnum.HotelDateSelectionType hotel_date_selection_type = 13
Hotel date selection type.
optional hotel_length_of_stay = 14
Hotel length of stay.
optional hotel_rate_rule_id = 73
Hotel rate rule ID.
enums.HotelRateTypeEnum.HotelRateType hotel_rate_type = 74
Hotel rate type.
enums.HotelPriceBucketEnum.HotelPriceBucket hotel_price_bucket = 78
Hotel price bucket.
optional hotel_state = 15
Hotel state.
optional hour = 16
Hour of day as a number between 0 and 23, inclusive.
optional interaction_on_this_extension = 49
Only used with feed item metrics. Indicates whether the interaction metrics occurred on the feed item itself or a different extension or ad unit.
optional keyword = 61
Keyword criterion.
optional month = 17
Month as represented by the date of the first day of a month. Formatted as yyyy-MM-dd.
enums.MonthOfYearEnum.MonthOfYear month_of_year = 18
Month of the year, e.g., January.
optional partner_hotel_id = 19
Partner hotel ID.
enums.PlaceholderTypeEnum.PlaceholderType placeholder_type = 20
Placeholder type. This is only used with feed item metrics.
optional product_aggregator_id = 28
Aggregator ID of the product.
optional product_bidding_category_level1 = 56
Bidding category (level 1) of the product.
optional product_bidding_category_level2 = 57
Bidding category (level 2) of the product.
optional product_bidding_category_level3 = 58
Bidding category (level 3) of the product.
optional product_bidding_category_level4 = 59
Bidding category (level 4) of the product.
optional product_bidding_category_level5 = 60
Bidding category (level 5) of the product.
optional product_brand = 29
Brand of the product.
enums.ProductChannelEnum.ProductChannel product_channel = 30
Channel of the product.
enums.ProductChannelExclusivityEnum.ProductChannelExclusivity product_channel_exclusivity = 31
Channel exclusivity of the product.
enums.ProductConditionEnum.ProductCondition product_condition = 32
Condition of the product.
optional product_country = 33
Resource name of the geo target constant for the country of sale of the product.
optional product_custom_attribute0 = 34
Custom attribute 0 of the product.
optional product_custom_attribute1 = 35
Custom attribute 1 of the product.
optional product_custom_attribute2 = 36
Custom attribute 2 of the product.
optional product_custom_attribute3 = 37
Custom attribute 3 of the product.
optional product_custom_attribute4 = 38
Custom attribute 4 of the product.
optional product_item_id = 39
Item ID of the product.
optional product_language = 40
Resource name of the language constant for the language of the product.
optional product_merchant_id = 41
Merchant ID of the product.
optional product_store_id = 42
Store ID of the product.
optional product_title = 43
Title of the product.
optional product_type_l1 = 44
Type (level 1) of the product.
optional product_type_l2 = 45
Type (level 2) of the product.
optional product_type_l3 = 46
Type (level 3) of the product.
optional product_type_l4 = 47
Type (level 4) of the product.
optional product_type_l5 = 48
Type (level 5) of the product.
optional quarter = 21
Quarter as represented by the date of the first day of a quarter. Uses the calendar year for quarters, e.g., the second quarter of 2018 starts on 2018-04-01. Formatted as yyyy-MM-dd.
enums.SearchEngineResultsPageTypeEnum.SearchEngineResultsPageType search_engine_results_page_type = 70
Type of the search engine results page.
enums.SearchTermMatchTypeEnum.SearchTermMatchType search_term_match_type = 22
Match type of the keyword that triggered the ad, including variants.
enums.SlotEnum.Slot slot = 23
Position of the ad.
optional webpage = 66
Resource name of the ad group criterion that represents webpage criterion.
optional week = 24
Week as defined as Monday through Sunday, and represented by the date of Monday. Formatted as yyyy-MM-dd.
optional year = 25
Year, formatted as yyyy.
message
ad_type_infos.proto:147A Shopping Comparison Listing ad.
Used in:
optional headline = 1
Headline of the ad. This field is required. Allowed length is between 25 and 45 characters.
message
ad_type_infos.proto:142A standard Shopping ad.
Used in:
(message has no fields)
message
ad_type_infos.proto:137A Smart Shopping ad.
Used in:
(message has no fields)
message
user_lists.proto:45SimilarUserList 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
extensions.proto:316Represents a sitelink extension.
Used in: , ,
optional link_text = 1
URL display text for the sitelink. The length of this string should be between 1 and 25, inclusive.
optional line1 = 2
First line of the description for the sitelink. If this value is set, line2 must also be set. The length of this string should be between 0 and 35, inclusive.
optional line2 = 3
Second line of the description for the sitelink. If this value is set, line1 must also be set. The length of this string should be between 0 and 35, inclusive.
repeated final_urls = 4
A list of possible final URLs after all cross domain redirects.
repeated final_mobile_urls = 5
A list of possible final mobile URLs after all cross domain redirects.
optional tracking_url_template = 6
URL template for constructing a tracking URL.
repeated url_custom_parameters = 7
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 final_url_suffix = 8
Final URL suffix to be appended to landing page URLs served with parallel tracking.
message
extensions.proto:305Represents a structured snippet extension.
Used in:
optional header = 1
The header of the snippet. This string must not be empty.
repeated values = 2
The values in the snippet. The maximum size of this collection is 10.
message
tag_snippet.proto:37The 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:120An 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.
message
simulation.proto:151Projected metrics for a specific target CPA amount.
Used in:
optional target_cpa_micros = 1
The simulated target CPA upon which projected metrics are based.
optional biddable_conversions = 2
Projected number of biddable conversions.
optional biddable_conversions_value = 3
Projected total value of biddable conversions.
optional clicks = 4
Projected number of clicks.
optional cost_micros = 5
Projected cost in micros.
optional impressions = 6
Projected number of impressions.
optional top_slot_impressions = 7
Projected number of top slot impressions. Only search advertising channel type supports this field.
message
simulation.proto:53A container for simulation points for simulations of type TARGET_CPA.
Used in:
repeated points = 1
Projected metrics for a series of target CPA amounts.
message
bidding.proto:137Target CPM (cost per thousand impressions) is an automated bidding strategy that sets bids to optimize performance given the target CPM you set.
Used in:
(message has no fields)
message
bidding.proto:145An 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). Next Id = 4
Used in: ,
enums.TargetImpressionShareLocationEnum.TargetImpressionShareLocation location = 1
The targeted location on the search results page.
optional location_fraction_micros = 2
The desired fraction of ads to be shown in the targeted location in micros. E.g. 1% equals 10,000.
optional cpc_bid_ceiling_micros = 3
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.
message
bidding.proto:162An automated bidding strategy that sets bids based on the target fraction of auctions where the advertiser should outrank a specific competitor. This strategy is deprecated.
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
targeting_setting.proto:45The list of per-targeting-dimension targeting settings.
Used in:
enums.TargetingDimensionEnum.TargetingDimension targeting_dimension = 1
The targeting dimension that these settings apply to.
optional bid_only = 2
Indicates whether to restrict your ads to show only for the criteria you have selected for this targeting_dimension, or to target all values for this targeting_dimension and show ads based on your targeting in other TargetingDimensions. A value of `true` means that these criteria will only apply bid modifiers, and not affect targeting. A value of `false` means that these criteria will restrict targeting as well as applying bid modifiers.
message
bidding.proto:192An 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:208An 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
targeting_setting.proto:38Settings for the targeting-related features, at the campaign and ad group levels. For more details about the targeting setting, visit https://support.google.com/google-ads/answer/7365594
Used in: ,
repeated target_restrictions = 1
The per-targeting-dimension setting to restrict the reach of your campaign or ad group.
message
ad_type_infos.proto:41A 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
asset_types.proto:79A Text asset.
Used in:
optional text = 1
Text content of the text asset.
message
text_label.proto:33A type of label displaying text on a colored background.
Used in:
optional background_color = 1
Background color of the label in RGB format. This string must match the regular expression '^\#([a-fA-F0-9]{6}|[a-fA-F0-9]{3})$'. Note: The background color may not be visible for manager accounts.
optional description = 2
A short description of the label. The length must be no more than 200 characters.
message
extensions.proto:175An extension that users can click on to send a text message to the advertiser.
Used in:
optional business_name = 1
The business name to prepend to the message text. This field is required.
optional country_code = 2
Uppercase two-letter country code of the advertiser's phone number. This field is required.
optional phone_number = 3
The advertiser's phone number the message will be sent to. Required.
optional text = 4
The text to show in the ad. This field is required.
optional extension_text = 5
The message text populated in the messaging app.
message
criteria.proto:469A 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:285Unknown listing dimension.
Used in:
(message has no fields)
message
url_collection.proto:35Collection of urls that is tagged with a unique identifier.
Used in:
optional url_collection_id = 1
Unique identifier for this UrlCollection instance.
repeated final_urls = 2
A list of possible final URLs.
repeated final_mobile_urls = 3
A list of possible final mobile URLs.
optional tracking_url_template = 4
URL template for constructing a tracking URL.
message
criteria.proto:509Represents a particular interest-based topic to be targeted.
Used in: ,
optional user_interest_category = 1
The UserInterest resource name.
message
user_lists.proto:284Represents an action type used for building remarketing user lists.
Used in:
oneof user_list_action
Subtypes of user list action.
conversion_action = 1
A conversion action that's not generated from remarketing.
remarketing_action = 2
A remarketing action.
message
user_lists.proto:124A rule item composed of date operation.
Used in:
enums.UserListDateRuleItemOperatorEnum.UserListDateRuleItemOperator operator = 1
Date comparison operator. This field is required and must be populated when creating new date rule item.
optional value = 2
String representing date value to be compared with the rule variable. Supported date format is YYYY-MM-DD. Times are reported in the customer's time zone.
optional offset_in_days = 3
The relative date value of the right hand side denoted by number of days offset from now. The value field will override this field when both are present.
message
criteria.proto:404A 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
user_lists.proto:263A user list logical rule. A rule has a logical operator (and/or/not) and a list of user lists as operands.
Used in:
enums.UserListLogicalRuleOperatorEnum.UserListLogicalRuleOperator operator = 1
The logical operator of the rule.
repeated rule_operands = 2
The list of operands of the rule.
message
user_lists.proto:142A rule item composed of number operation.
Used in:
enums.UserListNumberRuleItemOperatorEnum.UserListNumberRuleItemOperator operator = 1
Number comparison operator. This field is required and must be populated when creating a new number rule item.
optional value = 2
Number value to be compared with the variable. This field is required and must be populated when creating a new number rule item.
message
user_lists.proto:76A client defined rule based on custom parameters sent by web sites or uploaded by the advertiser.
Used in: , ,
enums.UserListRuleTypeEnum.UserListRuleType rule_type = 1
Rule type is used to determine how to group rule items. The default is OR of ANDs (disjunctive normal form). That is, rule items will be ANDed together within rule item groups and the groups themselves will be ORed together. Currently AND of ORs (conjunctive normal form) is only supported for ExpressionRuleUserList.
repeated rule_item_groups = 2
List of rule item groups that defines this rule. Rule item groups are grouped together based on rule_type.
message
user_lists.proto:93A group of rule items.
Used in:
repeated rule_items = 1
Rule items that will be grouped together based on rule_type.
message
user_lists.proto:99An atomic rule fragment.
Used in:
optional name = 1
Rule variable name. It should match the corresponding key name fired by the pixel. A name must begin with US-ascii letters or underscore or UTF8 code that is greater than 127 and consist of US-ascii letters or digits or underscore or UTF8 code that is greater than 127. For websites, there are two built-in variable URL (name = 'url__') and referrer URL (name = 'ref_url__'). This field must be populated when creating a new rule item.
oneof rule_item
An atomic rule fragment.
number_rule_item = 2
An atomic rule fragment composed of a number operation.
string_rule_item = 3
An atomic rule fragment composed of a string operation.
date_rule_item = 4
An atomic rule fragment composed of a date operation.
message
user_lists.proto:155A rule item fragment composed of date operation.
Used in:
enums.UserListStringRuleItemOperatorEnum.UserListStringRuleItemOperator operator = 1
String comparison operator. This field is required and must be populated when creating a new string rule item.
optional value = 2
The right hand side of the string rule item. For URLs or referrer URLs, the value can not contain illegal URL chars such as newlines, quotes, tabs, or parentheses. This field is required and must be populated when creating a new string rule item.
message
value.proto:34A 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
ad_type_infos.proto:325A video ad.
Used in:
optional media_file = 1
The MediaFile resource to use for the video.
oneof format
Format-specific schema for the different video formats.
in_stream = 2
Video TrueView in-stream ad format.
bumper = 3
Video bumper in-stream ad format.
out_stream = 4
Video out-stream ad format.
non_skippable = 5
Video non-skippable in-stream ad format.
message
ad_type_infos.proto:285Representation of video bumper in-stream ad format (very short in-stream non-skippable video ad).
Used in:
optional companion_banner = 1
The MediaFile resource name of the companion banner used with the ad.
message
ad_type_infos.proto:292Representation of video non-skippable in-stream ad format (15 second in-stream non-skippable video ad).
Used in:
optional companion_banner = 1
The MediaFile resource name of the companion banner used with the ad.
message
ad_type_infos.proto:316Representation of video out-stream ad format (ad shown alongside a feed with automatic playback, without sound).
Used in:
optional headline = 1
The headline of the ad.
optional description = 2
The description line.
message
ad_type_infos.proto:300Representation of video TrueView in-stream ad format (ad shown during video playback, often at beginning, which displays a skip button a few seconds into the video).
Used in:
optional action_button_label = 1
Label on the CTA (call-to-action) button taking the user to the video ad's final URL. Required for TrueView for action campaigns, optional otherwise.
optional action_headline = 2
Additional text displayed with the CTA (call-to-action) button to give context and encourage clicking on the button.
optional companion_banner = 3
The MediaFile resource name of the companion banner used with the ad.
message
criteria.proto:534Logical expression for targeting webpages of an advertiser's website.
Used in:
enums.WebpageConditionOperandEnum.WebpageConditionOperand operand = 1
Operand of webpage targeting condition.
enums.WebpageConditionOperatorEnum.WebpageConditionOperator operator = 2
Operator of webpage targeting condition.
optional argument = 3
Argument of webpage targeting condition.
message
criteria.proto:515Represents a criterion for targeting webpages of an advertiser's website.
Used in: ,
optional criterion_name = 1
The name of the criterion that is defined by this parameter. The name value will be used for identifying, sorting and filtering criteria with this type of parameters. This field is required for CREATE operations and is prohibited on UPDATE operations.
repeated conditions = 2
Conditions, or logical expressions, for webpage targeting. The list of webpage targeting conditions are and-ed together when evaluated for targeting. This field is required for CREATE operations and is prohibited on UPDATE operations.
message
criteria.proto:397A 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:391A YouTube Video criterion.
Used in: , , ,
optional video_id = 1
YouTube video id as it appears on the YouTube watch page.
message
asset_types.proto:36A YouTube asset.
Used in:
optional youtube_video_id = 1
YouTube video id. This is the 11 character string value used in the YouTube video URL.