Package madden.ingestion.offer

索引

ActionType

[START action_type_definition] 表示优惠的履单模式。如果某项优惠可跨多种履单模式共享,则应为每种履单模式创建重复的优惠。

枚举
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] 下一个 ID:5

字段
unit

FeeUnit

type

FeeType

联合字段 cost。

cost 只能是下列其中一项:

amount

Money

amount_range

MoneyRange

FeeType

[START fee_type_definition]

枚举
FEE_TYPE_UNSPECIFIED 不应在 Feed 中使用 UNSPECIFIED 或默认枚举值。
FEE_TYPE_FIXED
FEE_TYPE_VARIABLE

FeeUnit

[START fee_unit_definition]

枚举
FEE_UNIT_UNSPECIFIED 不应在 Feed 中使用 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 不应在 Feed 中使用 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 不应在 Feed 中使用 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] Next tag: 15

字段
offer_display_text

string

优惠提供商希望在搜索结果页上向客户展示的优惠文字。必填。

max_discount_value

Money

可享受的最高折扣。例如,九折优惠,最高可享 100 美元优惠。

min_spend_value

Money

享受折扣所需的支出下限。例如,总价达到 100 美元或以上时可享受 10% 的折扣。

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 不应在 Feed 中使用 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 不应在 Feed 中使用 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

除了合作伙伴的主要条款及条件之外的其他条款及条件。