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

extension_feed_item

The extension feed item referenced in the query.


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  Attributes

layers  Segments

show_chart  Metrics

extension_feed_item.ad_schedules

Field descriptionList of non-overlapping schedules specifying all time intervals for which the feed item may serve. There can be a maximum of 6 schedules per day.
CategoryATTRIBUTE
Data Type MESSAGE
Type URLgoogle.ads.googleads.v1.common.AdScheduleInfo
FilterableFalse
SelectableTrue
SortableFalse
RepeatedTrue

extension_feed_item.affiliate_location_feed_item.address_line_1

Field descriptionLine 1 of the business address.
CategoryATTRIBUTE
Data Type STRING
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

extension_feed_item.affiliate_location_feed_item.address_line_2

Field descriptionLine 2 of the business address.
CategoryATTRIBUTE
Data Type STRING
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

extension_feed_item.affiliate_location_feed_item.business_name

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

extension_feed_item.affiliate_location_feed_item.chain_id

Field descriptionId of the retail chain that is advertised as a seller of your product.
CategoryATTRIBUTE
Data Type INT64
Type URLgoogle.protobuf.Int64Value
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

extension_feed_item.affiliate_location_feed_item.chain_name

Field descriptionName of chain.
CategoryATTRIBUTE
Data Type STRING
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

extension_feed_item.affiliate_location_feed_item.city

Field descriptionCity of the business address.
CategoryATTRIBUTE
Data Type STRING
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

extension_feed_item.affiliate_location_feed_item.country_code

Field descriptionCountry code of the business address.
CategoryATTRIBUTE
Data Type STRING
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

extension_feed_item.affiliate_location_feed_item.phone_number

Field descriptionPhone number of the business.
CategoryATTRIBUTE
Data Type STRING
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

extension_feed_item.affiliate_location_feed_item.postal_code

Field descriptionPostal code of the business address.
CategoryATTRIBUTE
Data Type STRING
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

extension_feed_item.affiliate_location_feed_item.province

Field descriptionProvince of the business address.
CategoryATTRIBUTE
Data Type STRING
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

extension_feed_item.app_feed_item.app_id

Field descriptionThe store-specific ID for the target application. This string must not be empty.
CategoryATTRIBUTE
Data Type STRING
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

extension_feed_item.app_feed_item.app_store

Field descriptionThe application store that the target application belongs to. This field is required.
CategoryATTRIBUTE
Data Type
Type URLgoogle.ads.googleads.v1.enums.AppStoreEnum.AppStore
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

extension_feed_item.app_feed_item.final_mobile_urls

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

extension_feed_item.app_feed_item.final_url_suffix

Field descriptionURL template for appending params to landing page URLs served with parallel tracking.
CategoryATTRIBUTE
Data Type STRING
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

extension_feed_item.app_feed_item.final_urls

Field descriptionA list of possible final URLs after all cross domain redirects. This list must not be empty.
CategoryATTRIBUTE
Data Type STRING
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableFalse
RepeatedTrue

extension_feed_item.app_feed_item.link_text

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

extension_feed_item.app_feed_item.tracking_url_template

Field descriptionURL template for constructing a tracking URL. Default value is "{lpurl}".
CategoryATTRIBUTE
Data Type STRING
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

extension_feed_item.call_feed_item.call_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_tracking_enabled is set to true. Otherwise this field is ignored.
CategoryATTRIBUTE
Data Type RESOURCE_NAME
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

extension_feed_item.call_feed_item.call_conversion_reporting_state

Field descriptionEnum 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.
CategoryATTRIBUTE
Data Type
Type URLgoogle.ads.googleads.v1.enums.CallConversionReportingStateEnum.CallConversionReportingState
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

extension_feed_item.call_feed_item.call_conversion_tracking_disabled

Field descriptionIf true, disable call conversion tracking. call_conversion_action should not be set if this is true. Optional.
CategoryATTRIBUTE
Data Type BOOLEAN
Type URLgoogle.protobuf.BoolValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

extension_feed_item.call_feed_item.call_tracking_enabled

Field descriptionIndicates whether call tracking is enabled. By default, call tracking is not enabled.
CategoryATTRIBUTE
Data Type BOOLEAN
Type URLgoogle.protobuf.BoolValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

extension_feed_item.call_feed_item.country_code

Field descriptionUppercase two-letter country code of the advertiser's phone number. This string must not be empty.
CategoryATTRIBUTE
Data Type STRING
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

extension_feed_item.call_feed_item.phone_number

Field descriptionThe advertiser's phone number to append to the ad. This string must not be empty.
CategoryATTRIBUTE
Data Type STRING
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

extension_feed_item.callout_feed_item.callout_text

Field descriptionThe callout text. The length of this string should be between 1 and 25, inclusive.
CategoryATTRIBUTE
Data Type STRING
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

extension_feed_item.device

Field descriptionThe targeted device.
CategoryATTRIBUTE
Data Type
Type URLgoogle.ads.googleads.v1.enums.FeedItemTargetDeviceEnum.FeedItemTargetDevice
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

extension_feed_item.end_date_time

Field descriptionEnd time in which this feed item is no longer effective and will stop serving. The time is in the customer's time zone. The format is "YYYY-MM-DD HH:MM:SS". Examples: "2018-03-05 09:15:00" or "2018-02-01 14:34:30"
CategoryATTRIBUTE
Data Type STRING
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

extension_feed_item.extension_type

Field descriptionThe extension type of the extension feed item. This field is read-only.
CategoryATTRIBUTE
Data Type
Type URLgoogle.ads.googleads.v1.enums.ExtensionTypeEnum.ExtensionType
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

extension_feed_item.location_feed_item.address_line_1

Field descriptionLine 1 of the business address.
CategoryATTRIBUTE
Data Type STRING
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

extension_feed_item.location_feed_item.address_line_2

Field descriptionLine 2 of the business address.
CategoryATTRIBUTE
Data Type STRING
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

extension_feed_item.location_feed_item.business_name

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

extension_feed_item.location_feed_item.city

Field descriptionCity of the business address.
CategoryATTRIBUTE
Data Type STRING
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

extension_feed_item.location_feed_item.country_code

Field descriptionCountry code of the business address.
CategoryATTRIBUTE
Data Type STRING
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

extension_feed_item.location_feed_item.phone_number

Field descriptionPhone number of the business.
CategoryATTRIBUTE
Data Type STRING
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

extension_feed_item.location_feed_item.postal_code

Field descriptionPostal code of the business address.
CategoryATTRIBUTE
Data Type STRING
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

extension_feed_item.location_feed_item.province

Field descriptionProvince of the business address.
CategoryATTRIBUTE
Data Type STRING
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

extension_feed_item.price_feed_item.final_url_suffix

Field descriptionURL template for appending params to landing page URLs served with parallel tracking.
CategoryATTRIBUTE
Data Type STRING
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

extension_feed_item.price_feed_item.language_code

Field descriptionThe code of the language used for this price extension.
CategoryATTRIBUTE
Data Type STRING
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

extension_feed_item.price_feed_item.price_offerings

Field descriptionThe price offerings in this price extension.
CategoryATTRIBUTE
Data Type MESSAGE
Type URLgoogle.ads.googleads.v1.common.PriceOffer
FilterableFalse
SelectableTrue
SortableFalse
RepeatedTrue

extension_feed_item.price_feed_item.price_qualifier

Field descriptionPrice qualifier for all offers of this price extension.
CategoryATTRIBUTE
Data Type
Type URLgoogle.ads.googleads.v1.enums.PriceExtensionPriceQualifierEnum.PriceExtensionPriceQualifier
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

extension_feed_item.price_feed_item.tracking_url_template

Field descriptionTracking URL template for all offers of this price extension.
CategoryATTRIBUTE
Data Type STRING
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

extension_feed_item.price_feed_item.type

Field descriptionPrice extension type of this extension.
CategoryATTRIBUTE
Data Type
Type URLgoogle.ads.googleads.v1.enums.PriceExtensionTypeEnum.PriceExtensionType
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

extension_feed_item.promotion_feed_item.discount_modifier

Field descriptionEnum that modifies the qualification of the discount.
CategoryATTRIBUTE
Data Type
Type URLgoogle.ads.googleads.v1.enums.PromotionExtensionDiscountModifierEnum.PromotionExtensionDiscountModifier
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

extension_feed_item.promotion_feed_item.final_mobile_urls

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

extension_feed_item.promotion_feed_item.final_url_suffix

Field descriptionURL template for appending params to landing page URLs served with parallel tracking.
CategoryATTRIBUTE
Data Type STRING
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

extension_feed_item.promotion_feed_item.final_urls

Field descriptionA list of possible final URLs after all cross domain redirects. This field is required.
CategoryATTRIBUTE
Data Type STRING
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableFalse
RepeatedTrue

extension_feed_item.promotion_feed_item.language_code

Field descriptionThe language of the promotion. Represented as BCP 47 language tag.
CategoryATTRIBUTE
Data Type STRING
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

extension_feed_item.promotion_feed_item.money_amount_off.amount_micros

Field descriptionAmount in micros. One million is equivalent to one unit.
CategoryATTRIBUTE
Data Type INT64
Type URLgoogle.protobuf.Int64Value
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

extension_feed_item.promotion_feed_item.money_amount_off.currency_code

Field descriptionThree-character ISO 4217 currency code.
CategoryATTRIBUTE
Data Type STRING
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

extension_feed_item.promotion_feed_item.occasion

Field descriptionThe 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.
CategoryATTRIBUTE
Data Type
Type URLgoogle.ads.googleads.v1.enums.PromotionExtensionOccasionEnum.PromotionExtensionOccasion
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

extension_feed_item.promotion_feed_item.orders_over_amount.amount_micros

Field descriptionAmount in micros. One million is equivalent to one unit.
CategoryATTRIBUTE
Data Type INT64
Type URLgoogle.protobuf.Int64Value
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

extension_feed_item.promotion_feed_item.orders_over_amount.currency_code

Field descriptionThree-character ISO 4217 currency code.
CategoryATTRIBUTE
Data Type STRING
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

extension_feed_item.promotion_feed_item.percent_off

Field descriptionPercentage off discount in the promotion in micros. One million is equivalent to one percent. Either this or money_off_amount is required.
CategoryATTRIBUTE
Data Type INT64
Type URLgoogle.protobuf.Int64Value
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

extension_feed_item.promotion_feed_item.promotion_code

Field descriptionA code the user should use in order to be eligible for the promotion.
CategoryATTRIBUTE
Data Type STRING
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

extension_feed_item.promotion_feed_item.promotion_end_date

Field descriptionEnd date of when the promotion is eligible to be redeemed.
CategoryATTRIBUTE
Data Type DATE
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

extension_feed_item.promotion_feed_item.promotion_start_date

Field descriptionStart date of when the promotion is eligible to be redeemed.
CategoryATTRIBUTE
Data Type DATE
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

extension_feed_item.promotion_feed_item.promotion_target

Field descriptionA freeform description of what the promotion is targeting. This field is required.
CategoryATTRIBUTE
Data Type STRING
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

extension_feed_item.promotion_feed_item.tracking_url_template

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

extension_feed_item.resource_name

Field descriptionThe resource name of the extension feed item. Extension feed item resource names have the form: `customers/{customer_id}/extensionFeedItems/{feed_item_id}`
CategoryATTRIBUTE
Data Type RESOURCE_NAME
Type URLN/A
FilterableTrue
SelectableTrue
SortableFalse
RepeatedFalse

extension_feed_item.sitelink_feed_item.final_mobile_urls

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

extension_feed_item.sitelink_feed_item.final_url_suffix

Field descriptionFinal URL suffix to be appended to landing page URLs served with parallel tracking.
CategoryATTRIBUTE
Data Type STRING
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

extension_feed_item.sitelink_feed_item.final_urls

Field descriptionA list of possible final URLs after all cross domain redirects.
CategoryATTRIBUTE
Data Type STRING
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableFalse
RepeatedTrue

extension_feed_item.sitelink_feed_item.line1

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

extension_feed_item.sitelink_feed_item.line2

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

extension_feed_item.sitelink_feed_item.link_text

Field descriptionURL display text for the sitelink. The length of this string should be between 1 and 25, inclusive.
CategoryATTRIBUTE
Data Type STRING
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

extension_feed_item.sitelink_feed_item.tracking_url_template

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

extension_feed_item.start_date_time

Field descriptionStart time in which this feed item is effective and can begin serving. The time is in the customer's time zone. The format is "YYYY-MM-DD HH:MM:SS". Examples: "2018-03-05 09:15:00" or "2018-02-01 14:34:30"
CategoryATTRIBUTE
Data Type STRING
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

extension_feed_item.status

Field descriptionStatus of the feed item. This field is read-only.
CategoryATTRIBUTE
Data Type
Type URLgoogle.ads.googleads.v1.enums.FeedItemStatusEnum.FeedItemStatus
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

extension_feed_item.structured_snippet_feed_item.header

Field descriptionThe header of the snippet. This string must not be empty.
CategoryATTRIBUTE
Data Type STRING
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

extension_feed_item.structured_snippet_feed_item.values

Field descriptionThe values in the snippet. The maximum size of this collection is 10.
CategoryATTRIBUTE
Data Type STRING
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableFalse
RepeatedTrue

extension_feed_item.targeted_ad_group

Field descriptionThe targeted ad group.
CategoryATTRIBUTE
Data Type RESOURCE_NAME
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableFalse
RepeatedFalse

extension_feed_item.targeted_campaign

Field descriptionThe targeted campaign.
CategoryATTRIBUTE
Data Type RESOURCE_NAME
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableFalse
RepeatedFalse

extension_feed_item.targeted_geo_target_constant

Field descriptionThe targeted geo target constant.
CategoryATTRIBUTE
Data Type RESOURCE_NAME
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableFalse
RepeatedFalse

extension_feed_item.text_message_feed_item.business_name

Field descriptionThe business name to prepend to the message text. This field is required.
CategoryATTRIBUTE
Data Type STRING
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

extension_feed_item.text_message_feed_item.country_code

Field descriptionUppercase two-letter country code of the advertiser's phone number. This field is required.
CategoryATTRIBUTE
Data Type STRING
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

extension_feed_item.text_message_feed_item.extension_text

Field descriptionThe message text populated in the messaging app.
CategoryATTRIBUTE
Data Type STRING
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

extension_feed_item.text_message_feed_item.phone_number

Field descriptionThe advertiser's phone number the message will be sent to. Required.
CategoryATTRIBUTE
Data Type STRING
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

extension_feed_item.text_message_feed_item.text

Field descriptionThe text to show in the ad. This field is required.
CategoryATTRIBUTE
Data Type STRING
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

segments.ad_network_type

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

segments.click_type

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

segments.conversion_action

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

segments.conversion_action_category

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

segments.conversion_action_name

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

segments.date

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

segments.day_of_week

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

segments.device

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

segments.external_conversion_source

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

segments.interaction_on_this_extension

Field descriptionOnly used with feed item metrics. Indicates whether the interaction metrics occurred on the feed item itself or a different extension or ad unit.
CategorySEGMENT
Data TypeBOOLEAN
Type URLgoogle.protobuf.BoolValue
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 TypeDATE
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

segments.month_of_year

Field descriptionMonth of the year, e.g., January.
CategorySEGMENT
Data TypeENUM
Type URLgoogle.ads.googleads.v1.enums.MonthOfYearEnum.MonthOfYear
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 TypeDATE
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

segments.slot

Field descriptionPosition of the ad.
CategorySEGMENT
Data TypeENUM
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 TypeDATE
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

segments.year

Field descriptionYear, formatted as yyyy.
CategorySEGMENT
Data TypeINT32
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.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_click_to_call

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

metrics.all_conversions_from_directions

Field descriptionThe 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.
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_from_menu

Field descriptionThe number of times people clicked a link to view a store's menu after clicking an ad. This metric applies to feed items only.
CategoryMETRIC
Data TypeDOUBLE
Type URLgoogle.protobuf.DoubleValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

metrics.all_conversions_from_order

Field descriptionThe number of times people placed an order at a store after clicking an ad. This metric applies to feed items only.
CategoryMETRIC
Data TypeDOUBLE
Type URLgoogle.protobuf.DoubleValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

metrics.all_conversions_from_other_engagement

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

metrics.all_conversions_from_store_visit

Field descriptionEstimated number of times people visited a store after clicking an ad. This metric applies to feed items only.
CategoryMETRIC
Data TypeDOUBLE
Type URLgoogle.protobuf.DoubleValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

metrics.all_conversions_from_store_website

Field descriptionThe number of times that people were taken to a store's URL after clicking an ad. This metric applies to feed items only.
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_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_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_position

Field descriptionYour ad's position relative to those of other advertisers.
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.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.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.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.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

Send feedback about...

Google Ads API Beta
Google Ads API Beta
Need help? Visit our support page.