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] Next ID: 5

فیلدها
unit

FeeUnit

type

FeeType

فیلد اتحادیه cost.

cost فقط می‌تواند یکی از موارد زیر باشد:

amount

Money

amount_range

MoneyRange

FeeType

[START fee_type_definition]

شمارشی‌ها
FEE_TYPE_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

فهرستی از همه مبالغ مجزای دردسترس (مثلاً [۱۰۰، ۵۰۰، ۱۰۰۰]).

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 مقدار شمارشی «نامشخص» یا پیش‌فرض نباید در فیدها استفاده شود.
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] برچسب بعدی: ۲۶

فیلدها
offer_id

string

شناسه یکتای پیشنهاد ویژه. الزامی.

entity_ids[]

string

فهرست فروشندگانی که در این پیشنهاد ویژه شرکت می‌کنند.

add_on_offer_applicable_to_all_entities

bool

اگر درست باشد، این پیشنهاد برای همه نهادهای تحت تجمیع‌کننده قابل‌اعمال است. فقط برای پیشنهادهای ویژه برافزایی قابل‌اعمال است.

offer_source

OfferSource

پیشنهاد ویژه می‌تواند توسط تجمیع‌کننده، فروشنده شخصی، یا حتی طرف سوم به‌عنوان افزونه ارائه شود. الزامی.

action_type

ActionType

سرویسی که پیشنهاد را ارائه می‌دهد. یک offer_id فقط می‌تواند به یک action_type تعلق داشته باشد. اگر یک پیشنهاد ویژه را بتوان در چندین نوع خدمات هم‌رسانی کرد، انتظار می‌رود پیشنهادهای ویژه تکراری با شناسه‌های یکتا برای هر نوع خدمات ایجاد شود. الزامی.

offer_modes[]

OfferMode

روش‌هایی که می‌توان از پیشنهاد ویژه استفاده کرد - مراجعه حضوری، رزرو، آنلاین، و غیره. الزامی است.

offer_category

OfferCategory

دسته پیشنهاد ویژه. الزامی.

source_assigned_priority

int32

عدد صحیح غیرمنفی ([۱-۱۰۰]، که در آن ۱ نشان‌دهنده بالاترین اولویت است) که نشان‌دهنده سطح اولویت پیشنهاد ویژه اختصاص‌داده‌شده توسط منبع است. وقتی چند پیشنهاد ویژه برای یک فروشنده دردسترس باشد، این نشانه‌ای برای رتبه‌بندی پیشنهادهای ویژه خواهد بود. 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] دسته پیشنهاد. پیشنهاد پایه یک پیشنهاد استاندارد است که برای همه مشتریان دردسترس است، مثلاً ۱۰٪ تخفیف برای صرف بیش‌از ۱۰۰ دلار. پیشنهاد پایه محدودشده با کد تخفیف یا ابزار پرداخت، فیلدهای مربوطه را تنظیم خواهد کرد. همچنین پیشنهادهای افزودنی x مانند ADD_ON_PAYMENT_OFFER داریم. این پیشنهادهای ویژه را می‌توان به پیشنهادهای ویژه دیگر اضافه کرد تا تخفیف‌های بیشتری دریافت کنید.

شمارشی‌ها
OFFER_CATEGORY_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

حداکثر تخفیفی که می‌توانید دریافت کنید. برای مثال، ۱۰٪ تخفیف تا سقف ۱۰۰ دلار.

min_spend_value

Money

حداقل میزان هزینه برای استفاده از تخفیف. برای مثال، ۱۰٪ تخفیف وقتی قیمت کل ۱۰۰ دلار یا بیشتر باشد.

booking_cost

Money

هزینه رزرو این پیشنهاد. برای مثال، ۱۰۰ دلار تخفیف روی صورت‌حساب نهایی درصورتی‌که میز با پرداخت ۱۵ دلار رزرو شود.

booking_cost_unit

FeeUnit

واحد هزینه رزرو. برای مثال، برای هر نفر، برای هر تراکنش.

convenience_fee

