The product feed is the primary way for you to provide Google a list of Things to do products which are to be displayed on various Google surfaces.
A ProductFeed
object consists of a single FeedMetadata
object and
zero or more Product
objects. If no Product
is provided in all shards,
then all products are deleted.
ProductFeed
Proto
message
ProductFeed
{
// Metadata for this feed.
// Required.
FeedMetadata
feed_metadata
=
1
;
// List of the products.
// Optional. When unset in all shards, all products will be deleted.
repeated
Product
products
=
2
;
}
Implementation Notes
| Type | Field | Notes |
|---|---|---|
| feed_metadata | REQUIRED. Metadata for this feed. |
|
| products | OPTIONAL. When unset in all shards, all products are deleted. feed_metadata/max_removal_share
may need to be set when large number of products are removed. |
Examples
// Example 1: Basic structure
{
"feed_metadata"
:
{
...
},
"products"
:
[
...
]
}
// Example 2: Wipe all products
{
"feed_metadata"
:
{
"shard_id"
:
0
,
"total_shards_count"
:
1
,
"processing_instruction"
:
"PROCESS_AS_SNAPSHOT"
,
"nonce"
:
202113041501
,
"max_removal_share"
:
1.0
},
"products"
:
[]
}
FeedMetadata
Proto
message
FeedMetadata
{
// The current shard ID, zero-based. Shards do not need to be transferred in
// order. Processing will start only after a full set of shards was uploaded.
// Required when total_shards_count > 1.
uint32
shard_id
=
1
;
// Total number of shards in this transfer.
// Required. Must be >= 1.
uint32
total_shards_count
=
2
;
// An arbitrary number used to link multiple shards to the same transfer.
// Required when total_shards_count > 1.
// Must be the same for all shards within the transfer.
uint64
nonce
=
3
;
enum
ProcessingInstruction
{
// For compatibility, don't use.
PROCESS_AS_UNSPECIFIED
=
0
;
// This Feed upload should be processed as a complete snapshot replacing any
// previously uploaded data of this type.
// Supported feed types: product.
PROCESS_AS_SNAPSHOT
=
1
;
// This Feed upload should be processed as an upsert, updating or adding
// data to the previous uploads. Supported feed types: reviews,
// availability.
PROCESS_AS_UPSERT
=
2
;
}
// Processing instruction for this upload.
// Required.
ProcessingInstruction
processing_instruction
=
4
;
// Maximal share of currently active products that are allowed to be removed
// by an upload. If more products will be removed by this transfer, the whole
// transfer will be rejected.
// This is a safeguard against unintentional take down of a significant part
// of the inventory. Can be set to 1.0 to allow complete inventory take down.
// Optional.
double
max_removal_share
=
5
;
}
Implementation Notes
| Type | Field | Notes |
|---|---|---|
|
uint32
|
shard_id | REQUIRED when total_shards_count
> 1.Zero-based. Shards don't need to be transferred in order. Processing starts only after a full set of shards was uploaded. |
|
uint32
|
total_shards_count | REQUIRED, must be >= 1. |
|
uint64
|
nonce | REQUIRED when total_shards_count
> 1.Must be the same for all shards within the transfer. |
|
enum
|
processing_instruction | REQUIRED.PROCESS_AS_SNAPSHOT
is the only value
supported. |
|
double
|
max_removal_share | OPTIONAL. Maximal share of active products that are allowed to be removed by an upload. If more products are removed by this transfer, the whole transfer is rejected. This is a safeguard against unintentional take down of a significant part of the inventory. Can be set to 1.0 to allow complete inventory take down. |
Examples
// Example 1: metadata single JSON file
{
"shard_id"
:
0
,
"total_shards_count"
:
1
,
"processing_instruction"
:
"PROCESS_AS_SNAPSHOT"
,
"nonce"
:
202113041501
}
// Example 2a: two JSON files (1st file)
{
"shard_id"
:
0
,
"total_shards_count"
:
2
,
"processing_instruction"
:
"PROCESS_AS_SNAPSHOT"
,
"nonce"
:
202213041502
}
// Example 2b: two JSON files (2nd file)
{
"shard_id"
:
1
,
"total_shards_count"
:
2
,
"processing_instruction"
:
"PROCESS_AS_SNAPSHOT"
,
"nonce"
:
202213041502
}
Product
Proto
message
Product
{
// An opaque string from the partner which uniquely identifies the product.
// Allowed characters are alphanumeric, _, and -. Max length: 255.
// Required.
string
id
=
1
;
// The title of the product in plain text, e.g. "Horseback riding on the
// moon". See definition of "LocalizedTextSet" message for the details on the
// localization.
// Recommended to not exceed length of 50 in any language. Max length: 150.
// Required.
LocalizedTextSet
title
=
2
;
// The description of the product. Limited formatting options are allowed in
// the HTML format. Supported tags:
// * h1-h5
// * ul, ol, li
// * strong, italic, em
// * p, br
// Other tags are not supported and will be removed. CSS, tables, style
// property, `a` links are not supported. Images are not allowed, use the
// related_media field instead.
// Important notes:
// * Try not to use other tags except for the supported ones mentioned
// above, because the contents within unsupported tags will be stripped,
// and may lead to an undesirable user experience.
// * Try avoid deep nested structures like more than 3 different heading
// levels or nested lists. Keeping the structure flat, simple, and
// straightforward, helps to create a better user experience.
// * Do not duplicate info from the product_features field below in the
// description as both would normally be shown side by side.
// Recommended to not exceed length of 10000 in any language. Max length:
// 16000.
// Recommended.
LocalizedTextSet
description
=
3
;
// Structured details about the product features.
// Max number of features: 100.
// Recommended.
repeated
TextFeature
product_features
=
4
;
// Aggregated product rating.
// Recommended.
Rating
rating
=
5
;
// Related media such as photos or videos.
// Max number of media: 30.
// Recommended.
repeated
Media
related_media
=
6
;
// Whether Google should make use of the order in which related media are
// listed in the feed or not. The media order would be used to influence
// the final image order for the product in the UI.
// Optional, default is false.
bool
use_media_order
=
13
;
// Options available for this product.
// Max number of options: 20.
// At least one is required.
repeated
Option
options
=
7
;
// Operator details.
// Optional.
Operator
operator
=
8
;
// Inventory type of this product.
enum
InventoryType
{
// Default inventory type.
INVENTORY_TYPE_DEFAULT
=
0
;
// Product is an official ticket to a point of interest. To learn what
// qualifies as official inventory, refer to the policy doc.
INVENTORY_TYPE_OFFICIAL
=
1
;
// Product is coming directly from the operator or their official
// Connectivity Provider / ResTech.
INVENTORY_TYPE_OPERATOR_DIRECT
=
2
;
}
// Optional.
InventoryType
inventory_type
=
9
;
// Should contain only distinct values of InventoryType.
// Max number of inventory types: 2.
// Optional.
repeated
InventoryType
inventory_types
=
12
;
// Confirmation type of this product.
enum
ConfirmationType
{
// Type of confirmation is unknown.
CONFIRMATION_TYPE_UNKNOWN
=
0
;
// Booking is confirmed to the end user immediately.
CONFIRMATION_TYPE_INSTANT
=
1
;
// Booking is confirmed to the end user within 24 hours.
CONFIRMATION_TYPE_24HRS
=
2
;
// Booking is confirmed to the end user within 48 hours.
CONFIRMATION_TYPE_48HRS
=
3
;
}
// Optional.
ConfirmationType
confirmation_type
=
10
;
// Possible fulfillment types -- ways to obtain a document to confirm the
// booking. Combinations are possible, e.g. mobile + printed, or
// printed at home + in-person pickup is available.
// At least one field must be true.
message
FulfillmentType
{
// Confirmation on a mobile phone, e.g. with a QR code.
bool
mobile
=
1
;
// Printable confirmation.
bool
print_at_home
=
2
;
// Admission documents to be picked up in person.
bool
pickup
=
3
;
}
// Recommended.
FulfillmentType
fulfillment_type
=
11
;
// Provider brand name.
// Recommended to not exceed length of 50 in any language.
// Max length: 100.
// Optional.
LocalizedTextSet
brand_name
=
14
;
}
Implementation Notes
| Type | Field | Notes |
|---|---|---|
|
string
|
id | REQUIRED, max length 255. A unique string which identifies the product. Allowed characters are alphanumeric, _, and -. |
| title | REQUIRED, recommended length<= 50, max length 150 characters. See Title and description guidelines for more detail. |
|
| description | RECOMMENDED, recommended length <= 10000, max length 16000 characters. See Title and description guidelines for more detail. |
|
| product_features | RECOMMENDED, max number of features: 100. |
|
| rating | RECOMMENDED. Providing ratings are strongly recommended as products displaying ratings result in higher click through rate. |
|
| related_media | RECOMMENDED, max number of media: 30 Providing more than one image is strongly recommended. See Image guidelines for detailed guide on images. |
|
|
boolean
|
use_media_order | OPTIONAL Hint to Google that the order in which related media are listed in the feed should be taken into account when choosing which image to show. |
| options | REQUIRED, max number of options: 20 Each product must have at least one product option. |
|
| operator | OPTIONAL. | |
|
enum
|
deprecated
inventory_type |
OPTIONAL.INVENTORY_TYPE_OFFICIAL
can only be set in products which links to the official ticket site of a point of
interest. The ability to set this value is enabled only after an eligibility review.This field is deprecated and replaced by the new repeated field inventory_types. |
|
repeated
|
inventory_types | OPTIONAL. Repeated list of unique inventory types this product belongs to. INVENTORY_TYPE_OFFICIAL
can only be set in products which links to the official ticket site of a point of
interest. The ability to set this value is enabled only after an eligibility review.INVENTORY_TYPE_OPERATOR_DIRECT
can only be set in products which links to the tour operator site.
The ability to set this value is enabled only after an eligibility review. |
|
enum
|
confirmation_type | OPTIONAL. |
|
FulfillmentType
|
fulfillment_type | RECOMMENDED. If set, at least one field in fulfillment_rype
must be true.Sets ways to obtain a document to confirm the booking. Combinations are possible, for example mobile + printed, or printed at home + in-person pickup is available. |
| brand_name | max length 100. The brand name the product should show, this replaces the now deprecated `operator/name`. Only one of the two values can be set. |
Examples
{
"id"
:
"product-1"
,
"title"
:
{
"localized_texts"
:
[
{
"language_code"
:
"en"
,
"text"
:
"Dans bike tour"
},
{
"language_code"
:
"es"
,
"text"
:
"Tour en bicicleta por Dans"
},
{
"language_code"
:
"zh-HK"
,
"text"
:
"丹斯自行車之旅"
}
]
},
"description"
:
{
"localized_texts"
:
[
{
"language_code"
:
"en"
,
"text"
:
"<p>A very fun bike tour<p>"
},
{
"language_code"
:
"es"
,
"text"
:
"<p>Un recorrido en bicicleta muy divertido.</p>"
},
{
"language_code"
:
"zh-HK"
,
"text"
:
"<p>一個非常有趣的自行車之旅.</p>"
}
]
},
"brand_name"
:
{
"localized_texts"
:
[
{
"language_code"
:
"en"
,
"text"
:
"Dans Bikes"
}
]
},
"rating"
:
{
"average_value"
:
4.6
,
"rating_count"
:
192
},
"product_features"
:
[{
"feature_type"
:
"TEXT_FEATURE_INCLUSION"
,
"value"
:
{
"localized_texts"
:
[
{
"language_code"
:
"en"
,
"text"
:
"<p>A very fun bike tour<p>"
},
{
"language_code"
:
"es"
,
"text"
:
"<p>Un recorrido en bicicleta muy divertido.</p>"
},
{
"language_code"
:
"zh-HK"
,
"text"
:
"<p>一個非常有趣的自行車之旅.</p>"
}
]
}
},{
"feature_type"
:
"TEXT_FEATURE_HIGHLIGHT"
,
"value"
:
{
"localized_texts"
:
[
{
"language_code"
:
"en"
,
"text"
:
"<p>A very fun bike tour<p>"
},
{
"language_code"
:
"es"
,
"text"
:
"<p>Un recorrido en bicicleta muy divertido.</p>"
},
{
"language_code"
:
"zh-HK"
,
"text"
:
"<p>一個非常有趣的自行車之旅.</p>"
}
]
}
},{
"feature_type"
:
"TEXT_FEATURE_MUST_KNOW"
,
"value"
:
{
"localized_texts"
:
[
{
"language_code"
:
"en"
,
"text"
:
"<p>A very fun bike tour<p>"
},
{
"language_code"
:
"es"
,
"text"
:
"<p>Un recorrido en bicicleta muy divertido.</p>"
},
{
"language_code"
:
"zh-HK"
,
"text"
:
"<p>一個非常有趣的自行車之旅.</p>"
}
]
}
}],
"options"
:
[{
"id"
:
"option-1"
,
"title"
:
{
"localized_texts"
:
[
{
"language_code"
:
"en"
,
"text"
:
"Sunset tour"
},
{
"language_code"
:
"es"
,
"text"
:
"Tour al atardecer"
},
{
"language_code"
:
"zh-HK"
,
"text"
:
"日落之旅"
}
]
},
"landing_page"
:
{
"url"
:
"https://www.danstour.com/sunset?language={lang}¤cy={currency}"
},
"cancellation_policy"
:
{
"refund_conditions"
:
[
{
"min_duration_before_start_time_sec"
:
86400
,
"refund_percent"
:
100
}
]
},
"option_categories"
:
[
{
"label"
:
"sports"
},
{
"label"
:
"bike-tours"
}
],
"related_locations"
:
[
{
"location"
:
{
"location"
:
{
"place_id"
:
"ChIJ3S-JXmauEmsRUcIaWtf4MzE"
}
},
"relation_type"
:
"RELATION_TYPE_RELATED_NO_ADMISSION"
},
{
"location"
:
{
"location"
:
{
"lat_lng"
:
{
"latitude"
:
53.339688
,
"longitude"
:
6.236688
}
}
},
"relation_type"
:
"RELATION_TYPE_RELATED_NO_ADMISSION"
}
],
"price_options"
:
[
{
"id"
:
"option-1-adult"
,
"title"
:
"Adult (14+)"
,
"price"
:
{
"currency_code"
:
"EUR"
,
"units"
:
20
},
"fees_and_taxes"
:
{
"per_ticket_fee"
:
{
"currency_code"
:
"EUR"
,
"units"
:
1
},
"per_ticket_tax"
:
{
"currency_code"
:
"EUR"
,
"units"
:
1
}
}
}
]},{
"id"
:
"option-2"
,
"title"
:
{
"localized_texts"
:
[
{
"language_code"
:
"en"
,
"text"
:
"Sunrise tour"
},
{
"language_code"
:
"es"
,
"text"
:
"Tour al amanecer"
},
{
"language_code"
:
"zh-HK"
,
"text"
:
"日出之旅"
}
]
},
"landing_page"
:
{
"url"
:
"https://www.danstour.com/sunrise?language={lang}¤cy={currency}"
},
"cancellation_policy"
:
{
"refund_conditions"
:
[
{
"min_duration_before_start_time_sec"
:
86400
,
"refund_percent"
:
100
}
]
},
"option_categories"
:
[
{
"label"
:
"sports"
},
{
"label"
:
"bike-tours"
}
],
"related_locations"
:
[
{
"location"
:
{
"location"
:
{
"place_id"
:
"ChIJ3S-JXmauEmsRUcIaWtf4MzE"
}
},
"relation_type"
:
"RELATION_TYPE_RELATED_NO_ADMISSION"
}
],
"price_options"
:
[
{
"id"
:
"option-2-adult"
,
"title"
:
"Adult (14+)"
,
"price"
:
{
"currency_code"
:
"EUR"
,
"units"
:
20
,
"nanos"
:
0
}
}
],
"meeting_point"
:
{
"location"
:
{
"place_id"
:
"ChIJ3S-JXmauEmsRUcIaWtf4MzE"
},
"description"
:
{
"localized_texts"
:
[
{
"language_code"
:
"en"
,
"text"
:
"Sunrise tour"
},
{
"language_code"
:
"es"
,
"text"
:
"Tour al amanecer"
},
{
"language_code"
:
"zh-HK"
,
"text"
:
"日出之旅"
}
]
}
}
}
],
"related_media"
:
[
{
"url"
:
"http://www.danstour.com/photo1.jpg"
,
"type"
:
"MEDIA_TYPE_PHOTO"
},
{
"url"
:
"http://www.danstour.com/photo2.jpg"
,
"type"
:
"MEDIA_TYPE_PHOTO"
,
"attribution"
:
{
"localized_texts"
:
[
{
"language_code"
:
"en"
,
"text"
:
"Dans Photos"
}
]
}
}
],
"operator"
:
{
"name"
:
{
"localized_texts"
:
[
{
"language_code"
:
"en"
,
"text"
:
"Dans Bikes"
}
]
},
"phone_number"
:
"01234567"
,
"locations"
:
[{
"location"
:
{
"place_id"
:
"ChIJ3S-JXmauEmsRUcIaWtf4MzE"
}
}]
},
"inventory_types"
:
[
"INVENTORY_TYPE_OPERATOR_DIRECT"
]
}
Option
Proto
message
Option
{
// Option ID. Must be unique within a product.
// Required.
string
id
=
1
;
// The title of the option in plain text, e.g. "Sunset tour".
//
// If there is only a single option, the option title may be the same as the
// product title. If multiple product options are presented, the title must be
// unique to the option.
// Recommended to not exceed length of 50 in any language.
// Max length: 150.
// Required.
LocalizedTextSet
title
=
2
;
// The description of the option. Limited formatting options are allowed in
// the HTML format, see product description field for more details.
// Recommended to not exceed length of 10000 in any language.
// Max length: 16000.
// Recommended.
LocalizedTextSet
description
=
3
;
// Landing page URL for this option. The page should include a button to start
// the booking/checkout flow.
// Required.
DeepLink
landing_page
=
5
;
// Link to a list view at a higher level of available tickets and tours,
// prominently showing this option possibly among other options.
// Recommended.
DeepLink
landing_page_list_view
=
6
;
// Additional structured details about the option features. Should not
// duplicate the details from the product level.
// Max number of features: 100.
// Optional.
repeated
TextFeature
option_features
=
7
;
// Cancellation policy for this option.
// Recommended.
CancellationPolicy
cancellation_policy
=
8
;
// Relevant categories for this Option. Refer to the documentation for valid
// and mutually exclusive values.
// Max number of categories: 100.
// Optional.
repeated
Category
option_categories
=
9
;
// List of locations related to this option.
// Max number of locations: 100.
// Recommended.
repeated
RelatedLocation
related_locations
=
10
;
// If true, the option is a *typical ticket* that a user would expect to buy
// to participate in the experience, whether it's an attraction admission or
// a slot in a tour.
// Optional, default is false.
bool
base_ticket
=
11
;
// All possible prices for this option.
// Note: With Feed Spec v1 only single Adult price is supported. If multiple
// price options were provided, the lowest price, possibly with notion
// "from ..." would be displayed.
// At least one is required.
repeated
PriceOption
price_options
=
12
;
// Duration of the option in seconds, where applicable, e.g. for guided tours,
// boat trips etc. This should reflect the duration of experience (not
// validity time).
// Optional.
uint32
duration_sec
=
16
;
// Languages of the option. Only where relevant -- when it's important for
// the end user to understand and/or read in the language to enjoy the
// experience. E.g. relevant for a guided tour, but not for a mini-golf pass.
// Max number of languages: 100.
// Recommended.
repeated
Language
languages
=
14
;
// Meeting point -- the start location. Only add where relevant and
// beneficial, e.g. the place where participant will meet the tour guide to
// start a walking tour, the place where participant will be picked up for a
// city tour, the dock where a cruise trip will start.
// Optional.
Location
meeting_point
=
15
;
}
Implementation Notes
| Type | Field | Notes |
|---|---|---|
|
string
|
id | REQUIRED. Option ID. Must be unique within a product. |
| title | REQUIRED, recommended length: 50, max length: 150 characters. If there is only a single option, the option title may be the same as the product title. If multiple product options are presented, the title must be unique to the option. See Title and description guidelines for more detail. |
|
| description | RECOMMENDED, recommended length: 10000, max length: 16000. See Title and description guidelines for more detail. |
|
| landing_page | REQUIRED. Must contain button or link to book the product. See Landing page guidelines for more detail. |
|
| landing_page_list_view | RECOMMENDED. Link to a list view at a higher level of available tickets and tours, prominently showing this option possibly among other options. See Landing page guidelines for more detail. |
|
| option_features | OPTIONAL, max number of features: 100. Shouldn't duplicate the details from the product level. |
|
| cancellation_policy | RECOMMENDED. | |
| option_categories | Optional, max number of categories: 100. Relevant categories for this Option. Refer to the Product category documentation for additional recommended values. |
|
| related_location | RECOMMENDED, max number of locations: 100. Providing accurate list of related locations is extremely important for the product to show in the most relevant places, however overtagging or providing accurate data results in the product being removed. See Location and point of interest guide for more details. |
|
|
bool
|
base_ticket | OPTIONAL. Used to indicate if the product option is the basic entry ticket. |
| price_options | REQUIRED, at least 1. All possible prices for this option. Note: Only Adult price is supported. If multiple price options were provided, the first price which passes geographic restriction check would be used. For group tickets, the full price of the entire group must be used instead. |
|
|
uint32
|
duration_sec | OPTIONAL. Duration of the option in seconds, where applicable, such as for guided tours, boat trips. This should reflect the duration of experience (not validity time). |
| languages | RECOMMENDED, max number of languages: 100. Languages which the option is available in. When it's important for the end user to understand and/or read in the language to enjoy the experience. Such as for a guided tour. |
|
| meeting_point | OPTIONAL. Only add where relevant and beneficial such as the place where participant will meet the tour guide to start a walking tour or the place where participant will be picked up for a city tour, the dock where a cruise trip will start. |
Examples
{
"id"
:
"option-1"
,
"title"
:
{
"localized_texts"
:
[
{
"language_code"
:
"en"
,
"text"
:
"Sunset tour"
},
{
"language_code"
:
"es"
,
"text"
:
"Tour al atardecer"
},
{
"language_code"
:
"zh-HK"
,
"text"
:
"日落之旅"
}
]
},
"landing_page"
:
{
"url"
:
"https://www.danstour.com/sunset?language={lang}¤cy={currency}"
},
"cancellation_policy"
:
{
"refund_conditions"
:
[
{
"min_duration_before_start_time_sec"
:
86400
,
"refund_percent"
:
100
}
]
},
"option_categories"
:
[
{
"label"
:
"sports"
},
{
"label"
:
"bike-tours"
}
],
"related_locations"
:
[
{
"location"
:
{
"location"
:
{
"place_id"
:
"ChIJ3S-JXmauEmsRUcIaWtf4MzE"
}
},
"relation_type"
:
"RELATION_TYPE_RELATED_NO_ADMISSION"
},
{
"location"
:
{
"location"
:
{
"lat_lng"
:
{
"latitude"
:
53.339688
,
"longitude"
:
6.236688
}
}
},
"relation_type"
:
"RELATION_TYPE_RELATED_NO_ADMISSION"
}
],
"price_options"
:
[
{
"id"
:
"option-1-adult"
,
"title"
:
"Adult (14+)"
,
"price"
:
{
"currency_code"
:
"EUR"
,
"units"
:
20
},
"fees_and_taxes"
:
{
"per_ticket_fee"
:
{
"currency_code"
:
"EUR"
,
"units"
:
1
},
"per_ticket_tax"
:
{
"currency_code"
:
"EUR"
,
"units"
:
1
}
}
}
]
}
TextFeature
Proto
message
TextFeature
{
enum
TextFeatureType
{
// Don't use, for backwards compatibility only.
TEXT_FEATURE_UNKNOWN
=
0
;
// Feature is an inclusion.
TEXT_FEATURE_INCLUSION
=
1
;
// Feature is an exclusion.
TEXT_FEATURE_EXCLUSION
=
2
;
// Feature is a highlight.
TEXT_FEATURE_HIGHLIGHT
=
3
;
// Feature is a "must know".
TEXT_FEATURE_MUST_KNOW
=
4
;
// Feature represents information about safety measures.
TEXT_FEATURE_SAFETY_INFORMATION
=
5
;
}
// Feature type.
// Required.
TextFeatureType
feature_type
=
1
;
// LocalizedTextSet content of the feature. Values support both plain-text
// and HTML-like text for basic formatting. Supported HTML formatting tags:
//
// Phrase tags: <br>, <strong>, <em>, <i>:
// Only the four tags mentioned above are supported. <br> can be used to
// break lines in paragraphs, and <strong>/<em>/<i> can be used to highlight
// important text. Any other phrase tags will be ignored.
//
// All other tags and custom styles are not allowed and will be removed. Any
// URLs, anchors, and links will be stripped, and will never be displayed to
// end-users.
// Recommended to not exceed length of 1000 in any language. Max length: 2000.
// Required.
LocalizedTextSet
value
=
2
;
}
Implementation Notes
Type
Field
Notes
enum
feature_type
REQUIRED.
Feature type, possible values:
Feature type, possible values:
TEXT_FEATURE_INCLUSION
: Feature is an inclusion.TEXT_FEATURE_EXCLUSION
: Feature is an exclusion.TEXT_FEATURE_HIGHLIGHT
: Feature is a highlight.TEXT_FEATURE_MUST_KNOW
: Feature is a "must know".TEXT_FEATURE_SAFETY_INFORMATION
: Feature represents information about safety measures.value
REQUIRED, recommended length <= 1000 characters, max length: 2000.
Supported HTML formatting tags: br, strong, em, i
Only the four tags mentioned are supported.
All other tags and custom styles are not allowed and will be removed. Any URLs, anchors, and links will be stripped, and will never be displayed to end-users.
Supported HTML formatting tags: br, strong, em, i
Only the four tags mentioned are supported.
br
can be used to
break lines in paragraphs, and strong
/ em
/ i
can be used to highlight important text. Any other phrase tags will be ignored.All other tags and custom styles are not allowed and will be removed. Any URLs, anchors, and links will be stripped, and will never be displayed to end-users.
Examples
{
"feature_type"
:
"TEXT_FEATURE_HIGHLIGHT"
,
"value"
:
{
"localized_texts"
:
[
{
"language_code"
:
"en"
,
"text"
:
"<p>A very fun bike tour<p>"
},
{
"language_code"
:
"es"
,
"text"
:
"<p>Un recorrido en bicicleta muy divertido.</p>"
},
{
"language_code"
:
"zh-HK"
,
"text"
:
"<p>一個非常有趣的自行車之旅.</p>"
}
]
}
}
Rating
Proto
message
Rating
{
// Average rating value.
// The value must be in the range of [1, 5] and can be omitted if and only if
// the rating_count is zero.
double
average_value
=
1
;
// Number of ratings used in calculating the value.
// Required.
uint64
rating_count
=
2
;
}
Implementation Notes
| Type | Field | Notes |
|---|---|---|
|
double
|
average_value | OPTIONAL. Average rating value. The value must be in the range of [1, 5] and can be omitted if and only if rating_count
is zero. |
|
uint64
|
rating_count | REQUIRED. Number of ratings used in calculating the value. |
Examples
// Example 1
{
"average_value"
:
4.6
,
"rating_count"
:
192
}
// Example 2: No ratings data
{
"rating_count"
:
0
}
Media
Proto
message
Media
{
// URL of this media source. Google will crawl the media hosted at this URL.
// Max length: 2000.
// Required.
string
url
=
1
;
enum
MediaType
{
// Don't use, for backwards compatibility only.
MEDIA_TYPE_UNSPECIFIED
=
0
;
// Indicates the media provided by the url is a photo.
MEDIA_TYPE_PHOTO
=
1
;
}
// Type of this media source.
// Required.
MediaType
type
=
2
;
// Attribution information about the source of the media. Note that if
// the attribution is required to display with the media to give credit to
// photographer or agency, this field must be set.
// Recommended to not exceed length of 1000 in any language.
// Max length: 2000.
// Optional.
LocalizedTextSet
attribution
=
3
;
}
Implementation Notes
Type
Field
Notes
string
url
REQUIRED, max length: 2000.
URL of this media source. Google will crawl the media hosted at this URL.
URL of this media source. Google will crawl the media hosted at this URL.
enum
type
REQUIRED.
Type of this media source. Possible values:
Type of this media source. Possible values:
MEDIA_TYPE_PHOTO
: Indicates the media provided by the URL is a photo.attribution
OPTIONAL, recommended length: 1000, max length: 2000.
Attribution information about the source of the media. Note that if the attribution is required to display with the media to give credit to photographer or agency, this field must be set.
Attribution information about the source of the media. Note that if the attribution is required to display with the media to give credit to photographer or agency, this field must be set.
Examples
{
"url"
:
"http://www.danstour.com/photo2.jpg"
,
"type"
:
"MEDIA_TYPE_PHOTO"
,
"attribution"
:
{
"localized_texts"
:
[
{
"language_code"
:
"en"
,
"text"
:
"Dans Photos"
}
]
}
}
Category
Proto
message
Category
{
// Refer to the documentation for the valid values list.
// Required.
string
label
=
1
;
}
Implementation Notes
| Type | Field | Notes |
|---|---|---|
|
string
|
label | REQUIRED. Refer to the Product category documentation for the valid values list. |
Examples
{
"label"
:
"sports"
}
RelatedLocation
Proto
// Defines relation between an option and a location.
message
RelatedLocation
{
// Location related to an option. Can be a POI (e.g. Eiffel tower),
// neighbourhood (e.g. Old Town) or an address / arbitrary map point.
// Required.
Location
location
=
1
;
enum
RelationType
{
RELATION_TYPE_UNSPECIFIED
=
0
;
// Relation grants admission to this related location.
RELATION_TYPE_ADMISSION_TICKET
=
1
;
// Relation declares an additional service which doesn't get the user into
// the related location, e.g. a parking ticket, a temporary exhibition, etc.
RELATION_TYPE_SUPPLEMENTARY_ADDON
=
2
;
// Location is related but relation does not allow admission or admission is
// irrelevant, e.g. location is a square highlighted in a city tour.
RELATION_TYPE_RELATED_NO_ADMISSION
=
3
;
}
// Relation type of an option for the given location.
// Required.
RelationType
relation_type
=
2
;
}
Implementation Notes
Defines relation between an option and a location.
Type
Field
Notes
location
REQUIRED.
Location related to an option. Can be a POI (e.g. Eiffel tower), neighbourhood (e.g. Old Town) or an address / arbitrary map point.
Location related to an option. Can be a POI (e.g. Eiffel tower), neighbourhood (e.g. Old Town) or an address / arbitrary map point.
enum
relation_type
REQUIRED.
Relation type of an option for the given location. Possible values:
Relation type of an option for the given location. Possible values:
RELATION_TYPE_RELATED_NO_ADMISSION
: Location is related but relation
does not allow admission or admission is irrelevant such as location is a
square highlighted in a city tour.RELATION_TYPE_ADMISSION_TICKET
: Relation grants admission to this
related location.RELATION_TYPE_SUPPLEMENTARY_ADDON
: Relation declares an additional
service which doesn't get the user into the related location such as a
parking ticket or a temporary exhibition.Examples
// Example of place ID POI with no admissions
{
"location"
:
{
"location"
:
{
"place_id"
:
"ChIJ3S-JXmauEmsRUcIaWtf4MzE"
}
},
"relation_type"
:
"RELATION_TYPE_RELATED_NO_ADMISSION"
}
// Example of Address POI with admissions
{
"location"
:
{
"location"
:
{
"place_info"
:
{
"name"
:
"Eiffel Tower"
,
"unstructured_address"
:
"5 Av. Anatole France, 75007 Paris, France"
}
}
},
"relation_type"
:
"RELATION_TYPE_ADMISSION_TICKET"
}
DeepLink
Proto
// Deep link definition. Can include value parameters that will be expanded on
// serve time.
message
DeepLink
{
// Landing page URL template for desktop. If both `url` and `localized_url`
// are provided, the former is used as a fallback in case
// no URL matches the user’s locale.
// Max length: 2000.
// Either `url` or `localized_url` is required.
string
url
=
1
;
// Localized landing page URL template for desktop. If both `url` and
// `localized_url` are provided, the former is used as a fallback in case
// no URL matches the user’s locale.
// Max length: 2000.
// Max number of locales: 50.
// Either `url` or `localized_url` is required.
LocalizedTextSet
localized_url
=
3
;
reserved
2
,
4
;
}
Implementation Notes
Deep link definition. Can include value parameters that will be expanded at time of serving.
| Type | Field | Notes |
|---|---|---|
|
string
|
url | OPTIONAL, max length: 2000. Landing page URL template for desktop. Either `url` or `localized_url` is required. |
| localized_url | OPTIONAL, max length: 2000, max number of locals 50. Localized landing page URL template for desktop. If both url
and localized_url
are provided,
the former is used as a fallback in case no URL matches the user's locale. If url
is not available and
language is not provided, the english URL is used. |
Examples
// Example 1: single landing page URL.
{
"url"
:
"https://www.danstour.com/bike-tours/?language={lang}¤cy={currency}"
}
// Example 2: localized landing page url with fallback
{
"url"
:
"https://www.danstour.com/bike-tours/?currency={currency}"
,
"localized_url"
:
{
"localized_texts"
:
[{
"language_code"
:
"de"
,
"text"
:
"https://www.danstour.com.de/bike-tours/?currency={currency}"
},
{
"language_code"
:
"es-MX"
,
"text"
:
"https://mx.danstour.com/bike-tours/?currency={currency}"
},
{
"language_code"
:
"zh-HK"
,
"text"
:
"https://hk.danstour.com.es/bike-tours/?currency={currency}"
}]
}
}
Operator
Proto
message
Operator
{
// Operator name.
// Recommended to not exceed length of 50 in any language. Max length: 100.
// Required.
LocalizedTextSet
name
=
1
;
// Operator business name as it is registered in Google Business Profile and
// appearing on Google Maps.
// Recommended to not exceed length of 50 in any language.
// Max length: 100.
// Required.
LocalizedTextSet
google_business_profile_name
=
4
;
// Operator phone number. Prefer full international phone number format.
// Max length: 64.
// Optional.
string
phone_number
=
2
;
// List of operator locations.
// Max number of locations: 1.
// Optional.
repeated
Location
locations
=
3
;
}
Implementation Notes
| Type | Field | Notes |
|---|---|---|
| name [deprecated] | OPTIONAL, recommended length: 50, max length: 100. The brand name of the seller of this product. OTAs should set this as the OTA brand. This field is now deprecated and replaced by brand_name under products |
|
| google_business_profile_name | REQUIRED, max length: 100. Operator business name as it is registered in Google Business Profile and appearing on Google Maps. This field is required in order to participate in the operator booking module. |
|
|
string
|
phone_number | OPTIONAL, max length: 64. Operator phone number. Prefer full international phone number format. |
| locations | OPTIONAL, max number: 1. The business address of the operator. If address string is used, include the business name as part of the address string. For example "business name, street address". Operator business must be findable on Google Maps in order for the operator booking module to trigger, the operator should register a Google Business Profile if their business is not findable in Google Maps. |
Examples
// Example 1: Sending operator information for operator booking module:
opera
t
or
:
{
"google_business_profile_name"
:
{
"localized_texts"
:
[{
"language_code"
:
"en"
,
"text"
:
"Dans Bikes"
}]
},
"locations"
:
[{
"location"
:
{
//Operator business address
"place_info"
:
{
"name"
:
"Dans Bike Tour"
,
"unstructured_address"
:
"123 Baker st..."
}
}}]
}
Language
Proto
message
Language
{
// A BCP 47 compliant language code such as "en" or "de-CH".
string
code
=
1
;
}
Implementation Notes
| Type | Field | Notes |
|---|---|---|
|
string
|
code | A BCP-47 compliant language code such as "en" or "de-CH". |
Examples
{
"code"
:
"de-CH"
}
PriceOption
Proto
message
PriceOption
{
// Unique ID within the price set.
// Max length: 255.
// Required.
string
id
=
1
;
// Short description of the price option, e.g. "Adult weekday".
// Max length: 150.
// Required.
string
title
=
2
;
// Price value, must match the final price on the checkout page, including all
// taxes and charges, see price policy. Currency will be converted to the user
// currency on rendering.
// Required when is_free is false.
google.type.Money
price
=
3
;
// Admission or ticket is free. Must be set to true for zero-price options.
// Optional, default is false.
bool
is_free
=
4
;
// List of geographical regions this price is applicable to. If empty,
// applicable to all locations.
// Optional.
repeated
GeoCriterion
geo_criteria
=
5
;
// Break down of fees and taxes included in the price above.
// Optional.
PriceFeesAndTaxes
fees_and_taxes
=
6
;
}
Implementation Notes
| Type | Field | Notes |
|---|---|---|
|
string
|
id | REQUIRED, max length: 255. Unique ID within the price set. |
|
string
|
title | REQUIRED, max length: 150. Short description of the price option, for example "Adult weekday". |
| price | REQUIRED when is_free
is false.Price value, must match the final price on the checkout page, including all taxes and charges, see price policy. Currency will be converted to the user currency on rendering. |
|
|
bool
|
is_free | OPTIONAL, default is false. Admission or ticket is free. Must be set to true for zero-price options. |
| geo_criteria | OPTIONAL. List of geographical regions this price is applicable to. If empty, applicable to all locations. |
|
| fees_and_taxes | OPTIONAL. Break down of fees and taxes included in the price. |
Examples
{
"id"
:
"option-1-adult"
,
"title"
:
"Adult (14+)"
,
"price"
:
{
"currency_code"
:
"EUR"
,
"units"
:
20
},
"fees_and_taxes"
:
{
"per_ticket_fee"
:
{
"currency_code"
:
"EUR"
,
"units"
:
1
},
"per_ticket_tax"
:
{
"currency_code"
:
"EUR"
,
"units"
:
1
}
}
}
GeoCriterion
Proto
message
GeoCriterion
{
// 2-letter country code as defined in ISO 3166-1.
// Required.
string
country_code
=
1
;
// If true, criterion is negative (the country code is excluded).
bool
is_negative
=
2
;
}
Implementation Notes
| Type | Field | Notes |
|---|---|---|
|
string
|
country_code | REQUIRED. 2-letter country code as defined in ISO 3166-1. |
|
bool
|
is_negative | OPTIONAL. If true, criterion is negative (the country code is excluded). |
Examples
{
"country_code"
:
"US"
,
"is_negative"
:
"true"
}
PriceFeesAndTaxes
Proto
message
PriceFeesAndTaxes
{
// Booking fees included in the final product price for a single ticket.
// Optional.
google.type.Money
per_ticket_fee
=
1
;
// State taxes included in the final product price for a single ticket.
// Optional.
google.type.Money
per_ticket_tax
=
2
;
}
Implementation Notes
| Type | Field | Notes |
|---|---|---|
| per_ticket_fee | OPTIONAL. Booking fees included in the final product price for a single ticket. |
|
| per_ticket_tax | OPTIONAL. State taxes included in the final product price for a single ticket. |
Examples
{
"per_ticket_fee"
:
{
"currency_code"
:
"EUR"
,
"units"
:
1
},
"per_ticket_tax"
:
{
"currency_code"
:
"EUR"
,
"units"
:
1
}
}
Location
Proto
message
Location
{
// At least one of (location, description) must be set, and we highly
// recommend populating location wherever possible.
//
// To emphasize, both fields can be populated together, e.g. you can set
// Central Park New York for the location and "In front of the 72 Street
// Station" for the description.
GeoLocation
location
=
1
;
// Additional description in human-readable form, e.g.
// "On the left side of the fountain on the Palace square".
// At least one of (location, description) must be set.
// Recommended to not exceed length of 1000 in any language. Max length: 2000.
LocalizedTextSet
description
=
2
;
}
Implementation Notes
| Type | Field | Notes |
|---|---|---|
| location | OPTIONAL, at least one of location or description must be present. The geographic location. |
|
| description | OPTIONAL, recommended length: 1000, max length: 2000, at least one
of location or description must be present. Additional description in human-readable form such as "On the left side of the fountain on the Palace square". |
Examples
{
"location"
:
{
"place_id"
:
"ChIJ3S-JXmauEmsRUcIaWtf4MzE"
}
}
{
"location"
:
{
"place_info"
:
{
"name"
:
"Eiffel Tower"
,
"unstructured_address"
:
"5 Av. Anatole France, 75007 Paris, France"
}
}
}
GeoLocation
See usage guidelines for more detailed information about each hint type.
Proto
message
GeoLocation
{
// Required (exactly one variant from oneof).
// See
// https://developers.google.com/travel/things-to-do/guides/partner-integration/location
// for detailed guidelines.
oneof
value
{
// Place ID as defined by the Places API:
// https://developers.google.com/places/web-service/place-id
//
// Uniquely identifies a POI on Google.
// It can be sourced using the Places API endpoints, for instance Place
// Search or Place Autocomplete, or manually using the Find Location Matches
// tool in Things to Do Center.
string
place_id
=
1
;
// Legacy single-line address.
// Components are expected to be comma-separated, with the first component
// being the place name as it is displayed on Google.
// For higher matching accuracy, use the street address shown on Google for
// the place.
//
// Examples:
// - "Colosseum, Piazza del Colosseo, 1, 00184 Roma RM, Italy"
// - "The British Museum, Great Russell St, London WC1B 3DG, United Kingdom"
//
// Max length: 200.
//
// Deprecated: use `place_info` for higher matching accuracy, which provides
// a separate field for the place name and supports both structured and
// unstructured address formats.
string
address
=
3
[
deprecated
=
true
];
// Structured place information.
PlaceInfo
place_info
=
4
;
// Business Profile ID, as found in the Google Business Profile settings
// page. Use this field when sourcing locations directly from the place
// owner, who has access to the Google Business Profile for the place and
// can provide such ID.
uint64
business_profile_id
=
5
;
// Geographic coordinates.
// This field can only be used to determine a city or geographical region,
// as it is too ambiguous to identify a specific place or businesses.
// Use `place_info` instead to match to a specific place by name and
// coordinates.
google.type.LatLng
lat_lng
=
2
;
}
}
Implementation Notes
| Type | Field | Notes |
|---|---|---|
|
string
|
place_id | OPTIONAL, exactly one of place_id
, address
, place_info
, business_profile_id
, or lat_lng
must be
present.PlaceId as defined by The Places API . Uniquely identifies a POI on Google. It can be sourced using the Places API endpoints, for example Place Search or Place Autocomplete, or manually using the Find Location Matches tool in Things to Do Center. |
|
string
|
address | OPTIONAL, exactly one of place_id
, address
, place_info
, business_profile_id
, or lat_lng
must be
present.DEPRECATED. Legacy single-line address. Max length: 200. Components are expected to be comma-separated, with the first component being the place name as it is displayed on Google. For higher matching accuracy, use the street address shown on Google for the place. |
| place_info | OPTIONAL, exactly one of place_id
, address
, place_info
, business_profile_id
, or lat_lng
must be
present.Structured place information. |
|
|
uint64
|
business_profile_id | OPTIONAL, exactly one of place_id
, address
, place_info
, business_profile_id
, or lat_lng
must be
present.Business Profile ID, as found in the Google Business Profile settings page. Use this field when sourcing locations directly from the place owner, who has access to the Google Business Profile for the place and can provide such ID. |
| lat_lng | OPTIONAL, exactly one of place_id
, address
, place_info
, business_profile_id
, or lat_lng
must be
present.Geographic coordinates. This field can only be used to determine a city or geographical region, as it is too ambiguous to identify a specific place or businesses. Use place_info
instead to match to a
specific place by name and coordinates. |
Examples
"place_id"
:
"ChIJ3S-JXmauEmsRUcIaWtf4MzE"
"place_info"
:
{
"name"
:
"Eiffel Tower"
,
"unstructured_address"
:
"5 Av. Anatole France, 75007 Paris, France"
}
"business_profile_id"
:
11458995034835395294
"lat_lng"
:
{
"latitude"
:
-25.3511774
,
"longitude"
:
131.0326859
}
PlaceInfo
Proto
message
PlaceInfo
{
// Place or business name.
// For higher matching accuracy, this should be the same as the name shown on
// Google for the place. For places with a claimed Google Business Profile,
// this should be the same as the business name configured in the business
// profile.
// Max length: 100.
// Required.
string
name
=
1
;
// Phone number, including the international prefix.
// For higher matching accuracy, this should be the same as the phone number
// shown on Google for the place.
// It can include commonly used separator characters.
// Examples: "+1 212-363-3200", "+91 562 222 7261".
// Max length: 30.
// Optional.
string
phone_number
=
2
;
// Website URL shown on Google for the place, preferably the URL linked from
// the business listing in Google Maps or Search for the place.
// Max length: 1000.
// Optional.
string
website_url
=
3
;
// Geographic coordinates of the place.
// If left empty, Google will infer the coordinates from the address.
// Optional, but either `coordinates` or one of `address_type` must be
// provided.
google.type.LatLng
coordinates
=
4
;
// Optional, but either `coordinates` or one of `address_type` must be
// provided.
oneof
address_type
{
// Structured address.
// Prefer this format whenever possible for higher matching accuracy.
StructuredAddress
structured_address
=
5
;
// Unstructured address.
// It should not include the place or business name, which must instead be
// provided separately using the `name` field.
//
// Examples:
// - `name`: "Colosseum", `unstructured_address`: "Piazza del Colosseo, 1,
// 00184 Roma RM, Italy".
// - `name`: "The British Museum", `unstructured_address`: "Great Russell
// St, London WC1B 3DG, United Kingdom".
//
// Max length: 400.
string
unstructured_address
=
6
;
}
}
Implementation Notes
| Type | Field | Notes |
|---|---|---|
|
string
|
name | REQUIRED. Max length: 300. Place or business name. For higher matching accuracy, this should be the same as the name shown on Google for the place. For places with a claimed Google Business Profile, this should be the same as the business name configured in the business profile. |
|
string
|
phone_number | OPTIONAL. Max length: 30. Phone number, including the international prefix. For higher matching accuracy, this should be the same as the phone number shown on Google for the place. It can include commonly used separator characters. Examples: "+1 212-363-3200", "+91 562 222 7261". |
|
string
|
website_url | OPTIONAL. Max length: 1000. Website URL shown on Google for the place, preferably the URL linked from the business listing in Google Maps or Search for the place. |
| coordinates | OPTIONAL. Geographic coordinates of the place. If left empty, Google
will infer the coordinates from the address. Optional, but either coordinates
or any of structured_address
and unstructured_address
must be provided. |
|
| structured_address | OPTIONAL, exactly one of structured_address
or unstructured_address
may be present, never both. |
|
|
string
|
unstructured_address | OPTIONAL, exactly one of structured_address
or unstructured_address
may be present, never both. |
Examples
"place_info"
:
{
"name"
:
"Colosseum"
,
"phone_number"
:
"+39 063 99 67 700"
,
"website_url"
:
"https://colosseo.it/"
,
"coordinates"
:
{
"latitude"
:
41.8902102
,
"longitude"
:
12.4922309
},
"structured_address"
{
"street_address"
:
"Piazza del Colosseo, 1"
,
"locality"
:
"Roma"
,
"administrative_area"
:
"RM"
,
"postal_code"
:
"00184"
,
"country_code"
:
"IT"
}
}
"place_info"
:
{
"name"
:
"Eiffel Tower"
,
"unstructured_address"
:
"5 Av. Anatole France, 75007 Paris, France"
}
"place_info"
:
{
"name"
:
"Mutitjulu Waterhole"
,
"coordinates"
:
{
"latitude"
:
-25.3511774
,
"longitude"
:
131.0326859
}
}
StructuredAddress
Proto
message
StructuredAddress
{
// Street address, including house number and any other component that cannot
// be provided using the more specific fields defined below. It should not
// include the place or business name, which must instead be provided
// separately using the `name` field under `PlaceInfo`. It should also not
// include postal code, locality or country as those should be provided using
// the corresponding fields below.
//
// Examples:
// - "Piazza del Colosseo, 1" for the Colosseum.
// - "Great Russell St" for The British Museum.
// - "Champ de Mars, 5 Av. Anatole France" for the Eiffel Tower.
//
// Max length: 200.
// Required.
string
street_address
=
1
;
// Locality, generally referring to the city/town portion of an address.
// Examples: "New York", "Rome", "London", "Tokyo".
// In regions of the world where localities are not well defined or do not fit
// into this structure well, leave empty.
// Max length: 80.
// Optional.
string
locality
=
2
;
// Highest administrative subdivision used for postal addresses of the
// specific country or region. This can be a state, a region, a province, an
// oblast, a prefecture, etc.
// It can be an abbreviation or a full name, depending on how the region is
// usually represented in the postal addresses of the specific country. For
// example, "CA" or "California" for US addresses, "RM" for Rome province in
// Italy.
// Many countries don't use an administrative area in postal addresses. For
// instance, this field should not be used for addresses in Switzerland.
// Max length: 80.
// Optional.
string
administrative_area
=
3
;
// The postal code or zip code.
// Examples: "75007", "WC1B 3DG", etc.
// Required if the country supports postal codes, otherwise it should be left
// empty.
// Max length: 30.
// Optional.
string
postal_code
=
4
;
// Country code, as defined by Unicode's "CLDR", itself based on the ISO 3166
// alpha-2 standard. See
// https://unicode.org/cldr/charts/latest/supplemental/territory_containment_un_m_49.html.
//
// Examples: "US" for the United States, "FR" for France, "GB" for the United
// Kingdom, etc.
// Max length: 2.
// Required.
string
country_code
=
5
;
}
Implementation Notes
| Type | Field | Notes |
|---|---|---|
|
string
|
street_address | REQUIRED. Max length: 200. Street address, including house number
and any other component that cannot be provided using the more specific
fields. It shouldn't include the place or business name,
which must instead be provided separately using the name
field under PlaceInfo
. It should
also not include postal code, locality or country as those should be
provided using the corresponding fields. |
|
string
|
locality | OPTIONAL. Max length: 80. Locality, generally referring to the city or town portion of an address. In regions of the world where localities are not well defined or don't fit into this structure well, leave empty. |
|
string
|
administrative_area | OPTIONAL. Max length: 80. Highest administrative subdivision used for postal addresses of the specific country or region. This can be a state, a region, a province, an oblast, a prefecture. It can be an abbreviation or a full name, depending on how the region is usually represented in the postal addresses of the specific country. |
|
string
|
postal_code | OPTIONAL. Max length: 30. The postal code or zip code. Required if the country supports postal codes, otherwise it should be left empty. |
|
string
|
country_code | OPTIONAL. Max length: 2. Country code, as defined by Unicode "CLDR", itself based on the ISO 3166 alpha-2 standard. See Unicode documentation. |
Examples
{
"structured_address"
{
"street_address"
:
"Piazza del Colosseo, 1"
,
"locality"
:
"Roma"
,
"administrative_area"
:
"RM"
,
"postal_code"
:
"00184"
,
"country_code"
:
"IT"
}
}
LocalizedTextSet
Proto
// Values of the localized fields.
message
LocalizedTextSet
{
// Per-locale LocalizedText values.
// Maximum repeatedness: 50
repeated
google.type.LocalizedText
localized_texts
=
1
;
}
Implementation Notes
| Type | Field | Notes |
|---|---|---|
| localized_texts | Per-locale localized text values. Maximum number of locales: 50. |
Examples
{
"language_code"
:
"en"
,
"text"
:
"Sunrise tour"
}
CancellationPolicy
Proto
// Cancellation policy for a product.
message
CancellationPolicy
{
// Defines a single refund condition. Multiple refund conditions could be
// used together to describe "refund steps" as various durations before the
// service start time.
message
RefundCondition
{
// Duration in seconds before the start time, until when the customer can
// receive a refund for part of the service's cost specified in
// `refund_percent`.
// When unset or set to 0 the service can be cancelled at any time.
// Optional.
uint32
min_duration_before_start_time_sec
=
1
;
// The percent that can be refunded, as long as the service booking is
// cancelled at least `min_duration_before_start_time` before the service
// start time, in the range of [0, 100].
// When unset or set to 0, the service is not refundable. When set to 100
// this service is fully refundable.
// Optional.
uint32
refund_percent
=
2
;
// A flat fee deducted on refund. Could be used separately, or in
// combination with the refund_percent above. In the latter case, refund
// percent applies first, then the fee is deducted.
// Optional.
google.type.Money
refund_fee
=
3
;
}
// Zero or more refund conditions applicable to the policy.
// Max number of refund conditions: 10.
repeated
RefundCondition
refund_conditions
=
1
;
}
Implementation Notes
Defines a single refund condition. Multiple refund conditions could be used together to describe "refund steps" as various durations before the service start time.
| Type | Field | Notes |
|---|---|---|
|
RefundCondition
|
refund_conditions | OPTIONAL, max number of refund conditions: 10. |
RefundCondition
| Type | Field | Notes |
|---|---|---|
|
uint32
|
min_duration_before_start_time_sec | Optional. Duration in seconds before the start time, until when the customer can receive a refund for part of the service's cost specified in refund_percent
. When unset or set to 0 the service can be cancelled at any time. |
|
uint32
|
refund_percent | OPTIONAL. The percent that can be refunded, as long as the service booking is cancelled at least min_duration_before_start_time
before the service start time, in the range of [0, 100]. When unset or
set to 0, the service is not refundable. When set to 100 this service is
fully refundable. |
| refund_fee | OPTIONAL. A flat fee deducted on refund. Could be used separately, or in combination with the refund_percent
. In the
latter case, refund percent applies first, then the fee is deducted. |
Examples
"refund_conditions"
:
[
{
"min_duration_before_start_time_sec"
:
86400
,
"refund_percent"
:
100
}]
