UserLocationPerformanceReportColumn Value Set - Reporting

Defines the attributes and performance statistics columns that you can include in the UserLocationPerformanceReportRequest.

The attribute columns that you include in a report can affect how the statistics are aggregated. In other words the number of rows increase by a factor of the unique attributes. For more information, see Columns that Group the Data.

For a list of columns that you must include, please see the Required Columns section below.

To see how far back hourly, daily, weekly, monthly, yearly and summary aggregated data can be retrieved for a report, see Report Data Retention Time Periods.

Syntax

<xs:simpleType name="UserLocationPerformanceReportColumn" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:restriction base="xs:string">
    <xs:enumeration value="AccountName" />
    <xs:enumeration value="AccountNumber" />
    <xs:enumeration value="AccountId" />
    <xs:enumeration value="TimePeriod" />
    <xs:enumeration value="CampaignName" />
    <xs:enumeration value="CampaignId" />
    <xs:enumeration value="AdGroupName" />
    <xs:enumeration value="AdGroupId" />
    <xs:enumeration value="Country" />
    <xs:enumeration value="State" />
    <xs:enumeration value="MetroArea" />
    <xs:enumeration value="CurrencyCode" />
    <xs:enumeration value="AdDistribution" />
    <xs:enumeration value="Impressions" />
    <xs:enumeration value="Clicks" />
    <xs:enumeration value="Ctr" />
    <xs:enumeration value="AverageCpc" />
    <xs:enumeration value="Spend" />
    <xs:enumeration value="AveragePosition" />
    <xs:enumeration value="ProximityTargetLocation" />
    <xs:enumeration value="Radius" />
    <xs:enumeration value="Language" />
    <xs:enumeration value="City" />
    <xs:enumeration value="QueryIntentCountry" />
    <xs:enumeration value="QueryIntentState" />
    <xs:enumeration value="QueryIntentCity" />
    <xs:enumeration value="QueryIntentDMA" />
    <xs:enumeration value="BidMatchType" />
    <xs:enumeration value="DeliveredMatchType" />
    <xs:enumeration value="Network" />
    <xs:enumeration value="TopVsOther" />
    <xs:enumeration value="DeviceType" />
    <xs:enumeration value="DeviceOS" />
    <xs:enumeration value="Assists" />
    <xs:enumeration value="Conversions" />
    <xs:enumeration value="ConversionRate" />
    <xs:enumeration value="Revenue" />
    <xs:enumeration value="ReturnOnAdSpend" />
    <xs:enumeration value="CostPerConversion" />
    <xs:enumeration value="CostPerAssist" />
    <xs:enumeration value="RevenuePerConversion" />
    <xs:enumeration value="RevenuePerAssist" />
    <xs:enumeration value="County" />
    <xs:enumeration value="PostalCode" />
    <xs:enumeration value="QueryIntentCounty" />
    <xs:enumeration value="QueryIntentPostalCode" />
    <xs:enumeration value="LocationId" />
    <xs:enumeration value="QueryIntentLocationId" />
    <xs:enumeration value="AllConversions" />
    <xs:enumeration value="AllRevenue" />
    <xs:enumeration value="AllConversionRate" />
    <xs:enumeration value="AllCostPerConversion" />
    <xs:enumeration value="AllReturnOnAdSpend" />
    <xs:enumeration value="AllRevenuePerConversion" />
    <xs:enumeration value="ViewThroughConversions" />
  </xs:restriction>
</xs:simpleType>

Values

Value Description
AccountId The Microsoft Advertising assigned identifier of an account.
AccountName The account name.
AccountNumber The Microsoft Advertising assigned number of an account.
AdDistribution The network where you want your ads to show.
AdGroupId The Microsoft Advertising assigned identifier of an ad group.
AdGroupName The ad group name.
AllConversionRate The conversion rate as a percentage.

The number of conversions, divided by the total number of clicks. For example, if the ads in your campaign got 300 clicks and four conversions, the conversion rate is 1.33 (%).

The formula for calculating the conversion rate is (Conversions / Clicks) x 100.

Data will be excluded from the ConversionRate report column for any conversion goal with the ExcludeFromBidding property set to true. The AllConversionRate column will include data for all conversion goals regardless of their ExcludeFromBidding setting.

