Page Summary
-
A hotel list is an XML file listing hotels for which you provide pricing, but it doesn't contain the pricing itself.
-
The
element is the root of the hotel list, containingelements that describe individual properties. -
Hotel lists are created during initial setup and maintained to add or remove hotels.
-
Properties must meet specific listing requirements to be eligible for Google Hotel Ads, including having physical presence, fixed walls, plumbing, and a maximum 7-day minimum stay.
-
You can manually upload your hotel list or host it on your server after ensuring it conforms to syntax guidelines like UTF-8 encoding.
A hotel list is one or more XML files that lists all hotels for which you will provide pricing information. The hotel list file itself does not contain pricing information.
The root element of a hotel list is the element which contains
elements that describe your properties.
You create a hotel list as part of your initial implementation, and then add or remove hotels from it as part of regular maintenance.
Make sure your files conform to the syntax guidelines.
For example, use UTF-8 encoding and specify this encoding schema by including
the encoding attribute in your XML tag.
After creating a hotel list, you can manually upload it to Google using https://support.google.com/hotelprices/ or host it on yourserver.
Find and fix data issues
To find and fix data issues in your hotel list, refer to the following articles:
Listing requirements
To be eligible for Google Hotel Ads, a property in your hotel list must have the following:
- Rooms in which paying guests can stay
- A physical presence and fixed location that is open to the public
- Fixed walls and plumbing
- A minimum stay requirement of no greater than 7 days
Common examples of ineligible properties include cruises and
apartments because they usually don't meet the Listing requirements criteria.
Camping cabins and other camping establishments with fixed walls, plumbing, and climate control (including wood stoves or propane heaters) are eligible. Outdoor lodgings that are not eligible include:
- Campsites, where guests stay in tents
- RV parks, where guests bring their own RV
is the root element of a hotel list and it contains a
element and at least one .
The element appears in the following place in the hotel list
XML hierarchy:
+
+
+
+
Syntax
The element uses the following syntax:
version="1.0" encoding="UTF-8"?>
xmlns:xsi="xsi"
xsi:noNamespaceSchemaLocation="schema_xsd">
language_code
datum_code
listing
...
Attributes
The element has the following attributes:
| Attribute | Required? | Description |
|---|---|---|
xmlns:xsi |
Required | Set to http://www.w3.org/2001/XMLSchema-instance. |
xsi:noNamespaceSchemaLocation |
Required | Set to http://www.gstatic.com/localfeed/local_feed.xsd. |
Child elements
The element has the following child elements:
| Child element | Required? | Type | Description |
|---|---|---|---|
| Required | string | The language in which your feed is written. Set the value of this
element to a
two-letter language code. For example, en for English. |
|
| Optional | enum | This element specifies the geodetic datum or reference model for
the latitude/longitude coordinates provided in the feed. If no datum value
is provided, the default value for this element is WGS84, which
is used by most modern GPS devices. The Tokyo datum is only applicable to
addresses in Japan.
The valid values for this element are:
WGS84, don't include
the element in the hotel list.
|
|
| Required | |
One or more entries that describe each hotel in the feed. Note that each hotel in the list must have an ID that is unique to your site, and that this ID should never be re-used. |
Examples
Structured Address
The following example shows a partial hotel list with a structured address:
version="1.0" encoding="UTF-8"?>
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="http://www.gstatic.com/localfeed/local_feed.xsd">
en
123abc
Belgrave House
format="simple">
name="addr1">6 Acacia Ave
name="addr2">Floor 5
name="city">London
name="province">Greater London
name="postal_code">SW1W 9TQ
GB
35.070374
-106.213648
type="main">123-456-7890
hotel
...
Free-Form Address
The following example shows a partial hotel list with a free-form address:
version="1.0" encoding="UTF-8"?>
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="http://www.gstatic.com/localfeed/local_feed.xsd">
en
123abc
Belgrave House
6 Elm Ave Unit 3, Boston, MA, 02472
US
35.070374
-106.213648
type="main">123-456-7890
hotel
...
Optional Content
The following example shows a partial hotel list with a listing that
contains an optional :
version="1.0" encoding="UTF-8"?>
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="http://www.gstatic.com/localfeed/local_feed.xsd">
en
123456
My Apartment
format="simple">
name="addr1">1 Sandstone Building
name="city">Los Angeles
name="postal_code">90210
name="province">CA
US
40.730610
-73.935242
type="main">12345678
hotel
type="description">
https://examplelisting.com/listings/12345
3 bedrooms with ocean views
Stay in this newly renovated 3BR house with ocean views.
month="7" day="23" year="2023"/>
https://hotel.example.com
name="rating">8.2
type="photo" url="https://image_url">
https://image_url
Main hotel picture
...
A hotel definition within a hotel list element.
The element appears in the following place in the Hotel List
Feed XML hierarchy:
+
+
+
Syntax
The element uses the following syntax:
version="1.0" encoding="UTF-8"?>
... >
hotel_ID
hotel_name
name="addr1">street_address_1
name="addr2">street_address_2
name="city">city_name
name="province">province_name
name="postal_code">postal_code
country_code
hotel_latitude
hotel_longitude
type="[fax|main|mobile|tdd|tollfree]">phone_number
hotel
content
Attributes
The element has no attributes.
Child elements
The element has the following child elements:
| Child element | Required? | Type | Description |
|---|---|---|---|
| Required | string | A unique identifier for the hotel.
Note: This value must be unique to your site for all time. Don't re-use IDs, as that might cause problems when trying to resolve property matching issues. |
|
| Required | string | The name of the hotel. For example:
|
|
| Required | Object or string | The full physical location of the hotel. This element takes a single attribute, At a minimum, you must provide the street address, city, state or region,
and postal code for the hotel. Use
For example: <address format="simple"> <component name="addr1">6 Acacia Ave</component> <component name="addr2">Floor 5</component> <component name="city">London</component> <component name="province">Greater London</component> <component name="postal_code">SW1W 9TQ</component> </address> Alternatively, you can provide a "free-form" address, although this is not recommended. For example: <address>6 Elm Ave Unit 3, Boston, MA, 02472</address> Note that P.O. boxes or other mailing-only addresses are not considered full physical addresses. |
|
| Required | string | The country that this listing is located in. The value must be an
two-letter country code.
For example, United States is "US" and Canada is "CA". For example:
|
|
| Required* | float | The latitude that corresponds to the location of the listing. For
example:
This value can be generated with GeoCoding tools like the Google Maps API. |
|
| Required* | float | The longitude that corresponds to the location of the listing. For
example:
This value can be generated with GeoCoding tools like the Google Maps API. |
|
| Optional | integer | Precision of the location of the property sent in meters when the property latitude and longitude is obfuscated. Zero (0) means there is no obfuscation and that it is the exact location. Note: This element applies to Vacation Rentals only. | |
| Required* | string | One or more contact numbers for the hotel. If the listing is business branch, please provide the phone number specific to branch location (not the phone number of central headquarters). The
For example: <!-- Singapore (country code +65) --> <phone type="main">+65 6722-2323</phone> <!-- U.S. (country code +1) --> <phone type="fax">+1 408-555-1111</phone> At a minimum, you should provide a |
|
| Optional | string | The type of property, such as a hotel. Partners may use whatever internal categories they have to describe their property, such as "business hotels," "resorts," "motels," and similar. | |
|
Optional | |
Optional details used for the listing, such as a description, ratings, and features of the property. |
* Either a phone number or latitude/longitude is required. We recommend that you define both.
Examples
Structured Address
The following example shows a partial hotel list with a structured address:
version="1.0" encoding="UTF-8"?>
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="http://www.gstatic.com/localfeed/local_feed.xsd">
en
123abc
Belgrave House
format="simple">
name="addr1">6 Acacia Ave
name="addr2">Floor 5
name="city">London
name="province">Greater London
name="postal_code">SW1W 9TQ
GB
35.070374
-106.213648
type="main">123-456-7890
hotel
...
Free-Form Address
The following example shows a partial hotel list with a free-form address:
version="1.0" encoding="UTF-8"?>
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="http://www.gstatic.com/localfeed/local_feed.xsd">
en
123abc
Belgrave House
6 Elm Ave Unit 3, Boston, MA, 02472
US
35.070374
-106.213648
type="main">123-456-7890
hotel
...
Optional Content
The following example shows a partial hotel list with a listing that
contains an optional :
version="1.0" encoding="UTF-8"?>
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="http://www.gstatic.com/localfeed/local_feed.xsd">
en
123456
My Apartment
format="simple">
name="addr1">1 Sandstone Building
name="city">Los Angeles
name="postal_code">90210
name="province">CA
US
40.730610
-73.935242
type="main">12345678
hotel
type="description">
https://examplelisting.com/listings/12345
3 bedrooms with ocean views
Stay in this newly renovated 3BR house with ocean views.
month="7" day="23" year="2023"/>
https://hotel.example.com
name="rating">8.2
type="photo" url="https://image_url">
https://image_url
Main hotel picture
...
Adds information about a listing, such as ratings, amenities, and
other details. The element is optional. Within ,
all child elements are optional.
The element appears in the following place in the Hotel List
Feed XML hierarchy:
+
+
+
+
Syntax
The element uses the following syntax:
version="1.0" encoding="UTF-8"?>
... >
type="description">
listing_link
listing_title
listing_author
listing_description
month="MM" day="DD" year="YYYY"/>
https://hotel.example.com
name="alternate_hotel_id">alternate_hotel_id
name="hotel_brand">hotel_brand
name="rating">aggregate_rating
type="photo" url="https://image_url">
https://image_url
Main Hotel Picture
...
Attributes
The element has no attributes.
Child elements
The element has the following child elements:
Example
The following example shows a partial hotel list that includes the
element:
version="1.0" encoding="UTF-8"?>
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="http://www.gstatic.com/localfeed/local_feed.xsd">
en
123456
My Apartment
format="simple">
name="addr1">1 Sandstone Building
name="city">Los Angeles
name="postal_code">90210
name="province">CA
US
40.730610
-73.935242
type="main">12345678
hotel
type="description">
https://examplelisting.com/listings/12345
3 bedrooms with ocean views
Stay in this newly renovated 3BR house with ocean views.
month="7" day="23" year="2023"/>
https://hotel.example.com
name="rating">8.2
type="photo" url="https://image_url">
https://image_url
Main hotel picture
...
The tag can be used to describe property amenities and to
classify ratings for the property.
+
+
+
+
+
Child elements
| Child element | Required? | Description | |
|---|---|---|---|
| Optional | The primary website for the hotel. If present, it must be positioned
before the first element. Example:
|
||
| Optional | An additional characteristic or "attribute" of the property that
can be specified using the supported
attribute_name or
attribute_name for Vacation Rentals.
|
||
Values for the attribute_name placeholder
The following table lists valid values for attribute_name
in the
Values for attribute_name |
Description | Valid content values |
|---|---|---|
| alternate_hotel_id | An alternate identifier for your property. Having separate IDs is useful if you might need one property identifier for your feed information and another property identifier for your booking engine. | Any string value |
| Deprecated: Any string type custom attribute. These are not displayed to users. | Any string value | |
| hotel_brand | The brand to which this hotel belongs. For example, "Marriott" or "Hilton". This is not displayed to users but can be used for grouping hotels. |
Follow RFC 3986
(URI Generic Syntax):
|
| lodging | Encoded representation of all fields available in the
Lodging
proto. |
Base64-encoded string of the
encoded
Lodging proto |
| num_reviews | Number of reviews of the listing.
Key Point: "num_reviews" should only be sent for Vacation Rental feeds. |
Any non-negative integer. |
| rating | A floating point number representing the aggregate property rating. | This number is typically from 0-5, 0-10, or 0-100, but
you can use any range that represents your rating system. For example,
the property rating should be 3 or 4 for a rating_scale of 5.
Note: The default rating_scale is 0-10 if unspecified. |
Values for the attribute_name placeholder for Vacation Rentals
Refer to Vacation Rentals-specific attributes and XML example.
+
+
+
+
+
+
+
Images are used to show the property in the listing ID. All images used must follow these guidelines:
- The recommended aspect ratio for images is 4:3.
- The image URL must be accessible by the Googlebot Image crawler.
If your site includes a robots.txt at the root level, verify that it contains one of the two options shown:
Allows the Googlebot crawler to crawl your site's content, images included.
- User-agent: Googlebot
- Allow: /
Allows the Googlebot Image crawler to crawl the images on your site.
- User-agent: Googlebot-Image
- Allow: /
Screenshots of images or websites aren't permitted. Images must be original and actual images or photographs.
Photos shouldn't feature large blocks of text, logos, or watermarks.
Attributes
| Attribute name | Required? | Format | Description |
|---|---|---|---|
| type | Required | Text | An image must be one of the following: |
url |
Required | Text | The URL of the full-sized image. Use the url attribute to
specify the image to use on that page. |
| width | Required | A non-negative integer | Width of the image, in pixels (greater than 720 pixels is recommended) |
| height | Required | A non-negative integer | Height of the image, in pixels (greater than 720 pixels is recommended) |
Child elements
| Child element | Required? | Description |
|---|---|---|
| Requested, but required for local photo listings. | This tag contains the valid and up-to-date URL of the page on your site
that the relevant image is on. It doesn't contain the URL for the image itself.
Example: |
|
| Requested | This tag contains the title of the image. Example:
|
|
| Not required | The name of the author of the content. The value can either be a username or a full name in the format "Firstname Lastname." | |
| Required | This tag identifies the date that the content item was created. You must enter a year, month, and day, as in the following example: |
Example
The following example shows a partial hotel list with image tags:
version="1.0" encoding="UTF-8"?>
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="http://www.gstatic.com/localfeed/local_feed.xsd">
en
type="photo" url="https://image_url" width="400" height="300">
https://image_url
Apartment at Sandstone
Jessica Landlord
month="6" day="7" year="2023"/>
...
Syntax guidelines
When creating an XML-based hotel list, use the following guidelines:
Validate your Hotel List XML files with Google's XSD Schema.
Use UTF-8 encoding. Specify this encoding schema by including the
encodingattribute in your XML tag, as shown in the examples.You can specify data values in your feed with
CDATAsections. If you useCDATAsections, don't escape special characters.Use escape codes for data values that are not in
CDATAsections, including URLs. You can use either the entity code or the character code to represent these special characters. The following table lists common entity and character codes you can use:Character Entity Character Code Ampersand (&) & & Single Quote (') ' ' Double Quote (") " " Greater Than (>) > > Less Than (<) < < Omit XML elements that doesn't contain data. For example, if you don't have the latitude and longitude for a hotel, you shouldn't include empty
andelements.Don't use HTML in your XML elements under any circumstances (even if it is escaped).
To validate your feed prior to uploading, you can use the local feed XSD http://www.gstatic.com/localfeed/local_feed.xsd.
To use comments in your feed, wrap the comment in
tags, as the following example shows: