Package madden.ingestion.offer

索引

ActionType

[START action_type_definition] Represents the fulfillment mode of the offer. 如果某項商品可透過多種運送方式提供，則應為每種運送方式建立重複的商品。

列舉
ACTION_TYPE_UNSPECIFIED
ACTION_TYPE_FOOD_DELIVERY 這項優惠適用於餐點外送服務。
ACTION_TYPE_FOOD_TAKEOUT 這項優惠適用於外帶或自取餐點訂單。
ACTION_TYPE_DINING 這項優惠適用於餐廳的現場用餐服務。
ACTION_TYPE_SHOPPING_IN_STORE 這項優惠適用於實體店面購物。

AdditionalFee

[START additional_fee_definition]

欄位
name

string

額外費用的名稱。例如手續費、處理費等。必填。
fee

Fee

優惠券

[START coupon_definition]

欄位
text

string

優惠供應商想向使用者顯示的優待券文字。
code

string

須有優惠碼才能兌換優惠。必填。

費用

[START fee_definition] Next ID: 5

欄位
unit

FeeUnit
type

FeeType

聯集欄位 cost。

cost 只能是下列其中一項：
amount

Money
amount_range

MoneyRange

FeeType

[START fee_type_definition]

列舉
FEE_TYPE_UNSPECIFIED 請勿在動態饋給中使用 UNSPECIFIED 或預設列舉值。
FEE_TYPE_FIXED
FEE_TYPE_VARIABLE

FeeUnit

[START fee_unit_definition]

列舉
FEE_UNIT_UNSPECIFIED 請勿在動態饋給中使用 UNSPECIFIED 或預設列舉值。
FEE_UNIT_PER_GUEST
FEE_UNIT_PER_TRANSACTION

FixedDenominations

欄位
amounts[]

Money

所有可用的離散面額清單 (例如 [100, 500, 1000])。

FoodOfferRestrictions

[START food_offer_restrictions_definition]

欄位
meal_types[]

MealType

可套用優惠的餐點類型，例如午餐或晚餐。如未設定，優惠可套用至所有餐點類型。
restricted_to_certain_courses

bool

優惠是否僅適用於特定課程。

GiftCardInfo

[START gift_card_info_definition]

欄位

聯集欄位 denomination_type。

denomination_type 只能是下列其中一項：
fixed_denominations

FixedDenominations

禮物卡提供特定固定金額時使用。
custom_range

MoneyRange

如果品牌允許使用者在定義的範圍內選擇自訂 (彈性) 票面值，就會使用這個值。

MealType

[START meal_type_definition]

列舉
MEAL_TYPE_UNSPECIFIED 請勿在動態饋給中使用 UNSPECIFIED 或預設列舉值。
MEAL_TYPE_BREAKFAST
MEAL_TYPE_LUNCH
MEAL_TYPE_DINNER

MoneyRange

[START money_range_definition]

欄位
min_amount

Money
max_amount

Money

優惠

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

欄位
offer_id

string

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

string

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

bool

如果為 true，這項優惠適用於匯總器下的所有實體。僅適用於加購優惠。
offer_source

OfferSource

優惠可能由集結網站、個別商家提供，甚至由第三方以加購形式提供。必填。
action_type

ActionType

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

OfferMode

提供優惠的方式，例如親自前往、預約、線上等。必填。
offer_category

OfferCategory

優惠類別。必填。
source_assigned_priority

int32

非負整數 ([1-100]，其中 1 代表最高優先順序)，表示來源指派的方案優先順序。如果同一商家提供多項方案，這會成為方案排序的信號。0 代表未設定優先順序。
offer_details

OfferDetails

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

OfferRestrictions

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

Coupon

優惠券詳細資料。如果 offer_category 為 OFFER_CATEGORY_ADD_ON_COUPON_OFFER，則為必填欄位。
payment_instrument

PaymentInstrument

付款方式的詳細資料。如果 offer_category 為 OFFER_CATEGORY_ADD_ON_PAYMENT_OFFER，則為必填欄位。
subscription

Subscription

訂閱方案詳細資料。如果 offer_category 為 OFFER_CATEGORY_ADD_ON_SUBSCRIPTION_OFFER，則為必填欄位。
terms

Terms

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

ValidityPeriod

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

string

商家優惠頁面的網址。如果 offer_category 為 OFFER_CATEGORY_BASE_OFFER，則為必填欄位。
image_url

string

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

OfferTag

與優惠相關的特殊標記。用於識別「節慶」、「評價最高」、「預訂次數最多」等特別優惠。
brand_id

string

禮物卡交易必須提供這項資訊，才能識別提供交易的品牌。

OfferCategory

[START offer_category_definition] 方案類別。基底優惠是所有顧客都能使用的標準優惠，例如消費滿 $100 美元可享 9 折優惠。如果基本方案受到優待券或付款方式限制，系統會設定相應的欄位。我們也有加購 x 優惠，例如 ADD_ON_PAYMENT_OFFER。這類優惠可與其他優惠合併使用，以獲得額外折扣。

