סכימת מלאי רלציונית

בדף הזה מתוארים הפורמטים של פידים של נתונים מקצה לקצה של הזמנות (מפרט של קטלוג מזון) שאתם מספקים ל-Google. אם אתם צריכים גרסה של המידע הזה לקריאה למחשבים, אתם יכולים להוריד את סכימת ה-JSON.

דרישות כלליות

יש להציג את הישויות כך שכל ישות תופיע בשורה נפרדת בפיד (הישויות מופרדות באמצעות תווים של ירידת שורה). מטעמי קריאוּת, דוגמאות ה-JSON בדף הזה לא עומדות במבנה הזה. עם זאת, עליכם לפעול לפי המבנה הזה כשאתם שולחים את הפיד. לדוגמה, יש לבנות ישות תפריט לפי הקוד הבא: 

{"@type": "Menu","name": "Coffee Shop A","@id": "1535"}

לכל ישות מסוג 'מסעדה' יכולות להיות שתי ישויות מסוג 'שירות' (אחת לכל אחד מסוגי השירותים 'משלוח' ו'טייק אווי'). לכל ישות 'שירות' יכולה להיות רק ישות 'תפריט' אחת.

אפשר לעשות שימוש חוזר בישויות משנה בכמה מסעדות.

הנחיות לגבי ערכי JSON

כפייה של סוג

סוג של ערך JSON יכול להיות שונה מהסוג שמוגדר בסכימה, כל עוד אפשר לאלץ את הערך להפוך לסוג הנדרש. לדוגמה, מאפייני מחרוזת יכולים לקבל כקלט גם ערכי מחרוזות וגם ערכים של מספרים שלמים. באופן דומה, מאפייני מספרים שלמים יכולים לקבל ערך מחרוזת כל עוד אפשר לנתח את המחרוזת למספר שלם תקין.

אפשרות האילוץ של סוגים פועלת גם במאפיינים חוזרים. נכסים חוזרים יכולים לקבל ערכים כקלט בלי שתצטרכו להקיף אותם בסוגריים מרובעים []. לדוגמה, המאפיין OperationHours.serviceId מקבל גם את הערך "service_id" וגם את הערך ["service_id"] כקלט תקין.

ערכים של DateTime ו-Time

השדה DateTime מבוסס על הסוג schema.org, אלא אם צוין אחרת. הוא חייב להיות בפורמט ISO 8601 ולכלול את התאריך, השעה ואזור הזמן. צריך להשתמש בתחביר הבא עבור DateTime:

// DateTime format:
YYYY-MM-DDTHH:MM:SS[∓HH:MM|Z]

לדוגמה:

2017-05-01T06:30:00-07:00 // UTC minus 7 hours
2017-05-01T06:30:00Z  // UTC time zone. The optional "Z" suffix represents the UTC time zone.

Time הוא השעה המקומית באזור הזמן של מסעדה או שירות במיקום מסוים, וגם הוא מבוסס על הסוג של schema.org והוא צריך גם להיות בפורמט ISO 8601. התחביר של זמן הוא:

// Time format:
THH:MM:SS

לדוגמה:

T08:08:00 // 8:08 AM

חשוב לשים לב לנקודות הבאות בכל פעם שמציינים DateTime או Time:

  • הקידומת 'T' לפני השעה היא חלק מהפורמט והיא חובה.
  • יש לציין את אזור הזמן עבור DATETIME. לא נדרש עבור TIME.
  • צריך לציין את השעה לפי השעון המקומי של המסעדה או השירות.

נתוני מסעדות

מסעדה (חובה)

ישות נדרשת להטמעה. תיאור של מסעדה.

בטבלה הבאה מפורטים המאפיינים של הסוג Restaurant:

נכס סוג תיאור
@type Const

חובה.

ערך: Restaurant
@id String

חובה.

מזהה ייחודי של המסעדה או ספק המשלוח.

לדוגמה: restaurant_1
name String

חובה.

שם המסעדה.

לדוגמה: Foo
description String

תיאור של המסעדה.

לדוגמה: Best seafood in town
url Url

כתובת ה-URL שמייצגת את המסעדה. הדומיין של המסעדה מועדף על פני הדומיין של המאגר.

לדוגמה: http://www.provider.com/somerestaurant
sameAs Url

האתר הרשמי של המסעדה.

לדוגמה: http://www.provider2.com/somerestaurant
telephone String

מספר הטלפון של המסעדה.

לדוגמה: +12345665898
streetAddress String

חובה.

כתובת הרחוב של המסעדה.

לדוגמה: 12345 Bar Avenu
addressLocality String

חובה.

הרשות המוניציפאלית או העיר.

לדוגמה: San Francisco
addressRegion String

חובה.

האזור או המדינה.

לדוגמה: CA
postalCode String

חובה.

המיקוד.

לדוגמה: 94124
addressCountry String

חובה.

קוד מדינה בן שתי אותיות לפי תקן ISO 3166-1 alpha-2.

לדוגמה: US
latitude מספר

קו הרוחב במעלות. הערכים מוגבלים לטווח [[-90, 90]]. רמת הדיוק צריכה להיות לפחות 5 ספרות אחרי הנקודה העשרונית.

לדוגמה: 35.7392607
longitude מספר

קו האורך במעלות. הערכים מוגבלים לטווח [[-180, 180]]. הדיוק צריך להיות לפחות 5 ספרות אחרי הנקודה העשרונית.

לדוגמה: -120.3895522
dealId List<String>

Deal רלוונטיים מהמסעדה.
imprint String

חותמת המסעדה היא קטע של מידע נוסף על המסעדה, כמו השם החוקי, הכתובת הרשמית ומספר הרישום. ניתן לעצב את המידע הזה באמצעות " ".

לדוגמה: 

Three Brothers Tacos
123 FooSt
Mountain View
CA 94041, United States
email: contact@threebrotherstacos.com

Commercial Register: 123456789
economicOperator String

מידע על המפעיל הכלכלי המשויך למסעדה, אם רלוונטי. המידע הזה יוצג בקטע 'פרטי העסק'. אפשר לעצב טקסט באמצעות " ".

לדוגמה: 

XYZ Corp
123 Main Street
555-555-5555
dateModified חותמת זמן של ISO

התאריך והשעה של השינוי האחרון בפיד הישות של המסעדה בפורמט חותמת זמן לפי תקן ISO, אבל עם סוג String.

לדוגמה: 2017-01-02T00:00:00-07:00

בדוגמה הבאה מוצג רכיב Restaurant:

דוגמה

{
  "@type": "Restaurant",
  "@id": "10824",
  "name": "Pronto Wood Fired Pizzeria",
  "url": "https://www.provider.com/pronto-wood-fired-pizzeria",
  "telephone": "+16503659978",
  "streetAddress": "2560 El Camino Real",
  "addressLocality": "Palo Alto",
  "addressRegion": "CA",
  "postalCode": "94061",
  "addressCountry": "US",
  "latitude": 37.472842,
  "longitude": -122.217144
}

מבצע

סוגי ההנחות שאפשר להחיל על עגלת קניות.

בטבלה הבאה מפורטים המאפיינים של הסוג Deal:

