Edit

HotelDimensionPerformanceReportColumn Value Set - Reporting

  • Article

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

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.

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="HotelDimensionPerformanceReportColumn" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:restriction base="xs:string">
    <xs:enumeration value="TimePeriod" />
    <xs:enumeration value="CustomerId" />
    <xs:enumeration value="CustomerName" />
    <xs:enumeration value="AccountName" />
    <xs:enumeration value="AccountId" />
    <xs:enumeration value="CampaignName" />
    <xs:enumeration value="CampaignId" />
    <xs:enumeration value="AdGroupId" />
    <xs:enumeration value="AdGroupName" />
    <xs:enumeration value="AdId" />
    <xs:enumeration value="AccountStatus" />
    <xs:enumeration value="CampaignStatus" />
    <xs:enumeration value="AdGroupStatus" />
    <xs:enumeration value="SourceHotelId" />
    <xs:enumeration value="CampaignHotelId" />
    <xs:enumeration value="AdvertiserHotelId" />
    <xs:enumeration value="HotelName" />
    <xs:enumeration value="CountryName" />
    <xs:enumeration value="State" />
    <xs:enumeration value="City" />
    <xs:enumeration value="Brand" />
    <xs:enumeration value="Category" />
    <xs:enumeration value="StarRating" />
    <xs:enumeration value="CustomLabel0" />
    <xs:enumeration value="CustomLabel1" />
    <xs:enumeration value="CustomLabel2" />
    <xs:enumeration value="CustomLabel3" />
    <xs:enumeration value="CustomLabel4" />
    <xs:enumeration value="BidStrategyType" />
    <xs:enumeration value="DeviceType" />
    <xs:enumeration value="CurrencyCode" />
    <xs:enumeration value="CustomParameters" />
    <xs:enumeration value="FinalUrlSuffix" />
    <xs:enumeration value="Impressions" />
    <xs:enumeration value="Clicks" />
    <xs:enumeration value="Ctr" />
    <xs:enumeration value="Spend" />
    <xs:enumeration value="AverageCpc" />
    <xs:enumeration value="AverageCpm" />
    <xs:enumeration value="Conversions" />
    <xs:enumeration value="Revenue" />
    <xs:enumeration value="NetRevenue" />
    <xs:enumeration value="GrossReturnOnAdSpend" />
    <xs:enumeration value="NetReturnOnAdSpend" />
    <xs:enumeration value="CostPerAssist" />
    <xs:enumeration value="BookedLengthOfStay" />
    <xs:enumeration value="AvgBookedABW" />
    <xs:enumeration value="AvgBookedNights" />
    <xs:enumeration value="BookedABW" />
    <xs:enumeration value="CheckInDate" />
    <xs:enumeration value="DateType" />
    <xs:enumeration value="PartnerImpressions" />
    <xs:enumeration value="EligibleImpressions" />
    <xs:enumeration value="MissedImpressions" />
    <xs:enumeration value="ImpressionShare" />
    <xs:enumeration value="MissedImpressionsNoBid" />
    <xs:enumeration value="MissedImpressionsSpendingCapReached" />
    <xs:enumeration value="MissedImpressionsNoTax" />
    <xs:enumeration value="MissedImpressionsOther" />
    <xs:enumeration value="CheckInDateDayOfWeek" />
    <xs:enumeration value="LengthOfStay" />
    <xs:enumeration value="AdvancedBookingWindow" />
    <xs:enumeration value="SiteType" />
    <xs:enumeration value="UserCountry" />
    <xs:enumeration value="ClickShare" />
    <xs:enumeration value="MissedImpressionsInsufficientBid" />
  </xs:restriction>
</xs:simpleType>

Values

The HotelDimensionPerformanceReportColumn value set has the following values: AccountId, AccountName, AccountStatus, AdGroupId, AdGroupName, AdGroupStatus, AdId, AdvancedBookingWindow, AdvertiserHotelId, AverageCpc, AverageCpm, AvgBookedABW, AvgBookedNights, BidStrategyType, BookedABW, BookedLengthOfStay, Brand, CampaignHotelId, CampaignId, CampaignName, CampaignStatus, Category, CheckInDate, CheckInDateDayOfWeek, City, Clicks, ClickShare, Conversions, CostPerAssist, CountryName, Ctr, CurrencyCode, CustomerId, CustomerName, CustomLabel0, CustomLabel1, CustomLabel2, CustomLabel3, CustomLabel4, CustomParameters, DateType, DeviceType, EligibleImpressions, FinalUrlSuffix, GrossReturnOnAdSpend, HotelName, Impressions, ImpressionShare, LengthOfStay, MissedImpressions, MissedImpressionsInsufficientBid, MissedImpressionsNoBid, MissedImpressionsNoTax, MissedImpressionsOther, MissedImpressionsSpendingCapReached, NetReturnOnAdSpend, NetRevenue, PartnerImpressions, Revenue, SiteType, SourceHotelId, Spend, StarRating, State, TimePeriod, UserCountry.

Value Description
AccountId The Microsoft Advertising assigned identifier of an account.
AccountName The account name.
AccountStatus The account status.
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.

