REST Resource: projects.locations.menus

פריט

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

ייצוג ב-JSON
{
  "id": string,
  "semanticName": string,
  "displayName": string,
  "categoryIds": [
    string
  ],
  "description": string,
  "image": {
    object (Image)
  },
  "availability": {
    object (Availability)
  },
  "basePrice": {
    object (Money)
  },
  "integrationAttributes": {
    object (ItemIntegrationAttributes)
  },
  "modifierGroups": [
    {
      object (ModifierGroupReference)
    }
  ],
  "modifierConstraints": {
    object (ModifierConstraints)
  }
}
שדות
id

string

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

semanticName

string

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

displayName

string

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

categoryIds[]

string

זה שינוי אופציונלי. הקטגוריה של הפריט.

description

string

זה שינוי אופציונלי. תיאור קריא לאנשים.

image

object (Image)

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

availability

object (Availability)

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

basePrice

object (Money)

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

integrationAttributes

object (ItemIntegrationAttributes)

זה שינוי אופציונלי. מטא-נתונים שמשויכים לישות הזו ומשמשים לשילובים במורד הזרם.

modifierGroups[]

object (ModifierGroupReference)

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

modifierConstraints

object (ModifierConstraints)

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

זמינות

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

ייצוג ב-JSON
{
  "daypartAvailability": {
    object (DaypartAvailability)
  },
  "menuScheduleAvailability": {
    object (MenuScheduleAvailability)
  },
  "status": enum (Status),
  "fulfillmentAvailability": {
    object (FulfillmentMethodAvailability)
  }
}
שדות
daypartAvailability

object (DaypartAvailability)

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

menuScheduleAvailability

object (MenuScheduleAvailability)

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

status

enum (Status)

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

fulfillmentAvailability

object (FulfillmentMethodAvailability)

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

DaypartAvailability

מגביל את הזמינות של הישות הזו לחלקים מסוימים של היום.

ייצוג ב-JSON
{
  "daypartIds": [
    string
  ]
}
שדות
daypartIds[]

string

חובה. החלקים ביום שבהם הפריט זמין.

סטטוס

סטטוס הזמינות.

טיפוסים בני מנייה (enum)
STATUS_UNSPECIFIED סטטוס לא תקין. הפעולה menus.create תיכשל אם לאחד מהפריטים או מהתוספות יש את הסטטוס הזה.
STATUS_AVAILABLE מציין שהפריט זמין לרכישה.
STATUS_UNAVAILABLE מציין שהפריט לא זמין מסיבות לא ברורות.
STATUS_OUT_OF_STOCK הערך הזה מציין שהפריט חסר כרגע במלאי, אבל יכול להיות שיהיה זמין בעתיד הקרוב.
STATUS_DISCONTINUED מציין שהייצור של הפריט הופסק, והוא לא יהיה זמין בעתיד הנראה לעין.

FulfillmentMethodAvailability

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

ייצוג ב-JSON
{
  "fulfillmentMethods": [
    enum (FulfillmentMethod)
  ]
}
שדות
fulfillmentMethods[]

enum (FulfillmentMethod)

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

ModifierGroupReference

הפניה לקבוצת שינויים.

ייצוג ב-JSON
{
  "id": string,
  "defaultModifiers": [
    {
      object (DefaultModifierSelection)
    }
  ],
  "minSelectionCount": integer,
  "maxSelectionCount": integer
}
שדות
id

string

חובה. המזהה של קבוצת השינויים.

defaultModifiers[]

object (DefaultModifierSelection)

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

minSelectionCount

integer

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

maxSelectionCount

integer

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

DefaultModifierSelection

מציין את בחירת ברירת המחדל של מאפיין שינוי בתוך ModifierGroup.

ייצוג ב-JSON
{
  "id": string,
  "quantity": integer
}
שדות
id

string

חובה. מזהה המשתנה.

quantity

integer

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

ModifierConstraints

מגבילה את השינויים שאפשר או שחייבים להחיל על ישות בקבוצות ModifierGroups שאליהן מפנים.

ייצוג ב-JSON
{
  "minQuantity": integer,
  "maxQuantity": integer
}
שדות
minQuantity

integer

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

maxQuantity

integer

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

הרחבה

מגדיר אפשרויות לשינוי פריטים או משתנים אחרים, באמצעות קשרים שמוגדרים על ידי ModifierGroup.

ייצוג ב-JSON
{
  "id": string,
  "displayName": string,
  "description": string,
  "image": {
    object (Image)
  },
  "semanticName": string,
  "categoryIds": [
    string
  ],
  "availability": {
    object (Availability)
  },
  "priceAdjustment": {
    object (Money)
  },
  "integrationAttributes": {
    object (ModifierIntegrationAttributes)
  },
  "modifierGroups": [
    {
      object (ModifierGroupReference)
    }
  ],
  "modifierConstraints": {
    object (ModifierConstraints)
  }
}
שדות
id

string

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

displayName

string

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

description

string

זה שינוי אופציונלי. תיאור קריא לאנשים.

image

object (Image)

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

semanticName

string

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

categoryIds[]

string

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

availability

object (Availability)

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

priceAdjustment

object (Money)

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

integrationAttributes

object (ModifierIntegrationAttributes)

זה שינוי אופציונלי. מטא-נתונים שמשויכים לישות הזו ומשמשים לשילובים במורד הזרם.

modifierGroups[]

object (ModifierGroupReference)

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

modifierConstraints

object (ModifierConstraints)

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

ModifierGroup

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

ייצוג ב-JSON
{
  "id": string,
  "displayName": string,
  "semanticName": string,
  "modifierIds": [
    string
  ],
  "modifierActions": [
    {
      object (ModifierAction)
    }
  ],
  "minSelectionCount": integer,
  "maxSelectionCount": integer,
  "maxSelectionCountPerModifier": integer,
  "integrationAttributes": {
    object (ModifierGroupIntegrationAttributes)
  }
}
שדות
id

string

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

displayName

string

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

semanticName

string

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

modifierIds[]

string

חובה. המזהים של השינויים ששייכים לקבוצה הזו.

modifierActions[]

object (ModifierAction)

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

minSelectionCount

integer

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

maxSelectionCount

integer

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

maxSelectionCountPerModifier

integer

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

integrationAttributes

object (ModifierGroupIntegrationAttributes)

זה שינוי אופציונלי. מטא-נתונים שמשויכים לישות הזו ומשמשים לשילובים במורד הזרם.

ModifierAction

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

ייצוג ב-JSON
{
  "name": string
}
שדות
name

string

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

Methods

create

יצירת תפריט.

delete

מחיקת התפריט שצוין.

get

מקבל תפריט.

list

רשימת התפריטים.