נכס סוג תיאור
@type Const

חובה.

ערך: Deal
@id String

חובה.

מזהה ייחודי של העסקה.

לדוגמה: FREEDELIVERY
dealCode String

חובה.

מזהה עסקה ייחודי לכל עסקה לכל שותף. המזהה הזה צריך לזהות באופן ייחודי את המבצע במערכת שלכם לקידום מכירות. Google שולחת לכם את המזהה הזה בשדה promotions.coupon של CheckoutRequest לצורך אימות.

לדוגמה: ADETRE23
applicableServiceType List<ServiceType>

השירות שאליו חלה המבצע. כברירת מחדל, ההנחה חלה על כולם.
eligibleMaxOrders Integer

המבצע הזה זמין רק אם למשתמש יש פחות מ-10 הזמנות שהושלמו בעבר או אם יש לו 10 הזמנות שהושלמו בעבר.
availabilityId List<String>

ערכי ה-@ של ישויות זמינות שמספקים פרטים על הזמנים שבהם הקטע בתפריט זמין.

לדוגמה: [ "availability_1" ]
isDisabled בוליאני

ההגדרה הזו מבטלת בדיקות תקינות אחרות.
dealType DealType

חובה.

קטגוריית המבצע שעליו רוצים להחיל את ההנחה. הקטגוריה יכולה להיות הסכום הכולל של עגלת הקניות, עמלות שירות או דמי משלוח.
priceCurrency String

חובה כאשר discount is defined.

חובה כאשר eligibleTransactionVolumeMin is defined.

המטבע (בפורמט ISO 4217 בן 3 אותיות) של ההנחה.

לדוגמה: USD
eligibleTransactionVolumeMin מספר

נפח העסקאות, ביחידה כספית, שעבורה המבצע הזה תקף.
termsOfServiceUrl Url

חובה.

מסמכי תנאים והגבלות שקריאים לבני אדם.
dateModified חותמת זמן של ISO

התאריך והשעה של השינוי האחרון בפיד של ישות העסקה בפורמט חותמת זמן של ISO, אבל עם סוג String.

לדוגמה: 2017-01-02T00:00:00-07:00
צריך לציין בדיוק אחת מהקבוצות הבאות של מאפיינים.
discount קבוצה 1 מספר

הערך של ההנחה כמספר.
discountPercentage קבוצה 2 מספר

ערך ההנחה כאחוז מהמחיר המקורי.

בדוגמה הבאה מוצג רכיב Deal:

דוגמה 1

{
  "@type": "Deal",
  "@id": "ONEDOLLARFEE",
  "dealCode": "THREEDOLLARFEE",
  "dealType": "CART_OFF",
  "availabilityId": [
    "availability_may2020"
  ],
  "termsOfServiceUrl": "http://www.provider.com/onedollardeal",
  "applicableServiceType": [
    "TAKEOUT"
  ],
  "discount": 3,
  "priceCurrency": "USD"
}

דוגמה 2

{
  "@type": "Deal",
  "@id": "10PERCOFF",
  "dealCode": "10PERCOFF",
  "dealType": "CART_OFF",
  "availabilityId": [
    "availability_weekdays_evening"
  ],
  "termsOfServiceUrl": "http://www.provider.com/deal",
  "discountPercentage": 10,
  "priceCurrency": "USD"
}

דוגמה 3

{
  "@type": "Deal",
  "@id": "FREEDELIVERY",
  "dealCode": "FREEDELIVERY",
  "dealType": "DELIVERY_OFF",
  "availabilityId": [
    "availability_may"
  ],
  "applicableServiceType": [
    "DELIVERY"
  ],
  "termsOfServiceUrl": "http://www.provider.com/free_delivery_deal",
  "discountPercentage": 100,
  "eligibleTransactionVolumeMin": 25,
  "priceCurrency": "USD"
}

נתוני השירות

שירות (חובה)

תיאור פרטי שירות הזמנת אוכל עבור מסעדה. Service היא ישות חובה להטמעה.

בטבלה הבאה מפורטים המאפיינים של הסוג Service:

נכס סוג תיאור
@type Const

חובה.

ערך: Service
@id String

חובה.

המזהה של שירות המילוי.

לדוגמה: service_1
serviceType ServiceType

חובה.

סוג השירות שמוצג. ערכים אפשריים הם 'delivery' או 'Takeout'.

לדוגמה: DELIVERY
restaurantId String

חובה.

הערך @id של ישות המסעדה קשור לישות השירות הזו.

לדוגמה: restaurant_1
menuId String

חובה.

הערך של @id של ישות התפריט תואם לישות השירות הזו.

לדוגמה: menu_1
dateModified חותמת זמן לפי תקן ISO

התאריך ושעת השינוי האחרון של פיד ישות השירות בפורמט חותמת זמן ISO.

לדוגמה: 2017-01-02T00:00:00-07:00
isDisabled בוליאני

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

לדוגמה: true
servingConfig ServingConfig

הגדרות הצגה של השירות המשמשות לניהול תכונות שונות. לדוגמה, השבתת ווידג'ט קידום מכירות וכו'.
actionLinkUrl String

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

בדוגמה הבאה מוצג רכיב Service:

דוגמה 1

{
  "@type": "Service",
  "@id": "10824/takeout",
  "serviceType": "TAKEOUT",
  "menuId": "10824",
  "restaurantId": "10824",
  "actionLinkUrl": "https://www.rwgpartnerwebsite.com/foodorderpickup/merchant_foepa_3"
}

דוגמה 2

{
  "@type": "Service",
  "@id": "10824/delivery",
  "serviceType": "DELIVERY",
  "menuId": "10824",
  "restaurantId": "10824",
  "actionLinkUrl": "https://www.rwgpartnerwebsite.com/foodorderdelivery/merchant_foepa_3"
}

ServiceArea

מתאר את האזור הגיאוגרפי שאליו אפשר לשלוח את האוכל. צריך להטמיע את הישות הזו אם הערך של serviceType בישות המשויכת Service מוגדר כ-'DELIVERY'.

בטבלה הבאה מפורטים המאפיינים של הסוג ServiceArea:

נכס סוג תיאור
@type Const

חובה.

ערך: ServiceArea
@id String

חובה.

מזהה ייחודי של אזור השירות.

לדוגמה: service_area_1
serviceId List<String>

חובה.

הערך של @id של ישות השירות שתואם לישות ServiceArea הזו.

לדוגמה: [ "service_1" ]
dateModified חותמת זמן לפי תקן ISO

התאריך והשעה של השינוי האחרון בפיד הישות ServiceArea בפורמט חותמת זמן של ISO, אבל עם סוג String.

לדוגמה: 2017-01-02T00:00:00-07:00
exclude בוליאני

צריך להחריג את אזור השירות הזה מאזור המשלוח הכולל. לדוגמה, אפשר להחריג מיקוד מאזור פוליגון גדול יותר.
צריך לציין בדיוק אחת מהקבוצות הבאות של מאפיינים.
polygon קבוצה 1 List<String>

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

לדוגמה: [ "37.806000 -122.425592 37.775849 -122.419043 37.795547 -122.394046 37.808747" ]
geoMidpointLatitude קבוצה 2 מספר

קואורדינטת קו הרוחב במרכז האזור CIRCLE.

לדוגמה: 37.806000
geoMidpointLongitude קבוצה 2 מספר

קו האורך במרכז האזור CIRCLE.

לדוגמה: -122.425592
geoRadius קבוצה 2 Integer

רדיוס משוער (במטרים) של האזור CIRCLE.

לדוגמה: 10000
postalCode קבוצה 3 String

המיקוד.

לדוגמה: 91234
addressCountry קבוצה 3 String

מציין את קוד המדינה בן שתי האותיות לפי תקן ISO 3166-1 alpha-2

לדוגמה: US

בדוגמה הבאה מוצג רכיב ServiceArea:

דוגמה

{
  "@type": "ServiceArea",
  "@id": "28427",
  "serviceId": [
    "10824/delivery"
  ],
  "polygon": [
    "37.4818562 -122.25801303 37.48247836 -122.25801303 37.48434484 -122.25621319 37.48621133 -122.25424681 37.49181077 -122.24704744 37.49305509 -122.24541414 37.49429942 -122.2436143 37.49803238 -122.23821477 37.49803238 -122.21285044 37.49367726 -122.15885517 37.49056645 -122.15722187 37.48621133 -122.15542202 37.48558917 -122.15525548 37.4818562 -122.15525548 37.43191387 -122.17865343 37.43191387 -122.23444854"
  ]
}

OperationHours (חובה)

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

המאפיינים opens ו-closes ב-OperationHours מציינים את שעות הפתיחה והסגירה של המערכת אונליין שמאפשרת למשתמשים לבצע הזמנות. במהלך שעות הפעילות של המערכת אונליין, אפשר להשתמש ב-ServiceHours כדי לציין את שעות הפתיחה והסגירה שבהן אפשר למלא הזמנות של משתמשים.

צריך לציין את זמני השירות באזור הזמן המקומי. לא כוללים אזור זמן בערך opens. אם מציינים אזור זמן, Google מתעלמת מהמידע הזה. מידע נוסף זמין במאמר פורמטים של תאריך ושעה.

בטבלה הבאה מפורטים המאפיינים של הסוג OperationHours:

נכס סוג תיאור
@type Const

חובה.

ערך: OperationHours
@id String

חובה.

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

לדוגמה: operation_hour_1
serviceId List<String>

חובה.

הערך של @id של ישות השירות תואם לישות OperationHours הזו.

לדוגמה: [ "service_1" ]
opens שעון ISO (מקומי)

השעה הספציפית ביום בפורמט ISO שממנה והלאה המשתמשים יכולים לבצע הזמנות.

לדוגמה: T00:00
closes שעון ISO (מקומי)

השעה הספציפית ביום, בפורמט ISO, אחריה לא ניתן לבצע הזמנות של משתמשים.

לדוגמה: T16:00
dayOfWeek List<DayOfWeek>

רשימה של הימים בשבוע שבהם שעות הפעילות האלה תקפות. הערכים הקבילים הם 'יום שני', 'יום שלישי', 'יום רביעי', 'יום חמישי', 'יום שישי', 'יום שבת' ו'יום ראשון'.

לדוגמה: [ "MONDAY", "TUESDAY" ]
validFrom חותמת זמן של ISO

חובה כאשר isSpecialHour = true.

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

לדוגמה: 2017-01-01T00:00:00-07:00
validThrough חותמת זמן של ISO

חובה כאשר isSpecialHour = true.

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

לדוגמה: 2017-01-02T00:00:00-07:00
isSpecialHour בוליאני

ערך בוליאני שמציין אם השדה OperationHours מייצג שעות פתיחה מיוחדות. הערכים הקבילים הם 'false' ו-'true'.

לדוגמה: False
dateModified חותמת זמן לפי תקן ISO

התאריך והשעה של השינוי האחרון בפיד הישות OperationHours בפורמט חותמת זמן של ISO, אבל עם סוג String.

לדוגמה: 2017-01-02T00:00:00-07:00

בדוגמה הבאה מוצג רכיב OperationHours:

דוגמה 1

{
  "@type": "OperationHours",
  "@id": "10824/deliveryOh",
  "serviceId": [
    "10824/delivery"
  ],
  "isSpecialHour": false
}

דוגמה 2

{
  "@type": "OperationHours",
  "@id": "10824/takeoutOh",
  "serviceId": [
    "10824/takeout"
  ],
  "isSpecialHour": false
}

ServiceHours (חובה)

מתאר את חלון מילוי ההזמנות שבו משתמשים יכולים לבחור משבצות למילוי הזמנות (בהקדם האפשרי או בעתיד). נדרשת הטמעה של ServiceHours.

המאפיינים opens ו-closes ב-OperationHours מציינים את שעות הפתיחה והסגירה של המערכת אונליין שמאפשרת למשתמשים לבצע הזמנות. במהלך שעות הפעילות של המערכת אונליין, אפשר להשתמש ב-ServiceHours כדי לציין את שעות הפתיחה והסגירה שבהן אפשר למלא הזמנות של משתמשים.

צריך לציין את השעות לפי השעון המקומי של העסק. לא כוללים אזור זמן בערך opens. אם צוין אזור זמן, Google מתעלמת מהמידע הזה. מידע נוסף זמין במאמר פורמטים של תאריך ושעה.

בטבלה הבאה מפורטים המאפיינים של הסוג ServiceHours:

נכס סוג תיאור
@type Const

חובה.

ערך: ServiceHours
@id String

חובה.

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

לדוגמה: service_hour_1
orderType OrderType

חובה.

מחרוזת שמציינת אם שעות הפעילות חלות על הזמנות 'בהקדם האפשרי' או על הזמנות מתקדמות. הערכים הקבילים הם "ASAP" ו-"ADVANCE".

לדוגמה: ASAP
serviceId List<String>

חובה.

הערך של @id של ישות השירות תואם לישות ServiceHours הזו.

לדוגמה: [ "service_1" ]
operationHoursId List<String>

חובה כאשר isSpecialHour = false.

הערך של @id של הישות OperationHours תואם לישות ServiceHours הזו.

לדוגמה: [ "operation_hour_1" ]
opens שעון ISO (מקומי)

השעה הספציפית ביום בפורמט ISO שממנה אפשר למלא את ההזמנות של המשתמשים.

לדוגמה: T00:00
closes שעון ISO (מקומי)

השעה הספציפית ביום בפורמט ISO שמעבר לה לא ניתן למלא הזמנות של משתמשים.

לדוגמה: T16:00
dayOfWeek List<DayOfWeek>

רשימה של ימי השבוע שבהם שעות הפעילות האלה תקפות.

לדוגמה: [ "MONDAY", "TUESDAY" ]
validFrom חותמת זמן של ISO

חובה כאשר isSpecialHour = true.

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

לדוגמה: 2017-01-01T00:00:00-07:00
validThrough חותמת זמן של ISO

חובה כאשר isSpecialHour = true.

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

לדוגמה: 2017-01-02T00:00:00-07:00
isSpecialHour בוליאני

ערך בוליאני שמציין אם השדה OperationHours מייצג שעות פתיחה מיוחדות. הערכים הקבילים הם 'false' ו-'true'.

