- משאב: Menu
- פריט
- זמינות
- DaypartAvailability
- MenuScheduleAvailability
- סטטוס
- FulfillmentMethodAvailability
- ModifierGroupReference
- DefaultModifierSelection
- ModifierConstraints
- מגדיר
- ModifierGroup
- ModifierAction
- MenuCategory
- MenuLabel
- MenuSchedule
- Methods
מקור מידע: תפריט
מגדיר תפריט של מה שאפשר להזמין ממסעדה.
| ייצוג ב-JSON |
|---|
{ "name": string, "store": string, "displayName": string, "items": [ { object ( |
| שדות | |
|---|---|
name |
מזהה. שם התפריט. פורמט: projects/{project}/locations/{location}/menus/{menu} |
store |
זה שינוי אופציונלי. שם המשאב של החנות שהתפריט הזה משויך אליה. פורמט: projects/{project}/locations/{location}/brands/{brand}/stores/{store} |
displayName |
זה שינוי אופציונלי. שם תצוגה אופציונלי וקריא לאנשים של התפריט הזה בממשקי משתמש. |
items[] |
זה שינוי אופציונלי. הפריטים בתפריט הזה. |
modifiers[] |
זה שינוי אופציונלי. התאמות של פריטים בתפריט הזה. |
modifierGroups[] |
זה שינוי אופציונלי. קבוצות של משתנים בתפריט הזה. |
categories[] |
זה שינוי אופציונלי. קטגוריות התפריט בתפריט הזה. |
createTime |
פלט בלבד. השעה שבה התפריט נוצר. השימוש הוא ב-RFC 3339, שבו הפלט שנוצר תמיד יהיה מנורמל ל-Z וישתמש ב-0, 3, 6 או 9 ספרות אחרי הנקודה העשרונית. אפשר להשתמש גם בהיסטים אחרים, לא רק ב-Z. לדוגמה: |
updateTime |
פלט בלבד. השעה שבה התפריט עודכן לאחרונה. השימוש הוא ב-RFC 3339, שבו הפלט שנוצר תמיד יהיה מנורמל ל-Z וישתמש ב-0, 3, 6 או 9 ספרות אחרי הנקודה העשרונית. אפשר להשתמש גם בהיסטים אחרים, לא רק ב-Z. לדוגמה: |
labels[] |
זה שינוי אופציונלי. תוויות לתפריט הזה. |
menuSchedules[] |
זה שינוי אופציונלי. תזמון התפריטים בתפריט הזה. |
פריט
הפריט מייצג ישות של תפריט שתקפה רק כפריט ברמה העליונה בהזמנה. הפריט יכול לייצג מנה, משקה, שירות, מבצע או ארוחה משולבת שאפשר לשנות באמצעות אפשרויות שונות.
| ייצוג ב-JSON |
|---|
{ "id": string, "semanticName": string, "displayName": string, "categoryIds": [ string ], "description": string, "image": { object ( |
| שדות | |
|---|---|
id |
חובה. המזהה של הפריט הזה, ייחודי בתפריט. |
semanticName |
זה שינוי אופציונלי. שם קצר וקריא לאנשים שמזהה את הפריט הזה בצורה ברורה ומובחנת. הוא צריך להיות ייחודי ושונה משאר הפריטים בתפריט. |
displayName |
חובה. שם קריא לאנשים של הפריט הזה, שיוצג בממשקי המשתמש. |
categoryIds[] |
זה שינוי אופציונלי. הקטגוריה של הפריט. |
description |
זה שינוי אופציונלי. תיאור קריא לאנשים. |
image |
זה שינוי אופציונלי. התמונה שתוצג לפריט הזה בממשק המשתמש. |
availability |
זה שינוי אופציונלי. זמינות הפריט. |
basePrice |
זה שינוי אופציונלי. מחיר הבסיס של הפריט. מאפייני השינוי שנבחרו עשויים להשפיע על כך. |
integrationAttributes |
זה שינוי אופציונלי. מטא-נתונים שמשויכים לישות הזו ומשמשים לשילובים במורד הזרם. |
modifierGroups[] |
זה שינוי אופציונלי. הפניות לקבוצות של משני מנות שחלות על הפריט הזה. |
modifierConstraints |
זה שינוי אופציונלי. מגביל את השינויים שאפשר או שצריך להחיל על הפריט הזה בקבוצות השינויים שאליהן הוא משויך. |
זמינות
מגדיר את הזמינות של פריט או של משתנה.
| ייצוג ב-JSON |
|---|
{ "daypartAvailability": { object ( |
| שדות | |
|---|---|
daypartAvailability |
זה שינוי אופציונלי. מידע על הזמינות של הפריט הזה ברמת חלק היום. אם משמיטים את השדה, המערכת מתעלמת מהזמינות לפי חלקים ביום. |
menuScheduleAvailability |
זה שינוי אופציונלי. מידע על הזמינות של הפריט הזה ברמת לוח הזמנים של התפריט. אם משמיטים את השדה, המערכת מתעלמת מהזמינות שמבוססת על לוח הזמנים של התפריט. |
status |
זה שינוי אופציונלי. מציין סטטוס שמוביל לחוסר זמינות, או שהפריט זמין. אם משמיטים את המאפיין הזה, הפריט זמין כברירת מחדל. |
fulfillmentAvailability |
זה שינוי אופציונלי. שיטות המילוי שבהן אפשר לקבל את הפריט הזה. אם לא מציינים את המאפיין, הפריט זמין בכל שיטות המילוי. |
DaypartAvailability
מגביל את הזמינות של הישות הזו לחלקים מסוימים של היום.
| ייצוג ב-JSON |
|---|
{ "daypartIds": [ string ] } |
| שדות | |
|---|---|
daypartIds[] |
חובה. החלקים ביום שבהם הפריט זמין. |
MenuScheduleAvailability
מגבילה את הזמינות של הישות הזו ללוח הזמנים שצוין בתפריט.
| ייצוג ב-JSON |
|---|
{ "menuScheduleIds": [ string ] } |
| שדות | |
|---|---|
menuScheduleIds[] |
חובה. השעות שבהן הפריט זמין בתפריט. |
סטטוס
סטטוס הזמינות.
| טיפוסים בני מנייה (enum) | |
|---|---|
STATUS_UNSPECIFIED |
סטטוס לא תקין. הפעולה menus.create תיכשל אם לאחד מהפריטים או מהתוספות יש את הסטטוס הזה. |
STATUS_AVAILABLE |
מציין שהפריט זמין לרכישה. |
STATUS_UNAVAILABLE |
מציין שהפריט לא זמין מסיבות לא ברורות. |
STATUS_OUT_OF_STOCK |
הערך הזה מציין שהפריט חסר כרגע במלאי, אבל יכול להיות שיהיה זמין בעתיד הקרוב. |
STATUS_DISCONTINUED |
מציין שהייצור של הפריט הופסק, והוא לא יהיה זמין בעתיד הנראה לעין. |
FulfillmentMethodAvailability
מגביל את הזמינות של הישות הזו לשיטות מילוי הזמנות ספציפיות.
| ייצוג ב-JSON |
|---|
{
"fulfillmentMethods": [
enum ( |
| שדות | |
|---|---|
fulfillmentMethods[] |
חובה. שיטות המילוי שבהן הפריט הזה זמין. |
ModifierGroupReference
הפניה לקבוצת שינויים.
| ייצוג ב-JSON |
|---|
{
"id": string,
"defaultModifiers": [
{
object ( |
| שדות | |
|---|---|
id |
חובה. המזהה של קבוצת השינויים. |
defaultModifiers[] |
זה שינוי אופציונלי. קבוצת המגבילים שמוחלים כברירת מחדל. |
minSelectionCount |
זה שינוי אופציונלי. המספר המינימלי של מקשי צירוף שצריך לבחור מתוך ModifierGroup שאליו מתייחסים. אם הערך הזה מוגדר גם ב-ModifierGroupReference וגם ב-ModifierGroup, שתי ההגבלות נאכפות. אם לא מגדירים את המאפיין, אין מינימום. |
maxSelectionCount |
זה שינוי אופציונלי. המספר המקסימלי של שינויים שאפשר לבחור מהקבוצה שאליה מתייחסים. אם הערך הזה מוגדר גם ב-ModifierGroupReference וגם ב-ModifierGroup, שתי ההגבלות נאכפות. אם המדיניות לא מוגדרת, אין מספר מקסימלי של תווים. |
DefaultModifierSelection
מציין את בחירת ברירת המחדל של מאפיין שינוי בתוך ModifierGroup.
| ייצוג ב-JSON |
|---|
{ "id": string, "quantity": integer } |
| שדות | |
|---|---|
id |
חובה. מזהה המשתנה. |
quantity |
זה שינוי אופציונלי. כמות השינויים שצריך להחיל. אם משמיטים את הפרמטר הזה, המערכת מתייחסת לקובץ העזר כאילו הכמות שלו היא 1. |
ModifierConstraints
מגבילה את השינויים שאפשר או שחייבים להחיל על ישות בקבוצות ModifierGroups שאליהן מפנים.
| ייצוג ב-JSON |
|---|
{ "minQuantity": integer, "maxQuantity": integer } |
| שדות | |
|---|---|
minQuantity |
זה שינוי אופציונלי. המספר המינימלי של מקשי הצירוף שצריך להחיל על ModifierGroups שאליהן מפנים ישירות. אם לא מציינים ערך, לא נאכף ערך מינימלי. |
maxQuantity |
זה שינוי אופציונלי. המספר המקסימלי של משתנים שאפשר להחיל על קבוצות משתנים (ModifierGroups) שמפנים אליהן ישירות. אם לא מציינים ערך, לא נאכף מספר מקסימלי. |
הרחבה
מגדיר אפשרויות לשינוי פריטים או משתנים אחרים, באמצעות קשרים שמוגדרים על ידי ModifierGroup.
| ייצוג ב-JSON |
|---|
{ "id": string, "displayName": string, "description": string, "image": { object ( |
| שדות | |
|---|---|
id |
חובה. המזהה של השינוי הזה, ייחודי בתפריט. |
displayName |
חובה. שם קריא לאנשים של הפריט הזה, שיוצג בממשקי המשתמש. |
description |
זה שינוי אופציונלי. תיאור קריא לאנשים. |
image |
זה שינוי אופציונלי. התמונה שתוצג לפריט הזה בממשק המשתמש. |
semanticName |
זה שינוי אופציונלי. שם קצר וקריא לאנשים שמזהה בבירור את המגדיר הזה. הוא צריך להיות ייחודי בין כל השינויים בקבוצות השינויים שבהן השינוי הזה קיים. |
categoryIds[] |
זה שינוי אופציונלי. הקטגוריה של מאפיין השינוי. |
availability |
זה שינוי אופציונלי. הזמינות של השינוי הזה. |
priceAdjustment |
זה שינוי אופציונלי. התאמה מצטברת שחלה על המחיר של הפריט ברמה העליונה כשבוחרים את המגדיר הזה. אם השינוי לא משפיע על המחיר, משאירים את השדה ריק. |
integrationAttributes |
זה שינוי אופציונלי. מטא-נתונים שמשויכים לישות הזו ומשמשים לשילובים במורד הזרם. |
modifierGroups[] |
זה שינוי אופציונלי. הפניות לקבוצות של משני מחיר שחלות על משנה המחיר הזה. |
modifierConstraints |
זה שינוי אופציונלי. מגביל את השינויים שאפשר או שצריך להחיל על השינוי הזה בקבוצות השינויים שאליהן הוא משויך. |
ModifierGroup
מגדירה קבוצה של מאפייני שינוי שאפשר לבחור מתוכם.
| ייצוג ב-JSON |
|---|
{ "id": string, "displayName": string, "semanticName": string, "modifierIds": [ string ], "modifierActions": [ { object ( |
| שדות | |
|---|---|
id |
חובה. המזהה של קבוצת השינויים הזו, ייחודי בתפריט שלה. |
displayName |
חובה. שם קבוצת השינויים – לדוגמה, "תוספות (כריך)" או "תוספת לארוחה בינונית". |
semanticName |
זה שינוי אופציונלי. שם קבוצת השינויים – לדוגמה, "תוספות (כריך)" או "תוספת לארוחה". |
modifierIds[] |
חובה. המזהים של השינויים ששייכים לקבוצה הזו. |
modifierActions[] |
זה שינוי אופציונלי. הפעולות שאפשר לבצע על השינויים בקבוצה הזו. |
minSelectionCount |
זה שינוי אופציונלי. המספר המינימלי של משתנים מהקבוצה שאליה מתייחסים שצריך לבחור כדי שהפריט יהיה תקין. אם לא מגדירים את המאפיין, אין מינימום. בקבוצה שבה נדרשת בחירה אחת בדיוק, הערך צריך להיות 1. |
maxSelectionCount |
זה שינוי אופציונלי. המספר המקסימלי של שינויים שאפשר לבחור מהקבוצה שאליה מתייחסים. אם המדיניות לא מוגדרת, אין מספר מקסימלי של תווים. בקבוצה שבה נדרשת בחירה אחת בדיוק, הערך צריך להיות 1. |
maxSelectionCountPerModifier |
זה שינוי אופציונלי. מגבילה את מספר הפעמים שאפשר להחיל כל משתנה בקבוצה הזו. אם לא מגדירים את המדיניות, ברירת המחדל היא 1. |
integrationAttributes |
זה שינוי אופציונלי. מטא-נתונים שמשויכים לישות הזו ומשמשים לשילובים במורד הזרם. |
ModifierAction
מגדיר פעולה שאפשר לבצע על משתנים.
| ייצוג ב-JSON |
|---|
{ "name": string } |
| שדות | |
|---|---|
name |
חובה. שם הפעולה של השינוי – למשל, "בלי", "תוספת", "הוספה", "אקסטרה". |
MenuCategory
מגדיר קטגוריה שמכילה פריטים או משתנים. הקטגוריות משמשות לארגון פריטים בממשקי משתמש ולקבץ אותם לפי משמעות כדי שהנציג יבין אותם.
| ייצוג ב-JSON |
|---|
{ "id": string, "displayName": string, "description": string, "parentId": string } |
| שדות | |
|---|---|
id |
חובה. המזהה של קטגוריית התפריט הזו, ייחודי בתפריט. |
displayName |
זה שינוי אופציונלי. שם קריא לאנשים של קטגוריית התפריט הזו, לשימוש בממשקי משתמש. |
description |
זה שינוי אופציונלי. תיאור קריא לאנשים. |
parentId |
זה שינוי אופציונלי. מזהה הקטגוריה של התפריט הראשי. אם השדה ריק, זו קטגוריה ברמה העליונה. |
MenuLabel
תוויות מחרוזת לתיאור תפריט בממשקי משתמש.
| ייצוג ב-JSON |
|---|
{ "name": string } |
| שדות | |
|---|---|
name |
חובה. שם התווית. |
MenuSchedule
הגדרת לוח הזמנים של התפריט לפריטים ולמשתנים.
| ייצוג ב-JSON |
|---|
{
"id": string,
"schedules": [
{
object ( |
| שדות | |
|---|---|
id |
זה שינוי אופציונלי. מזהה לוח הזמנים, למשל "BREAKFAST", "LUNCH" וכו'. |
schedules[] |
זה שינוי אופציונלי. תזמון שעות פעילות. |
displayName |
זה שינוי אופציונלי. מציין שם אופציונלי לתצוגה של לוח הזמנים הזה. |
Methods |
|
|---|---|
|
יצירת תפריט. |
|
מחיקת התפריט שצוין. |
|
מקבל תפריט. |
|
רשימת התפריטים. |