רשימת התפריטים.
בקשת HTTP
GET https://foodorderingaiagent.googleapis.com/v1beta/{parent=projects/*/locations/*}/menus
כתובת ה-URL כתובה בתחביר של gRPC Transcoding.
פרמטרים של הנתיב
| פרמטרים | |
|---|---|
parent |
חובה. ההורה, שהוא הבעלים של אוסף התפריטים הזה. פורמט: projects/{project}/locations/{location} |
פרמטרים של שאילתה
| פרמטרים | |
|---|---|
pageSize |
זה שינוי אופציונלי. המספר המקסימלי של תפריטים שיוחזרו. יכול להיות שהשירות יחזיר פחות מהערך הזה. |
pageToken |
זה שינוי אופציונלי. טוקן של דף שהתקבל מקריאה קודמת של |
filter |
זה שינוי אופציונלי. ביטוי לסינון התוצאות. תחביר הביטוי מתועד בכתובת https://google.aip.dev/160. השדות הבאים נתמכים: -
|
view |
זה שינוי אופציונלי. התצוגה שתוחזר לתפריטים. |
גוף הבקשה
גוף הבקשה צריך להיות ריק.
גוף התשובה
הודעת התשובה של MenuService.ListMenus.
אם הפעולה מצליחה, גוף התשובה מכיל נתונים במבנה הבא:
| ייצוג ב-JSON |
|---|
{
"menus": [
{
object ( |
| שדות | |
|---|---|
menus[] |
התפריטים מהאוסף שצוין. |
nextPageToken |
טוקן שאפשר לשלוח כ- |
היקפי הרשאות
נדרש היקף ההרשאות הבא של OAuth:
https://www.googleapis.com/auth/cloud-platform
ניתן למצוא מידע נוסף כאן: Authentication Overview.
MenuView
מציינת את רמת הפירוט של התפריטים שיוחזרו.
| טיפוסים בני מנייה (enum) | |
|---|---|
MENU_VIEW_UNSPECIFIED |
ערך ברירת המחדל / ערך שלא הוגדר. כברירת מחדל, ה-API יציג את התצוגה המלאה (FULL). |
MENU_VIEW_BASIC |
לכלול מטא-נתונים בסיסיים על התפריט. |
MENU_VIEW_NAME_ONLY |
לכלול רק את שם התפריט |
MENU_VIEW_FULL |
לכלול את כל הפרטים. זה ערך ברירת המחדל. |