Package madden.ingestion.offer

אינדקס

ActionType

‫[START action_type_definition] מייצג את מצב המימוש של המבצע. אם אפשר לשתף מבצע בכמה מצבי מימוש, צריך ליצור עותקים של המבצע לכל מצב מימוש.

טיפוסים בני מנייה (enum)
ACTION_TYPE_UNSPECIFIED
ACTION_TYPE_FOOD_DELIVERY המבצע תקף לשירותי משלוחי מזון.
ACTION_TYPE_FOOD_TAKEOUT המבצע תקף להזמנות של אוכל באיסוף עצמי או ב-Take Away.
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]

טיפוסים בני מנייה (enum)
FEE_TYPE_UNSPECIFIED אין להשתמש בערך UNSPECIFIED או בערך ברירת המחדל של סוג הנתונים enum בפידים.
FEE_TYPE_FIXED
FEE_TYPE_VARIABLE

FeeUnit

[START fee_unit_definition]

טיפוסים בני מנייה (enum)
FEE_UNIT_UNSPECIFIED אין להשתמש בערך UNSPECIFIED או בערך ברירת המחדל של סוג הנתונים enum בפידים.
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]

טיפוסים בני מנייה (enum)
MEAL_TYPE_UNSPECIFIED אין להשתמש בערך UNSPECIFIED או בערך ברירת המחדל של סוג הנתונים enum בפידים.
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

המזהה הייחודי של המוצר. חובה.

entity_ids[]

string

רשימת המוכרים שמשתתפים במבצע הזה.

add_on_offer_applicable_to_all_entities

bool

אם הערך הוא true, המבצע הזה חל על כל הישויות שמשויכות למצטבר. המאפיין הזה רלוונטי רק למבצעים של חבילות ערוצים.

offer_source

OfferSource

יכול להיות שהמבצע יסופק על ידי האתר המאגד, על ידי מוכר ספציפי או אפילו על ידי צד שלישי כתוסף. חובה.

action_type

ActionType

השירות שמספק את המבצע. מזהה המבצע יכול להשתייך רק לסוג פעולה אחד. אם אפשר לשתף מבצע בכמה סוגי שירותים, המערכת צפויה ליצור עותקים של המבצע עם מזהים ייחודיים לכל סוג שירות. חובה.

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_BASE_OFFER.

image_url

string

כתובת ה-URL של תמונת המבצע של המוכר.

tags[]

OfferTag

תגים מיוחדים שמשויכים למבצע. המאפיין הזה משמש לזיהוי מבצעים מיוחדים כמו 'חגיגי', 'מומלץ', 'הזמנות רבות' וכו'.

brand_id

string

חובה להוסיף את הלוגו של המותג כדי לזהות את המותג שמציע את המבצע על כרטיס המתנה.

OfferCategory

‫[START offer_category_definition] קטגוריית המבצע. מבצע בסיסי הוא מבצע רגיל שזמין לכל הלקוחות, כמו 10% הנחה על הוצאה של מעל 100$. אם מבצע בסיסי מוגבל על ידי שובר או אמצעי תשלום, השדות הרלוונטיים יוגדרו. יש לנו גם מבצעים של חבילות ערוצים, כמו ADD_ON_PAYMENT_OFFER. אפשר להוסיף מבצעים כאלה למבצעים אחרים כדי לקבל הנחות נוספות.

טיפוסים בני מנייה (enum)
OFFER_CATEGORY_UNSPECIFIED אין להשתמש בערך UNSPECIFIED או בערך ברירת המחדל של סוג הנתונים enum בפידים.
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% הנחה כשמחיר הקנייה הכולל הוא 100 $או יותר.

booking_cost

Money

העלות של הזמנת המבצע הזה. לדוגמה, הנחה של 100$ מהחשבון הסופי כשמזמינים שולחן בעלות של 15$.

booking_cost_unit

FeeUnit

יחידת העלות של ההזמנה. לדוגמה, לכל אדם, לכל עסקה.

convenience_fee

Fee

booking_cost_adjustable

bool

האם אפשר לשנות את עלות ההזמנה, כלומר, האם עלות ההזמנה מופחתת מהחשבון הסופי. לדוגמה: 30% הנחה על ארוחת ערב בהזמנה מראש. העלות של ההזמנה היא 15 $והיא תנוכה מהחיוב הסופי. לכן החיוב הסופי הוא: סכום ההוצאה הכולל פחות 30% פחות 15$‎

additional_fees[]

AdditionalFee

עמלות נוספות שחלות על המשתמש. דוגמאות: עמלת נוחות, דמי טיפול, משלוח, אריזה, דמי שירות וכו'.

