您可以透過產品動態饋給,向 Google 提供觀光景點產品清單,該清單會顯示在各種 Google 平台上。
ProductFeed
物件包含單一 FeedMetadata
物件和零個或多個 Product
物件。如未在所有資料分割中提供 Product
,則系統會刪除所有產品。
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;
}
實作注意事項
類型 | 欄位 | 附註 |
---|---|---|
FeedMetadata | feed_metadata | 必填。 這個動態饋給的中繼資料。 |
重複 產品 |
產品 | 選用。 如果在所有資料分割中都未設定,系統會刪除所有產品。移除大量產品時,可能需要設定 feed_metadata/max_removal_share 。 |
示例
// 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;
}
實作注意事項
類型 | 欄位 | 附註 |
---|---|---|
uint32 | shard_id | total_shards_count > 1 時為必要。從零開始。不必依序轉移資料分割。所有資料分割都上傳完畢後,系統才會開始處理資料。 |
uint32 | total_shards_count | 必要,必須大於或等於 1。 |
uint64 | nonce | total_shards_count > 1 時為必要。移轉作業中的所有資料分割都必須相同。 |
列舉 | processing_instruction | 必要值。PROCESS_AS_SNAPSHOT 是唯一支援的值。 |
雙精準數 | max_removal_share | 選用。 透過上傳後可移除的有效產品比例上限。如果透過這項移轉作業移除更多產品,系統會拒絕所有轉移作業。這種做法可以防止有心人士意外將商品目錄中的重要部分下架。可設為 1.0,讓廣告空間完全下架。 |
示例
// 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
}
產品
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;
}
實作注意事項
類型 | 欄位 | 附註 |
---|---|---|
字串 | id | 必要,長度上限為 255。 用於識別產品的專屬字串。允許的字元包括英數字元、_ 和 -。 |
LocalizedTextSet | 名稱 | 必填,建議長度<= 50 個半形字元,長度上限為 150 個半形字元。 詳情請參閱標題和說明規範。 |
LocalizedTextSet | description | 建議長度 <= 10000,長度上限為 16000 個字元。 詳情請參閱標題和說明規範。 |
重複 TextFeature |
product_features | 建議功能數量上限為 100 項。 |
評分 | rating | 建議。 顯示評分的產品可提高點閱率,因此強烈建議你提供評分。 |
重複 媒體 |
related_media | 媒體建議數量上限:30 個 強烈建議提供多張圖片。如需圖片的詳細指南,請參閱「圖片規範」。 |
boolean | use_media_order | 選用 請讓 Google 知道在選擇要顯示的圖片時,應將相關媒體的排列順序納入考量。 |
重複 Option |
選項 | 必填,數量上限:20 個 每項產品至少要有一個產品選項。 |
運算子 | 運算子 | 選用。 |
列舉 | 已淘汰 inventory_type |
選用。INVENTORY_TYPE_OFFICIAL 只能在連結至搜尋點官方票券網站的產品中設定。只有在資格審查後,才能設定這個值。這個欄位已淘汰,並由新的重複欄位 inventory_types 取代。 |
repeated | inventory_types | 選用。 這項產品所屬不重複商品目錄類型的重複清單。 INVENTORY_TYPE_OFFICIAL 只能在連結至搜尋點官方票券網站的產品中設定。只有在資格審查後,才能設定這個值。INVENTORY_TYPE_OPERATOR_DIRECT 只能在連結至旅遊業者網站的產品中設定。
只有在資格審查後,才能設定這個值。 |
列舉 | confirmation_type | 選用。 |
FulfillmentType | fulfillment_type | 建議。如要設定,fulfillment_rype 中至少有一個欄位必須設為 true。設定取得文件並確認預訂的方法。可能會搭配組合,例如行動裝置 + 列印,或在家中列印 + 現場取貨。 |
LocalizedTextSet | brand_name | 長度上限為 100 個字元。 應顯示產品的品牌名稱,這會取代目前已淘汰的「運算子/名稱」。您只能設定這兩個值的其中一個。 |
示例
{
"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?source={src}&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?source={src}&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"]
}
選項
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;
}
實作注意事項
類型 | 欄位 | 附註 |
---|---|---|
字串 | id | 必填。 選項 ID。產品中的值不得重複。 |
LocalizedTextSet | 名稱 | 必要 (建議長度:50 個半形字元),最多 150 個半形字元。 如果只有單一選項,選項名稱可以與產品名稱相同。如果提供了多個產品選項,則該選項的名稱不得重複。詳情請參閱標題與說明規範。 |
LocalizedTextSet | description | 建議長度:10000,長度上限:16000。 詳情請參閱標題和說明規範。 |
DeepLink | landing_page | 必填。 必須包含產品的預訂按鈕或連結。 詳情請參閱到達網頁指南。 |
DeepLink | landing_page_list_view | 建議。 可連結至更高層級的可用票券和行程的清單檢視畫面,並在顯眼的位置列出可能的選項。詳情請參閱到達網頁指南。 |
重複 TextFeature |
option_features | 選用,地圖項目數量上限:100 個。 不得複製產品層級的詳細資料。 |
CancellationPolicy | cancellation_policy | 建議。 |
重複 類別 |
option_categories | 選填,類別數量上限為 100 個。 這個選項的相關類別。特別重要,請務必為所有非行程型活動設定 self-guided ,並將 guided-tour 設為遊覽活動。
如需其他建議值,請參閱產品類別說明文件。 |
重複 RelatedLocation |
related_location | 建議地點數量上限:100 個。 提供產品時,提供正確的相關地點清單極為重要,不過如果產品過度標記或提供正確的資料,就會遭到移除。詳情請參閱「地點和搜尋點」指南。 |
bool | base_ticket | 選填。 用於表示產品選項是否為基本入場券。 |
重複 PriceOption |
price_options | 必填,最少 1。 這個選項的所有適用價格。 注意:僅支援成人價格。如果提供多個價格選項,系統會使用第一個通過地理區域限制檢查的價格。如果是團體票券,請改用整個群組的完整價格。 |
uint32 | duration_sec | 選用。 選項的持續時間,在適用的情況下 (以秒為單位),例如導覽或乘船行程等。這應反映到體驗的時間長度 (不具效力時間)。 |
重複 語言 |
語言 | 建議語言數上限:100。 有提供選項的語言。需要使用者能理解及/或閱讀語言內容才能享受這項服務。例如與導覽相關的內容。 |
位置 | meeting_point | 選用。 只加入與有益於相關或有益之處,例如:參與者可以遇見導遊的地點、提供城市導覽的地點、出遊地點、郵輪行程的起點。 |
示例
{
"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?source={src}&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;
}
實作注意事項
類型 | 欄位 | 附註 |
---|---|---|
列舉 | feature_type | 必填。 地圖項目類型,可能的值: TEXT_FEATURE_INCLUSION :功能包含。TEXT_FEATURE_EXCLUSION :功能為排除條件。TEXT_FEATURE_HIGHLIGHT :為醒目顯示功能,TEXT_FEATURE_MUST_KNOW :功能是「重要資訊」。TEXT_FEATURE_SAFETY_INFORMATION :功能代表安全措施相關資訊。 |
LocalizedTextSet | 值 | 必要,建議長度 <= 1,000 個字元,長度上限:2000 個字元。 支援的 HTML 格式標記:br、strong、em、i 僅支援上述四個標記。 br 可用於在段落中分行,strong /em /i 則可用來醒目顯示重要文字。系統會忽略其他所有詞組標記。不得使用所有其他標記和自訂樣式,系統會將其移除。所有網址、錨定標記和連結都將移除,且一律不會向使用者顯示。 |
示例
{
"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;
}
實作注意事項
類型 | 欄位 | 附註 |
---|---|---|
雙精準數 | average_value | 選用。 平均評分值。這個值必須在 [1, 5] 的範圍內,只有在 rating_count 為零時可省略。 |
uint64 | rating_count | 必填。 用於計算值的評分次數。 |
示例
// Example 1
{
"average_value": 4.6,
"rating_count": 192
}
// Example 2: No ratings data
{
"rating_count": 0
}
媒體
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;
}
實作注意事項
類型 | 欄位 | 附註 |
---|---|---|
字串 | url | 必要,長度上限:2000。 這個媒體來源的網址。Google 會檢索透過這個網址代管的媒體。 |
列舉 | 類型 | 必要。 此媒體來源的類型。可能的值: MEDIA_TYPE_PHOTO :表示網址提供的媒體是相片。 |
LocalizedTextSet | 歸因 | 建議長度 (選用):1000,長度上限:2000。 媒體來源的作者資訊。請注意,如果必須提供出處,才能註明拍攝者或拍攝機構,請務必設定這個欄位。 |
示例
{
"url": "http://www.danstour.com/photo2.jpg",
"type": "MEDIA_TYPE_PHOTO",
"attribution": {
"localized_texts": [
{
"language_code": "en",
"text": "Dans Photos"
}
]
}
}
類別定義
Proto
message Category {
// Refer to the documentation for the valid values list.
// Required.
string label = 1;
}
實作注意事項
類型 | 欄位 | 附註 |
---|---|---|
字串 | 標籤 | 必填。如需有效值清單,請參閱產品類別說明文件。 |
示例
{
"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 {
// 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 = 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;
}
// Relation type of an option for the given location.
// Required.
RelationType relation_type = 2;
}
實作注意事項
定義選項與位置之間的關係。
類型 | 欄位 | 附註 |
---|---|---|
位置 | 地點 | 必填。 與選項相關的位置。可以是搜尋點 (例如艾菲爾鐵塔)、社區 (例如舊城區) 或地址 / 任意地圖點。 |
列舉 | relation_type | 必要。 特定位置選項的關係類型。可能的值: RELATION_TYPE_RELATED_NO_ADMISSION :地點相關,但不允許門票或入場資訊無關,例如:地點在城市觀光行程中醒目顯示的正方形。RELATION_TYPE_ADMISSION_TICKET :關係會授予此相關地點的門票。RELATION_TYPE_SUPPLEMENTARY_ADDON :關係宣告不提供使用者前往相關地點的額外服務,例如停車票券、臨時展覽等。 |
示例
// 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": {
"address": "Madame Tussauds Berlin, Unter den Linden 74, 10117 Berlin, Germany"
}
},
"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;
// Landing page URL template for mobile. If omitted, it defaults to the `url`
// value.
// Max length: 2000.
// Optional.
string mobile_url = 2;
// 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;
// Localized landing page URL template for mobile.
// Max length: 2000.
// Max number of locales: 50.
// Optional.
LocalizedTextSet localized_mobile_url = 4;
}
實作注意事項
深層連結定義。可以加入會在廣告放送時展開的價值參數。
類型 | 欄位 | 附註 |
---|---|---|
字串 | url | 選用,長度上限:2000。 電腦版的到達網頁網址。必須提供「url」或「localized_url」。 |
字串 | mobile_url | 選用,長度上限:2000。 適用於行動裝置的到達網頁網址範本。 |
LocalizedTextSet | localized_url | 選填,長度上限:2000,本機數量上限為 50。 電腦版網站的本地化到達網頁網址範本。如果同時提供 url 和 localized_url ,如果兩者的網址不符合使用者的語言代碼,就會使用前者做為備用選項。如果無法使用 url 且未提供語言,則會使用英文網址。 |
LocalizedTextSet | localized_mobile_url | 選用,長度上限:2000,本機數量上限為 50 個。 針對行動裝置本地化的 mobile_landing page 網址範本。 |
示例
// Example 1: single landing page url.
{
"url": "https://www.danstour.com/bike-tours/?source={src}&language={lang}¤cy={currency}"
}
// Example 2: localized landing page url with fallback
{
"url": "https://www.danstour.com/bike-tours/?source={src}¤cy={currency}",
"localized_url": {
"localized_texts": [{
"language_code": "de",
"text": "https://www.danstour.com.de/bike-tours/?source={src}¤cy={currency}"
}, {
"language_code": "es-MX",
"text": "https://mx.danstour.com/bike-tours/?source={src}¤cy={currency}"
}, {
"language_code": "zh-HK",
"text": "https://hk.danstour.com.es/bike-tours/?source={src}¤cy={currency}"
}]
}
}
運作資源
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;
}
實作注意事項
類型 | 欄位 | 附註 |
---|---|---|
LocalizedTextSet | 名稱 [已淘汰] | 建議長度 (選用):50 個半形字元,長度上限 100 個半形字元。 這項產品的賣方品牌名稱。OTA 應將其設為 OTA 品牌。 這個欄位目前已淘汰,並由產品下的 brand_name 取代 |
LocalizedTextSet | google_business_profile_name | 必要,長度上限:100。 業者商家名稱 (你在 Google 商家檔案中註冊,並顯示在 Google 地圖上)。你必須填寫這個欄位,才能參與業者預訂模組。 |
字串 | phone_number | 選填,長度上限為 64 個半形字元。 電信業者的電話號碼。偏好完整的國際電話號碼格式。 |
重複 位置 |
地點 | 選填,數量上限:1. 業者的公司地址。 如果使用地址字串,請在地址字串中加入商家名稱,例如「 |
示例
// Example 1: Sending operator information for operator booking module:
operator: {
"google_business_profile_name": {
"localized_texts": [{
"language_code": "en",
"text": "Dans Bikes"}]
},
"locations": [{
"location": { //Operator business address
"address": "Dans Bikes, 123 NYC st…"
}}]
}
語言定義
Proto
message Language {
// A BCP 47 compliant language code such as "en" or "de-CH".
string code = 1;
}
實作注意事項
類型 | 欄位 | 附註 |
---|---|---|
字串 | 代碼 | 符合 BCP-47 規範的語言代碼,例如「en」或「de-CH」。 |
示例
{
"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;
}
實作注意事項
類型 | 欄位 | 附註 |
---|---|---|
字串 | id | 必填,長度上限:255。位於所設定價格中的 個專屬 ID。 |
字串 | 名稱 | 必填,長度上限:150。 價格選項的簡短說明,例如「成人平日」。 |
google.type.Money | 價格 | 當 is_free 為 false 時為必填。價格值必須與結帳頁面上的最終價格 (包含所有稅金和費用) 相符,請參閱價格政策。曝光時,系統會將貨幣轉換成使用者貨幣。 |
bool | is_free | 選填,預設為 false。 入場或門票免費。零價格選項須設為 true。 |
重複 GeoCriterion |
geo_criteria | 選填。 此價格適用的地理區域清單。如果留空,表示適用於所有地點。 |
重複 PriceFeesAndTaxes |
fees_and_taxes | 選填。 依上述價格細分的費用和稅金。 |
示例
{
"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;
}
實作注意事項
類型 | 欄位 | 附註 |
---|---|---|
字串 | country_code | 必填。 ISO 3166-1 所定義的國家/地區代碼 (由 2 個英文字母組成)。 |
bool | is_negative | OPTIONAL。 如果為 true,條件為負數 (排除國家/地區代碼)。 |
示例
{
"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;
}
實作注意事項
類型 | 欄位 | 附註 |
---|---|---|
google.type.Money | per_ticket_fee | 選填。 單一票券的最終產品價格已包含預訂費用。 |
google.type.Money | per_ticket_tax | 選填。 在單一票券的最終產品價格中納入州別稅金。 |
示例
{
"per_ticket_fee": {
"currency_code": "EUR",
"units": 1
},
"per_ticket_tax": {
"currency_code": "EUR",
"units": 1
}
}
位置
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;
}
實作注意事項
類型 | 欄位 | 附註 |
---|---|---|
GeoLocation | 地點 | 選用,必須至少提供一個地點或說明。 地理位置。 |
LocalizedTextSet | description | 建議長度:選用,建議長度為 1000 個字元,上限為 2000 個字元,且至少必須含有一個地點或說明。 額外說明也應以使用者可理解的格式呈現,例如「在宮殿廣場上的噴泉左側。」 |
示例
{
"location": {
"place_id": "ChIJ3S-JXmauEmsRUcIaWtf4MzE"
}
}
GeoLocation
如要進一步瞭解每種提示類型,請參閱 使用指南。
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;
}
}
實作注意事項
類型 | 欄位 | 附註 |
---|---|---|
字串 | place_id | 選用,只能有 place_id 、address 、place_info 、business_profile_id 或 lat_lng 其中之一。Places API 定義的 PlaceId。 用於識別 Google 上的搜尋點。您可以使用 Places API 端點 (例如 Place Search 或 Place Autocomplete) 取得這項資訊,或使用 Things to Do Center 的「尋找位置比對」工具手動取得。 |
字串 | 地址 | 選用,只能有 place_id 、address 、place_info 、business_profile_id 或 lat_lng 其中之一。已淘汰。舊版單行地址。長度上限:200。 元件應以半形逗號分隔,而第一個元件是 Google 上顯示的地點名稱。為提高比對準確度,請使用 Google 上顯示的街道地址。 |
PlaceInfo | place_info | 選用,只能有 place_id 、address 、place_info 、business_profile_id 或 lat_lng 其中之一。結構化地點資訊。 |
uint64 | business_profile_id | 選用,只能有 place_id 、address 、place_info 、business_profile_id 或 lat_lng 其中之一。商家檔案 ID (可在 Google 商家檔案設定頁面中找到)。如果你是直接向地點擁有者取得地點,且對方有權存取該地點的 Google 商家檔案,且能提供這類 ID,請使用這個欄位。 |
google.type.LatLng | lat_lng | 選用,只能有 place_id 、address 、place_info 、business_profile_id 或 lat_lng 其中之一。地理座標。這個欄位太過模糊,無法用來識別特定地點或商家,因此只能用來判斷城市或地理區域。請改用 place_info ,依據名稱和座標來比對特定地點。 |
示例
"place_id": "ChIJ3S-JXmauEmsRUcIaWtf4MzE"
"address": "Eiffel Tower, 5 Av. Anatole France, 75007 Paris, France"
"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: 300.
// 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;
}
}
實作注意事項
類型 | 欄位 | 附註 |
---|---|---|
字串 | 名稱 | 必填。長度上限:300。地點或商家名稱。為提高比對準確度,這個名稱必須與 Google 上顯示的地點名稱相同。如果地點的 Google 商家檔案已聲明擁有權,則此名稱應與商家檔案中設定的商家名稱相同。 |
字串 | phone_number | 選用。長度上限:30。電話號碼 (包含國際前置字串)。為了提高比對準確度,這個值應與 Google 上顯示的地點電話號碼相同。可包含常用的分隔符字元。例如:「+1 212-363-3200」、「+91 562 222 7261」。 |
字串 | website_url | 選用。長度上限:1000。在 Google 顯示地點的網站網址,最好是 Google 地圖或搜尋地點的商家資訊連結網址。 |
google.type.LatLng | 座標 | 選用。地點的地理座標。如果留空,Google 會根據地址推論座標。選用,但必須提供 coordinates ,或是 structured_address 和 unstructured_address 。 |
StructuredAddress | structured_address | 選用,structured_address 或 unstructured_address 可能只存在其中一個,而非兩者都存在。 |
字串 | unstructured_address | 選用,structured_address 或 unstructured_address 可能只存在其中一個,而非兩者都存在。 |
示例
"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;
}
實作注意事項
類型 | 欄位 | 附註 |
---|---|---|
字串 | street_address | 必填。長度上限:200。街道地址,包括門牌號碼,以及無法透過下方定義更具體欄位提供的任何其他元件。不得包含地點或商家名稱。如要另外提供,必須使用 PlaceInfo 下的 name 欄位。也不應包含郵遞區號、縣市或國家/地區。請務必透過下列對應欄位提供這些資訊。 |
字串 | locality | 選用。長度上限:80。縣市,通常是指地址的縣市或鄉鎮部分。如為未明確定義縣市或不適用此結構的地區,請將此欄位留白。 |
字串 | administrative_area | 選用。長度上限:80。用於特定國家/地區郵政地址的最高行政區。可以是州、區域、州/省、都/道/府/縣等。這可以是縮寫或全名,取決於該區域通常在特定國家/地區郵政地址中的表示方式。 |
字串 | postal_code | 選用。長度上限:30。郵遞區號。如果國家/地區支援郵遞區號,則為必填,否則應留空。 |
字串 | country_code | 選用。長度上限:2. 依 ISO 3166 alpha-2 標準定義的國家/地區代碼,如 Unicode「CLDR」定義。請參閱 Unicode 說明文件。 |
示例
{
"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.
repeated google.type.LocalizedText localized_texts = 1;
}
實作注意事項
類型 | 欄位 | 附註 |
---|---|---|
重複 google.type.LocalizedText |
localized_texts | 依語言代碼調整的本地化文字值。 |
示例
{
"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;
}
實作注意事項
定義單一退款條件。您可以同時使用多項退款條件,在服務開始時間前的不同時間點來說明「退款步驟」。
類型 | 欄位 | 附註 |
---|---|---|
RefundCondition | refund_conditions | 選填,退款條件數量上限:10 個。 |
RefundCondition
類型 | 欄位 | 附註 |
---|---|---|
uint32 | min_duration_before_start_time_sec | 選填。 開始時間前的持續時間 (以秒為單位),客戶可以收到 refund_percent 中前述服務費用的部分退款。如果未設定或設為 0,則隨時可以取消服務。 |
uint32 | refund_percent | 選填。 如要退款的百分比,只要在服務開始時間前至少 min_duration_before_start_time 取消服務預訂,範圍在 [0, 100] 之間即可。如未設定或設為 0,服務將無法退款。如果設為「100」,這項服務可全額退款。 |
google.type.Money | refund_fee | 選填。 退款時已扣除固定費用。可以單獨使用,也可以與上方的 refund_percent 搭配使用。如果是後者,則會先計算退款百分比,再扣除相關費用。 |
示例
"refund_conditions": [
{
"min_duration_before_start_time_sec": 86400,
"refund_percent": 100
}]