Represents a single Point of Interest (POI) entity e.g. a hotel or restaurant.
| Field Name | Type | Requirement | Description |
|---|---|---|---|
poi_id | string | Required | Required. A string generated by the partner that identifies a POI. |
name | object(Text) | Required | Required. The name of the POI. |
telephone | string | The contact telephone number of the POI including its country and area codes, e.g. +14567891234. | |
url | string | The url of the POI's public website. Note: This will be used just for matching purposes, not for display. | |
location | object(GeoCoordinates) | Required | Required. The location of the POI. |
display_address | object(Text) | The address displayed on the UI. | |
images | array of object(Image) | Images of the POI. Max number of images: 5. | |
rating | number | Average rating for the POI. | |
num_ratings | number | The number of contributing ratings for the rating field. | |
rating_scale | number | The rating scale used for the rating field. If max rating is 5, then
rating_scale is 5. | |
category | enum(Category) | Required | Required. Represents the category of the POI. |
description | object(Text) | A description of the POI. | |
| oneOf(additional_data) | Required | Only one of the fields in this oneOf can be set. |
Represents a text with localizations.
| Field Name | Type | Requirement | Description |
|---|---|---|---|
localizations | array of object(LocalizedString) | The localized strings. | |
default_locale | string | The locale to use as the default language it must be present in the localizations. |
Represents a localized string.
| Field Name | Type | Requirement | Description |
|---|---|---|---|
locale | string | The text's language tag, such as "en", "en-US" or "sr-Latn". | |
text | string | The text in the specified locale. |
The Geo data of a location, including latitude, longitude, and address.
| Field Name | Type | Requirement | Description |
|---|---|---|---|
latitude | number | [-90, +90] degrees (inclusive). Required if longitude is set, otherwise nice to have. | |
longitude | number | [-180, +180] degrees (inclusive). Required if latitude is set, otherwise nice to have. | |
| oneOf(addresses) | Required | Only one of the fields in this oneOf can be set. |
The postal address for the location.
| Field Name | Type | Requirement | Description |
|---|---|---|---|
country | string | Required | Required. The country, using ISO 3166-1 alpha-2 country code, e.g. "US". |
locality | string | Required | Required. The locality/city, e.g. "Mountain View". |
region | string | The region/state/province, e.g. "CA". This field is only required in countries where region is commonly a part of the address. (optional) | |
postal_code | string | Required | Required. The postal code, e.g. "94043". |
street_address | string | Required | Required. The street address, e.g. "1600 Amphitheatre Pkwy". |
Represents an image of the Point of Interest (POI).
| Field Name | Type | Requirement | Description |
|---|---|---|---|
url | string | The url of the image. Google will crawl the media hosted at this URL. Max length: 2000. | |
alt_text | object(Text) | The alternative text to be used for accessibility. |
Hotel specific feed data.
| Field Name | Type | Requirement | Description |
|---|---|---|---|
hotel_star_class | number | The official hotel class star value. Can be used in a label like "5-star hotel." This value is expected to be an integer between 1 and 5. | |
brand_ids | array of string | The brands that can display this hotel. If this field is empty, the hotel can be displayed under any of the brands associated with the feed. |
Establishment specific feed data.
| Field Name | Type | Requirement | Description |
|---|---|---|---|
business_hours | object(BusinessHours) | The regular business hours of the establishment. | |
price_range | object(PriceRange) | Price range of the services offered by the establishment. | |
establishment_category | object(Text) | The type of establishment. | |
brand_landing_pages | array of object(BrandLandingPages) | The brand landing pages. |
Represents the time periods that this location is open for business. Holds a collection of [TimeRange][madden.vss_poi_feed.TimeRange] instances. Example: Open on Saturdays from 09:00-12:00 and 13:00-17:00: time_ranges { open_day: SATURDAY open_time: { hours: 9, minutes: 0 } close_day: SATURDAY close_time: { hours: 12, minutes: 0 } } time_rages { open_day: SATURDAY open_time: { hours: 13, minutes: 0 } close_day: SATURDAY close_time: { hours: 17, minutes: 0 } } Example: Open on Saturdays from 21:00 to Sunday 02:00: time_ranges { open_day: SATURDAY open_time: { hours: 21, minutes: 0 } close_day: SUNDAY close_time: { hours: 2, minutes: 0 } }
| Field Name | Type | Requirement | Description |
|---|---|---|---|
time_ranges | array of object(TimeRange) | A collection of times that this POI is open for business. Each period represents a range of hours when the POI is open during the week. |
Represents a span of time that the POI is open, starting on the specified open day/time and closing on the specified close day/time. The closing time must occur after the opening time, for example later in the same day, or on a subsequent day.
| Field Name | Type | Requirement | Description |
|---|---|---|---|
open_day | enum(DayOfWeek) | The open day of the time range. | |
open_time | object(TimeOfDay) | The open time of the time range. | |
close_day | enum(DayOfWeek) | The close day of the time range. | |
close_time | object(TimeOfDay) | The close time of the time range. |
| Field Name | Type | Requirement | Description |
|---|---|---|---|
hours | number | Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. | |
minutes | number | Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. | |
seconds | number | Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. | |
nanos | number | Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. |
Price range of the services offered by the POI.
| Field Name | Type | Requirement | Description |
|---|---|---|---|
min_price | object(Money) | The minimum price of the services offered by the POI. | |
max_price | object(Money) | The maximum price of the services offered by the POI. |
Represents an amount of money with its currency type.
| Field Name | Type | Requirement | Description |
|---|---|---|---|
currency_code | string | The three-letter currency code defined in ISO 4217. | |
units | number | The whole units of the amount.
For example if currencyCode is "USD", then 1 unit is one US dollar. | |
nanos | number | Number of nano (10^-9) units of the amount.
The value must be between -999,999,999 and +999,999,999 inclusive.
If units is positive, nanos must be positive or zero.
If units is zero, nanos can be positive, zero, or negative.
If units is negative, nanos must be negative or zero.
For example $-1.75 is represented as units=-1 and nanos=-750,000,000. |
The Localized brand landing pages for a single Point of Interest (POI).
| Field Name | Type | Requirement | Description |
|---|---|---|---|
brand_id | string | The brand this configuration applies to. | |
localized_landing_pages | array of object(LocalizedLandingPage) | The localized landing pages. The url and locales fields values must be unique across all the localized landing pages. | |
default_url | string | The default landing page url to be used when none of the localized landing pages matches the user's language. |
Localized landing page for the Point of Interest (POI).
| Field Name | Type | Requirement | Description |
|---|---|---|---|
url | string | The url of the landing page. Max length: 2000. | |
locales | array of string | Restricts this page to users with the specified language preference. Must contain language tags, such as "en", "en-US" or "sr-Latn". |
Represents the category of the POI.
It should match the additional_data oneof field below.
| Name | Description |
|---|---|
UNKNOWN_CATEGORY | |
HOTEL | |
LOCAL |
Represents a day of the week.
| Name | Description |
|---|---|
DAY_OF_WEEK_UNSPECIFIED | The day of the week is unspecified. |
MONDAY | Monday |
TUESDAY | Tuesday |
WEDNESDAY | Wednesday |
THURSDAY | Thursday |
FRIDAY | Friday |
SATURDAY | Saturday |
SUNDAY | Sunday |
Required. Category specific fields.
It should match the category field above.
| Field Name | Type | Requirement | Description |
|---|---|---|---|
hotel_data | object(HotelData) | Mutally exclusive with | Hotel specific fields. |
local_data | object(LocalData) | Mutally exclusive with | Local specific fields. |
Required. Address for a location.
| Field Name | Type | Requirement | Description |
|---|---|---|---|
address | object(PostalAddress) | Postal address of the location. |