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 フィードでは、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

[ギフトカード情報の定義の開始]

フィールド

共用体フィールド 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] 次のタグ: 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 は 1 つの 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

販売者の特典ページの URL。offer_category: OFFER_CATEGORY_BASE_OFFER の場合は必須です。

image_url

string

販売者の特典の画像への URL。

tags[]

OfferTag

特典に関連付けられた特別なタグ。「お祭り」、「高評価」、「予約数が多い」などの特別オファーを特定するために使用されます。

brand_id

string

ギフトカードの特典で、特典を提供するブランドを特定するために必要です。

OfferCategory

[START offer_category_definition] オファーのカテゴリ。基本特典とは、100 ドル以上の購入で 10% 割引など、すべてのお客様が利用できる標準的な特典です。クーポンまたは支払い方法によって制限されているベースオファーには、それぞれのフィールドが設定されます。また、ADD_ON_PAYMENT_OFFER などのアドオン x オファーもあります。このようなオファーは、他のオファーに追加して、追加の割引を受けることができます。

列挙型
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

利用できる最大割引額。例: 10% 割引(最大 100 ドル)。

min_spend_value

Money

割引を利用するための最低購入金額。たとえば、合計金額が 10, 000 円以上の場合は 10% 割引など。

booking_cost

Money

この特典の予約費用。たとえば、テーブルを $15 で予約すると、最終請求額から $100 割引されます。

booking_cost_unit

FeeUnit

予約費用の単位。(1 人あたり、1 回の取引あたりなど)。

convenience_fee

Fee

booking_cost_adjustable

bool

予約費用が調整可能かどうか(予約費用が最終請求額から差し引かれるかどうか)。例: 予約でディナーが 30% オフ。予約料金は $15 で、最終請求額に適用されます。したがって、最終的な請求額は「合計費用 - 30% - $15」となります。

additional_fees[]

AdditionalFee

ユーザーに請求される追加料金。例: 利便性、手数料、配送、梱包、サービス料金など。

gift_card_info

GiftCardInfo

ギフトカードの特典に固有の詳細。

共用体フィールド offer_specification。割引は、総額から差し引かれる割合または固定値にすることができます。例: 1. 最終請求額が 10% オフになります。2. ご注文金額から $15 オフ。販売者は、関連する仕様フィールドで「1 つ買うと 1 つ無料」などのカスタム割引を提供することもできます。必須。offer_specification は次のいずれかになります。
discount_percent

float

請求額の割引率。[0, 100] 食事全体に適用される 1+1 または 50% オフの特典(1+1 ビュッフェ、1+1 の請求書全体、1+1 のセットメニューなど)の場合、この値は 50 に設定できます。

discount_value

Money

割引の固定値。

other_offer_detail_text

string

割引を説明するための自由形式のテキスト。特定の 1+1 オファー(1+1 ドリンク、+1 メインコース、1+1 選択メニューなど)については、ここに詳細を記載する必要があります。

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

この定期購入に関連するパートナーの利用規約の URL。

利用規約

[START terms_definition]

フィールド
url

string

パートナーの利用規約の URL。

restricted_to_certain_users

bool

特典が特定のユーザーに限定されているかどうか。

terms_and_conditions

string

パートナーから提供された主な利用規約のテキスト。

additional_terms_and_conditions[]

string

パートナーの主な利用規約に加えて適用される利用規約。