Offer

LINT.IfChange(offer_definition) [START offer_definition] Next tag: 26

JSON 表示法 
{
  "offerId": string,
  "entityIds": [
    string
  ],
  "addOnOfferApplicableToAllEntities": boolean,
  "offerSource": enum (OfferSource),
  "actionType": enum (ActionType),
  "offerModes": [
    enum (OfferMode)
  ],
  "offerCategory": enum (OfferCategory),
  "sourceAssignedPriority": integer,
  "offerDetails": {
    object (OfferDetails)
  },
  "offerRestrictions": {
    object (OfferRestrictions)
  },
  "coupon": {
    object (Coupon)
  },
  "paymentInstrument": {
    object (PaymentInstrument)
  },
  "subscription": {
    object (Subscription)
  },
  "terms": {
    object (Terms)
  },
  "validityPeriods": [
    {
      object (ValidityPeriod)
    }
  ],
  "offerUrl": string,
  "imageUrl": string,
  "tags": [
    enum (OfferTag)
  ],
  "brandId": string
}
欄位
offerId

string

優惠的專屬 ID。必填。
entityIds[]

string

參與這項優惠的商家清單。
addOnOfferApplicableToAllEntities

boolean

如果為 true，這項優惠適用於集結網站下的所有實體。僅適用於加購優惠。
offerSource

enum (OfferSource)

優惠可由集結網站、個別商家，甚至是第三方提供，做為附加項目。必填。
actionType

enum (ActionType)

提供優惠的服務。一個 offerId 只能屬於一個 actionType。如果優惠可跨多種服務類型共用，則系統會為每種服務類型建立具有專屬 ID 的重複優惠。必填。
offerModes[]

enum (OfferMode)

優惠的使用方式，例如現場候位、預訂、線上等。必填。
offerCategory

enum (OfferCategory)

優惠類別。必填。
sourceAssignedPriority

integer

非負整數 ([1-100]，其中 1 代表最高優先順序)，表示來源指派的商品/服務優先順序。如果同一商家有多項優惠，系統會根據這項信號為優惠排名。0 代表未設定優先順序。
offerDetails

object (OfferDetails)

優惠詳細資料，例如折扣、預訂費用等。必填。
offerRestrictions

object (OfferRestrictions)

說明優惠限制，例如是否需要訂閱/付款工具、是否可與其他優惠合併使用 (以及哪些類型) 等。必填。
coupon

object (Coupon)

優惠券詳細資料。offerCategory 為 OFFER_CATEGORY_ADD_ON_COUPON_OFFER 時，必須提供這項屬性。
paymentInstrument

object (PaymentInstrument)

付款方式的詳細資料。offerCategory 為 OFFER_CATEGORY_ADD_ON_PAYMENT_OFFER 時，必須提供這項資訊。
subscription

object (Subscription)

訂閱方案的詳細資料。offerCategory 為 OFFER_CATEGORY_ADD_ON_SUBSCRIPTION_OFFER 時，必須提供這項資訊。
terms

object (Terms)

優惠條款及細則。必填。
validityPeriods[]

object (ValidityPeriod)

優惠的有效期限。說明優惠的有效時間範圍，包括開始和結束時間、星期幾等。必填。
offerUrl

string

商家優惠頁面的網址。offerCategory 為 OFFER_CATEGORY_BASE_OFFER 時，必須提供這項資訊。
imageUrl

string

商家優惠圖片的網址。
tags[]

enum (OfferTag)

與優惠相關聯的特殊標籤。這項屬性可用於識別「節慶」、「評價最高」、「預訂次數最多」等特別優惠。
brandId

string

用於識別與商品相關聯的品牌。如未設定，則會使用預設品牌。

OfferDetails

[START offer_details_definition] 下一個標記：15

JSON 表示法 
{
  "offerDisplayText": string,
  "maxDiscountValue": {
    object (Money)
  },
  "minSpendValue": {
    object (Money)
  },
  "bookingCost": {
    object (Money)
  },
  "bookingCostUnit": enum (FeeUnit),
  "convenienceFee": {
    object (Fee)
  },
  "bookingCostAdjustable": boolean,
  "additionalFees": [
    {
      object (AdditionalFee)
    }
  ],
  "giftCardInfo": {
    object (GiftCardInfo)
  },

  // Union field offer_specification can be only one of the following:
  "discountPercent": number,
  "discountValue": {
    object (Money)
  },
  "otherOfferDetailText": string
  // End of list of possible types for union field offer_specification.
}
欄位
offerDisplayText

string

優惠供應商想在搜尋結果網頁上向顧客顯示的優惠文字。必填。
maxDiscountValue

object (Money)

可享有的最高折扣。例如 9 折優惠，最高折抵 $100 美元。
minSpendValue

object (Money)

可享折扣的最低支出門檻。例如，總價達 $100 美元以上時，可享 9 折優惠。
bookingCost

object (Money)

預訂這項優惠的費用。舉例來說，如果預訂桌位費用為 $15 美元，最終帳單可折抵 $100 美元。
bookingCostUnit

enum (FeeUnit)

預訂費用的單位。例如每人每次交易。
convenienceFee

object (Fee)
bookingCostAdjustable

boolean

預訂費用是否可調整，也就是從最終帳單中扣除預訂費用。例如：預訂晚餐可享 7 折優惠。預約費用為 $15 美元，將計入最終帳單。因此最終帳單：總支出 - 30% - $15
additionalFees[]

