Skip to content

Latest commit

 

History

History
158 lines (100 loc) · 16.5 KB

reference.md

File metadata and controls

158 lines (100 loc) · 16.5 KB
title description ms.service ms.topic author ms.author ms.date
Property feed (formerly Hotel feed) reference
Describes the schema used to create a property feed file.
bing-ads-hotel-service
article
jonmeyers
jonmeyers
11/13/2024

Property feed (formerly Hotel feed) reference

If you create hotel price ads in Bing, you must use a Property feed to provide Bing information about the hotels that you advertise. You must define and import your property feed prior to sending Bing Price feeds.

For information about creating a property feed, see Creating a Property feed.

Note

The elements must be specified in the order defined by the Hotel XSD (and as listed in this topic).


Listings

Defines the top-level element of a property feed.

Element Description Children
listings The top-level element in a property feed. Listings Type

Listings Type

Defines a list of hotels in the feed.

Element Description Children
language Required.
Data type is string.

The language that the hotel data in the feed is written in. Specify the language using the two-letter ISO 639 language code. For example, use en for English.

None
listing Defines a hotel listing. Include a listing element for each hotel in the feed. Listing Type

Listing Type

Defines a hotel.

Element Description Children
id Required.
Data type is string.

An opaque, user-defined ID that uniquely identifies the hotel in the feed.

When you create your Price feed, use this ID in the Property element of your Price feed to identify the hotel.
None
name Required.
Data type is string.

The hotel's name. The name may contain a maximum of 200 characters.
None
address Required.
Data type is string or Component Type.

The street address of the hotel.

Notes:
  • You may specify the address using free-form text in the body of the address element or using component child elements to specify the components of the address (see Component Type).
  • You're encouraged to use component elements to specify the address' components.
  • If you use free-form text, separate each component of the address with a comma. For example, 1234 Billings Way, Redmond, WA, 98030.
Component Type
country Required.
Data type is string.

The country where the hotel is located. Specify the country using the two-letter ISO 3116 country code. For example, use US for United States.
None
latitude Required.
Data type is decimal.

The latitude of the hotel's geographical coordinates.

Notes:
  • The latitude and longitude are required only if you don't specify phone. It's preferred that you specify both the phone and geographical coordinates.
  • The latitude must be in the range -90.0 through 90.0.
  • Use Location API or another GeoCoding tool to generate the coordinates.
None
longitude Required.
Data type is decimal.

The longitude of the hotel's geographical coordinates.

Notes:
  • The latitude and longitude are required only if you don't specify phone. It's preferred that you specify both the phone and geographical coordinates.
  • The longitude must be in the range -180.0 through 180.0.
  • Use Location API or another GeoCoding tool to generate the coordinates.
None
phone Required.
Data type is string.

A list of telephone numbers that customers use to contact the hotel.

Attributes:
  • type—Required. The type of telephone number specified. The following are the possible values.
    • main—Required. The hotel's main voice telephone number.
    • tollfree—Optional. The hotel's toll-free voice telephone number.
    • fax—Optional. The hotel's fax telephone number.
    • tdd—Optional. The hotel's telecommunications device for the deaf telephone number.
    • mobile—Optional. The hotel's mobile telephone number.
Notes:
  • A phone number is required only if you don't specify latitude and longitude. It's preferred that you specify both the phone and geographical coordinates.
  • Provide unique telephone numbers for the listing.
  • Use dashes, spaces, or parentheses in the phone number to make it easier to read. For example, use “610-222-3333” or “(610) 222-3333” rather than “6102223333”.
  • Specify only one telephone number in each phone element. Do not specify multiple numbers, such as 650-123-2222/33.
  • The telephone number may contain an extension of up to 7 digits. Precede extensions with one of the following abbreviations: "ext", "extn", and "x". For example, "408-555-1111x12345" or "408-555-1111 x12345".
  • The telephone number may not include alphabetical characters.
  • Each listing should specify one of each type of phone number: "main", "mobile", "tollfree", "fax", or "tdd", if applicable.
  • If the telephone number includes the country code, precede it with a "+". For example, “+65 6722-2323” for a number in Singapore where the country code is 65, or “+001 (408) 555-1111” for a number in the United States where the country code is 001.
