Google Ads API is returning to beta status. Please read our blog post for more details.

ad_group_ad

The ad referenced in the query.

Selectable With

Attributed resources

Fields from the following resources may be selected along with this resource in your SELECT and WHERE clauses. These fields will not segment metrics:

info_outline  Resource fields

layers  Segments

show_chart  Metrics

ad_group_ad.ad.added_by_google_ads

Field descriptionIndicates if this ad was automatically added by Google Ads and not by a user. For example, this could happen when ads are automatically created as suggestions for new ads based on knowledge of how existing ads are performing.
CategoryATTRIBUTE
Data Type BOOLEAN
Type URLgoogle.protobuf.BoolValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

ad_group_ad.ad.app_ad.descriptions

Field descriptionList of text assets for descriptions. When the ad serves the descriptions will be selected from this list.
CategoryATTRIBUTE
Data Type MESSAGE
Type URLgoogle.ads.googleads.v1.common.AdTextAsset
FilterableFalse
SelectableTrue
SortableFalse
RepeatedTrue

ad_group_ad.ad.app_ad.headlines

Field descriptionList of text assets for headlines. When the ad serves the headlines will be selected from this list.
CategoryATTRIBUTE
Data Type MESSAGE
Type URLgoogle.ads.googleads.v1.common.AdTextAsset
FilterableFalse
SelectableTrue
SortableFalse
RepeatedTrue

ad_group_ad.ad.app_ad.html5_media_bundles

Field descriptionList of media bundle assets that may be used with the ad.
CategoryATTRIBUTE
Data Type MESSAGE
Type URLgoogle.ads.googleads.v1.common.AdMediaBundleAsset
FilterableFalse
SelectableTrue
SortableFalse
RepeatedTrue

ad_group_ad.ad.app_ad.html5_media_bundles.asset

Field descriptionThe Asset resource name of this media bundle.
CategoryATTRIBUTE
Data Type RESOURCE_NAME
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableFalse
SortableFalse
RepeatedFalse

ad_group_ad.ad.app_ad.images

Field descriptionList of image assets that may be displayed with the ad.
CategoryATTRIBUTE
Data Type MESSAGE
Type URLgoogle.ads.googleads.v1.common.AdImageAsset
FilterableFalse
SelectableTrue
SortableFalse
RepeatedTrue

ad_group_ad.ad.app_ad.images.asset

Field descriptionThe Asset resource name of this image.
CategoryATTRIBUTE
Data Type RESOURCE_NAME
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableFalse
SortableFalse
RepeatedFalse

ad_group_ad.ad.app_ad.mandatory_ad_text

Field descriptionAn optional text asset that, if specified, must always be displayed when the ad is served.
CategoryATTRIBUTE
Data Type MESSAGE
Type URLgoogle.ads.googleads.v1.common.AdTextAsset
FilterableFalse
SelectableTrue
SortableFalse
RepeatedFalse

ad_group_ad.ad.app_ad.youtube_videos

Field descriptionList of YouTube video assets that may be displayed with the ad.
CategoryATTRIBUTE
Data Type MESSAGE
Type URLgoogle.ads.googleads.v1.common.AdVideoAsset
FilterableFalse
SelectableTrue
SortableFalse
RepeatedTrue

ad_group_ad.ad.app_ad.youtube_videos.asset

Field descriptionThe Asset resource name of this video.
CategoryATTRIBUTE
Data Type RESOURCE_NAME
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableFalse
SortableFalse
RepeatedFalse

ad_group_ad.ad.app_engagement_ad.descriptions

Field descriptionList of text assets for descriptions. When the ad serves the descriptions will be selected from this list.
CategoryATTRIBUTE
Data Type MESSAGE
Type URLgoogle.ads.googleads.v1.common.AdTextAsset
FilterableFalse
SelectableTrue
SortableFalse
RepeatedTrue

ad_group_ad.ad.app_engagement_ad.headlines

Field descriptionList of text assets for headlines. When the ad serves the headlines will be selected from this list.
CategoryATTRIBUTE
Data Type MESSAGE
Type URLgoogle.ads.googleads.v1.common.AdTextAsset
FilterableFalse
SelectableTrue
SortableFalse
RepeatedTrue

ad_group_ad.ad.app_engagement_ad.images

Field descriptionList of image assets that may be displayed with the ad.
CategoryATTRIBUTE
Data Type MESSAGE
Type URLgoogle.ads.googleads.v1.common.AdImageAsset
FilterableFalse
SelectableTrue
SortableFalse
RepeatedTrue

ad_group_ad.ad.app_engagement_ad.images.asset

Field descriptionThe Asset resource name of this image.
CategoryATTRIBUTE
Data Type RESOURCE_NAME
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableFalse
SortableFalse
RepeatedFalse

ad_group_ad.ad.app_engagement_ad.videos

Field descriptionList of video assets that may be displayed with the ad.
CategoryATTRIBUTE
Data Type MESSAGE
Type URLgoogle.ads.googleads.v1.common.AdVideoAsset
FilterableFalse
SelectableTrue
SortableFalse
RepeatedTrue

ad_group_ad.ad.app_engagement_ad.videos.asset

Field descriptionThe Asset resource name of this video.
CategoryATTRIBUTE
Data Type RESOURCE_NAME
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableFalse
SortableFalse
RepeatedFalse

ad_group_ad.ad.call_only_ad.business_name

Field descriptionThe business name in the ad.
CategoryATTRIBUTE
Data Type STRING
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

ad_group_ad.ad.call_only_ad.call_tracked

Field descriptionWhether to enable call tracking for the creative. Enabling call tracking also enables call conversions.
CategoryATTRIBUTE
Data Type BOOLEAN
Type URLgoogle.protobuf.BoolValue
FilterableFalse
SelectableTrue
SortableFalse
RepeatedFalse

ad_group_ad.ad.call_only_ad.conversion_action

Field descriptionThe 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.
CategoryATTRIBUTE
Data Type RESOURCE_NAME
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableFalse
RepeatedFalse