Note: AdId is restricted for share of voice metrics.
AdvancedBookingWindow The number of days before the check-in date that the user is asking to book the hotel room. For example, if today is 3 May and the user is asking to book a room for 8 May, the column's value is 5.
AdvertiserHotelId The Microsoft Advertising assigned identifier of an advertiser hotel.
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.
AvgBookedABW The average advanced booking window for the hotel. The average is calculated as (booked ABW/conversions).
AvgBookedNights The average nights booked for the hotel. The average is calculated as (total booked nights/conversions).
BidStrategyType The bid strategy type. Possible values include EnhancedCpc, ManualCpc, MaxClicks, MaxConversions, and TargetCpa. 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.
BookedABW The total advanced booking window days for the hotel.
BookedLengthOfStay The booked length of stay in number of days.
Brand The hotel chain's brand. For example, Fabrikam Residences by Contoso, where Contoso is the brand.
CampaignHotelId The identifier of the lodging campaign.
CampaignId The Microsoft Advertising assigned identifier of a campaign.
CampaignName The campaign name.
CampaignStatus The campaign status.
Category A user-defined category that identifies the type of hotel. For example, extended stay, economy, or motel.
CheckInDate The check-in date.
CheckInDateDayOfWeek The check-in date and day of the week.
City The city where the hotel is located.
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.
ClickShare The estimated percentage of clicks, out of the total number of clicks available, in auctions your ad showed in or was competitive in.

Example: Out of the estimated 1,000 clicks that occurred on this day in your target auctions, you had about 230, or 23%.
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.

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).
CountryName The name of the country where the hotel is located.
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.
CustomerId The Microsoft Advertising assigned identifier of a customer.
CustomerName The name of the customer.
CustomLabel0 The value of the Custom_0 field in your Microsoft Hotel Center feed.
CustomLabel1 The value of the Custom_1 field in your Microsoft Hotel Center feed.
CustomLabel2 The value of the Custom_2 field in your Microsoft Hotel Center feed.
CustomLabel3 The value of the Custom_3 field in your Microsoft Hotel Center feed.
CustomLabel4 The value of the Custom_4 field in your Microsoft Hotel Center feed.
CustomParameters Defines a key and value custom parameter for URL tracking. Used for campaign, ad group, ad, keyword, sitelink, and ad group criterion URL custom parameters.
DateType Indicates whether the user searched for hotels using specific dates. The following are the possible values.
  • DefaultDate—The user didn't search for hotels using specific dates
  • SelectedDate—The user searched for hotels using specific dates
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.
EligibleImpressions The total number of realized and unrealized impressions (impressions plus missed impressions).
FinalUrlSuffix The final URL suffix can include tracking parameters that will be appended to the end of your landing page URL. We recommend placing tracking parameters that your landing page requires in a final URL suffix so that your customers are always sent to your landing page. For more details and validation rules see Final URL Suffix in the technical guides.

Add: Optional
Update: Optional. If no value is set for the update, this setting is not changed. If you set this element to an empty string (""), the previous setting will be deleted.
GrossReturnOnAdSpend The gross return on ad spend.
HotelName The name of the hotel.
Impressions The number of times an ad has been displayed on search results pages. Without impressions there are no clicks or conversions.
ImpressionShare The percentage of impressions, out of the total available impressions in the market you were targeting. For example, out of an estimated 59,000 impressions that occurred on this day in your targeted market, you received 2,300, or 3%. The value is in the range 0.0 through 1.0.
LengthOfStay The length of stay in nights.
MissedImpressions The total number of impressions lost. This is the sum of the following columns:
  • MissedImpressionsInsufficientBid
  • MissedImpressionsNoTax
  • MissedImpressionsOther
  • MissedImpressionsSpendingCapReached
MissedImpressionsInsufficientBid The number of impressions lost because there were insufficient bids.
MissedImpressionsNoBid The number of impressions lost because there were no bids.
MissedImpressionsNoTax The number of impressions lost because the hotel didn't specify taxes.
MissedImpressionsOther The number of impressions lost for all other reasons. Typically, low ranking or your rate was available in the More rates section, but the user did not expand the section to view your rate.
MissedImpressionsSpendingCapReached The number of impressions lost because you reached your daily spending limit.
NetReturnOnAdSpend The net return on ad spend.
NetRevenue The net revenue.
PartnerImpressions The number of times an ad has been displayed on search results pages on our partner networks. Without impressions there are no clicks or conversions.
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.

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.
SiteType The Bing website that users used to search for hotels. The possible values are:
  • LocalUniversal: The user used Bing.com to search for hotels and properties.
  • MapResults: The user used Bing.com/maps to search for hotels and properties.
  • PropertyPromotionAd: The user was looking at the first results page shown in the maps search.
SourceHotelId The identifier of the source hotel.
Spend The cost per click (CPC) summed for each click.
StarRating The hotel's star rating. Possible values are 1 through 5.
State The name of the state where the hotel is located.
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. If you include the TimePeriod column, the column label in the downloaded report depends on the aggregation level that you specify in the report request. For more information, see Time Period Column.

This attribute is available in multiple reports, for example see KeywordPerformanceReportColumn Value Set.
UserCountry The country of location for the user.

Requirements

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

Used By

HotelDimensionPerformanceReportRequest