None
category Optional.
Data type is string.

A category that identifies the type of hotel. The expected format is vacation_rental or hotel followed by the pipe character and a custom value. For example, vacation_rental | 'custom value' or hotel | 'custom value'

For a list of custom values, see Lodging property categories.
None
content Optional.
Data type is Content Type.

Provides additional information about the hotel such as a description, reviews, and amenities.
Content Type

Component Type

Defines a component of a street address.

Element Description Children
component Optional.
Data type is string.

Specify a component element for each component of the address.

Attributes:
  • name—Required. The name of the address component. The following are the possible values.
    • addr1—Required. The hotel's street address.
    • addr2—Optional. Second street address line.
    • addr3—Optional. Third street address line.
    • city—Required. The name of the city where the hotel is located.
    • province—Required. The name of the state, region, or province where the hotel is located.
    • postal_code—Required. The address' postal code.
None

Content Type

Defines additional information about the hotel. (These elements may appear in any order.)

Element Description Children
text Optional.
Data type is Description type.

A description of the hotel.

Attributes:
  • type—Required. Set to description.
Description type
review Optional.
Data type is Review type.

A hotel review. You may specify one or more <review> elements.

Attributes:
  • type—Required. Set to either of the following types:
    • editorial—The review is written by a blogger or other professional authority.
    • user—The review is written by a user.
Review type
attributes Optional.
Data type is Attribute type.

The list of hotel amenities. Specify an <attr> child element for each amenity you want to include.
Attribute type
image Optional.
Data type is Image type.

An image of the hotel. You may specify one or more <image> elements. Best image aspect ratio is 4:3.

Attributes:
  • type—Required. Set to either of the following types:
    • ad—The image is an ad.
    • menu—The image shows the menu for the hotel's restaurant.
    • photo—The image is of the hotel.
  • url—Required. The URL to the image.
  • width—Optional. The image's width, in pixels. Should be greater than 720 pixels.
  • height—Optional. The image's height, in pixels. Should be greater than 720 pixels.
Image type
neighborhoods Optional.
Data type is Neighborhood type.

A list of neighborhoods where the hotel is located.
Neighborhood type
brandCode Optional.
Data type is string.

The brand code associated to the logo. This is used when you have multiple logos for the properties you are advertising.
None

Description Type

Defines a description of the hotel.

Element Description Children
link Optional.
Data type is string.

A URL to an online description of the hotel.
None
title Optional.
Data type is string.

A title to use for the description.
None
body Required.
Data type is string.

A description of the hotel.
None

Image Type

Defines an image of the hotel.

Element Description Children
date Required.

The date the image was taken.

Attributes:
  • month—Required. The month the image was taken. Valid values are 1 (January) through 12 (December)
  • day—Required. The day of the month the image was taken.
  • year—Required. The four-digit year the image was taken.
None
link Optional.
Data type is string.

A URL to the hotel's webpage that contains the image.
None
title Optional.
Data type is string.

A title to use for the image.
None
author Optional.
Data type is string.

The name of the person that took the image.
None

Neighborhood Type

Defines a neighborhood where the hotel is located.

Element Description Children
neighborhood Optional.
Data type is string.

The name of the neighborhood where the hotel is located.
None

Review Type

Defines a hotel review.

Element Description Children
author Optional.
Data type is string.

The name of the person who wrote the review.
None
body Optional.
Data type is string.

The review's text. The text should not include HTML but if it does, it must be escaped.
None
date Optional.

The date the review was written. Specify the date only if the review's type is user.

Attributes:
  • month—Required. The month the review was written. Valid values are 1 (January) through 12 (December).
  • day—Required. The day of the month the review was written.
  • year—Required. The four-digit year the review was written.
None
link Optional.
Data type is string.

A URL to the review online.
None
rating Optional.
Data type is string.

The rating that the reviewer gave the hotel. The rating is a string decimal in the range 0.0 through 10.0.
None
title Optional.
Data type is string.

