SearchTermView
A search term view with metrics aggregated by search term at the ad group level.
Table Specific Information
Select
Google Ads does not allow every column to be selected in a single query as some data will conflict if selected together. Therefore, when issuing a query that selects all columns, only the default metrics, segments, and attributes will be returned. In general, these defaults are the same fields that are exposed through the Ads console.
To use the nondefault fields, explicitly select them in your query.
Filters can also be used in the WHERE clause. The supported operators are the =, !=, >, >=, <, <=, LIKE, NOT LIKE, IN, and NOT IN operators. All filters must be joined by the AND keyword as OR is not supported by the Ads API.
Columns
Name | Type | Behavior | Description |
CustomerId | Long | ATTRIBUTE | Output only. The ID of the customer. |
SearchTermViewAdGroup | String | ATTRIBUTE | Output only. The ad group the search term served in. |
SearchTermViewResourceName | String | ATTRIBUTE | Output only. The 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} |
SearchTermViewSearchTerm | String | ATTRIBUTE | Output only. The search term. |
SearchTermViewStatus | String | ATTRIBUTE | Output only. Indicates whether the search term is currently one of your targeted or excluded keywords.
The allowed values are ADDED, ADDED_EXCLUDED, EXCLUDED, NONE, UNKNOWN, UNSPECIFIED. |
AbsoluteTopImpressionPercentage | Double | METRIC | Search absolute top impression share is the percentage of your Search ad impressions that are shown in the most prominent Search position. |
AllConversions | Double | METRIC | The total number of conversions. This includes all conversions regardless of the value of include_in_conversions_metric. |
AllConversionsFromInteractionsRate | Double | METRIC | All conversions from interactions (as oppose to view through conversions) divided by the number of ad interactions. |
AllConversionsFromInteractionsValuePerInteraction | Double | METRIC | The value of all conversions from interactions divided by the total number of interactions. |
AllConversionsValue | Double | METRIC | The value of all conversions. |
AllConversionsValuePerCost | Double | METRIC | The value of all conversions divided by the total cost of ad interactions (such as clicks for text ads or views for video ads). |
AverageCost | Double | METRIC | The average amount you pay per interaction. This amount is the total cost of your ads divided by the total number of interactions. |
AverageCpc | Double | METRIC | The total cost of all clicks divided by the total number of clicks received. |
AverageCpe | Double | METRIC | The average amount that you've been charged for an ad engagement. This amount is the total cost of all ad engagements divided by the total number of ad engagements. |
AverageCpm | Double | METRIC | Average cost-per-thousand impressions (CPM). |
AverageCpv | Double | METRIC | The average amount you pay each time someone views your ad. The average CPV is defined by the total cost of all ad views divided by the number of views. |
Clicks | Long | METRIC | The number of clicks. |
Conversions | Double | METRIC | The number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions. |
ConversionsFromInteractionsRate | Double | METRIC | Conversions from interactions divided by the number of ad interactions (such as clicks for text ads or views for video ads). This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions. |
ConversionsFromInteractionsValuePerInteraction | Double | METRIC | The value of conversions from interactions divided by the number of ad interactions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions. |
ConversionsValue | Double | METRIC | The value of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions. |
ConversionsValuePerCost | Double | METRIC | The value of conversions divided by the cost of ad interactions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions. |
CostMicros | Long | METRIC | The sum of your cost-per-click (CPC) and cost-per-thousand impressions (CPM) costs during this period. |
CostPerAllConversions | Double | METRIC | The cost of ad interactions divided by all conversions. |
CostPerConversion | Double | METRIC | The cost of ad interactions divided by conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions. |
CrossDeviceConversions | Double | METRIC | Conversions from when a customer clicks on a Google Ads ad on one device, then converts on a different device or browser. Cross-device conversions are already included in all_conversions. |
Ctr | Double | METRIC | The number of clicks your ad receives (Clicks) divided by the number of times your ad is shown (Impressions). |
EngagementRate | Double | METRIC | How often people engage with your ad after it's shown to them. This is the number of ad expansions divided by the number of times your ad is shown. |
Engagements | Long | METRIC | The number of engagements. An engagement occurs when a viewer expands your Lightbox ad. Also, in the future, other ad types may support engagement metrics. |
Impressions | Long | METRIC | Count of how often your ad has appeared on a search results page or website on the Google Network. |
InteractionEventTypes | String | METRIC | The types of payable and free interactions.
The allowed values are UNSPECIFIED, UNKNOWN, CLICK, ENGAGEMENT, VIDEO_VIEW, NONE. |
InteractionRate | Double | METRIC | How often people interact with your ad after it is shown to them. This is the number of interactions divided by the number of times your ad is shown. |
Interactions | Long | METRIC | The number of interactions. An interaction is the main user action associated with an ad format-clicks for text and shopping ads, views for video ads, and so on. |
TopImpressionPercentage | Double | METRIC | The percent of your ad impressions that are shown adjacent to the top organic search results. |
ValuePerAllConversions | Double | METRIC | The value of all conversions divided by the number of all conversions. |
ValuePerConversion | Double | METRIC | The value of conversions divided by the number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions. |
VideoQuartileP100Rate | Double | METRIC | Percentage of impressions where the viewer watched all of your video. |
VideoQuartileP25Rate | Double | METRIC | Percentage of impressions where the viewer watched 25% of your video. |
VideoQuartileP50Rate | Double | METRIC | Percentage of impressions where the viewer watched 50% of your video. |
VideoQuartileP75Rate | Double | METRIC | Percentage of impressions where the viewer watched 75% of your video. |
VideoViewRate | Double | METRIC | The number of views your TrueView video ad receives divided by its number of impressions, including thumbnail impressions for TrueView in-display ads. |
VideoViews | Long | METRIC | The number of times your video ads were viewed. |
ViewThroughConversions | Long | METRIC | The total number of view-through conversions. These happen when a customer sees an image or rich media ad, then later completes a conversion on your site without interacting with (for example, clicking on) another ad. |
AdNetworkType | String | SEGMENT | Ad network type.
The allowed values are CONTENT, GOOGLE_TV, MIXED, SEARCH, SEARCH_PARTNERS, UNKNOWN, UNSPECIFIED, YOUTUBE. |
ConversionAction | String | SEGMENT | Resource name of the conversion action. |
ConversionActionCategory | String | SEGMENT | Conversion action category.
The allowed values are ADD_TO_CART, BEGIN_CHECKOUT, BOOK_APPOINTMENT, CONTACT, CONVERTED_LEAD, DEFAULT, DOWNLOAD, ENGAGEMENT, GET_DIRECTIONS, IMPORTED_LEAD, OUTBOUND_CLICK, PAGE_VIEW, PHONE_CALL_LEAD, PURCHASE, QUALIFIED_LEAD, REQUEST_QUOTE, SIGNUP, STORE_SALE, STORE_VISIT, SUBMIT_LEAD_FORM, SUBSCRIBE_PAID, UNKNOWN, UNSPECIFIED. |
ConversionActionName | String | SEGMENT | Conversion action name. |
Date | Date | SEGMENT | Date to which metrics apply. yyyy-MM-dd format, for example, 2018-04-17. |
DayOfWeek | String | SEGMENT | Day of the week, for example, MONDAY.
The allowed values are FRIDAY, MONDAY, SATURDAY, SUNDAY, THURSDAY, TUESDAY, UNKNOWN, UNSPECIFIED, WEDNESDAY. |
Device | String | SEGMENT | Device to which metrics apply.
The allowed values are CONNECTED_TV, DESKTOP, MOBILE, OTHER, TABLET, UNKNOWN, UNSPECIFIED. |
ExternalConversionSource | String | SEGMENT | External conversion source.
The allowed values are AD_CALL_METRICS, ANALYTICS, ANALYTICS_SEARCH_ADS_360, ANDROID_FIRST_OPEN, ANDROID_IN_APP, APP_UNSPECIFIED, CLICK_TO_CALL, DISPLAY_AND_VIDEO_360_FLOODLIGHT, FIREBASE, FIREBASE_SEARCH_ADS_360, FLOODLIGHT, GOOGLE_ATTRIBUTION, GOOGLE_HOSTED, GOOGLE_PLAY, IOS_FIRST_OPEN, IOS_IN_APP, SALESFORCE, SEARCH_ADS_360, STORE_SALES, STORE_SALES_CRM, STORE_SALES_DIRECT_UPLOAD, STORE_SALES_PAYMENT_NETWORK, STORE_VISITS, THIRD_PARTY_APP_ANALYTICS, UNKNOWN, UNSPECIFIED, UPLOAD, UPLOAD_CALLS, WEBPAGE, WEBSITE_CALL_METRICS. |
KeywordAdGroupCriterion | String | SEGMENT | The AdGroupCriterion resource name. |
KeywordInfoMatchType | String | SEGMENT | The match type of the keyword.
The allowed values are BROAD, EXACT, PHRASE, UNKNOWN, UNSPECIFIED. |
KeywordInfoText | String | SEGMENT | The text of the keyword (at most 80 characters and 10 words). |
Month | Date | SEGMENT | Month as represented by the date of the first day of a month. Formatted as yyyy-MM-dd. |
MonthOfYear | String | SEGMENT | Month of the year, for example, January.
The allowed values are APRIL, AUGUST, DECEMBER, FEBRUARY, JANUARY, JULY, JUNE, MARCH, MAY, NOVEMBER, OCTOBER, SEPTEMBER, UNKNOWN, UNSPECIFIED. |
Period | String | SEGMENT | Predefined date range.
The allowed values are TODAY, YESTERDAY, LAST_7_DAYS, LAST_BUSINESS_WEEK, THIS_MONTH, LAST_MONTH, LAST_14_DAYS, LAST_30_DAYS, THIS_WEEK_SUN_TODAY, THIS_WEEK_MON_TODAY, LAST_WEEK_SUN_SAT, LAST_WEEK_MON_SUN. |
Quarter | Date | SEGMENT | Quarter as represented by the date of the first day of a quarter. Uses the calendar year for quarters, for example, the second quarter of 2018 starts on 2018-04-01. Formatted as yyyy-MM-dd. |
SearchTermMatchType | String | SEGMENT | Match type of the keyword that triggered the ad, including variants.
The allowed values are BROAD, EXACT, NEAR_EXACT, NEAR_PHRASE, PHRASE, UNKNOWN, UNSPECIFIED. |
Week | Date | SEGMENT | Week as defined as Monday through Sunday, and represented by the date of Monday. Formatted as yyyy-MM-dd. |
Year | Int | SEGMENT | Year, formatted as yyyy. |
Pseudo-Columns
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
ManagerId | Long | Id of the manager account on behalf of which you are requesting customer data. |