列舉
OFFER_CATEGORY_UNSPECIFIED 請勿在動態饋給中使用 UNSPECIFIED 或預設列舉值。
OFFER_CATEGORY_BASE_OFFER
OFFER_CATEGORY_ADD_ON_PAYMENT_OFFER
OFFER_CATEGORY_ADD_ON_COUPON_OFFER
OFFER_CATEGORY_ADD_ON_SUBSCRIPTION_OFFER

OfferCondition

[START offer_condition_definition]

欄位
description

string

OfferDetails

[START offer_details_definition] 下一個標記：15

欄位
offer_display_text

string

供應商希望在搜尋結果網頁上向消費者顯示的優惠文字。必填。
max_discount_value

Money

可享有的最高折扣。例如：最高可享 $100 美元的 9 折優惠。
min_spend_value

Money

享有折扣的最低消費金額。例如：總價滿 $100 美元可享 9 折優惠。
booking_cost

Money

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

FeeUnit

預訂費用的單位。例如每人每筆交易。
convenience_fee

Fee
booking_cost_adjustable

bool

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

AdditionalFee

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

GiftCardInfo

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

float

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

Money

折扣的固定值。
other_offer_detail_text

string

你可以自由輸入文字，說明折扣。如果是特定買一送一優惠 (例如買一送一飲料、加購主餐、買一送一指定菜單項目)，請在此處說明這些詳細資料。

OfferMode

[START offer_mode_definition] 指定使用者可透過哪種方法或管道兌換優惠。

列舉
OFFER_MODE_OTHER 適用於其他特定模式未涵蓋的運送方式。
OFFER_MODE_WALK_IN 這項優惠適用於現場參觀，無須事先預約。
OFFER_MODE_FREE_RESERVATION 使用者預訂時不需預付費用，即可享有這項優惠。
OFFER_MODE_PAID_RESERVATION 使用者預訂時必須先付款，才能享有優惠。
OFFER_MODE_ONLINE_ORDER 透過網站或數位平台下單即符合優惠資格。
OFFER_MODE_GIFT_CARD_PURCHASE 表示購買禮物卡是取得優惠的主要必要步驟。

OfferRestrictions

[START offer_restrictions_definition] 下一個標記：11

欄位
combinable_with_other_offers

bool

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

OfferCategory

這項優惠可與哪些類型的優惠合併使用。舉例來說，這項優惠可能可與其他優待券併用。如果 combinable_with_other_offers 為 true，且這個欄位未設定，則所有類型皆可合併。
combinable_offer_ids[]

string

這項優惠可與哪些 offer_id 合用。部分優惠可能只能與特定其他 offer_id (可視為父項優惠) 併用。如果 combinable_with_other_offers 為 true，且這個欄位未設定，則所有優惠 ID 皆可合併使用。
inclusions[]

OfferCondition

優惠生效的條件清單 (例如無酒精飲料、食物)。
exclusions[]

OfferCondition

會使優惠失效的條件清單 (例如自助餐、套餐優惠和雞尾酒)。
min_guest

int32

使用優惠的人數下限。
food_offer_restrictions

FoodOfferRestrictions

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

string

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

OfferSource

[START offer_source_definition]

列舉
OFFER_SOURCE_UNSPECIFIED
OFFER_SOURCE_AGGREGATOR

OfferTag

[START offer_tag_definition]

列舉
OFFER_TAG_UNSPECIFIED 請勿在動態饋給中使用 UNSPECIFIED 或預設列舉值。
OFFER_TAG_NEW_YEAR_SPECIAL
OFFER_TAG_VALENTINES_SPECIAL

PaymentInstrument

[START payment_instrument_definition]

欄位
items[]

PaymentInstrumentItem

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

string

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

PaymentInstrumentItem

[START payment_instrument_item_definition]

欄位
type

PaymentInstrumentType

付款方式類型。必填。
name

string

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

PaymentInstrumentType

[START payment_instrument_type_definition]

列舉
PAYMENT_INSTRUMENT_TYPE_UNSPECIFIED 請勿在動態饋給中使用 UNSPECIFIED 或預設列舉值。
PAYMENT_INSTRUMENT_CREDIT_CARD
PAYMENT_INSTRUMENT_DEBIT_CARD
PAYMENT_INSTRUMENT_BANK_ACCOUNT
PAYMENT_INSTRUMENT_UPI
PAYMENT_INSTRUMENT_ONLINE_WALLET
PAYMENT_INSTRUMENT_NETBANKING

訂閱

[START subscription_definition]

欄位
name

string

訂閱方案名稱。必填。
subscription_auto_added

bool

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

Money

訂閱費用。必填。
subscription_duration

Duration

訂閱方案在 subscription_cost 的效期。必填。
terms_and_conditions_url

string

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

條款

[START terms_definition]

欄位
url

string

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

bool

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

string

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

string

除了合作夥伴的主要條款及細則外，還須遵守其他條款及細則。