ad_group_ad.ad.call_only_ad.conversion_reporting_state

Field descriptionThe call conversion behavior of this call only ad. It can use its own call conversion setting, inherit the account level setting, or be disabled.
CategoryATTRIBUTE
Data Type
Type URLgoogle.ads.googleads.v1.enums.CallConversionReportingStateEnum.CallConversionReportingState
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

ad_group_ad.ad.call_only_ad.country_code

Field descriptionThe country code in the ad.
CategoryATTRIBUTE
Data Type STRING
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

ad_group_ad.ad.call_only_ad.description1

Field descriptionThe first line of the ad's description.
CategoryATTRIBUTE
Data Type STRING
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

ad_group_ad.ad.call_only_ad.description2

Field descriptionThe second line of the ad's description.
CategoryATTRIBUTE
Data Type STRING
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

ad_group_ad.ad.call_only_ad.disable_call_conversion

Field descriptionWhether 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.
CategoryATTRIBUTE
Data Type BOOLEAN
Type URLgoogle.protobuf.BoolValue
FilterableFalse
SelectableTrue
SortableFalse
RepeatedFalse

ad_group_ad.ad.call_only_ad.headline1

Field descriptionFirst headline in the ad.
CategoryATTRIBUTE
Data Type STRING
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

ad_group_ad.ad.call_only_ad.headline2

Field descriptionSecond headline in the ad.
CategoryATTRIBUTE
Data Type STRING
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

ad_group_ad.ad.call_only_ad.phone_number

Field descriptionThe phone number in the ad.
CategoryATTRIBUTE
Data Type STRING
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

ad_group_ad.ad.call_only_ad.phone_number_verification_url

Field descriptionThe URL to be used for phone number verification.
CategoryATTRIBUTE
Data Type STRING
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

ad_group_ad.ad.device_preference

Field descriptionThe device preference for the ad. You can only specify a preference for mobile devices. When this preference is set the ad will be preferred over other ads when being displayed on a mobile device. The ad can still be displayed on other device types, e.g. if no other ads are available. If unspecified (no device preference), all devices are targeted. This is only supported by some ad types.
CategoryATTRIBUTE
Data Type
Type URLgoogle.ads.googleads.v1.enums.DeviceEnum.Device
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

ad_group_ad.ad.display_upload_ad.display_upload_product_type

Field descriptionThe product type of this ad. See comments on the enum for details.
CategoryATTRIBUTE
Data Type
Type URLgoogle.ads.googleads.v1.enums.DisplayUploadProductTypeEnum.DisplayUploadProductType
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

ad_group_ad.ad.display_upload_ad.media_bundle

Field descriptionA 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.
CategoryATTRIBUTE
Data Type MESSAGE
Type URLgoogle.ads.googleads.v1.common.AdMediaBundleAsset
FilterableFalse
SelectableTrue
SortableFalse
RepeatedFalse

ad_group_ad.ad.display_upload_ad.media_bundle.asset

Field descriptionThe Asset resource name of this media bundle.
CategoryATTRIBUTE
Data Type RESOURCE_NAME
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableFalse
SortableFalse
RepeatedFalse

ad_group_ad.ad.display_url

Field descriptionThe URL that appears in the ad description for some ad formats.
CategoryATTRIBUTE
Data Type STRING
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

ad_group_ad.ad.expanded_dynamic_search_ad.description

Field descriptionThe description of the ad.
CategoryATTRIBUTE
Data Type STRING
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

ad_group_ad.ad.expanded_text_ad.description

Field descriptionThe description of the ad.
CategoryATTRIBUTE
Data Type STRING
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

ad_group_ad.ad.expanded_text_ad.description2

Field descriptionThe second description of the ad.
CategoryATTRIBUTE
Data Type STRING
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

ad_group_ad.ad.expanded_text_ad.headline_part1

Field descriptionThe first part of the ad's headline.
CategoryATTRIBUTE
Data Type STRING
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

ad_group_ad.ad.expanded_text_ad.headline_part2

Field descriptionThe second part of the ad's headline.
CategoryATTRIBUTE
Data Type STRING
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

ad_group_ad.ad.expanded_text_ad.headline_part3

Field descriptionThe third part of the ad's headline.
CategoryATTRIBUTE
Data Type STRING
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

ad_group_ad.ad.expanded_text_ad.path1

Field descriptionThe text that can appear alongside the ad's displayed URL.
CategoryATTRIBUTE
Data Type STRING
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

ad_group_ad.ad.expanded_text_ad.path2

Field descriptionAdditional text that can appear alongside the ad's displayed URL.
CategoryATTRIBUTE
Data Type STRING
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

ad_group_ad.ad.final_app_urls

Field descriptionA list of final app URLs that will be used on mobile if the user has the specific app installed.
CategoryATTRIBUTE
Data Type MESSAGE
Type URLgoogle.ads.googleads.v1.common.FinalAppUrl
FilterableFalse
SelectableTrue
SortableFalse
RepeatedTrue

ad_group_ad.ad.final_mobile_urls

Field descriptionThe list of possible final mobile URLs after all cross-domain redirects for the ad.
CategoryATTRIBUTE
Data Type STRING
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableFalse
RepeatedTrue

ad_group_ad.ad.final_urls

Field descriptionThe list of possible final URLs after all cross-domain redirects for the ad.
CategoryATTRIBUTE
Data Type STRING
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableFalse
RepeatedTrue

ad_group_ad.ad.gmail_ad.header_image

Field descriptionThe 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%).
CategoryATTRIBUTE
Data Type RESOURCE_NAME
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

ad_group_ad.ad.gmail_ad.marketing_image

Field descriptionThe 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%)
CategoryATTRIBUTE
Data Type RESOURCE_NAME
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

ad_group_ad.ad.gmail_ad.marketing_image_description

Field descriptionDescription of the marketing image.
CategoryATTRIBUTE
Data Type STRING
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

ad_group_ad.ad.gmail_ad.marketing_image_display_call_to_action.text

