UserLocationView
A user location view.
View-Specific Information
Select
Google Ads does not allow every column to be selected in a single query, as some data conflicts if selected together. Therefore, when issuing a query that selects all columns, only the default metrics, segments, and attributes are 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 using the following supported operators: =, !=, >, >=, <, <=, LIKE, NOT LIKE, IN, NOT IN . Note that all filters must be joined by AND, as OR is not supported by the Ads API.
Columns
| Name | Type | Behavior | Description |
| AdGroupId | Long | SEGMENT | Output only. The ID of the ad group. |
| CampaignId | Long | SEGMENT | Output only. The ID of the campaign. |
| CustomerId | Long | ATTRIBUTE | Output only. The ID of the customer. |
| UserLocationViewCountryCriterionId | Long | ATTRIBUTE | Output only. Criterion Id for the country. |
| UserLocationViewResourceName | String | ATTRIBUTE | Output only. The resource name of the user location view. UserLocation view resource names have the form: customers/{customer_id}/userLocationViews/{country_criterion_id}~{targeting_location} |
| UserLocationViewTargetingLocation | Bool | ATTRIBUTE | Output only. Indicates whether location was targeted or not. |
| AllConversions | Double | METRIC | The total number of conversions. This includes all conversions regardless of the value of include_in_conversions_metric. |
| AllConversionsByConversionDate | Double | METRIC | The total number of conversions. This includes all conversions regardless of the value of include_in_conversions_metric. When this column is selected with date, the values in date column means the conversion date. Details for the by_conversion_date columns are available at Understand conversions by time with new columns. |
| AllConversionsFromInteractionsRate | Double | METRIC | All conversions from interactions (as oppose to view through conversions) divided by the number of ad interactions. |
| AllConversionsValue | Double | METRIC | The value of all conversions. |
| AllConversionsValueByConversionDate | Double | METRIC | The value of all conversions. When this column is selected with date, the values in date column means the conversion date. Details for the by_conversion_date columns are available at Understand conversions by time with new columns. |
| 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. |
| AverageCpm | Double | METRIC | Average cost-per-thousand impressions (CPM). |
| 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. |
| ConversionsByConversionDate | 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. When this column is selected with date, the values in date column means the conversion date. Details for the by_conversion_date columns are available at Understand conversions by time with new columns. |
| 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. |
| 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. |
| ConversionsValueByConversionDate | 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. When this column is selected with date, the values in date column means the conversion date. Details for the by_conversion_date columns are available at Understand conversions by time with new columns. |
| 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. |
| CrossDeviceConversionsByConversionDate | Double | METRIC | The number of cross-device conversions by conversion date. Details for the by_conversion_date columns are available at Understand conversions by time with new columns |
| CrossDeviceConversionsValueByConversionDate | Double | METRIC | The sum of cross-device conversions value by conversion date. Details for the by_conversion_date columns are available at Understand conversions by time with new columns |
| Ctr | Double | METRIC | The number of clicks your ad receives (Clicks) divided by the number of times your ad is shown (Impressions). |
| 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 CLICK, ENGAGEMENT, NONE, UNKNOWN, VIDEO_VIEW. |
| 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. |
| TrueviewAverageCpv | 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 TrueView views. |
| ValuePerAllConversions | Double | METRIC | The value of all conversions divided by the number of all conversions. |
| ValuePerAllConversionsByConversionDate | Double | METRIC | The value of all conversions divided by the number of all conversions. When this column is selected with date, the values in date column means the conversion date. Details for the by_conversion_date columns are available at Understand conversions by time with new columns. |
| ValuePerConversion | Double | METRIC | The value of conversions divided by the number of conversions. This only includes conversion actions for which the include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions. |
| ValuePerConversionsByConversionDate | Double | METRIC | The value of conversions divided by the number of conversions. This only includes conversion actions for which the include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions. When this column is selected with date, the values in date column means the conversion date. Details for the by_conversion_date columns are available at Understand conversions by time with new columns. |
| VideoTrueviewViewRate | Double | METRIC | The number of TrueView views your video ad receives divided by its number of impressions, including thumbnail impressions for TrueView in-display ads. |
| VideoTrueviewViews | Long | METRIC | The number of TrueView views your video ads received. |
| 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, DISCOVER, GMAIL, GOOGLE_OWNED_CHANNELS, GOOGLE_TV, MAPS, MIXED, SEARCH, SEARCH_PARTNERS, UNKNOWN, YOUTUBE. |
| AdSubNetworkType | String | SEGMENT | Ad sub network type. Currently only available for ads running as part of DemandGen campaigns on YouTube and has to always be selected together with ad_network_type.
The allowed values are UNKNOWN, UNSEGMENTED, YOUTUBE_INFEED, YOUTUBE_INSTREAM, YOUTUBE_SHORTS. |
| 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, YOUTUBE_FOLLOW_ON_VIEWS. |
| 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, WEDNESDAY. |
| Device | String | SEGMENT | Device to which metrics apply.
The allowed values are CONNECTED_TV, DESKTOP, MOBILE, OTHER, TABLET, UNKNOWN. |
| 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, UPLOAD, UPLOAD_CALLS, WEBPAGE, WEBSITE_CALL_METRICS. |
| GeoTargetAirport | String | SEGMENT | Resource name of the geo target constant that represents an airport. |
| GeoTargetCanton | String | SEGMENT | Resource name of the geo target constant that represents a canton. |
| GeoTargetCity | String | SEGMENT | Resource name of the geo target constant that represents a city. |
| GeoTargetCounty | String | SEGMENT | Resource name of the geo target constant that represents a county. |
| GeoTargetDistrict | String | SEGMENT | Resource name of the geo target constant that represents a district. |
| GeoTargetMetro | String | SEGMENT | Resource name of the geo target constant that represents a metro. |
| GeoTargetMostSpecificLocation | String | SEGMENT | Resource name of the geo target constant that represents the most specific location. |
| GeoTargetPostalCode | String | SEGMENT | Resource name of the geo target constant that represents a postal code. |
| GeoTargetProvince | String | SEGMENT | Resource name of the geo target constant that represents a province. |
| GeoTargetRegion | String | SEGMENT | Resource name of the geo target constant that represents a region. |
| GeoTargetState | String | SEGMENT | Resource name of the geo target constant that represents a state. |
| 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. |
| 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. |
| 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. |
Pseudocolumns
Pseudocolumn fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.
| Name | Type | Description |
| ManagerId | Long | Id of the manager account on behalf of which you are requesting customer data. |