ProductDimensionPerformanceReportColumn Value Set - Reporting
Defines the attributes and performance statistics columns that you can include in the ProductDimensionPerformanceReportRequest.
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="ProductDimensionPerformanceReportColumn" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:restriction base="xs:string">
<xs:enumeration value="TimePeriod" />
<xs:enumeration value="AccountName" />
<xs:enumeration value="AccountNumber" />
<xs:enumeration value="AdGroupName" />
<xs:enumeration value="AdGroupId" />
<xs:enumeration value="CampaignStatus" />
<xs:enumeration value="AccountStatus" />
<xs:enumeration value="AdGroupStatus" />
<xs:enumeration value="Network" />
<xs:enumeration value="AdId" />
<xs:enumeration value="CampaignId" />
<xs:enumeration value="CampaignName" />
<xs:enumeration value="CurrencyCode" />
<xs:enumeration value="DeviceType" />
<xs:enumeration value="Language" />
<xs:enumeration value="MerchantProductId" />
<xs:enumeration value="Title" />
<xs:enumeration value="Condition" />
<xs:enumeration value="Brand" />
<xs:enumeration value="Price" />
<xs:enumeration value="CustomLabel0" />
<xs:enumeration value="CustomLabel1" />
<xs:enumeration value="CustomLabel2" />
<xs:enumeration value="CustomLabel3" />
<xs:enumeration value="CustomLabel4" />
<xs:enumeration value="ProductType1" />
<xs:enumeration value="ProductType2" />
<xs:enumeration value="ProductType3" />
<xs:enumeration value="ProductType4" />
<xs:enumeration value="ProductType5" />
<xs:enumeration value="ProductCategory1" />
<xs:enumeration value="ProductCategory2" />
<xs:enumeration value="ProductCategory3" />
<xs:enumeration value="ProductCategory4" />
<xs:enumeration value="ProductCategory5" />
<xs:enumeration value="Impressions" />
<xs:enumeration value="Clicks" />
<xs:enumeration value="Ctr" />
<xs:enumeration value="AverageCpc" />
<xs:enumeration value="Spend" />
<xs:enumeration value="Conversions" />
<xs:enumeration value="ConversionRate" />
<xs:enumeration value="Revenue" />
<xs:enumeration value="RevenuePerConversion" />
<xs:enumeration value="SellerName" />
<xs:enumeration value="OfferLanguage" />
<xs:enumeration value="CountryOfSale" />
<xs:enumeration value="AdStatus" />
<xs:enumeration value="ImpressionSharePercent" />
<xs:enumeration value="ImpressionLostToBudgetPercent" />
<xs:enumeration value="ImpressionLostToRankPercent" />
<xs:enumeration value="BenchmarkBid" />
<xs:enumeration value="BenchmarkCtr" />
<xs:enumeration value="TopVsOther" />
<xs:enumeration value="AdDistribution" />
<xs:enumeration value="ClickTypeId" />
<xs:enumeration value="TotalClicksOnAdElements" />
<xs:enumeration value="ClickType" />
<xs:enumeration value="ReturnOnAdSpend" />
<xs:enumeration value="BidStrategyType" />
<xs:enumeration value="LocalStoreCode" />
<xs:enumeration value="StoreId" />
<xs:enumeration value="AssistedImpressions" />
<xs:enumeration value="AssistedClicks" />
<xs:enumeration value="ClickSharePercent" />
<xs:enumeration value="AbsoluteTopImpressionSharePercent" />
<xs:enumeration value="AssistedConversions" />
<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="CostPerConversion" />
<xs:enumeration value="ViewThroughConversions" />
<xs:enumeration value="Goal" />
<xs:enumeration value="GoalType" />
<xs:enumeration value="ProductBought" />
<xs:enumeration value="QuantityBought" />
<xs:enumeration value="AbsoluteTopImpressionRatePercent" />
<xs:enumeration value="AverageCpm" />
<xs:enumeration value="ConversionsQualified" />
<xs:enumeration value="AssistedConversionsQualified" />
<xs:enumeration value="AllConversionsQualified" />
<xs:enumeration value="ViewThroughConversionsQualified" />
<xs:enumeration value="ProductBoughtTitle" />
<xs:enumeration value="GTIN" />
<xs:enumeration value="MPN" />
<xs:enumeration value="ViewThroughRevenue" />
<xs:enumeration value="GoalId" />
<xs:enumeration value="Sales" />
<xs:enumeration value="CostPerSale" />
<xs:enumeration value="RevenuePerSale" />
<xs:enumeration value="Installs" />
<xs:enumeration value="CostPerInstall" />
<xs:enumeration value="RevenuePerInstall" />
<xs:enumeration value="CampaignType" />
<xs:enumeration value="AssetGroupId" />
<xs:enumeration value="AssetGroupName" />
<xs:enumeration value="AssetGroupStatus" />
<xs:enumeration value="CollectionId" />
</xs:restriction>
</xs:simpleType>
Values
The ProductDimensionPerformanceReportColumn value set has the following values: AbsoluteTopImpressionRatePercent, AbsoluteTopImpressionSharePercent, AccountName, AccountNumber, AccountStatus, AdDistribution, AdGroupId, AdGroupName, AdGroupStatus, AdId, AdStatus, AllConversionRate, AllConversions, AllConversionsQualified, AllCostPerConversion, AllReturnOnAdSpend, AllRevenue, AllRevenuePerConversion, AssetGroupId, AssetGroupName, AssetGroupStatus, AssistedClicks, AssistedConversions, AssistedConversionsQualified, AssistedImpressions, AverageCpc, AverageCpm, BenchmarkBid, BenchmarkCtr, BidStrategyType, Brand, CampaignId, CampaignName, CampaignStatus, CampaignType, Clicks, ClickSharePercent, ClickType, ClickTypeId, CollectionId, Condition, ConversionRate, Conversions, ConversionsQualified, CostPerConversion, CostPerInstall, CostPerSale, CountryOfSale, Ctr, CurrencyCode, CustomLabel0, CustomLabel1, CustomLabel2, CustomLabel3, CustomLabel4, DeviceType, Goal, GoalId, GoalType, GTIN, ImpressionLostToBudgetPercent, ImpressionLostToRankPercent, Impressions, ImpressionSharePercent, Installs, Language, LocalStoreCode, MerchantProductId, MPN, Network, OfferLanguage, Price, ProductBought, ProductBoughtTitle, ProductCategory1, ProductCategory2, ProductCategory3, ProductCategory4, ProductCategory5, ProductType1, ProductType2, ProductType3, ProductType4, ProductType5, QuantityBought, ReturnOnAdSpend, Revenue, RevenuePerConversion, RevenuePerInstall, RevenuePerSale, Sales, SellerName, Spend, StoreId, TimePeriod, Title, TopVsOther, TotalClicksOnAdElements, ViewThroughConversions, ViewThroughConversionsQualified, ViewThroughRevenue.
| Value | Description |
|---|---|
| AbsoluteTopImpressionRatePercent | How often your ad was in the first position of all results, as a percentage of your total impressions. A higher number indicates your ad is frequently showing in the best ad position. The value of this column is empty if the data is not available. Neither Hourly or HourOfDay aggregation are supported. If you include this column with Hourly or HourOfDay aggregation the service will not return an error and you should ignore any performance data returned for this column. |
| AbsoluteTopImpressionSharePercent | The number of times your ad is shown in the top position as a percentage of the total available impressions in the market you were targeting. Reports on impression highlight information about how many impressions you're missing in the top slot and why. You can use this data to inform you about making changes to get more impressions, increase the likelihood of more clicks on those ads, and as a result, increase the likelihood of more sales. If you include this column, then you may not include restricted attributes such as TopVsOther in the same report request. Likewise if you include any of the restricted attribute columns, then you must exclude this column. For more information, see Column Restrictions. |
| AccountName | The account name. |
| AccountNumber | The Microsoft Advertising assigned number of an account. |
| AccountStatus | The account status. |
| AdDistribution | The network where you want your ads to show. This can be the entire Microsoft Advertising Network, Microsoft sites and select traffic, cross-network traffic, or only partner traffic (this network type is deprecated as of July 2024). |
| AdGroupId | The Microsoft Advertising assigned identifier of an ad group. |
| AdGroupName | The ad group name. |
| AdGroupStatus | The ad group status. |
| AdId | The Microsoft Advertising assigned identifier of an ad. |
| AdStatus | The ad status. |
| 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. This column is deprecated as of 2022, so you should use the AllConversionsQualified column instead. Going forward, performance reports will return "0" (zero) in this column. Historical data for time periods prior to the deprecation date will still be available according to the published data retention period. |
| AllConversionsQualified | 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. You should expect the data type as double whether or not there are partial externally attributed offline conversions. Not everyone has this feature yet. If you don't, don't worry - it's coming soon! |
| 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. |
| AssetGroupId | The Microsoft Advertising assigned identifier of an asset group. |
| AssetGroupName | The asset group name. |
| AssetGroupStatus | The asset group status. |
| AssistedClicks | Clicks on your ads that have received co-bids from your manufacturer partners. 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). This performance statistic is only available for Sponsored Products in Microsoft Shopping Campaigns. |
| AssistedConversions | 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. |
| AssistedConversionsQualified | Reserved for future use. |
| AssistedImpressions | The number of times an ad that is being co-bid by your manufacturer partners has been displayed on search results pages or other sites on the Microsoft Advertising Network. This performance statistic is only available for Sponsored Products in Microsoft Shopping Campaigns. |
| 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). |
| AverageCpm | The total advertising cost divided by the number of impressions (in thousands).<br/ In Latin, mille means a thousand. Also, sometimes called average cost per thousand (CPT). This is a standard advertising industry performance metric that we calculate based on your spend and number of impressions. The goal of CPM-based ad budgeting is to build awareness of your brand to large audiences. CPM tells you how much it costs to get an ad to the type of users you're targeting. |
| BenchmarkBid | Shows you how much other advertisers are bidding on average on similar products as your current target. Use this information as a benchmark to compare your bidding strategy for a product group against that of other advertisers advertising similar products. If the benchmark bid is significantly higher than your bid, you might consider raising your bid. |
| BenchmarkCtr | Shows you how other product ads for similar products are performing on average based on how often people who see the ad end up clicking on it. If the benchmark CTR is significantly higher than the CTR for your product group, you might consider raising your bid for that product group, or improving the product information, particularly product images and titles. |
| BidStrategyType | The bid strategy type. Possible values include EnhancedCpc and ManualCpc. If the InheritFromParent strategy type is used, the report will include the inherited bid strategy type e.g. one of the supported values listed above. |
| Brand | The product item's manufacturer, brand, or publisher. |
| CampaignId | The Microsoft Advertising assigned identifier of a campaign. |
| CampaignName | The campaign name. |
| CampaignStatus | The campaign status. |
| CampaignType | The campaign type. Possible values include Audience, Dynamic search, Performance max, Search & content, and Shopping. |
| 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. |
| ClickSharePercent | The percentage of clicks that went to your ads. It is the share of the prospective customer's mindshare and buying intent you captured. You can use this performance metric to see where your growth opportunites are. For example, your click share percent is 30% if 10 ads were clicked, and three of the 10 ads were yours. The value of this column is empty if the data is not available. If you try to include this column with Hourly or HourOfDay aggregation the service will return code 2053. If you include this column, then you may not include restricted attributes such as TopVsOther in the same report request. Likewise if you include any of the restricted attribute columns, then you must exclude this column. For more information, see Column Restrictions. |
| ClickType | Click type refers to each component of an ad that a customer can click. The possible click types are ad title, image, phone number, driving directions, sitelink, and review. |
| ClickTypeId | The click type ID. |
| CollectionId | The collection ID. |
| Condition | The condition of a product item. Possible values include:NewUsedRefurbishedRemanufacturedCollectableOpen Box |
| 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. This column is deprecated as of 2022, so you should use the ConversionsQualified column instead. Going forward, performance reports will return "0" (zero) in this column. Historical data for time periods prior to the deprecation date will still be available according to the published data retention period. |
| ConversionsQualified | 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. You should expect the data type as double whether or not there are partial externally attributed offline conversions. Not everyone has this feature yet. If you don't, don't worry - it's coming soon! |
| 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. |
| CostPerInstall | The cost per install. The formula for calculating the cost per install is (Spend / Installs) |
| CostPerSale | The cost per sale. The formula for calculating the cost per sale is (Spend / Sales) |
| CountryOfSale | The country/region of sale for the product catalog. |
| 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. |
| CustomLabel0 | The value of the Custom_label_0 field in your Microsoft Merchant Center catalog. |
| CustomLabel1 | The value of the Custom_label_1 field in your Microsoft Merchant Center catalog. |
| CustomLabel2 | The value of the Custom_label_2 field in your Microsoft Merchant Center catalog. |
| CustomLabel3 | The value of the Custom_label_3 field in your Microsoft Merchant Center catalog. |
| CustomLabel4 | The value of the Custom_label_4 field in your Microsoft Merchant Center catalog. |
| 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. |
| Goal | The name of the goal you set for the conversions you want, meaning actions customers take after clicking your ad. |
| GoalId | The Microsoft Advertising assigned identifier of a conversion goal. |
| GoalType | The type of conversion goal. Possible values include AppInstall, Duration, Event, InStoreTransaction, OfflineConversion, PagesViewedPerVisit, and Url. |
| GTIN | Global Trade Item Number (GTIN) is a unique numerical value for commercial products that usually appears printed under the barcode on retail products. |
| ImpressionLostToBudgetPercent | The estimated percentage of impressions your ad did not receive due to issues with your daily or monthly budget. The value of this column is empty if the data is not available. If you try to include this column with Hourly or HourOfDay aggregation the service will return code 2053. If you include this column, then you may not include restricted attributes such as TopVsOther in the same report request. Likewise if you include any of the restricted attribute columns, then you must exclude this column. For more information, see Column Restrictions. Data for this column is typically updated 14-18 hours after the UTC day ends. For Microsoft Shopping Campaigns, this data is only available with the campaign and ad group performance reports. |
| ImpressionLostToRankPercent | The estimated percentage of impressions your ad did not receive due to issues with your ad ranking. The value of this column is empty if the data is not available. If you try to include this column with Hourly or HourOfDay aggregation the service will return code 2053. If you include this column, then you may not include restricted attributes such as TopVsOther in the same report request. Likewise if you include any of the restricted attribute columns, then you must exclude this column. For more information, see Column Restrictions. Data for this column is typically updated 14-18 hours after the UTC day ends. For Microsoft Shopping Campaigns, this data is not available. |
| Impressions | The number of times an ad has been displayed on search results pages. Without impressions there are no clicks or conversions. |
| ImpressionSharePercent | The estimated percentage of impressions, out of the total available impressions in the market you were targeting. The value of this column is empty if the data is not available. For example, out of estimated 59,000 impressions that occurred on this day in your targeted market, you got only about 2,300, or 3%. If you try to include this column with Hourly or HourOfDay aggregation the service will return code 2053. If you include this column, then you may not include restricted attributes such as TopVsOther in the same report request. Likewise if you include any of the restricted attribute columns, then you must exclude this column. For more information, see Column Restrictions. Data for this column is typically updated 14-18 hours after the UTC day ends. For Microsoft Shopping Campaigns, this data is only available with the campaign and ad group performance reports. |
| Installs | The total number of installs. |
| Language | The language of the publisher where the ad was shown. For possible values, see the Language column of Ad Languages. The language display name will be provided in the report e.g. English. |
| LocalStoreCode | An alphanumeric identifier defined by the merchant to uniquely identify each local store. |
| MerchantProductId | The unique identifier provided by a merchant for each product offer. |
| MPN | Manufacturer Part Number (MPN) is a unique number that identifies the product to its manufacturer. |
| Network | The entire Microsoft Advertising Network made up of Microsoft sites and select traffic, cross-network traffic, and only partner traffic (this network type is deprecated as of July 2024). Use this data to make the best decision on network selection for your ad groups. The possible values include AOL search, Audience, Microsoft sites and select traffic, Content, and Syndicated search partners. Note: Not everyone can use the value Microsoft sites and select traffic yet. If you can't, don't worry - it's coming soon! |
| OfferLanguage | The language for the product offer. For possible values see Ad Languages. The language display name will be provided in the report e.g. English. |
| Price | The different price for products in your catalog. |
| ProductBought | The product purchased from your catalog or via your retail partner. The purchased product will always match the same brand, but can differ from the specific product ad that was clicked on. If different products were purchased as a result of one click, the report will include multiple rows with the same ad ID and Merchant product ID, and each will contain a unique ProductBought value. You can also include the QuantityBought column to get data on quantity purchased per product. |
| ProductBoughtTitle | The title associated with the purchased product. |
| ProductCategory1 | The first level value of the Product_category field in your Microsoft Merchant Center catalog. For more information, see How is the catalog feed organized? |
| ProductCategory2 | The second level value of the Product_category field in your Microsoft Merchant Center catalog. For more information, see How is the catalog feed organized? |
| ProductCategory3 | The third level value of the Product_category field in your Microsoft Merchant Center catalog. For more information, see How is the catalog feed organized? |
| ProductCategory4 | The fourth level value of the Product_category field in your Microsoft Merchant Center catalog. For more information, see How is the catalog feed organized? |
| ProductCategory5 | The fifth level value of the Product_category field in your Microsoft Merchant Center catalog. For more information, see How is the catalog feed organized? |
| ProductType1 | The first level value of the Product_type field in your Microsoft Merchant Center catalog. For more information, see How is the catalog feed organized? |
| ProductType2 | The second level value of the Product_type field in your Microsoft Merchant Center catalog. For more information, see How is the catalog feed organized? |
| ProductType3 | The third level value of the Product_type field in your Microsoft Merchant Center catalog. For more information, see How is the catalog feed organized? |
| ProductType4 | The fourth level value of the Product_type field in your Microsoft Merchant Center catalog. For more information, see How is the catalog feed organized? |
| ProductType5 | The fifth level value of the Product_type field in your Microsoft Merchant Center catalog. For more information, see How is the catalog feed organized? |
| QuantityBought | The quantity of the product purchased (ProductBought) from your catalog or via your retail partner. |
| 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. |
| 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. |
| RevenuePerInstall | The revenue per install. The formula for calculating the revenue per install is (Revenue / Installs) |
| RevenuePerSale | The revenue per sale. The formula for calculating the revenue per sale is (Revenue / Sales) |
| Sales | The total number of sales. |
| SellerName | The merchant or store name that offers the product. |
| Spend | The cost per click (CPC) summed for each click. |
| StoreId | The unique identifier for the Microsoft Merchant Center store. |
| 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. |
| Title | The product item name. For example the title of a book, DVD, or game. |
| TopVsOther | 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. |
| TotalClicksOnAdElements | The number of clicks when this ad element was present in the ad copy, whether this or another ad element was clicked on. |
| 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. This column is deprecated as of 2022, so you should use the ViewThroughConversionsQualified column instead. Going forward, performance reports will return "0" (zero) in this column. Historical data for time periods prior to the deprecation date will still be available according to the published data retention period. |
| ViewThroughConversionsQualified | 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. You should expect the data type as double whether or not there are partial externally attributed offline conversions. Not everyone has this feature yet. If you don't, don't worry - it's coming soon! |
| ViewThroughRevenue | The revenue optionally reported by the advertiser as a result of view-through conversions. |
Remarks
Required Columns
The report must include the following columns at a minimum. As a general rule, each report must include at least one attribute column and at least one non-impression share 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 |
|---|
| TimePeriod |
Requirements
Service: ReportingService.svc v13
Namespace: https://bingads.microsoft.com/Reporting/v13