Field descriptionText for the display-call-to-action.
CategoryATTRIBUTE
Data Type STRING
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

ad_group_ad.ad.gmail_ad.marketing_image_display_call_to_action.text_color

Field descriptionText color for the display-call-to-action in hexadecimal, e.g. #ffffff for white.
CategoryATTRIBUTE
Data Type STRING
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

ad_group_ad.ad.gmail_ad.marketing_image_display_call_to_action.url_collection_id

Field descriptionIdentifies the url collection in the ad.url_collections field. If not set the url defaults to final_url.
CategoryATTRIBUTE
Data Type STRING
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

ad_group_ad.ad.gmail_ad.marketing_image_headline

Field descriptionHeadline of the marketing image.
CategoryATTRIBUTE
Data Type STRING
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

ad_group_ad.ad.gmail_ad.product_images

Field descriptionProduct images. Up to 15 images are supported.
CategoryATTRIBUTE
Data Type MESSAGE
Type URLgoogle.ads.googleads.v1.common.ProductImage
FilterableFalse
SelectableTrue
SortableFalse
RepeatedTrue

ad_group_ad.ad.gmail_ad.product_images.product_image

Field descriptionThe 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%).
CategoryATTRIBUTE
Data Type RESOURCE_NAME
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableFalse
SortableFalse
RepeatedFalse

ad_group_ad.ad.gmail_ad.product_videos

Field descriptionProduct videos. Up to 7 videos are supported. At least one product video or a marketing image must be specified.
CategoryATTRIBUTE
Data Type MESSAGE
Type URLgoogle.ads.googleads.v1.common.ProductVideo
FilterableFalse
SelectableTrue
SortableFalse
RepeatedTrue

ad_group_ad.ad.gmail_ad.product_videos.product_video

Field descriptionThe MediaFile resource name of a video which must be hosted on YouTube.
CategoryATTRIBUTE
Data Type RESOURCE_NAME
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableFalse
SortableFalse
RepeatedFalse

ad_group_ad.ad.gmail_ad.teaser.business_name

Field descriptionBusiness name of the advertiser.
CategoryATTRIBUTE
Data Type STRING
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

ad_group_ad.ad.gmail_ad.teaser.description

Field descriptionDescription of the teaser.
CategoryATTRIBUTE
Data Type STRING
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

ad_group_ad.ad.gmail_ad.teaser.headline

Field descriptionHeadline of the teaser.
CategoryATTRIBUTE
Data Type STRING
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

ad_group_ad.ad.gmail_ad.teaser.logo_image

Field descriptionThe 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%).
CategoryATTRIBUTE
Data Type RESOURCE_NAME
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

ad_group_ad.ad.hotel_ad

Field descriptionDetails pertaining to a hotel ad.
CategoryATTRIBUTE
Data Type MESSAGE
Type URLgoogle.ads.googleads.v1.common.HotelAdInfo
FilterableFalse
SelectableTrue
SortableFalse
RepeatedFalse

ad_group_ad.ad.id

Field descriptionThe ID of the ad.
CategoryATTRIBUTE
Data Type INT64
Type URLgoogle.protobuf.Int64Value
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

ad_group_ad.ad.image_ad.image_url

Field descriptionURL of the full size image.
CategoryATTRIBUTE
Data Type STRING
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

ad_group_ad.ad.image_ad.media_file

Field descriptionThe MediaFile resource to use for the image.
CategoryATTRIBUTE
Data Type RESOURCE_NAME
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableFalse
SortableFalse
RepeatedFalse

ad_group_ad.ad.image_ad.mime_type

Field descriptionThe mime type of the image.
CategoryATTRIBUTE
Data Type
Type URLgoogle.ads.googleads.v1.enums.MimeTypeEnum.MimeType
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

ad_group_ad.ad.image_ad.name

Field descriptionThe 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.
CategoryATTRIBUTE
Data Type STRING
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

ad_group_ad.ad.image_ad.pixel_height

Field descriptionHeight in pixels of the full size image.
CategoryATTRIBUTE
Data Type INT64
Type URLgoogle.protobuf.Int64Value
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

ad_group_ad.ad.image_ad.pixel_width

Field descriptionWidth in pixels of the full size image.
CategoryATTRIBUTE
Data Type INT64
Type URLgoogle.protobuf.Int64Value
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

ad_group_ad.ad.image_ad.preview_image_url

Field descriptionURL of the preview size image.
CategoryATTRIBUTE
Data Type STRING
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

ad_group_ad.ad.image_ad.preview_pixel_height

Field descriptionHeight in pixels of the preview size image.
CategoryATTRIBUTE
Data Type INT64
Type URLgoogle.protobuf.Int64Value
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

ad_group_ad.ad.image_ad.preview_pixel_width

Field descriptionWidth in pixels of the preview size image.
CategoryATTRIBUTE
Data Type INT64
Type URLgoogle.protobuf.Int64Value
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

ad_group_ad.ad.legacy_app_install_ad

Field descriptionDetails pertaining to a legacy app install ad.
CategoryATTRIBUTE
Data Type MESSAGE
Type URLgoogle.ads.googleads.v1.common.LegacyAppInstallAdInfo
FilterableFalse
SelectableTrue
SortableFalse
RepeatedFalse

ad_group_ad.ad.legacy_responsive_display_ad.accent_color

Field descriptionThe 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.
CategoryATTRIBUTE
Data Type STRING
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

ad_group_ad.ad.legacy_responsive_display_ad.allow_flexible_color

Field descriptionAdvertiser'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.
CategoryATTRIBUTE
Data Type BOOLEAN
Type URLgoogle.protobuf.BoolValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

ad_group_ad.ad.legacy_responsive_display_ad.business_name

Field descriptionThe business name in the ad.
CategoryATTRIBUTE
Data Type STRING
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

ad_group_ad.ad.legacy_responsive_display_ad.call_to_action_text

Field descriptionThe call-to-action text for the ad.
CategoryATTRIBUTE
Data Type STRING
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

