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

search_term_view

The search term view 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

search_term_view.ad_group

Field descriptionThe ad group the search term served in.
CategoryATTRIBUTE
Data Type RESOURCE_NAME
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableFalse
RepeatedFalse

search_term_view.resource_name

Field descriptionThe resource name of the search term view. Search term view resource names have the form: `customers/{customer_id}/searchTermViews/{campaign_id}~{ad_group_id}~{URL-base64_search_term}`
CategoryATTRIBUTE
Data Type RESOURCE_NAME
Type URLN/A
FilterableTrue
SelectableTrue
SortableFalse
RepeatedFalse

search_term_view.search_term

Field descriptionThe search term.
CategoryATTRIBUTE
Data Type STRING
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

search_term_view.status

Field descriptionIndicates whether the search term is currently one of your targeted or excluded keywords.
CategoryATTRIBUTE
Data Type
Type URLgoogle.ads.googleads.v2.enums.SearchTermTargetingStatusEnum.SearchTermTargetingStatus
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

segments.ad_network_type

Field descriptionAd network type.
CategorySEGMENT
Data TypeENUM
Type URLgoogle.ads.googleads.v2.enums.AdNetworkTypeEnum.AdNetworkType
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.v2.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.v2.enums.DayOfWeekEnum.DayOfWeek
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

segments.device

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

segments.external_conversion_source

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

segments.keyword.ad_group_criterion

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

segments.keyword.info.match_type

Field descriptionThe match type of the keyword.
CategorySEGMENT
Data TypeENUM
Type URLgoogle.ads.googleads.v2.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 TypeSTRING
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 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.v2.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.search_term_match_type

Field descriptionMatch type of the keyword that triggered the ad, including variants.
CategorySEGMENT
Data TypeENUM
Type URLgoogle.ads.googleads.v2.enums.SearchTermMatchTypeEnum.SearchTermMatchType
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_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_interactions_value_per_interaction

Field descriptionThe value of all conversions from interactions divided by the total number of 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.all_conversions_value_per_cost

Field descriptionThe value of all conversions divided by the total cost of ad interactions (such as clicks for text ads or views for video ads).
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.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_from_interactions_value_per_interaction

Field descriptionThe value of conversions from interactions divided by the number of ad interactions. This only includes conversion actions which include_in_conversions_metric attribute is set to true.
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.conversions_value_per_cost

Field descriptionThe value of conversions divided by the cost of ad interactions. This only includes conversion actions which include_in_conversions_metric attribute is set to true.
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.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.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.v2.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.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_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

Send feedback about...

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