לדוגמה: False
leadTimeMin Integer

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

לדוגמה: 60
leadTimeMax Integer

זמן האספקה המשוער או זמן האיסוף המשוער, בדקות, מרגע ביצוע ההזמנה בהקדם האפשרי. מומלץ מאוד להגדיר את המאפיין הזה.

לדוגמה: 70
advanceBookingRequirementMin Integer

חובה כאשר orderType = "ADVANCE".

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

לדוגמה: 15
advanceBookingRequirementMax Integer

חובה כאשר orderType = "ADVANCE".

מספר הדקות המקסימלי מרגע ההזמנה שבה אפשר להשלים את ההזמנה מראש. לדוגמה, אם ההזמנה מראש מוגבלת למועד ביצוע של יותר מ-2 ימים מאוחר יותר, הערך של advanceBookingRequirementMax הוא 2880.

לדוגמה: 10080
advanceBookingSlotInterval String

חובה כאשר: orderType = "ADVANCE".

המרווח בין שתי שעות רצף של תורים להזמנות מראש. לדוגמה: אם שעות הפתיחה והסגירה הן 8:00 ו-20:00, ו-advanceBookingSlotInterval הוא 15 דקות, המשתמש יכול לבחור זמני ביצוע של 8:00, 8:15, 8:30, 8:45 וכן הלאה עד 20:00. משך הזמן חייב להיות מוגדר כמשך תקופה לפי תקן ISO. לדוגמה: 'PT15M' פירושו מרווחים של 15 דקות.

לדוגמה: PT15M
dateModified חותמת זמן לפי תקן ISO

התאריך והשעה של השינוי האחרון בפיד הישות ServiceHours בפורמט חותמת זמן של ISO, אבל עם סוג String.

לדוגמה: 2017-01-02T00:00:00-07:00

בדוגמה הבאה מוצג רכיב ServiceHours:

דוגמה 1

{
  "@type": "ServiceHours",
  "@id": "613741/delivery",
  "orderType": "ASAP",
  "serviceId": [
    "10824/delivery"
  ],
  "opens": "T00:00",
  "closes": "T00:00",
  "isSpecialHour": true,
  "validFrom": "2017-12-25T00:00:00-07:00",
  "validThrough": "2017-12-25T23:59:00-07:00"
}

דוגמה 2

{
  "@type": "ServiceHours",
  "@id": "10824/takeoutSh_0",
  "orderType": "ASAP",
  "serviceId": [
    "10824/takeout"
  ],
  "operationHoursId": [
    "10824/takeoutOh"
  ],
  "opens": "11:00",
  "closes": "21:00",
  "dayOfWeek": [
    "MONDAY",
    "TUESDAY",
    "WEDNESDAY",
    "THURSDAY"
  ],
  "isSpecialHour": false
}

עמלה

תיאור של עמלה. אם הערך של serviceType שמוגדרת ליישות המשויכת Service הוא 'DELIVERY', צריך להגדיר את הערך של feeType ב-Fee כ-'DELIVERY'.

בטבלה הבאה מפורטים המאפיינים לסוג Fee:

נכס סוג תיאור
@type Const

חובה.

ערך: Fee
@id String

חובה.

מזהה ייחודי של הישות שמתארת את העמלה.

לדוגמה: service_fee_1
serviceId List<String>

חובה.

הערך של @id של ישות השירות שתואם לישות העמלה הזו.

לדוגמה: [ "service_1" ]
feeType FeeType

חובה.

מחרוזת שמציינת אם העמלה חלה על הזמנות של משלוחים או שירותים. הערכים הקבילים הם 'DELIVERY' ו-'SERVICE'.

לדוגמה: DELIVERY
priceCurrency String

חובה.

קוד המטבע בן 3 האותיות לפי תקן ISO 4217.

לדוגמה: USD
basePrice מספר

מחיר הבסיס של העמלה, שחלה כשמשתמשים ב-percentageOfCart או ב-pricePerMeter.

לדוגמה: 2.0
minPrice מספר

עמלה מינימלית, מגבילה את ערך העמלה כשמשתמשים ב-percentageOfCart או ב-pricePerMeter.

לדוגמה: 2.0
maxPrice מספר

Max fee, מגביל את ערך העמלה כשמשתמשים ב-percentageOfCart או ב-pricePerMeter.

לדוגמה: 10.0
eligibleRegion List<String>

הערך של @id של ServiceArea לאזורים הגיאו-פוליטיים שבהם העמלה תקפה. צריך להשתמש במאפיין הזה רק אם עלויות המשלוח משתנות בהתאם לאזור.

לדוגמה: [ "service_area_1" ]
eligibleTransactionVolumeMin מספר

נפח העסקאות המינימלי, ביחידת מטבע, שבו פרטי העמלה האלה תקפים.

לדוגמה: 50
eligibleTransactionVolumeMax מספר

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

לדוגמה: 10
validFrom חותמת זמן לפי תקן ISO

חותמת זמן לפי תקן ISO שמציינת את זמן ההתחלה שבו העמלה תקפה.

לדוגמה: 2017-01-01T00:00:00-07:00
validThrough חותמת זמן לפי תקן ISO

חותמת זמן לפי תקן ISO שמציינת את שעת הסיום שמעבר לה העמלה לא תקפה.

לדוגמה: 2017-01-02T00:00:00-07:00
dateModified חותמת זמן לפי תקן ISO

התאריך והשעה של השינוי האחרון בפיד של ישות העמלה, בפורמט חותמת זמן לפי תקן ISO אבל עם סוג String.

לדוגמה: 2017-01-02T00:00:00-07:00
priority מספר

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

לדוגמה: 3
דרושה בדיוק אחת מקבוצות הנכסים הבאות.
price קבוצה 1 מספר

המחיר של העמלה. אם המחיר לא קבוע, אפשר לציין את minPrice ו-maxPrice במקום price.

לדוגמה: 1.5
percentageOfCart קבוצה 2 מספר

העמלה היא אחוז מערך עגלת הקניות. הערכים הקבילים הם ערכים של משתנה מסוג float בין 0 ל-100, כולל.

לדוגמה: 9.00
pricePerMeter קבוצה 3 מספר

עמלה למטר על מרחק רדיאלי מהמשתמש. לדוגמה, אם המרחק מהמשתמש הוא 5 ק"מ והתעריף הוא 0.001$, העמלה למשתמש תהיה 5$.

לדוגמה: 0.001

בדוגמה הבאה מוצג רכיב Fee:

דוגמה 1

{
  "@type": "Fee",
  "@id": "28427",
  "serviceId": [
    "10824/delivery"
  ],
  "feeType": "DELIVERY",
  "priceCurrency": "USD",
  "eligibleRegion": [
    "28427"
  ],
  "eligibleTransactionVolumeMin": 20,
  "price": 5
}

דוגמה 2

{
  "@type": "Fee",
  "@id": "28427",
  "serviceId": [
    "10824/delivery"
  ],
  "feeType": "DELIVERY",
  "priceCurrency": "USD",
  "eligibleRegion": [
    "28427"
  ],
  "eligibleTransactionVolumeMin": 20,
  "pricePerMeter": 0.0005,
  "basePrice": 4
}