Available for accounts that are setup to use analytics with Microsoft Advertising Universal Event Tracking. For more information, see the Track sales and other conversions help topic.
AllConversions The number of conversions.

A conversion is the completion of an action by a customer after viewing your ad. The action could be purchasing your product, registering for your webinar, joining an organization, or whatever you consider your goal and best measure of the ad's success.

Conversions are measured by adding a small bit of code to your website pages so that a visitor's progress through your site can be tracked.

Data will be excluded from the Conversions report column for any conversion goal with the ExcludeFromBidding property set to true. The AllConversions column will include data for all conversion goals regardless of their ExcludeFromBidding setting.

Available for accounts that are setup to use analytics with Microsoft Advertising Universal Event Tracking. For more information, see the Track sales and other conversions help topic.
AllCostPerConversion The cost per conversion.

The formula for calculating the cost per conversion is (Spend / Conversions). Only ads in campaigns that enable conversion tracking contribute to the conversion number, so unless all campaigns in the account enable conversion tracking, the number will not be accurate.

Data will be excluded from the CostPerConversion report column for any conversion goal with the ExcludeFromBidding property set to true. The AllCostPerConversion column will include data for all conversion goals regardless of their ExcludeFromBidding setting.

Available for accounts that are setup to use analytics with Microsoft Advertising Universal Event Tracking. For more information, see the Track sales and other conversions help topic.
AllReturnOnAdSpend The return on ad spend (ROAS).

The formula for calculating the ROAS is (Revenue / Spend).

Data will be excluded from the ReturnOnAdSpend report column for any conversion goal with the ExcludeFromBidding property set to true. The AllReturnOnAdSpend column will include data for all conversion goals regardless of their ExcludeFromBidding setting.

Available for accounts that are setup to use analytics with Microsoft Advertising Universal Event Tracking. For more information, see the Track sales and other conversions help topic.
AllRevenue The revenue optionally reported by the advertiser as a result of conversions.

Data will be excluded from the Revenue report column for any conversion goal with the ExcludeFromBidding property set to true. The AllRevenue column will include data for all conversion goals regardless of their ExcludeFromBidding setting.

Available for accounts that are setup to use analytics with Microsoft Advertising Universal Event Tracking. For more information, see the Track sales and other conversions help topic.
AllRevenuePerConversion The revenue per conversion.

The formula for calculating the revenue per conversion is (Revenue / Conversions).

Data will be excluded from the RevenuePerConversion report column for any conversion goal with the ExcludeFromBidding property set to true. The AllRevenuePerConversion column will include data for all conversion goals regardless of their ExcludeFromBidding setting.

Available for accounts that are setup to use analytics with Microsoft Advertising Universal Event Tracking. For more information, see the Track sales and other conversions help topic.
Assists The number of conversions from other ads within the same account that were preceded by one or more clicks from this ad. An ad is considered to have assisted the conversion if it was clicked before the most recently clicked ad that was credited with the conversion. Additionally, the click corresponding to the assist must occur within the conversion period of the goal.
AverageCpc The average cost per click (CPC). The total cost of all clicks on an ad divided by the number of clicks. This is the average amount you're actually charged each time your ad is clicked. For example, if you paid a total of 48.35 for 300 clicks, your average CPC is 0.16. The formula for calculating the average CPC is (Spend /Clicks).
AveragePosition The average position of the ad on a webpage.

Average position will be deprecated from performance reports beginning in April 2020. From the deprecation date onwards, performance reports will return average position of "0" (zero). Historical average position data for time periods prior to the deprecation date will still be available according to the published data retention period per report type.
BidMatchType The keyword bid match type. This can be different from the DeliveredMatchType column, for example if you bid on a broad match and the search term was an exact match. For more information, see Budget and Bid Strategies. The possible values are Broad, Exact, Phrase, and Unknown.
CampaignId The Microsoft Advertising assigned identifier of a campaign.
CampaignName The campaign name.
City The city where the user was physically located when they clicked the ad.

The location where the user was in physically when they clicked the ad.
Clicks Clicks are what you pay for. Clicks typically include a customer clicking an ad on a search results page or on a website on the search network. Clicks can also come from other sources (for example, spiders, robots, and test servers). For more information, see Microsoft Advertising click measurement: description of methodology.
ConversionRate The conversion rate as a percentage.