ad_group_ad.ad.legacy_responsive_display_ad.description

Field descriptionThe description of the ad.
CategoryATTRIBUTE
Data Type STRING
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

ad_group_ad.ad.legacy_responsive_display_ad.format_setting

Field descriptionSpecifies which format the ad will be served in. Default is ALL_FORMATS.
CategoryATTRIBUTE
Data Type
Type URLgoogle.ads.googleads.v1.enums.DisplayAdFormatSettingEnum.DisplayAdFormatSetting
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

ad_group_ad.ad.legacy_responsive_display_ad.logo_image

Field descriptionThe MediaFile resource name of the logo image used in the ad.
CategoryATTRIBUTE
Data Type RESOURCE_NAME
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

ad_group_ad.ad.legacy_responsive_display_ad.long_headline

Field descriptionThe long version of the ad's headline.
CategoryATTRIBUTE
Data Type STRING
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

ad_group_ad.ad.legacy_responsive_display_ad.main_color

Field descriptionThe 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.
CategoryATTRIBUTE
Data Type STRING
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

ad_group_ad.ad.legacy_responsive_display_ad.marketing_image

Field descriptionThe MediaFile resource name of the marketing image used in the ad.
CategoryATTRIBUTE
Data Type RESOURCE_NAME
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

ad_group_ad.ad.legacy_responsive_display_ad.price_prefix

Field descriptionPrefix before price. E.g. 'as low as'.
CategoryATTRIBUTE
Data Type STRING
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

ad_group_ad.ad.legacy_responsive_display_ad.promo_text

Field descriptionPromotion text used for dyanmic formats of responsive ads. For example 'Free two-day shipping'.
CategoryATTRIBUTE
Data Type STRING
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

ad_group_ad.ad.legacy_responsive_display_ad.short_headline

Field descriptionThe short version of the ad's headline.
CategoryATTRIBUTE
Data Type STRING
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

ad_group_ad.ad.legacy_responsive_display_ad.square_logo_image

Field descriptionThe MediaFile resource name of the square logo image used in the ad.
CategoryATTRIBUTE
Data Type RESOURCE_NAME
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

ad_group_ad.ad.legacy_responsive_display_ad.square_marketing_image

Field descriptionThe MediaFile resource name of the square marketing image used in the ad.
CategoryATTRIBUTE
Data Type RESOURCE_NAME
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

ad_group_ad.ad.name

Field descriptionThe name of the ad. This is only used to be able to identify the ad. It does not need to be unique and does not affect the served ad.
CategoryATTRIBUTE
Data Type STRING
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

ad_group_ad.ad.responsive_display_ad.accent_color

Field descriptionThe 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.
CategoryATTRIBUTE
Data Type STRING
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

ad_group_ad.ad.responsive_display_ad.allow_flexible_color

Field descriptionAdvertiser'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.
CategoryATTRIBUTE
Data Type BOOLEAN
Type URLgoogle.protobuf.BoolValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

ad_group_ad.ad.responsive_display_ad.business_name

Field descriptionThe advertiser/brand name. Maximum display width is 25.
CategoryATTRIBUTE
Data Type STRING
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

ad_group_ad.ad.responsive_display_ad.call_to_action_text

Field descriptionThe call-to-action text for the ad. Maximum display width is 30.
CategoryATTRIBUTE
Data Type STRING
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

ad_group_ad.ad.responsive_display_ad.descriptions

Field descriptionDescriptive texts for the ad. The maximum length is 90 characters. At least 1 and max 5 headlines can be specified.
CategoryATTRIBUTE
Data Type MESSAGE
Type URLgoogle.ads.googleads.v1.common.AdTextAsset
FilterableFalse
SelectableTrue
SortableFalse
RepeatedTrue

ad_group_ad.ad.responsive_display_ad.format_setting

Field descriptionSpecifies which format the ad will be served in. Default is ALL_FORMATS.
CategoryATTRIBUTE
Data Type
Type URLgoogle.ads.googleads.v1.enums.DisplayAdFormatSettingEnum.DisplayAdFormatSetting
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

ad_group_ad.ad.responsive_display_ad.headlines

Field descriptionShort format headlines for the ad. The maximum length is 30 characters. At least 1 and max 5 headlines can be specified.
CategoryATTRIBUTE
Data Type MESSAGE
Type URLgoogle.ads.googleads.v1.common.AdTextAsset
FilterableFalse
SelectableTrue
SortableFalse
RepeatedTrue

ad_group_ad.ad.responsive_display_ad.logo_images

Field descriptionLogo 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.
CategoryATTRIBUTE
Data Type MESSAGE
Type URLgoogle.ads.googleads.v1.common.AdImageAsset
FilterableFalse
SelectableTrue
SortableFalse
RepeatedTrue

ad_group_ad.ad.responsive_display_ad.logo_images.asset

Field descriptionThe Asset resource name of this image.
CategoryATTRIBUTE
Data Type RESOURCE_NAME
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableFalse
SortableFalse
RepeatedFalse

ad_group_ad.ad.responsive_display_ad.long_headline

Field descriptionA required long format headline. The maximum length is 90 characters.
CategoryATTRIBUTE
Data Type MESSAGE
Type URLgoogle.ads.googleads.v1.common.AdTextAsset
FilterableFalse
SelectableTrue
SortableFalse
RepeatedFalse

ad_group_ad.ad.responsive_display_ad.main_color

Field descriptionThe 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.
CategoryATTRIBUTE
Data Type STRING
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

ad_group_ad.ad.responsive_display_ad.marketing_images

Field descriptionMarketing 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.
CategoryATTRIBUTE
Data Type MESSAGE
Type URLgoogle.ads.googleads.v1.common.AdImageAsset
FilterableFalse
SelectableTrue
SortableFalse
RepeatedTrue

ad_group_ad.ad.responsive_display_ad.marketing_images.asset

Field descriptionThe Asset resource name of this image.
CategoryATTRIBUTE
Data Type RESOURCE_NAME
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableFalse
SortableFalse
RepeatedFalse