Fee

booking_cost_adjustable

bool

آیا هزینه رزرو قابل‌تنظیم است، یعنی هزینه رزرو از صورت‌حساب نهایی کسر می‌شود. برای مثال: ‎٪۳۰ تخفیف برای شام با رزرو. هزینه رزرو ۱۵ دلار است و به صورت‌حساب نهایی اضافه خواهد شد. بنابراین صورت‌حساب نهایی: کل هزینه - ‎٪۳۰ - ۱۵ دلار

additional_fees[]

AdditionalFee

کارمزدهای اضافی که از کاربر دریافت می‌شود. مثال‌ها: راحتی، جابه‌جایی، ارسال، بسته‌بندی، کارمزد خدمات، و غیره.

gift_card_info

GiftCardInfo

جزئیات مربوط به معامله‌های کارت هدیه.

فیلد اتحادیه offer_specification. تخفیف می‌تواند به‌صورت درصد یا مقدار ثابتی باشد که از مقدار کل کسر می‌شود. برای مثال: ۱. ‫٪۱۰ تخفیف روی صورت‌حساب نهایی. ۲. ‫۱۵ دلار تخفیف برای سفارش. فروشندگان همچنین می‌توانند ازطریق فیلدهای مشخصه مربوطه، تخفیف‌های سفارشی مثل «یکی بخر، یکی رایگان ببر» ارائه دهند. الزامی. offer_specification فقط می‌تواند یکی از موارد زیر باشد:
discount_percent

float

درصدی از صورت‌حساب که تخفیف داده می‌شود. [0, 100] برای پیشنهادهای ویژه «یکی بخر، یکی رایگان بگیر» یا ۵۰٪ تخفیف که برای کل وعده غذایی اعمال می‌شود (مثلاً بوفه «یکی بخر، یکی رایگان بگیر»، «یکی بخر، یکی رایگان بگیر» برای کل صورت‌حساب، «یکی بخر، یکی رایگان بگیر» برای منو ثابت)، این مقدار را می‌توان روی ۵۰ تنظیم کرد.

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] Next tag: 11

فیلدها
combinable_with_other_offers

bool

آیا این پیشنهاد ویژه را می‌توان با پیشنهادهای ویژه دیگر ترکیب کرد. وقتی مقدار true باشد، شرکا می‌توانند مشخص کنند این پیشنهاد با چه پیشنهادهایی می‌تواند ترکیب شود. اگر هر دو combinable_offer_categories و combinable_offer_ids تنظیم شده باشند، هر پیشنهاد ویژه‌ای که با یکی از شرایط بالا مطابقت داشته باشد قابل‌ترکیب خواهد بود.

combinable_offer_categories[]

OfferCategory

فهرست انواع پیشنهادهای ویژه‌ای که این پیشنهاد ویژه می‌تواند با آن‌ها ترکیب شود. برای مثال، این پیشنهاد ویژه ممکن است با «کوپن‌های» دیگر ترکیب شود. اگر combinable_with_other_offers درست باشد و این فیلد تنظیم نشده باشد، همه انواع قابل ترکیب خواهند بود.

combinable_offer_ids[]

string

فهرست offer_ids که این پیشنهاد ویژه می‌تواند با آن‌ها ترکیب شود. برخی‌از پیشنهادهای ویژه ممکن است فقط با برخی‌از شناسه_پیشنهادهای ویژه خاص دیگر ترکیب شوند (می‌توان آن‌ها را پیشنهادهای ویژه اصلی درنظر گرفت). اگر combinable_with_other_offers درست باشد و این فیلد تنظیم نشده باشد، همه شناسه‌های پیشنهاد ویژه قابل ترکیب خواهند بود.

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 مقدار شمارشی «نامشخص» یا پیش‌فرض نباید در فیدها استفاده شود.
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 مقدار شمارشی «نامشخص» یا پیش‌فرض نباید در فیدها استفاده شود.
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

شرایط خدمات علاوه‌بر شرایط خدمات اصلی ازسوی شریک.