gift_card_info

GiftCardInfo

פרטים ספציפיים לגבי מבצעים על כרטיסי מתנה.

שדה איחוד offer_specification. ההנחה יכולה להיות באחוזים או ערך קבוע שמופחת מהערך הכולל. לדוגמה: 1. הנחה של 10% על החשבון הסופי. 2. ‫15$ הנחה על הזמנה. מוֹכרים יכולים גם להציע הנחות מותאמות אישית כמו 'קונים אחד ומקבלים אחד במתנה' באמצעות שדות המפרט הרלוונטיים. חובה. הערך offer_specification יכול להיות רק אחד מהבאים:
discount_percent

float

אחוז ההנחה בחשבון. ‫[0, 100] במבצעים של 1+1 או 50% הנחה שחלים על כל הארוחה (למשל, מזנון 1+1, הנחה של 50% על כל החשבון, 1+1 על תפריט קבוע), אפשר להגדיר את הערך הזה כ-50.

discount_value

Money

ערך קבוע של ההנחה.

other_offer_detail_text

string

טקסט חופשי שמתאר את ההנחה. אם מציעים מבצעים ספציפיים של 1+1 (למשל: משקה אחד ועוד אחד, מנה עיקרית אחת ועוד אחת, פריט אחד ועוד אחד בתפריט נבחר), צריך לציין את הפרטים האלה כאן.

OfferMode

[START offer_mode_definition] מציין את השיטה או הערוץ שדרכם המשתמש יכול לממש את המבצע.

טיפוסים בני מנייה (enum)
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

רשימה של מזהי מבצעים שאפשר לשלב עם המבצע הזה. יכול להיות שמבצעים מסוימים ניתנים לשילוב רק עם מזהי מבצעים ספציפיים אחרים (אפשר להתייחס אליהם כמבצעים ראשיים). אם הערך של combinable_with_other_offers הוא true והשדה הזה לא מוגדר, אפשר לשלב את כל מזהי המבצעים.

inclusions[]

OfferCondition

רשימת התנאים שצריך לעמוד בהם כדי שהמבצע יהיה תקף (למשל, משקאות לא אלכוהוליים, אוכל).

exclusions[]

OfferCondition

רשימת התנאים שבעקבותיהם המבצע לא תקף (למשל, בופה, מבצעים על ארוחות משולבות וקוקטיילים).

min_guest

int32

מספר האנשים המינימלי שנדרש למימוש המבצע.

food_offer_restrictions

FoodOfferRestrictions

הגבלות ספציפיות למבצעים על אוכל.

special_conditions[]

string

תנאים מיוחדים של המבצע שחובה להציג למשתמש. דוגמאות: 'השובר תקף רק לתשלום ב[אזור]', 'לא כולל תשלומים באינטרנט'

OfferSource

[START offer_source_definition]

טיפוסים בני מנייה (enum)
OFFER_SOURCE_UNSPECIFIED
OFFER_SOURCE_AGGREGATOR

OfferTag

[START offer_tag_definition]

טיפוסים בני מנייה (enum)
OFFER_TAG_UNSPECIFIED אין להשתמש בערך UNSPECIFIED או בערך ברירת המחדל של סוג הנתונים enum בפידים.
OFFER_TAG_NEW_YEAR_SPECIAL
OFFER_TAG_VALENTINES_SPECIAL

PaymentInstrument

[START payment_instrument_definition]

שדות
items[]

PaymentInstrumentItem

רשימה של אמצעי תשלום שאפשר להשתמש בהם כדי לממש את המבצע. חובה.

provider_name

string

השם של ספק אמצעי התשלום. יכול להיות שם של שותף בנקאי, שם של בנק וכו'. לדוגמה: אמריקן אקספרס,‏ HDFC,‏ ICICI.

PaymentInstrumentItem

[START payment_instrument_item_definition]

שדות
type

PaymentInstrumentType

סוג אמצעי התשלום. חובה.

name

string

שם פריט אמצעי התשלום, כמו שם כרטיס האשראי. לדוגמה: HDFC Infinia, ‏ אמריקן אקספרס Platinum. חובה.

PaymentInstrumentType

[START payment_instrument_type_definition]

טיפוסים בני מנייה (enum)
PAYMENT_INSTRUMENT_TYPE_UNSPECIFIED אין להשתמש בערך UNSPECIFIED או בערך ברירת המחדל של סוג הנתונים enum בפידים.
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

תנאים והגבלות בנוסף לתנאים ולהגבלות העיקריים של השותף.