ad_group_ad.ad.responsive_display_ad.price_prefix

Field descriptionPrefix before price. E.g. 'as low as'.
CategoryATTRIBUTE
Data Type STRING
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

ad_group_ad.ad.responsive_display_ad.promo_text

Field descriptionPromotion text used for dyanmic formats of responsive ads. For example 'Free two-day shipping'.
CategoryATTRIBUTE
Data Type STRING
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

ad_group_ad.ad.responsive_display_ad.square_logo_images

Field descriptionSquare 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.
CategoryATTRIBUTE
Data Type MESSAGE
Type URLgoogle.ads.googleads.v1.common.AdImageAsset
FilterableFalse
SelectableTrue
SortableFalse
RepeatedTrue

ad_group_ad.ad.responsive_display_ad.square_logo_images.asset

Field descriptionThe Asset resource name of this image.
CategoryATTRIBUTE
Data Type RESOURCE_NAME
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableFalse
SortableFalse
RepeatedFalse

ad_group_ad.ad.responsive_display_ad.square_marketing_images

Field descriptionSquare 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.
CategoryATTRIBUTE
Data Type MESSAGE
Type URLgoogle.ads.googleads.v1.common.AdImageAsset
FilterableFalse
SelectableTrue
SortableFalse
RepeatedTrue

ad_group_ad.ad.responsive_display_ad.square_marketing_images.asset

Field descriptionThe Asset resource name of this image.
CategoryATTRIBUTE
Data Type RESOURCE_NAME
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableFalse
SortableFalse
RepeatedFalse

ad_group_ad.ad.responsive_display_ad.youtube_videos

Field descriptionOptional YouTube vidoes for the ad. A maximum of 5 videos can be specified.
CategoryATTRIBUTE
Data Type MESSAGE
Type URLgoogle.ads.googleads.v1.common.AdVideoAsset
FilterableFalse
SelectableTrue
SortableFalse
RepeatedTrue

ad_group_ad.ad.responsive_display_ad.youtube_videos.asset

Field descriptionThe Asset resource name of this video.
CategoryATTRIBUTE
Data Type RESOURCE_NAME
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableFalse
SortableFalse
RepeatedFalse

ad_group_ad.ad.responsive_search_ad.descriptions

Field descriptionList of text assets for descriptions. When the ad serves the descriptions will be selected from this list.
CategoryATTRIBUTE
Data Type MESSAGE
Type URLgoogle.ads.googleads.v1.common.AdTextAsset
FilterableFalse
SelectableTrue
SortableFalse
RepeatedTrue

ad_group_ad.ad.responsive_search_ad.headlines

Field descriptionList of text assets for headlines. When the ad serves the headlines will be selected from this list.
CategoryATTRIBUTE
Data Type MESSAGE
Type URLgoogle.ads.googleads.v1.common.AdTextAsset
FilterableFalse
SelectableTrue
SortableFalse
RepeatedTrue

ad_group_ad.ad.responsive_search_ad.path1

Field descriptionFirst part of text that may appear appended to the url displayed in the ad.
CategoryATTRIBUTE
Data Type STRING
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

ad_group_ad.ad.responsive_search_ad.path2

Field descriptionSecond 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.
CategoryATTRIBUTE
Data Type STRING
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

ad_group_ad.ad.shopping_comparison_listing_ad.headline

Field descriptionHeadline of the ad. This field is required. Allowed length is between 25 and 45 characters.
CategoryATTRIBUTE
Data Type STRING
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

ad_group_ad.ad.shopping_product_ad

Field descriptionDetails pertaining to a Shopping product ad.
CategoryATTRIBUTE
Data Type MESSAGE
Type URLgoogle.ads.googleads.v1.common.ShoppingProductAdInfo
FilterableFalse
SelectableTrue
SortableFalse
RepeatedFalse

ad_group_ad.ad.shopping_smart_ad

Field descriptionDetails pertaining to a Smart Shopping ad.
CategoryATTRIBUTE
Data Type MESSAGE
Type URLgoogle.ads.googleads.v1.common.ShoppingSmartAdInfo
FilterableFalse
SelectableTrue
SortableFalse
RepeatedFalse

ad_group_ad.ad.system_managed_resource_source

Field descriptionIf this ad is system managed, then this field will indicate the source. This field is read-only.
CategoryATTRIBUTE
Data Type
Type URLgoogle.ads.googleads.v1.enums.SystemManagedResourceSourceEnum.SystemManagedResourceSource
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

ad_group_ad.ad.text_ad.description1

Field descriptionThe first line of the ad's description.
CategoryATTRIBUTE
Data Type STRING
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

ad_group_ad.ad.text_ad.description2

Field descriptionThe second line of the ad's description.
CategoryATTRIBUTE
Data Type STRING
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

ad_group_ad.ad.text_ad.headline

Field descriptionThe headline of the ad.
CategoryATTRIBUTE
Data Type STRING
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

ad_group_ad.ad.tracking_url_template

Field descriptionThe URL template for constructing a tracking URL.
CategoryATTRIBUTE
Data Type STRING
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

ad_group_ad.ad.type

Field descriptionThe type of ad.
CategoryATTRIBUTE
Data Type
Type URLgoogle.ads.googleads.v1.enums.AdTypeEnum.AdType
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

ad_group_ad.ad.url_collections

Field descriptionAdditional URLs for the ad that are tagged with a unique identifier that can be referenced from other fields in the ad.
CategoryATTRIBUTE
Data Type MESSAGE
Type URLgoogle.ads.googleads.v1.common.UrlCollection
FilterableFalse
SelectableTrue
SortableFalse
RepeatedTrue

ad_group_ad.ad.url_custom_parameters

Field descriptionThe list of mappings that can be used to substitute custom parameter tags in a `tracking_url_template`, `final_urls`, or `mobile_final_urls`.
CategoryATTRIBUTE
Data Type MESSAGE
Type URLgoogle.ads.googleads.v1.common.CustomParameter
FilterableFalse
SelectableTrue
SortableFalse
RepeatedTrue