object (AdditionalFee)

向使用者收取的額外費用。例如：便利、處理、運送、包裝、服務費等。
giftCardInfo

object (GiftCardInfo)

禮物卡優惠的詳細資料。
聯集欄位 offer_specification。折扣可以是百分比，也可以是從總價值扣除的固定值。例如：1. 最終帳單可享 9 折優惠。2. 訂單可折抵 $15 美元。商家也可以透過相關規格欄位提供自訂折扣，例如「買一送一」。必填。offer_specification 只能是下列其中一項：
discountPercent

number

帳單的折扣百分比。[0, 100] 如果是買一送一或 5 折優惠，且適用於整份餐點 (例如買一送一自助餐、整筆帳單買一送一、套餐買一送一)，這個值可以設為 50。
discountValue

object (Money)

折扣的固定值。
otherOfferDetailText

string

說明折扣的任意形式文字。如果是買一送一優惠 (例如買一送一飲料、買一送一主餐、買一送一指定菜單項目)，請在此說明詳細資訊。

OfferRestrictions

[START offer_restrictions_definition] Next tag: 11

JSON 表示法 
{
  "combinableWithOtherOffers": boolean,
  "combinableOfferCategories": [
    enum (OfferCategory)
  ],
  "combinableOfferIds": [
    string
  ],
  "inclusions": [
    {
      object (OfferCondition)
    }
  ],
  "exclusions": [
    {
      object (OfferCondition)
    }
  ],
  "minGuest": integer,
  "foodOfferRestrictions": {
    object (FoodOfferRestrictions)
  },
  "specialConditions": [
    string
  ]
}
欄位
combinableWithOtherOffers

boolean

這項優惠是否可與其他優惠併用。如果為 true，合作夥伴可以指定這項優惠可與哪些優惠合併使用。如果同時設定 combinableOfferCategories 和 combinableOfferIds，只要符合上述任一條件，即可合併使用優惠。
combinableOfferCategories[]

enum (OfferCategory)

這項優惠可與哪些類型的優惠合併使用。例如，這項優惠可能可以與其他優待券合併使用。如果 combinableWithOtherOffers 為 true，且未設定這個欄位，則所有類型都可合併。
combinableOfferIds[]

string

可與這項優惠合併使用的 offer_id 清單。部分優惠可能只能與特定其他優惠 ID (可視為父項優惠) 搭配使用。如果 combinableWithOtherOffers 為 true，且未設定這個欄位，則所有優惠 ID 均可合併。
inclusions[]

object (OfferCondition)

優惠必須符合的條件清單 (例如不含酒精的飲料、食物)。
exclusions[]

object (OfferCondition)

列出會導致優惠失效的條件 (例如自助餐、組合優惠和雞尾酒)。
minGuest

integer

可享優惠的最低人數門檻。
foodOfferRestrictions

object (FoodOfferRestrictions)

餐飲優惠的專屬限制。
specialConditions[]

string

這項優惠的特殊條件，必須向使用者顯示。例如：「僅限在 [地區] 付款時使用」、「不適用於線上付款」

OfferCondition

[START offer_condition_definition]

JSON 表示法 
{
  "description": string
}
欄位
description

string

PaymentInstrument

[START payment_instrument_definition]

JSON 表示法 
{
  "items": [
    {
      object (PaymentInstrumentItem)
    }
  ],
  "providerName": string
}
欄位
items[]

object (PaymentInstrumentItem)

可用於兌換優惠的付款方式清單。必填。
providerName

string

付款方式供應商的名稱。可以是銀行合作夥伴、銀行名稱等，例如 American Express、HDFC、ICICI。

PaymentInstrumentItem

[START payment_instrument_item_definition]

JSON 表示法 
{
  "type": enum (PaymentInstrumentType),
  "name": string
}
欄位
type

enum (PaymentInstrumentType)

付款方式類型。必填。
name

string

付款方式項目的名稱，例如信用卡名稱。例如：HDFC Infinia、American Express Platinum。必填。

訂閱

[START subscription_definition]

JSON 表示法 
{
  "name": string,
  "subscriptionAutoAdded": boolean,
  "cost": {
    object (Money)
  },
  "subscriptionDuration": string,
  "termsAndConditionsUrl": string
}
欄位
name

string

訂閱項目名稱。必填。
subscriptionAutoAdded

boolean

使用者兌換這項優惠時，是否自動新增訂閱項目
cost

object (Money)

訂閱費用。必填。
subscriptionDuration

string (Duration format)

訂閱費用 [subscription_cost] 的有效期限。必填。

以秒為單位的時間長度，最多 9 個小數位數，結尾為「s」。示例："3.5s"。
termsAndConditionsUrl

string

合作夥伴與這項訂閱方案相關的條款及細則網址。

條款

[START terms_definition]

JSON 表示法 
{
  "url": string,
  "restrictedToCertainUsers": boolean,
  "termsAndConditions": string,
  "additionalTermsAndConditions": [
    string
  ]
}
欄位
url

string

合作夥伴條款及細則的網址。
restrictedToCertainUsers

boolean

優惠是否僅限特定使用者。
termsAndConditions

string

合作夥伴提供的主要條款及細則文字。
additionalTermsAndConditions[]

string

合作夥伴主要條款及細則以外的條款及細則。