The review's title. Specify the title only if the review's type is editorial.
None

Attribute Type

Defines a hotel amenity.

Element Description Children
website Optional.
Data type is string.

The URL to the hotel's website.
None
attr Optional.
Data type is string.

A hotel amenity.

Attributes:
  • name—Required. Set to one of the following values:
    • air_conditioned—Indicates whether all guest rooms have air conditioning. Set the element's value to Yes or No as appropriate.
    • all_inclusive_available—Indicates whether the room rate includes food and drinks. Set the element's value to Yes or No as appropriate.
    • child_friendly—Indicates whether the hotel includes special features for families traveling with kids such as reduced room rates, play area, or kid's club. Set the element's value to Yes or No as appropriate.
    • has_affiliated_golf_course—Indicates whether the hotel has a golf course onsite or nearby for guests to enjoy. Set the element's value to Yes or No as appropriate.
    • has_airport_shuttle—Indicates whether the hotel offers an airport shuttle for free or a fee. Set the element's value to Yes or No as appropriate.
    • has_bar_or_lounge—Indicates whether the hotel has a bar or lounge that serves alcoholic beverages. Set the element's value to Yes or No as appropriate.
    • has_beach_access—Indicates whether the hotel has beach access without having to cross a road. Set the element's value to Yes or No as appropriate.
    • has_business_center—Indicates whether the hotel includes a business center where guests can use a computer and printer for free or a fee. Set the element's value to Yes or No as appropriate.
    • has_fitness_center—The hotel has an onsite fitness center. Set the element's value to Yes or No as appropriate.
    • has_free_breakfast—Indicates whether the hotel provides a free breakfast to all guest each day. Set the element's value to Yes or No as appropriate.
    • has_hot_tub—Indicates whether the hotel has a hot tub onsite or some or all guest rooms include a whirlpool or jacuzzi tub. Set the element's value to Yes or No as appropriate.
    • has_laundry_service—Indicates whether the hotel offers laundry service where the hotel launders the guest's clothes. An onsite, self-serve, coin-operated facility doesn't count. Set the element's value to Yes or No as appropriate.
    • has_restaurant—Indicates whether the hotel has an onsite restaurant for guests. Set the element's value to Yes or No as appropriate.
    • has_room_service—Indicates whether the hotel offers room service where food is prepared onsite and delivered to the guest's room. Set the element's value to Yes or No as appropriate.
    • has_spa—Indicates whether the hotel has an onsite spa that provides services such as a massage, facial, or sauna. Set the element's value to Yes or No as appropriate.
    • kitchen_availability—Indicates whether guest rooms include kitchens with a refrigerator and stove. Set the element's value to Available in all rooms, Available in some rooms, or Not available.
    • num_reviews—The number of times the hotel was reviewed. Set the element's value the number of reviews.
    • number_of_rooms—The number of units associated with the listing. Set the element's value the number of reviews.
    • parking_type—Indicates whether parking is available and whether it's free. Set the element's value to No payment required, Paid, or Not available.
    • pets_allowed—Indicates whether the hotel allows guests to bring pets. Set the element's value to Yes or No.
    • smoke_free_property—Indicates whether the hotel allows smoking. Set the element's value to Yes or No.
    • star_rating—The hotel's star rating. Possible values are 1 through 5.
    • swimming_pool_type—Indicates whether the hotel has a swimming pool for guests. Set the element's value to Indoors, Outdoors, Indoors and outdoors, or Not available.
    • wheelchair_accessible—Indicates whether the hotel is wheelchair accessible. Set the element's value to Yes or No.
    • wifi_type—Indicates whether the hotel offers WiFi service. Set the element's value to No payment required, Paid, or Not available.
    • custom_0—Custom parameter for extra information not applicable to other attributes
    • custom_1—Custom parameter for extra information not applicable to other attributes
    • custom_2—Custom parameter for extra information not applicable to other attributes
    • custom_3—Custom parameter for extra information not applicable to other attributes
    • custom_4—Custom parameter for extra information not applicable to other attributes
None