ad_group_ad.ad.video_ad.bumper

Field descriptionVideo bumper in-stream ad format.
CategoryATTRIBUTE
Data Type MESSAGE
Type URLgoogle.ads.googleads.v1.common.VideoBumperInStreamAdInfo
FilterableFalse
SelectableTrue
SortableFalse
RepeatedFalse

ad_group_ad.ad.video_ad.in_stream.action_button_label

Field descriptionLabel 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.
CategoryATTRIBUTE
Data Type STRING
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

ad_group_ad.ad.video_ad.in_stream.action_headline

Field descriptionAdditional text displayed with the CTA (call-to-action) button to give context and encourage clicking on the button.
CategoryATTRIBUTE
Data Type STRING
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

ad_group_ad.ad.video_ad.in_stream.companion_banner

Field descriptionThe MediaFile resource name of the companion banner used with the ad.
CategoryATTRIBUTE
Data Type RESOURCE_NAME
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

ad_group_ad.ad.video_ad.media_file

Field descriptionThe MediaFile resource to use for the video.
CategoryATTRIBUTE
Data Type RESOURCE_NAME
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

ad_group_ad.ad.video_ad.non_skippable

Field descriptionVideo non-skippable in-stream ad format.
CategoryATTRIBUTE
Data Type MESSAGE
Type URLgoogle.ads.googleads.v1.common.VideoNonSkippableInStreamAdInfo
FilterableFalse
SelectableTrue
SortableFalse
RepeatedFalse

ad_group_ad.ad.video_ad.out_stream.description

Field descriptionThe description line.
CategoryATTRIBUTE
Data Type STRING
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

ad_group_ad.ad.video_ad.out_stream.headline

Field descriptionThe headline of the ad.
CategoryATTRIBUTE
Data Type STRING
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

ad_group_ad.ad_group

Field descriptionThe ad group to which the ad belongs.
CategoryATTRIBUTE
Data Type RESOURCE_NAME
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableFalse
RepeatedFalse

ad_group_ad.ad_strength

Field descriptionOverall ad strength for this ad group ad.
CategoryATTRIBUTE
Data Type
Type URLgoogle.ads.googleads.v1.enums.AdStrengthEnum.AdStrength
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

ad_group_ad.policy_summary

Field descriptionPolicy information for the ad.
CategoryATTRIBUTE
Data Type MESSAGE
Type URLgoogle.ads.googleads.v1.resources.AdGroupAdPolicySummary
FilterableFalse
SelectableTrue
SortableFalse
RepeatedFalse

ad_group_ad.resource_name

Field descriptionThe resource name of the ad. Ad group ad resource names have the form: `customers/{customer_id}/adGroupAds/{ad_group_id}~{ad_id}`
CategoryATTRIBUTE
Data Type RESOURCE_NAME
Type URLN/A
FilterableTrue
SelectableTrue
SortableFalse
RepeatedFalse

ad_group_ad.status

Field descriptionThe status of the ad.
CategoryATTRIBUTE
Data Type
Type URLgoogle.ads.googleads.v1.enums.AdGroupAdStatusEnum.AdGroupAdStatus
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

segments.ad_network_type

Field descriptionAd network type.
CategorySEGMENT
Data Type
Type URLgoogle.ads.googleads.v1.enums.AdNetworkTypeEnum.AdNetworkType
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

segments.click_type

Field descriptionClick type.
CategorySEGMENT
Data Type
Type URLgoogle.ads.googleads.v1.enums.ClickTypeEnum.ClickType
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

segments.conversion_action

Field descriptionResource name of the conversion action.
CategorySEGMENT
Data Type RESOURCE_NAME
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

segments.conversion_action_category

Field descriptionConversion action category.
CategorySEGMENT
Data Type
Type URLgoogle.ads.googleads.v1.enums.ConversionActionCategoryEnum.ConversionActionCategory
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

segments.conversion_action_name

Field descriptionConversion action name.
CategorySEGMENT
Data Type STRING
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

segments.conversion_adjustment

Field descriptionThis 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.
CategorySEGMENT
Data Type BOOLEAN
Type URLgoogle.protobuf.BoolValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

segments.conversion_lag_bucket

Field descriptionAn enum value representing the number of days between the impression and the conversion.
CategorySEGMENT
Data Type
Type URLgoogle.ads.googleads.v1.enums.ConversionLagBucketEnum.ConversionLagBucket
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

segments.conversion_or_adjustment_lag_bucket

Field descriptionAn enum value representing the number of days between the impression and the conversion or between the impression and adjustments to the conversion.
CategorySEGMENT
Data Type
Type URLgoogle.ads.googleads.v1.enums.ConversionOrAdjustmentLagBucketEnum.ConversionOrAdjustmentLagBucket
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

segments.date

Field descriptionDate to which metrics apply. yyyy-MM-dd format, e.g., 2018-04-17.
CategorySEGMENT
Data Type DATE
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

segments.day_of_week

Field descriptionDay of the week, e.g., MONDAY.
CategorySEGMENT
Data Type
Type URLgoogle.ads.googleads.v1.enums.DayOfWeekEnum.DayOfWeek
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

segments.device

Field descriptionDevice to which metrics apply.
CategorySEGMENT
Data Type
Type URLgoogle.ads.googleads.v1.enums.DeviceEnum.Device
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

segments.external_conversion_source

Field descriptionExternal conversion source.
CategorySEGMENT
Data Type
Type URLgoogle.ads.googleads.v1.enums.ExternalConversionSourceEnum.ExternalConversionSource
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

segments.keyword.ad_group_criterion

Field descriptionThe AdGroupCriterion resource name.
CategorySEGMENT
Data Type RESOURCE_NAME
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableFalse
RepeatedFalse

segments.keyword.info.match_type

Field descriptionThe match type of the keyword.
CategorySEGMENT
Data Type
Type URLgoogle.ads.googleads.v1.enums.KeywordMatchTypeEnum.KeywordMatchType
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

segments.keyword.info.text

Field descriptionThe text of the keyword (at most 80 characters and 10 words).
CategorySEGMENT
Data Type STRING
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

segments.month

Field descriptionMonth as represented by the date of the first day of a month. Formatted as yyyy-MM-dd.
CategorySEGMENT
Data Type DATE
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

segments.quarter

Field descriptionQuarter 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.
CategorySEGMENT
Data Type DATE
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

segments.slot

Field descriptionPosition of the ad.
CategorySEGMENT
Data Type
Type URLgoogle.ads.googleads.v1.enums.SlotEnum.Slot
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

segments.week

Field descriptionWeek as defined as Monday through Sunday, and represented by the date of Monday. Formatted as yyyy-MM-dd.
CategorySEGMENT
Data Type DATE
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

segments.year

Field descriptionYear, formatted as yyyy.
CategorySEGMENT
Data Type INT32
Type URLgoogle.protobuf.Int32Value
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

metrics.absolute_top_impression_percentage

Field descriptionThe percent of your ad impressions that are shown as the very first ad above the organic search results.
CategoryMETRIC
Data TypeDOUBLE
Type URLgoogle.protobuf.DoubleValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

metrics.active_view_cpm

Field descriptionAverage cost of viewable impressions (`active_view_impressions`).
CategoryMETRIC
Data TypeDOUBLE
Type URLgoogle.protobuf.DoubleValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

metrics.active_view_ctr

Field descriptionActive view measurable clicks divided by active view viewable impressions. This metric is reported only for display network.
CategoryMETRIC
Data TypeDOUBLE
Type URLgoogle.protobuf.DoubleValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

metrics.active_view_impressions

Field descriptionA measurement of how often your ad has become viewable on a Display Network site.
CategoryMETRIC
Data TypeINT64
Type URLgoogle.protobuf.Int64Value
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

metrics.active_view_measurability

Field descriptionThe ratio of impressions that could be measured by Active View over the number of served impressions.
CategoryMETRIC
Data TypeDOUBLE
Type URLgoogle.protobuf.DoubleValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

metrics.active_view_measurable_cost_micros

Field descriptionThe cost of the impressions you received that were measurable by Active View.
CategoryMETRIC
Data TypeINT64
Type URLgoogle.protobuf.Int64Value
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

metrics.active_view_measurable_impressions

Field descriptionThe number of times your ads are appearing on placements in positions where they can be seen.
CategoryMETRIC
Data TypeINT64
Type URLgoogle.protobuf.Int64Value
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

metrics.active_view_viewability

Field descriptionThe percentage of time when your ad appeared on an Active View enabled site (measurable impressions) and was viewable (viewable impressions).
CategoryMETRIC
Data TypeDOUBLE
Type URLgoogle.protobuf.DoubleValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

metrics.all_conversions

Field descriptionThe total number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true.
CategoryMETRIC
Data TypeDOUBLE
Type URLgoogle.protobuf.DoubleValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

metrics.all_conversions_from_interactions_rate

Field descriptionAll conversions from interactions (as oppose to view through conversions) divided by the number of ad interactions.
CategoryMETRIC
Data TypeDOUBLE
Type URLgoogle.protobuf.DoubleValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

metrics.all_conversions_value

Field descriptionThe total value of all conversions.
CategoryMETRIC
Data TypeDOUBLE
Type URLgoogle.protobuf.DoubleValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

metrics.average_cost

Field descriptionThe average amount you pay per interaction. This amount is the total cost of your ads divided by the total number of interactions.
CategoryMETRIC
Data TypeDOUBLE
Type URLgoogle.protobuf.DoubleValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

metrics.average_cpc

Field descriptionThe total cost of all clicks divided by the total number of clicks received.
CategoryMETRIC
Data TypeDOUBLE
Type URLgoogle.protobuf.DoubleValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

metrics.average_cpe

Field descriptionThe 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.
CategoryMETRIC
Data TypeDOUBLE
Type URLgoogle.protobuf.DoubleValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

metrics.average_cpm

Field descriptionAverage cost-per-thousand impressions (CPM).
CategoryMETRIC
Data TypeDOUBLE
Type URLgoogle.protobuf.DoubleValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

metrics.average_cpv

Field descriptionThe 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.
CategoryMETRIC
Data TypeDOUBLE
Type URLgoogle.protobuf.DoubleValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

metrics.average_page_views

Field descriptionAverage number of pages viewed per session.
CategoryMETRIC
Data TypeDOUBLE
Type URLgoogle.protobuf.DoubleValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

metrics.average_position

Field descriptionYour ad's position relative to those of other advertisers.
CategoryMETRIC
Data TypeDOUBLE
Type URLgoogle.protobuf.DoubleValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

metrics.average_time_on_site

Field descriptionTotal duration of all sessions (in seconds) / number of sessions. Imported from Google Analytics.
CategoryMETRIC
Data TypeDOUBLE
Type URLgoogle.protobuf.DoubleValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

metrics.bounce_rate

Field descriptionPercentage of clicks where the user only visited a single page on your site. Imported from Google Analytics.
CategoryMETRIC
Data TypeDOUBLE
Type URLgoogle.protobuf.DoubleValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

metrics.clicks

Field descriptionThe number of clicks.
CategoryMETRIC
Data TypeINT64
Type URLgoogle.protobuf.Int64Value
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

metrics.conversions

Field descriptionThe number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true.
CategoryMETRIC
Data TypeDOUBLE
Type URLgoogle.protobuf.DoubleValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

metrics.conversions_from_interactions_rate

Field descriptionConversions 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.
CategoryMETRIC
Data TypeDOUBLE
Type URLgoogle.protobuf.DoubleValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

metrics.conversions_value

Field descriptionThe total value of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true.
CategoryMETRIC
Data TypeDOUBLE
Type URLgoogle.protobuf.DoubleValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

metrics.cost_micros