דוגמה 3

{
  "@type": "Fee",
  "@id": "28427",
  "serviceId": [
    "10824/delivery"
  ],
  "feeType": "DELIVERY",
  "priceCurrency": "USD",
  "eligibleRegion": [
    "28427"
  ],
  "eligibleTransactionVolumeMin": 20,
  "pricePerMeter": 0.0005,
  "basePrice": 4,
  "minPrice": 5,
  "maxPrice": 50
}

דוגמה 4

{
  "@type": "Fee",
  "@id": "28427",
  "serviceId": [
    "10824/delivery"
  ],
  "feeType": "DELIVERY",
  "priceCurrency": "USD",
  "eligibleRegion": [
    "28427"
  ],
  "eligibleTransactionVolumeMin": 20,
  "percentageOfCart": 5,
  "basePrice": 4
}

דוגמה 5

{
  "@type": "Fee",
  "@id": "28427",
  "serviceId": [
    "10824/delivery"
  ],
  "feeType": "DELIVERY",
  "priceCurrency": "USD",
  "eligibleRegion": [
    "28427"
  ],
  "eligibleTransactionVolumeMin": 20,
  "percentageOfCart": 5,
  "basePrice": 4,
  "minPrice": 5,
  "maxPrice": 50
}

ישות נדרשת להטמעה. תיאור של תפריט.

בטבלה הבאה מפורטים המאפיינים לסוג Menu:

נכס סוג תיאור
@type Const

חובה.

ערך: Menu
@id String

חובה.

מזהה ייחודי של התפריט.

לדוגמה: menu_1
name String

הטקסט שיכול לזהות את התפריט כשמשתמש מעיין בתפריט.

לדוגמה: Foo
disclaimer String

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

לדוגמה: Items may contain peanuts.
disclaimerUrl Url

כתובת URL שמפנה לדף עם פרטים נוספים על כתב הוויתור
dateModified חותמת זמן של ISO

התאריך ושעת השינוי האחרון של פיד הישות 'תפריט' בפורמט חותמת זמן ISO, אבל מסוג 'מחרוזת'.

לדוגמה: 2017-01-02T00:00:00-07:00

בדוגמה הבאה מוצג רכיב Menu:

{
  "@type": "Menu",
  "@id": "10824"
}

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

בטבלה הבאה מפורטים המאפיינים לסוג MenuSection:

נכס סוג תיאור
@type Const

חובה.

ערך: MenuSection
@id String

חובה.

מזהה ייחודי של קטע התפריט.

לדוגמה: menu_section_1
menuId רשימה<ReverseReference>

הערך של @id של ישות התפריט שמשויך לישות MenuSection הזו.

לדוגמה: [ { "@id": "menu_id", "displayOrder": 4 } ]
menuSectionId List<String>

רשימה של ערכי ה-@id של ישויות הילד MenuSection שתואמות לישות MenuSection הזו.

חשוב: צריך להשתמש רק בהפניה אחת מבין menuSectionId או parentMenuSectionId(in child).

לדוגמה: [ "child_menu_section_1", "child_menu_section_2" ]
parentMenuSectionId רשימה<ReverseReference>

הערך של @id של ישות ההורה MenuSection שמשויך לישות MenuSection הזו.

חשוב: צריך להשתמש רק בהפניה אחת מבין parentMenuSectionId או menuSectionId(in parent).

לדוגמה: [ { "@id": "parent_menu_section_id", "displayOrder": 4 } ]
name String

חובה.

הטקסט שיכול לזהות את MenuSection כשמשתמש מנווט בתפריט.

לדוגמה: Foo
description String

תיאור של קטע התפריט.

לדוגמה: Example menu section description that helps users.
image Url

כתובת ה-URL של תמונה של קטע התפריט.

לדוגמה: https://provider.com/someimage
menuItemId List<String>

רשימה של ערכי ה-@id של ישויות ה-MenuItem שתואמות לישות ה-MenuSection הזו.

חשוב: צריך להשתמש רק בהפניה אחת מבין menuItemId או MenuItem.parentMenuSectionId.

לדוגמה: [ "menu_item1", "menu_item2" ]
parentMenuItemId List<ReverseReference>

רשימה של ערכי ה-@id של ישויות ההורה MenuItem שתואמות לישות MenuSection הזו.

חשוב: צריך להשתמש רק באחד מתוך קובצי העזר של parentMenuItemId או MenuItem.menuAddOnId.

לדוגמה: [ { "@id": "parent_menu_item_id", "displayOrder": 4 } ]
parentMenuItemOptionId List<ReverseReference>

רשימה של ערכי ה-@id של ישויות ההורה MenuItemOption שתואמות לישות MenuSection הזו.

חשוב: צריך להשתמש רק באחד מתוך קובצי העזר של parentMenuItemOptionId או MenuItemOption.menuAddOnId.

לדוגמה: [ { "@id": "parent_menu_item_option_id", "displayOrder": 4 } ]
eligibleQuantityMax Integer

המספר המקסימלי של תוספים שאפשר לבחור בקטע 'תוספים'.

לדוגמה: 5
eligibleQuantityMin Integer

המספר המינימלי של התוספים שצריך לבחור בקטע 'תוספים'.

לדוגמה: 1
defaultItemId List<String>

רשימה של מזהי @id שמפנים לישויות MenuItem, שייבחרו מראש כברירת מחדל למשתמשים בתוסף MenuSection. המשתמשים יכולים לשנות את הבחירות הסופיות. אם לא מציינים את defaultItemId, לא תתבצע בחירה מראש של MenuItem.

לדוגמה: [ "item1", "item2" ]
availabilityId List<String>

ערכי ה-@id של ישויות הזמינות שמספקות פרטים לגבי המועד שבו קטע התפריט זמין.

לדוגמה: [ "menu_availability_1" ]
numberOfFreeAddOns Integer

מספר התוספים שהמשתמשים יכולים לבחור ללא תשלום. התכונה תקפה רק לקטעים בתפריט של חבילות התוספים.

לדוגמה: 3
dateModified חותמת זמן לפי תקן ISO

התאריך ושעת השינוי האחרון של פיד הישות MenuSection בפורמט חותמת זמן ISO, אבל מסוג מחרוזת.

לדוגמה: 2017-01-02T00:00:00-07:00
applicableServiceType רשימה<ServiceType>

השירות שאליו MenuSection הזה רלוונטי. כברירת מחדל, ההנחה היא ש-MenuSection רלוונטי לכולם.
offeredById List<String>

ערכי ה-@id של ישויות Restaurant שבהן MenuSection הזה זמין. ברירת המחדל מתייחסת למצב שבו MenuSection זמין בכל המיקומים.

לדוגמה: [ "restaurant_id_1", "restaurant_id_55" ]

בדוגמה הבאה מוצג רכיב MenuSection:

{
  "@type": "MenuSection",
  "@id": "853705",
  "menuId": [
    {
      "@id": "10824",
      "displayOrder": 853705
    }
  ],
  "menuSectionId": [
    12345,
    43645
  ],
  "name": "Pasta",
  "applicableServiceType": [
    "TAKEOUT"
  ],
  "offeredById": [
    "italian_restaurant_location_1"
  ]
}
 
{
  "@type": "MenuSection",
  "@id": "427484",
  "menuId": [
    {
      "@id": "4287",
      "displayOrder": 964376
    }
  ],
  "menuItemId": [
    46784,
    42728
  ],
  "name": "Burger",
  "applicableServiceType": [
    "TAKEOUT",
    "DELIVERY"
  ]
}
 
{
  "@type": "MenuSection",
  "@id": "3138486",
  "name": "Choose a side:",
  "parentMenuItemId": [
    {
      "@id": "6680295",
      "displayOrder": 3138486
    }
  ],
  "eligibleQuantityMax": "5",
  "numberOfFreeAddOns": "2"
}
 
{
  "@type": "MenuSection",
  "@id": "3138482",
  "name": "Additional Pizza Toppings",
  "parentMenuItemId": [
    {
      "@id": "6680246",
      "displayOrder": 3138482
    }
  ],
  "eligibleQuantityMax": "3"
}

זמינות

ישות אופציונלית להטמעה. תיאור תקופת הזמן שבה מוצגת ישות MenuSection.

בטבלה הבאה מפורטים המאפיינים של הסוג Availability:

נכס סוג תיאור
@type Const

חובה.

ערך: Availability
@id String

חובה.

מזהה ייחודי של הישות שמתארת את הזמינות של קטע התפריט.

לדוגמה: menu_section_avail_1
availabilityStarts שעון ISO (מקומי)

חותמת הזמן לפי תקן ISO שמציינת את שעת ההתחלה שבה זמינות הקטע בתפריט.

לדוגמה: T00:00
availabilityEnds שעון ISO (מקומי)

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

לדוגמה: T16:00
availableDay List<DayOfWeek>

רשימה של הימים בשבוע שבהם זמינות הקטע בתפריט.

לדוגמה: [ "MONDAY", "TUESDAY" ]
validFrom חותמת זמן לפי תקן ISO

חותמת זמן לפי תקן ISO שמציינת את שעת ההתחלה שבה זמינות הקטע בתפריט תקפה.

לדוגמה: 2017-01-01T00:00:00-07:00
validThrough חותמת זמן לפי תקן ISO

חותמת זמן לפי תקן ISO שמציינת את שעת הסיום שמעבר לה הזמינות של קטע התפריט לא תקפה.

לדוגמה: 2017-01-02T00:00:00-07:00
dateModified חותמת זמן לפי תקן ISO

התאריך והשעה של השינוי האחרון בפיד הישות של הזמינות בפורמט חותמת זמן של ISO, אבל עם סוג String.

לדוגמה: 2017-01-02T00:00:00-07:00

בדוגמה הבאה מוצג רכיב Availability:

דוגמה

{
  "@type": "Availability",
  "@id": "85343705",
  "availabilityStarts": "06:00",
  "availabilityEnds": "22:30",
  "availableDay": [
    "SATURDAY",
    "SUNDAY"
  ]
}

ישות נדרשת להטמעה. תיאור של פריט בישויות Menu.

בטבלה הבאה מפורטים המאפיינים של הסוג MenuItem:

נכס סוג תיאור
@type Const

חובה.

ערך: MenuItem
@id String

חובה.

מזהה ייחודי של פריט התפריט.

לדוגמה: menu_item_1
name String

חובה.

הטקסט שיכול לזהות את MenuItem כשמשתמש מנווט בתפריט.

לדוגמה: Foo
description String

תיאור של פריט התפריט.

לדוגמה: Foo
image כתובת URL

כתובת URL של תמונה של האפשרות בתפריט.

לדוגמה: http://someprovider.com/someimage
parentMenuSectionId List<ReverseReference>

רשימה של ערכי @id של ישויות ההורה MenuSection שתואמים לישות MenuItem.

חשוב: צריך להשתמש רק באחד מתוך קובצי העזר של parentMenuSectionId או MenuSection.menuItemId.

לדוגמה: { "@id": "menu_section_parent_id", "displayOrder": 4 }
menuAddOnId List<String>

רשימה של ערכי ה-‎ @id של ישויות ה-MenuSection מהקטע של התוסף שתואמות לישות ה-MenuItem הזו.

חשוב: צריך להשתמש רק בהפניה אחת מבין menuAddOnId או MenuSection.parentMenuItemId.

לדוגמה: menu_addon_1
nutrition NutritionInformation

מידע תזונתי על המנה, במיוחד קלוריות.

לדוגמה: { "calories": "120-150 Cal" }
allergen List<Allergen>

אלרגנים של הפריט הזה בתפריט.

לדוגמה: [ { "allergenType": "PEANUTS", "levelOfContainment": "MAY_CONTAIN" } ]
additive List<Additive>

תוספים של הפריט הזה בתפריט.

לדוגמה: [ { "additiveName": "Sodium nitrite", "levelOfContainment": "CONTAINS" } ]
suitableDiet List<RestrictedDiet>

המנה עומדת בהגבלה התזונתית המתוארת.

לדוגמה: [ "DIABETIC", "GLUTEN_FREE" ]
depositInfo DepositInfo

מידע על האריזה והמיחזור של הפריט הזה בתפריט.

לדוגמה: { "depositCode": "RECYCLABLE", "depositValue": "0.05", "depositValueCurrency": "USD" }
numberOfServings Integer

מספר המנות הזמינות בפריט נתון בתפריט.

לדוגמה: 2
dateModified חותמת זמן לפי תקן ISO

התאריך והשעה של השינוי האחרון בפיד הישות MenuItem בפורמט חותמת זמן של ISO, אבל עם סוג String.

לדוגמה: 2017-01-02T00:00:00-07:00

בדוגמה הבאה מוצג רכיב MenuItem:

{
  "@type": "MenuItem",
  "@id": "18931508",
  "name": "Sauteed Baby Spinach",
  "parentMenuSectionId": [
    {
      "@id": "3138479",
      "displayOrder": 18931508
    }
  ]
}
 
{
  "@type": "MenuItem",
  "@id": "18931508",
  "name": "Hamburger",
  "parentMenuSectionId": [
    {
      "@id": "4645747",
      "displayOrder": 12345
    }
  ],
  "nutrition": {
    "calories": "400 cal"
  },
  "allergen": [
    {
      "allergenType": "GLUTEN",
      "levelOfContainment": "CONTAINS"
    }
  ],
  "additive": [
    {
      "additiveName": "Sodium nitrite",
      "levelOfContainment": "CONTAINS"
    }
  ],
  "suitableDiet": [
    "DIABETIC",
    "LOW_FAT"
  ]
}

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

בטבלה הבאה מפורטים המאפיינים של הסוג MenuItemOption:

נכס סוג תיאור
@type המשך

ערך: MenuItemOption
@id String

חובה.

מזהה ייחודי של האפשרות של פריט התפריט.

לדוגמה: menu_item_1_option
menuItemId ReverseReference

חובה.

הערך של @id של הישות MenuItem שמשויכת לישות MenuItemOption הזו.

לדוגמה: { "@id": "menu_item_1", "displayOrder": 4 }
optionType OptionType

מחרוזת שמציינת אם האפשרות של פריט התפריט מסווגת לפי גודל, אפשרות או תוספת לפיצה. הערכים הקבילים הם 'SIZE',‏ 'OPTION' ו-'PIZZA_SIDE'. 'SIZE': הגודל של MenuItemOption. לדוגמה, קטן, בינוני או גדול. 'אפשרות': כל וריאציה שאינה מידה (למשל, מנה שזמינה כסלט או ככריך). אם אין לך אפשרות להבחין בין 'SIZE' ל-'OPTION', יש להשתמש באפשרות OPTION. 'PIZZA_SIDE': ספציפי לפיצות: לדוגמה, השדה MenuItemOption תקף רק לחלק מהפיצה או לפיצה שלמה (למשל, תוספת פטריות בצד ימין, בצד שמאל או בפיצה שלמה).

לדוגמה: SIZE
value מחרוזת או PizzaSide

חובה כאשר: optionType is defined.

ערך מחרוזת או ערך enum. ערכי Enum ספציפיים לסוג האפשרות PIZZA_SIDE.
applicableParentOptionValue String

מחרוזת שמכילה את הערך של ערך האפשרות של פריט ההורה שעבורו האפשרות הזו זמינה.

לדוגמה: Small
menuAddOnId List<String>

רשימה של ערכי ה-@id של MenuSection הישויות מקטע התוסף שמתאימות לישות MenuItemOption.

חשוב: צריך להשתמש רק בהפניה אחת מבין menuAddOnId או MenuSection.parentMenuItemId.

לדוגמה: menuAddOnId
nutrition NutritionInformation

מידע תזונתי על המנה, במיוחד קלוריות.

לדוגמה: { "calories": "120-150 Cal" }
allergen רשימה<Allergen>

האלרגנים של MenuItem הזה.

לדוגמה: { "allergenType": "PEANUTS", "levelOfContainment": "MAY_CONTAIN" }
additive רשימה<Additive>

התוספים של פריט התפריט הזה.

לדוגמה: { "additiveName": "Sodium nitrite", "levelOfContainment": "CONTAINS" }
depositInfo DepositInfo

פרטי האריזה והמיחזור של פריט התפריט הזה.

לדוגמה: { "depositCode": "RECYCLABLE", "depositValue": "0.05", "depositValueCurrency": "USD" }
numberOfServings Integer

מספר המנות הזמינות באפשרות מסוימת של פריט בתפריט.

לדוגמה: 2
dateModified חותמת זמן לפי תקן ISO

התאריך והשעה של השינוי האחרון בפיד הישות MenuItemOption בפורמט חותמת זמן של ISO, אבל עם סוג String.

לדוגמה: 2017-01-02T00:00:00-07:00

בדוגמה הבאה מוצג רכיב MenuItemOption:

{
  "@type": "MenuItemOption",
  "@id": "56177944",
  "menuItemId": {
    "@id": "18930213",
    "displayOrder": 1234
  },
  "optionType": "PIZZA_SIDE",
  "value": "PIZZA_SIDE_LEFT"
}
 
{
  "@type": "MenuItemOption",
  "@id": "56177944",
  "menuItemId": {
    "@id": "18930213",
    "displayOrder": 1234
  },
  "applicableParentOptionValue": "Small Pizza"
}

ישות נדרשת להטמעה. תיאור של מבצע לישות מסוג MenuItem או MenuItemOption.

בטבלה הבאה מפורטים המאפיינים לסוג MenuItemOffer:

נכס סוג תיאור
@type Const

חובה.

ערך: MenuItemOffer
@id String

חובה.

מזהה ייחודי של המבצע על פריט התפריט.

לדוגמה: menu_item_offer
sku String

חובה.

מזהה של המבצע על המנה בתפריט. ערכי המק"טים יכולים להיות שונים או זהים בכמה ישויות של מוצרים בתפריט. ערך המק"ט יוגדר בהזמנה כשנשלח אליכם קריאה ל-API.

לדוגמה: Menu_item_offer_sku
price מספר

חובה.

המחיר של המנה בתפריט.

לדוגמה: 2.5
priceCurrency String

חובה.

קוד המטבע בן 3 האותיות לפי תקן ISO 4217.

לדוגמה: USD
availabilityId List<String>

ערכי @id של ישויות זמינות שמספקים פרטים על המועד שבו האפשרות בתפריט זמינה.

לדוגמה: [ "menu_availability_1" ]
eligibleQuantityMin מספר

כמות ההזמנה המינימלית שעבורה צוין MenuItemOffer.

לדוגמה: 1
eligibleQuantityMax מספר

הכמות המקסימלית להזמנה שבה MenuItemOffer תקף.

לדוגמה: 25
inventoryLevel מספר

רמת המלאי המשוערת הנוכחית של הפריט או הפריטים שתואמים ל-MenuItemOffer הזה.

לדוגמה: 10
dateModified חותמת זמן של ISO

התאריך והשעה של השינוי האחרון בפיד הישות MenuItemOffer בפורמט חותמת זמן של ISO, אבל עם סוג String.

לדוגמה: 2017-01-02T00:00:00-07:00
applicableServiceType List<ServiceType>

השירות שאליו MenuItemOffer הזה רלוונטי. כברירת מחדל, ההנחה היא ש-MenuItemOffer רלוונטי לכולם.
offeredById List<String>

ערכי ה-@ של Restaurant ישויות שהמאפיין MenuItemOffer זמין בהן. כברירת מחדל, ההנחה היא ש-MenuItemOffer זמין בכל המיקומים.

לדוגמה: [ "restaurant_id_5", "restaurant_id_26" ]
דרושה בדיוק אחת מקבוצות הנכסים הבאות.
menuItemId קבוצה 1 String

הערך של @id של הישות MenuItem שמשויכת לישות MenuItemOffer הזו.

לדוגמה: menu_item_1
menuItemOptionId קבוצה 2 String

הערך של @id של הישות MenuItemOption שמשויכת לישות MenuItemOffer הזו.

לדוגמה: menu_item_option_1

בדוגמה הבאה מוצג רכיב MenuItemOffer:

{
  "@type": "MenuItemOffer",
  "@id": "6680262",
  "sku": "offer-mediterranean-bagel",
  "menuItemId": "896532",
  "price": 15.5,
  "priceCurrency": "USD",
  "applicableServiceType": [
    "DELIVERY"
  ],
  "offeredById": [
    "bagel_shop_location_5"
  ]
}

נפוץ

ReverseReference

בטבלה הבאה מפורטים המאפיינים של הסוג ReverseReference:

נכס סוג תיאור
@id String

חובה.

@id של ישות ההורה.
displayOrder Integer

חובה.

סדר הצגת הפריט בתוך הרכיב ההורה.

NutritionInformation

בטבלה הבאה מפורטים המאפיינים של הסוג NutritionInformation:

נכס סוג תיאור
description String

מידע תזונתי בטקסט חופשי. לדוגמה, 'מכיל חומרים משמרים'.
calories String

מספר הקלוריות ב-Cal,‏ kcal או kJ, לפי הפורמט הבא: ערך Cal או min-max Cal

לדוגמה: 120.34 Cal
sodiumContent String

מספר המ"ג או ג' של נתרן בפורמט הבא: ערך g או min-max g

לדוגמה: 1200 mg

בדוגמה הבאה מוצג רכיב NutritionInformation:

דוגמה

{
  "calories": "120-150 Cal",
  "sodiumContent": "100 mg"
}

אלרגן

בטבלה הבאה מפורטים המאפיינים של הסוג Allergen:

נכס סוג תיאור
allergenType AllergenType

חובה.

סוג האלרגן.
levelOfContainment ContainmentLevel

רמת האלרגן בתפריט.

בדוגמה הבאה מוצג רכיב Allergen:

דוגמה

{
  "allergenType": "PEANUTS",
  "levelOfContainment": "MAY_CONTAIN"
}

תוסף

בטבלה הבאה מפורטים המאפיינים של הסוג Additive:

נכס סוג תיאור
additiveName String

חובה.

שם התוסף.
levelOfContainment ContainmentLevel

רמת התוסף בתפריט.

בדוגמה הבאה מוצג רכיב Additive:

דוגמה

{
  "additiveName": "Sodium nitrite",
  "levelOfContainment": "CONTAINS"
}

DepositInfo

בטבלה הבאה מפורטים המאפיינים לסוג DepositInfo:

נכס סוג תיאור
depositCode DepositCode

קוד הפקדה.
depositValue מספר

הערך המספרי של הפיקדון על הפריט, למשל כשממחזרים אותו.
depositValueCurrency String

המטבע של ערך ההפקדה

בדוגמה הבאה מוצג רכיב DepositInfo:

דוגמה

{
  "depositCode": "RECYCLABLE",
  "depositValue": 0.05,
  "depositValueCurrency": "USD"
}

ServingConfig

הגדרות הצגה של השירות המשמשות לניהול תכונות שונות. לדוגמה, השבתת ווידג'ט קידום מכירות וכו'.

בטבלה הבאה מפורטים המאפיינים של הסוג ServingConfig:

נכס סוג תיאור
disableOrderInstructions בוליאני

הסתרת האפשרות לציין הוראות להזמנה.
disableMenuItemSpecialInstructions בוליאני

הסתרת האפשרות לציין הוראות מיוחדות לפריט בתפריט.
disableTipWidget בוליאני

הווידג'ט של התשלום על טיפים מוסתר בדף 'ביצוע הזמנה' בתהליך ההזמנה.
disablePromoWidget בוליאני

הסתרת הווידג'ט של המבצע בדף 'ביצוע הזמנה' בתהליך ההזמנה.
menuItemSpecialInstructionsMaxLength מספר

מציין את מספר התווים המקסימלי שהוראות מיוחדות של פריטי תפריט יכולות להכיל.
orderInstructionsMaxLength מספר

מציין את מספר התווים המקסימלי שאפשר לכלול בהוראה להזמנה.

בדוגמה הבאה מוצג רכיב ServingConfig:

דוגמה 1

{
  "disableMenuItemSpecialInstructions": true
}

דוגמה 2

{
  "disableTipWidget": true,
  "disablePromoWidget": true
}

דוגמה 3

{
  "menuItemSpecialInstructionsMaxLength": 250,
  "orderInstructionsMaxLength": 1000
}

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

DayOfWeek

אלה הערכים האפשריים של הסוג DayOfWeek:

  • MONDAY
  • TUESDAY
  • WEDNESDAY
  • THURSDAY
  • FRIDAY
  • SATURDAY
  • SUNDAY

ServiceType

אלה הערכים האפשריים של הסוג ServiceType:

  • DELIVERY
  • TAKEOUT

OrderType

הסוג OrderType כולל את הערכים האפשריים הבאים:

  • ASAP
  • ADVANCE

FeeType

אלה הערכים האפשריים של הסוג FeeType:

  • DELIVERY
  • SERVICE

OptionType

אלה הערכים האפשריים של הסוג OptionType:

  • SIZE
  • OPTION
  • PIZZA_SIDE

PizzaSide

אלה הערכים האפשריים של הסוג PizzaSide:

  • PIZZA_SIDE_LEFT
  • PIZZA_SIDE_RIGHT
  • PIZZA_SIDE_WHOLE

AllergenType

סוג האלרגנים לפי gs1:AllergenTypeCode.

אלה הערכים האפשריים של הסוג AllergenType:

  • ALMONDS
  • ALPHA_ISOMETHYL_IONONE
  • ALCOHOL
  • AMYL_CINNAMAL
  • ANISE_ALCOHOL
  • BARLEY
  • BENZYL_ALCOHOL
  • BENZYL_BENZOATE
  • BENZYL_CINNAMATE
  • BENZYL_SALICYLATE
  • BRAZIL_NUTS
  • BUTYLPHENYL_METHYLPROPIONATE
  • CARROTS
  • CASHEW_NUTS
  • CELERY
  • CEREALS_CONTAINING_GLUTEN
  • CINNAMAL
  • CINNAMYL_ALCOHOL
  • CITRAL
  • CITRONELLOL
  • COCOA
  • CORIANDER
  • CORN
  • COUMARIN
  • CRUSTACEANS
  • EGGS
  • EUGENOL
  • EVERNIA_FURFURACEA
  • EVERNIA_PRUNASTRI
  • FARNESOL
  • FISH
  • GERANIOL
  • GLUTEN
  • HAZELNUTS
  • HEXYL_CINNAMAL
  • HYDROXYCITRONELLAL
  • HYDROXYISOHEXYL_3_CYCLOHEXENE_CARBOXALDEHYDE_ISOEUGENOL_LIMONENE_LINAL
  • KAMUT
  • LACTOSE
  • LUPINE
  • MACADAMIA_NUTS
  • METHYL_2_OCTYNOATE
  • MILK
  • MOLLUSCS
  • MUSTARD
  • NO_DECLARED_ALLERGENS
  • OAT
  • PEANUTS
  • PEAS
  • PECAN_NUTS
  • PISTACHIOS
  • POD_FRUITS
  • QUEENSLAND_NUTS
  • RYE
  • SESAME_SEEDS
  • SOYBEANS
  • SPELT
  • SULPHUR_DIOXIDE
  • TREE_NUTS
  • TREE_NUT_TRACES
  • WALNUTS
  • WHEAT

ContainmentLevel

אלה הערכים האפשריים של הסוג ContainmentLevel:

  • CONTAINS
  • FREE_FROM
  • MAY_CONTAIN

DepositCode

אלה הערכים האפשריים של הסוג DepositCode:

  • REUSABLE
  • RECYCLABLE

DealType

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

אלה הערכים האפשריים של הסוג DealType:

  • CART_OFF
  • DELIVERY_OFF

RestrictedDiet

סוג הדיאטות המוגבלות לפי schema.org:RestrictedDiet.

אלה הערכים האפשריים של הסוג RestrictedDiet:

  • DIABETIC
  • GLUTEN_FREE
  • HALAL
  • HINDU
  • KOSHER
  • LOW_CALORIE
  • LOW_FAT
  • LOW_LACTOSE
  • LOW_SALT
  • VEGAN
  • VEGETARIAN