The number of conversions, divided by the total number of clicks. For example, if the ads in your campaign got 300 clicks and four conversions, the conversion rate is 1.33 (%).

The formula for calculating the conversion rate is (Conversions / Clicks) x 100.

Data will be excluded from the ConversionRate report column for any conversion goal with the ExcludeFromBidding property set to true. The AllConversionRate column will include data for all conversion goals regardless of their ExcludeFromBidding setting.

Available for accounts that are setup to use analytics with Microsoft Advertising Universal Event Tracking. For more information, see the Track sales and other conversions help topic.
Conversions The number of conversions.

A conversion is the completion of an action by a customer after viewing your ad. The action could be purchasing your product, registering for your webinar, joining an organization, or whatever you consider your goal and best measure of the ad's success.

Conversions are measured by adding a small bit of code to your website pages so that a visitor's progress through your site can be tracked.

Data will be excluded from the Conversions report column for any conversion goal with the ExcludeFromBidding property set to true. The AllConversions column will include data for all conversion goals regardless of their ExcludeFromBidding setting.

Available for accounts that are setup to use analytics with Microsoft Advertising Universal Event Tracking. For more information, see the Track sales and other conversions help topic.
CostPerAssist The cost per assist. The formula for calculating the cost per assist is (Spend / Assists).
CostPerConversion The cost per conversion.

The formula for calculating the cost per conversion is (Spend / Conversions). Only ads in campaigns that enable conversion tracking contribute to the conversion number, so unless all campaigns in the account enable conversion tracking, the number will not be accurate.

Data will be excluded from the CostPerConversion report column for any conversion goal with the ExcludeFromBidding property set to true. The AllCostPerConversion column will include data for all conversion goals regardless of their ExcludeFromBidding setting.

Available for accounts that are setup to use analytics with Microsoft Advertising Universal Event Tracking. For more information, see the Track sales and other conversions help topic.
Country The country where the user was physically located when they clicked the ad.
County The county where the user was physically located when they clicked the ad.
Ctr The click-through rate (CTR) is the number of times an ad was clicked, divided by the number of times the ad was shown (impressions). For example, if your ads got 50 clicks given 2,348 impressions, your CTR is 2.13 (%). The formula for calculating CTR is (Clicks / Impressions) x 100.
CurrencyCode The account currency type. For possible values, see Currencies.
DeliveredMatchType The match type used to deliver an ad. This can be different from the BidMatchType column, for example if you bid on a broad match and the search term was an exact match. For more information, see Budget and Bid Strategies. The possible values are Broad, Exact, Phrase, and Unknown.
DeviceOS The operating system of the device reported in the DeviceType column. The possible values include Android, Blackberry, iOS, Other, Unknown, and Windows. If the operating system of the device cannot be determined or is not one of the operating systems that you can target, the value in this column will be Unknown.
DeviceType The device name attribute of a device OS target bid. The type of device which showed ads. The possible values include Computer, Smartphone, Tablet, and Unknown.
Impressions The number of times an ad has been displayed on search results pages. Without impressions there are no clicks or conversions.
Language The language of the country the ad is served in.

For possible values, see the Language column of Ad Languages. The language display name will be provided in the report e.g. English.
LocationId The Microsoft Advertising identifier of the location where the user was physically located when they clicked the ad.

For geographical location identifiers, see Geographical Location Codes.If the location ID is in the report but not found in the file downloaded via GetGeoLocationsFileUrl, it is not targetable.
MetroArea The metro area (Nielsen DMA® in the United States) where the user was physically located when they clicked the ad.
Network The combined search advertising marketplace made up of Bing, AOL, Yahoo, and partner sites. Use this data to make the best decision on network selection for your ad groups. The possible values include AOL search, Audience, Bing and Yahoo! search, Content, and Syndicated search partners.
PostalCode The postal code where the user was physically located when they clicked the ad.
ProximityTargetLocation The radius target bid name. The name of the geographic radius where the user was physically located when they clicked the ad. The Radius attribute column contains the distance of the radius.
QueryIntentCity The name of a city if the user's geographical intent can be determined. The city is set if the user's intent is a city, and not necessarily if they are physically located in the city.
QueryIntentCountry The name of a country if the user's geographical intent can be determined. The country is set if the user's intent is related to a country, and not necessarily if they are physically located in the county.
QueryIntentCounty The name of a county if the user's geographical intent can be determined. The county is set if the user's intent is related to a county, and not necessarily if they are physically located in the county.
QueryIntentDMA The name of a metro area (Nielsen DMA® in the United States) if the user's geographical intent can be determined. The metro area is set if the user's intent is a metro area or city within the metro area, and not necessarily if they are physically located in the metro area.
QueryIntentLocationId The location identifier if the user's geographical intent can be determined.
QueryIntentPostalCode The name of a postal code if the user's geographical intent can be determined. The postal code is set if the user's intent is a postal code, and not necessarily if they are physically located in the postal code.
QueryIntentState The name of a state if the user's geographical intent can be determined. The state is set if the user's intent is a state or sub geography of the state, and not necessarily if they are physically located in the state.
Radius The radius of a radius target bid. The geographic radius where the user was physically located when they clicked the ad. The ProximityTargetLocation attribute column contains the address or landmark name of the radius.
ReturnOnAdSpend The return on ad spend (ROAS).

The formula for calculating the ROAS is (Revenue / Spend).

Data will be excluded from the ReturnOnAdSpend report column for any conversion goal with the ExcludeFromBidding property set to true. The AllReturnOnAdSpend column will include data for all conversion goals regardless of their ExcludeFromBidding setting.

Available for accounts that are setup to use analytics with Microsoft Advertising Universal Event Tracking. For more information, see the Track sales and other conversions help topic.
Revenue The revenue optionally reported by the advertiser as a result of conversions.

Data will be excluded from the Revenue report column for any conversion goal with the ExcludeFromBidding property set to true. The AllRevenue column will include data for all conversion goals regardless of their ExcludeFromBidding setting.

Available for accounts that are setup to use analytics with Microsoft Advertising Universal Event Tracking. For more information, see the Track sales and other conversions help topic.
RevenuePerAssist The revenue per assist. The formula for calculating the revenue per assist is (Revenue / Assists).
RevenuePerConversion The revenue per conversion.

The formula for calculating the revenue per conversion is (Revenue / Conversions).

Data will be excluded from the RevenuePerConversion report column for any conversion goal with the ExcludeFromBidding property set to true. The AllRevenuePerConversion column will include data for all conversion goals regardless of their ExcludeFromBidding setting.

Available for accounts that are setup to use analytics with Microsoft Advertising Universal Event Tracking. For more information, see the Track sales and other conversions help topic.
Spend The cost per click (CPC) summed for each click.
State The state where the user was physically located when they clicked the ad.

The location where the user was in physically when they clicked the ad.
TimePeriod The time period of each report row. You may not include this column if the Aggregation element of the request object is set to Summary. For more information, see Time Period Column.
TopVsOther The report will include a column that indicates whether the ad impression appeared in a top position or elsewhere. The possible values include AOL search - Top, AOL search - Other, Audience network, Bing and Yahoo! search - Top, Bing and Yahoo! search - Other, Syndicated search partners - Top, Syndicated search partners - Other, Content network, and Unknown.
ViewThroughConversions View-through conversions are conversions that people make after they have seen your ad, even though they did not click the ad.

View-through conversions don’t have a click associated but do have an impression associated within the advertiser defined conversion window.​ If the user also clicked on an ad that was delivered via the Microsoft Audience or Search network, there won't be any view-through conversion counted. Only the click-based conversion would be counted.

View-through conversions are only counted for ads in the Microsoft Audience network.

Not everyone has view-through conversions yet. If you don't, don't worry. It's coming soon.

Remarks

Required Columns

The report must include the following columns. As a general rule, each report must include at least one non-impression share attribute column and at least one performance statistics column. For more information, see Report Attributes and Performance Statistics.

Note

The TimePeriod column is expected for all aggregation types except Summary. It is important to note that if you do not include TimePeriod, the aggregation you chose will be ignored and Summary aggregation will be used regardless.

Column
AccountName
TimePeriod

Requirements

Service: ReportingService.svc v13
Namespace: https://bingads.microsoft.com/Reporting/v13

Used By

UserLocationPerformanceReportRequest