Field descriptionThe sum of your cost-per-click (CPC) and cost-per-thousand impressions (CPM) costs during this period.
CategoryMETRIC
Data TypeINT64
Type URLgoogle.protobuf.Int64Value
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

metrics.cost_per_all_conversions

Field descriptionThe cost of ad interactions divided by all conversions.
CategoryMETRIC
Data TypeDOUBLE
Type URLgoogle.protobuf.DoubleValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

metrics.cost_per_conversion

Field descriptionThe cost of ad interactions divided by conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true.
CategoryMETRIC
Data TypeDOUBLE
Type URLgoogle.protobuf.DoubleValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

metrics.cost_per_current_model_attributed_conversion

Field descriptionThe 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.
CategoryMETRIC
Data TypeDOUBLE
Type URLgoogle.protobuf.DoubleValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

metrics.cross_device_conversions

Field descriptionConversions 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.
CategoryMETRIC
Data TypeDOUBLE
Type URLgoogle.protobuf.DoubleValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

metrics.ctr

Field descriptionThe number of clicks your ad receives (Clicks) divided by the number of times your ad is shown (Impressions).
CategoryMETRIC
Data TypeDOUBLE
Type URLgoogle.protobuf.DoubleValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

metrics.current_model_attributed_conversions

Field descriptionShows 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.
CategoryMETRIC
Data TypeDOUBLE
Type URLgoogle.protobuf.DoubleValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

metrics.current_model_attributed_conversions_value

Field descriptionThe total value of current model attributed conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true.
CategoryMETRIC
Data TypeDOUBLE
Type URLgoogle.protobuf.DoubleValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

metrics.engagement_rate

Field descriptionHow 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.
CategoryMETRIC
Data TypeDOUBLE
Type URLgoogle.protobuf.DoubleValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

metrics.engagements

Field descriptionThe number of engagements. An engagement occurs when a viewer expands your Lightbox ad. Also, in the future, other ad types may support engagement metrics.
CategoryMETRIC
Data TypeINT64
Type URLgoogle.protobuf.Int64Value
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

metrics.gmail_forwards

Field descriptionThe number of times the ad was forwarded to someone else as a message.
CategoryMETRIC
Data TypeINT64
Type URLgoogle.protobuf.Int64Value
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

metrics.gmail_saves

Field descriptionThe number of times someone has saved your Gmail ad to their inbox as a message.
CategoryMETRIC
Data TypeINT64
Type URLgoogle.protobuf.Int64Value
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

metrics.gmail_secondary_clicks

Field descriptionThe number of clicks to the landing page on the expanded state of Gmail ads.
CategoryMETRIC
Data TypeINT64
Type URLgoogle.protobuf.Int64Value
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

metrics.impressions

Field descriptionCount of how often your ad has appeared on a search results page or website on the Google Network.
CategoryMETRIC
Data TypeINT64
Type URLgoogle.protobuf.Int64Value
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

metrics.interaction_event_types

Field descriptionThe types of payable and free interactions.
CategoryMETRIC
Data TypeENUM
Type URLgoogle.ads.googleads.v1.enums.InteractionEventTypeEnum.InteractionEventType
FilterableTrue
SelectableTrue
SortableFalse
RepeatedTrue

metrics.interaction_rate

Field descriptionHow 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.
CategoryMETRIC
Data TypeDOUBLE
Type URLgoogle.protobuf.DoubleValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

metrics.interactions

Field descriptionThe 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.
CategoryMETRIC
Data TypeINT64
Type URLgoogle.protobuf.Int64Value
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

metrics.percent_new_visitors

Field descriptionPercentage of first-time sessions (from people who had never visited your site before). Imported from Google Analytics.
CategoryMETRIC
Data TypeDOUBLE
Type URLgoogle.protobuf.DoubleValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

metrics.top_impression_percentage

Field descriptionThe percent of your ad impressions that are shown anywhere above the organic search results.
CategoryMETRIC
Data TypeDOUBLE
Type URLgoogle.protobuf.DoubleValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

metrics.value_per_all_conversions

Field descriptionThe value of all conversions divided by the number of all conversions.
CategoryMETRIC
Data TypeDOUBLE
Type URLgoogle.protobuf.DoubleValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

metrics.value_per_conversion

Field descriptionThe value of conversions divided by the number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true.
CategoryMETRIC
Data TypeDOUBLE
Type URLgoogle.protobuf.DoubleValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

metrics.value_per_current_model_attributed_conversion

Field descriptionThe 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.
CategoryMETRIC
Data TypeDOUBLE
Type URLgoogle.protobuf.DoubleValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

metrics.video_quartile_100_rate

Field descriptionPercentage of impressions where the viewer watched all of your video.
CategoryMETRIC
Data TypeDOUBLE
Type URLgoogle.protobuf.DoubleValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

metrics.video_quartile_25_rate

Field descriptionPercentage of impressions where the viewer watched 25% of your video.
CategoryMETRIC
Data TypeDOUBLE
Type URLgoogle.protobuf.DoubleValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

metrics.video_quartile_50_rate

Field descriptionPercentage of impressions where the viewer watched 50% of your video.
CategoryMETRIC
Data TypeDOUBLE
Type URLgoogle.protobuf.DoubleValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

metrics.video_quartile_75_rate

Field descriptionPercentage of impressions where the viewer watched 75% of your video.
CategoryMETRIC
Data TypeDOUBLE
Type URLgoogle.protobuf.DoubleValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

metrics.video_view_rate

Field descriptionThe number of views your TrueView video ad receives divided by its number of impressions, including thumbnail impressions for TrueView in-display ads.
CategoryMETRIC
Data TypeDOUBLE
Type URLgoogle.protobuf.DoubleValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

metrics.video_views

Field descriptionThe number of times your video ads were viewed.
CategoryMETRIC
Data TypeINT64
Type URLgoogle.protobuf.Int64Value
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

metrics.view_through_conversions

Field descriptionThe 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.
CategoryMETRIC
Data TypeINT64
Type URLgoogle.protobuf.Int64Value
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse