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

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

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

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

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

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

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

הנחיות לקביעת ערך JSON

כפיית סוג

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

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

ערכי DateTime ושעה

הערך 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:

מאפיין (property) סוג תיאור
@type המשך

חובה.

ערך: 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:

מאפיין (property) סוג תיאור
@type המשך

חובה.

ערך: Deal
@id String

חובה.

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

דוגמה: FREEDELIVERY
dealCode String

חובה.

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

דוגמה: ADETRE23
applicableServiceType רשימה<ServiceType>

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

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

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

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

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

חובה.

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

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

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

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

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

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

חובה.

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

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

דוגמה: 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:

מאפיין (property) סוג תיאור
@type המשך

חובה.

ערך: 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

מתאר את האזור הגיאוגרפי שאליו אפשר לשלוח אוכל. הישות הזו נדרשת להטמיע אם הישות Service המשויכת serviceType מוגדרת כ-delivery (מסירה).

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

מאפיין (property) סוג תיאור
@type המשך

חובה.

ערך: ServiceArea
@id String

חובה.

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

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

חובה.

ערך @id של ישות השירות בקורלציה לישות הזו של ServiceArea.

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

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

דוגמה: 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

מציין את הרדיוס המשוער (במטרים) של אזור העיגול.

דוגמה: 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 מציינים את שעות הפתיחה והסגירה של המערכת הווירטואלית שמאפשרת למשתמשים לבצע הזמנות. בשעות האלה של המערכת אונליין, תוכלו להשתמש ב-ServiceHours כדי לציין את שעות הפתיחה והסגירה שבהן אפשר למלא את ההזמנות של המשתמשים.

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

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

מאפיין (property) סוג תיאור
@type המשך

חובה.

ערך: OperationHours
@id String

חובה.

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

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

חובה.

ערך ה- @id של ישות השירות בקורלציה לישות הזו של ActionHours.

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

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

דוגמה: T00:00
closes זמן ISO (מקומי)

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

דוגמה: T16:00
dayOfWeek רשימה<DayOfWeek>

רשימה של הימים בשבוע שבהם שעות הפעילות האלה תקפות. הערכים הקבילים הם "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY" ו-"SUNDAY".

דוגמה: [ "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 בוליאני

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

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

תאריך השינוי האחרון ושעת השינוי האחרון בפיד הישות ActionHours בפורמט חותמת זמן לפי 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.

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

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

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

מאפיין (property) סוג תיאור
@type המשך

חובה.

ערך: ServiceHours
@id String

חובה.

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

דוגמה: service_hour_1
orderType OrderType

חובה.

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

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

חובה.

ערך @id של ישות השירות בקורלציה לישות הזו של ServiceHours.

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

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

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

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

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

דוגמה: T00:00
closes זמן ISO (מקומי)

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

דוגמה: T16:00
dayOfWeek רשימה<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 בוליאני

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

דוגמה: False
leadTimeMin Integer

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

דוגמה: 60
leadTimeMax Integer

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

דוגמה: 70
advanceBookingRequirementMin Integer

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

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

דוגמה: 15
advanceBookingRequirementMax Integer

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

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

דוגמה: 10080
advanceBookingSlotInterval String

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

המרווח בין שני מועדים רצופים להזמנה מראש. לדוגמה: אם שעות הפתיחה והסגירה הן 08:00 ו-20:00 ומשך הזמן של PreBookingSlotInterval הוא 15 דקות, המשתמשים יכולים לבחור שעות מילוי הזמנות: 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
}

תשלום

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

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

מאפיין (property) סוג תיאור
@type המשך

חובה.

ערך: 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 מספר

עמלה מקסימלית, סכום העמלה המקסימלי הוא 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 במקום מחיר.

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

עמלה באחוזים מערך העגלה. הערכים הקבילים הם ערכים צפים בין 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:

מאפיין (property) סוג תיאור
@type המשך

חובה.

ערך: Menu
@id String

חובה.

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

דוגמה: menu_1
name String

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

דוגמה: Foo
disclaimer String

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

דוגמה: Items may contain peanuts.
disclaimerUrl כתובת URL

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

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

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

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

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

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

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

מאפיין (property) סוג תיאור
@type המשך

חובה.

ערך: 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 רשימה<ReverseReference>

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

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

דוגמה: [ { "@id": "parent_menu_item_id", "displayOrder": 4 } ]
parentMenuItemOptionId רשימה<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, אבל עם סוג String.

דוגמה: 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:

מאפיין (property) סוג תיאור
@type המשך

חובה.

ערך: Availability
@id String

חובה.

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

דוגמה: menu_section_avail_1
availabilityStarts זמן ISO (מקומי)

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

דוגמה: T00:00
availabilityEnds זמן ISO (מקומי)

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

דוגמה: T16:00
availableDay רשימה<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:

מאפיין (property) סוג תיאור
@type המשך

חובה.

ערך: MenuItem
@id String

חובה.

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

דוגמה: menu_item_1
name String

חובה.

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

דוגמה: Foo
description String

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

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

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

דוגמה: http://someprovider.com/someimage
parentMenuSectionId רשימה<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 רשימה<Allergen>

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

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

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

דוגמה: [ { "additiveName": "Sodium nitrite", "levelOfContainment": "CONTAINS" } ]
suitableDiet רשימה<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:

מאפיין (property) סוג תיאור
@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. לדוגמה, Small, medium או large. "אפשרות": כל שינוי מלבד גודל (למשל, מנה המוגשת כסלט או ככריך). אם לא ניתן להבחין בין "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>

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

דוגמה: { "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:

מאפיין (property) סוג תיאור
@type המשך

חובה.

ערך: 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 מספר

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

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

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

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

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

ערכי @id של 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:

מאפיין (property) סוג תיאור
@id String

חובה.

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

חובה.

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

NutritionInformation

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

מאפיין (property) סוג תיאור
description String

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

מספר הקלוריות בקלוריות, בקלוריות או בקילוג'אול, בפורמט הבא: ערך קלוריות או מינימום קלוריות

דוגמה: 120.34 Cal
sodiumContent String

מספר מ"ג או ג' של נתרן, בפורמט הבא: ערך g או מינימום-מקסימום g

דוגמה: 1200 mg

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

דוגמה

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

אלרגנים

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

מאפיין (property) סוג תיאור
allergenType AllergenType

חובה.

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

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

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

דוגמה

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

תוסף

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

מאפיין (property) סוג תיאור
additiveName String

חובה.

שם התוסף.
levelOfContainment ContainmentLevel

הרמה של כל תוסף נתון באפשרות בתפריט.

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

דוגמה

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

DepositInfo

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

מאפיין (property) סוג תיאור
depositCode DepositCode

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

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

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

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

דוגמה

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

ServingConfig

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

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

מאפיין (property) סוג תיאור
disableOrderInstructions בוליאני

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

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

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

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

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

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

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

דוגמה 1

{
  "disableMenuItemSpecialInstructions": true
}

דוגמה 2

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

דוגמה 3

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

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

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