Package google.cloud.foodorderingaiagent.v1beta

אינדקס

EvaluationRunService

‫EvaluationRunService מספק API להרצת מקרי הערכה.

RunEvaluationCase

rpc RunEvaluationCase(RunEvaluationCaseRequest) returns (Operation)

מריץ מקרה הערכה.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/cloud-platform

ניתן למצוא מידע נוסף כאן: Authentication Overview.

RunEvaluationDataset

rpc RunEvaluationDataset(RunEvaluationDatasetRequest) returns (Operation)

מריץ מערך נתונים להערכה.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/cloud-platform

ניתן למצוא מידע נוסף כאן: Authentication Overview.

FoodOrderingService

‫FoodOrderingService מספק API לסוכנים של הזמנה ממסעדה.

BidiProcessOrder

rpc BidiProcessOrder(BidiProcessOrderRequest) returns (BidiProcessOrderResponse)

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

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/cloud-platform

ניתן למצוא מידע נוסף כאן: Authentication Overview.

ProcessOrder

rpc ProcessOrder(ProcessOrderRequest) returns (ProcessOrderResponse)

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

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/cloud-platform

ניתן למצוא מידע נוסף כאן: Authentication Overview.

‫MenuService מספק ממשקי API לניהול משאבים שקשורים למותג, לחנות ולתפריט.

AppendIngestionPhase

rpc AppendIngestionPhase(AppendIngestionPhaseRequest) returns (IngestionLog)

הוספת שלב הטמעה ליומן הטמעה.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/cloud-platform

ניתן למצוא מידע נוסף כאן: Authentication Overview.

BatchCreateEvaluationCases

rpc BatchCreateEvaluationCases(BatchCreateEvaluationCasesRequest) returns (BatchCreateEvaluationCasesResponse)

יצירת EvaluationCases באצווה.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/cloud-platform

ניתן למצוא מידע נוסף כאן: Authentication Overview.

BatchDeleteStores

rpc BatchDeleteStores(BatchDeleteStoresRequest) returns (Empty)

מחיקה של חנויות בכמות גדולה.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/cloud-platform

ניתן למצוא מידע נוסף כאן: Authentication Overview.

BatchGetMenuEntities

rpc BatchGetMenuEntities(BatchGetMenuEntitiesRequest) returns (BatchGetMenuEntitiesResponse)

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

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/cloud-platform

ניתן למצוא מידע נוסף כאן: Authentication Overview.

BatchUpdateEvaluationCases

rpc BatchUpdateEvaluationCases(BatchUpdateEvaluationCasesRequest) returns (BatchUpdateEvaluationCasesResponse)

חבילת עדכונים של EvaluationCases.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/cloud-platform

ניתן למצוא מידע נוסף כאן: Authentication Overview.

BatchUpdateStores

rpc BatchUpdateStores(BatchUpdateStoresRequest) returns (BatchUpdateStoresResponse)

חבילת עדכונים מאגרים.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/cloud-platform

ניתן למצוא מידע נוסף כאן: Authentication Overview.

ComputeAnalyticsMetrics

rpc ComputeAnalyticsMetrics(ComputeAnalyticsMetricsRequest) returns (ComputeAnalyticsMetricsResponse)

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

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/cloud-platform

ניתן למצוא מידע נוסף כאן: Authentication Overview.

CreateBrand

rpc CreateBrand(CreateBrandRequest) returns (Brand)

יוצרת מותג.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/cloud-platform

ניתן למצוא מידע נוסף כאן: Authentication Overview.

CreateChannelConfig

rpc CreateChannelConfig(CreateChannelConfigRequest) returns (ChannelConfig)

יוצר ChannelConfig.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/cloud-platform

ניתן למצוא מידע נוסף כאן: Authentication Overview.

CreateConfigApplicationRule

rpc CreateConfigApplicationRule(CreateConfigApplicationRuleRequest) returns (ConfigApplicationRule)

יצירת ConfigApplicationRule.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/cloud-platform

ניתן למצוא מידע נוסף כאן: Authentication Overview.

CreateDiscount

rpc CreateDiscount(CreateDiscountRequest) returns (Discount)

יוצרת הנחה.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/cloud-platform

ניתן למצוא מידע נוסף כאן: Authentication Overview.

CreateEvaluationCase

rpc CreateEvaluationCase(CreateEvaluationCaseRequest) returns (EvaluationCase)

יוצרת EvaluationCase.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/cloud-platform

ניתן למצוא מידע נוסף כאן: Authentication Overview.

CreateEvaluationContext

rpc CreateEvaluationContext(CreateEvaluationContextRequest) returns (EvaluationContext)

יוצר EvaluationContext.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/cloud-platform

ניתן למצוא מידע נוסף כאן: Authentication Overview.

CreateEvaluationDataset

rpc CreateEvaluationDataset(CreateEvaluationDatasetRequest) returns (EvaluationDataset)

יוצרת EvaluationDataset.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/cloud-platform

ניתן למצוא מידע נוסף כאן: Authentication Overview.

CreateEvaluationMatcher

rpc CreateEvaluationMatcher(CreateEvaluationMatcherRequest) returns (EvaluationMatcher)

יוצרת EvaluationMatcher.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/cloud-platform

ניתן למצוא מידע נוסף כאן: Authentication Overview.

CreateIngestionLog

rpc CreateIngestionLog(CreateIngestionLogRequest) returns (IngestionLog)

יוצרת יומן הטמעה.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/cloud-platform

ניתן למצוא מידע נוסף כאן: Authentication Overview.

CreateInventory

rpc CreateInventory(CreateInventoryRequest) returns (Inventory)

יצירת מלאי.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/cloud-platform

ניתן למצוא מידע נוסף כאן: Authentication Overview.

CreateMenu

rpc CreateMenu(CreateMenuRequest) returns (Menu)

יצירת תפריט.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/cloud-platform

ניתן למצוא מידע נוסף כאן: Authentication Overview.

CreateStore

rpc CreateStore(CreateStoreRequest) returns (Store)

יוצר חנות.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/cloud-platform

ניתן למצוא מידע נוסף כאן: Authentication Overview.

DeleteBrand

rpc DeleteBrand(DeleteBrandRequest) returns (Empty)

מוחקת את המותג שצוין.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/cloud-platform

ניתן למצוא מידע נוסף כאן: Authentication Overview.

DeleteBrandRevision

rpc DeleteBrandRevision(DeleteBrandRevisionRequest) returns (Empty)

מחיקת ה-BrandRevision שצוין.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/cloud-platform

ניתן למצוא מידע נוסף כאן: Authentication Overview.

DeleteChannelConfig

rpc DeleteChannelConfig(DeleteChannelConfigRequest) returns (Empty)

מחיקת ה-ChannelConfig שצוין.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/cloud-platform

ניתן למצוא מידע נוסף כאן: Authentication Overview.

DeleteChannelConfigRevision

rpc DeleteChannelConfigRevision(DeleteChannelConfigRevisionRequest) returns (Empty)

מוחק את ה-ChannelConfigRevision שצוין.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/cloud-platform

ניתן למצוא מידע נוסף כאן: Authentication Overview.

DeleteConfigApplicationRule

rpc DeleteConfigApplicationRule(DeleteConfigApplicationRuleRequest) returns (Empty)

מחיקת ה-ConfigApplicationRule שצוין.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/cloud-platform

ניתן למצוא מידע נוסף כאן: Authentication Overview.

DeleteConfigApplicationRuleRevision

rpc DeleteConfigApplicationRuleRevision(DeleteConfigApplicationRuleRevisionRequest) returns (Empty)

מחיקת ה-ConfigApplicationRuleRevision שצוין.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/cloud-platform

ניתן למצוא מידע נוסף כאן: Authentication Overview.

DeleteDiscount

rpc DeleteDiscount(DeleteDiscountRequest) returns (Empty)

מחיקת ההנחה שצוינה.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/cloud-platform

ניתן למצוא מידע נוסף כאן: Authentication Overview.

DeleteEvaluationCase

rpc DeleteEvaluationCase(DeleteEvaluationCaseRequest) returns (Empty)

מחיקת ה-EvaluationCase שצוין.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/cloud-platform

ניתן למצוא מידע נוסף כאן: Authentication Overview.

DeleteEvaluationCaseResult

rpc DeleteEvaluationCaseResult(DeleteEvaluationCaseResultRequest) returns (Empty)

מחיקת ה-EvaluationCaseResult שצוין.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/cloud-platform

ניתן למצוא מידע נוסף כאן: Authentication Overview.

DeleteEvaluationContext

rpc DeleteEvaluationContext(DeleteEvaluationContextRequest) returns (Empty)

מחיקת ה-EvaluationContext שצוין.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/cloud-platform

ניתן למצוא מידע נוסף כאן: Authentication Overview.

DeleteEvaluationDataset

rpc DeleteEvaluationDataset(DeleteEvaluationDatasetRequest) returns (Empty)

מחיקת ה-EvaluationDataset שצוין.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/cloud-platform

ניתן למצוא מידע נוסף כאן: Authentication Overview.

DeleteEvaluationDatasetResult

rpc DeleteEvaluationDatasetResult(DeleteEvaluationDatasetResultRequest) returns (Empty)

מחיקת ה-EvaluationDatasetResult שצוין.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/cloud-platform

ניתן למצוא מידע נוסף כאן: Authentication Overview.

DeleteEvaluationMatcher

rpc DeleteEvaluationMatcher(DeleteEvaluationMatcherRequest) returns (Empty)

מחיקת ה-EvaluationMatcher שצוין.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/cloud-platform

ניתן למצוא מידע נוסף כאן: Authentication Overview.

DeleteIngestionLog

rpc DeleteIngestionLog(DeleteIngestionLogRequest) returns (Empty)

מחיקה של יומן ההטמעה שצוין.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/cloud-platform

ניתן למצוא מידע נוסף כאן: Authentication Overview.

DeleteInventory

rpc DeleteInventory(DeleteInventoryRequest) returns (Empty)

מחיקת המלאי שצוין.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/cloud-platform

ניתן למצוא מידע נוסף כאן: Authentication Overview.

DeleteMenu

rpc DeleteMenu(DeleteMenuRequest) returns (Empty)

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

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/cloud-platform

ניתן למצוא מידע נוסף כאן: Authentication Overview.

DeleteSessionRecord

rpc DeleteSessionRecord(DeleteSessionRecordRequest) returns (Empty)

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

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/cloud-platform

ניתן למצוא מידע נוסף כאן: Authentication Overview.

DeleteStore

rpc DeleteStore(DeleteStoreRequest) returns (Empty)

מחיקת החנות שצוינה.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/cloud-platform

ניתן למצוא מידע נוסף כאן: Authentication Overview.

DeleteStoreRevision

rpc DeleteStoreRevision(DeleteStoreRevisionRequest) returns (Empty)

מוחקת את ה-StoreRevision שצוין.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/cloud-platform

ניתן למצוא מידע נוסף כאן: Authentication Overview.

GetBrand

rpc GetBrand(GetBrandRequest) returns (Brand)

מקבל מותג.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/cloud-platform

ניתן למצוא מידע נוסף כאן: Authentication Overview.

GetBrandRevision

rpc GetBrandRevision(GetBrandRevisionRequest) returns (BrandRevision)

מקבל BrandRevision.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/cloud-platform

ניתן למצוא מידע נוסף כאן: Authentication Overview.

GetChannelConfig

rpc GetChannelConfig(GetChannelConfigRequest) returns (ChannelConfig)

מקבל ChannelConfig.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/cloud-platform

ניתן למצוא מידע נוסף כאן: Authentication Overview.

GetChannelConfigRevision

rpc GetChannelConfigRevision(GetChannelConfigRevisionRequest) returns (ChannelConfigRevision)

מקבל ChannelConfigRevision.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/cloud-platform

ניתן למצוא מידע נוסף כאן: Authentication Overview.

GetConfigApplicationRule

rpc GetConfigApplicationRule(GetConfigApplicationRuleRequest) returns (ConfigApplicationRule)

אחזור של ConfigApplicationRule.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/cloud-platform

ניתן למצוא מידע נוסף כאן: Authentication Overview.

GetConfigApplicationRuleRevision

rpc GetConfigApplicationRuleRevision(GetConfigApplicationRuleRevisionRequest) returns (ConfigApplicationRuleRevision)

אחזור של ConfigApplicationRuleRevision.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/cloud-platform

ניתן למצוא מידע נוסף כאן: Authentication Overview.

GetDiscount

rpc GetDiscount(GetDiscountRequest) returns (Discount)

מקבלים הנחה.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/cloud-platform

ניתן למצוא מידע נוסף כאן: Authentication Overview.

GetEvaluationCase

rpc GetEvaluationCase(GetEvaluationCaseRequest) returns (EvaluationCase)

מקבל EvaluationCase.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/cloud-platform

ניתן למצוא מידע נוסף כאן: Authentication Overview.

GetEvaluationCaseResult

rpc GetEvaluationCaseResult(GetEvaluationCaseResultRequest) returns (EvaluationCaseResult)

מקבל EvaluationCaseResult.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/cloud-platform

ניתן למצוא מידע נוסף כאן: Authentication Overview.

GetEvaluationContext

rpc GetEvaluationContext(GetEvaluationContextRequest) returns (EvaluationContext)

מקבל EvaluationContext.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/cloud-platform

ניתן למצוא מידע נוסף כאן: Authentication Overview.

GetEvaluationDataset

rpc GetEvaluationDataset(GetEvaluationDatasetRequest) returns (EvaluationDataset)

מקבל EvaluationDataset.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/cloud-platform

ניתן למצוא מידע נוסף כאן: Authentication Overview.

GetEvaluationDatasetResult

rpc GetEvaluationDatasetResult(GetEvaluationDatasetResultRequest) returns (EvaluationDatasetResult)

מקבל EvaluationDatasetResult.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/cloud-platform

ניתן למצוא מידע נוסף כאן: Authentication Overview.

GetEvaluationMatcher

rpc GetEvaluationMatcher(GetEvaluationMatcherRequest) returns (EvaluationMatcher)

מקבל EvaluationMatcher.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/cloud-platform

ניתן למצוא מידע נוסף כאן: Authentication Overview.

GetIngestionLog

rpc GetIngestionLog(GetIngestionLogRequest) returns (IngestionLog)

אחזור של יומן הטמעה.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/cloud-platform

ניתן למצוא מידע נוסף כאן: Authentication Overview.

GetInventory

rpc GetInventory(GetInventoryRequest) returns (Inventory)

אחזור מלאי.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/cloud-platform

ניתן למצוא מידע נוסף כאן: Authentication Overview.

GetMenu

rpc GetMenu(GetMenuRequest) returns (Menu)

מקבל תפריט.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/cloud-platform

ניתן למצוא מידע נוסף כאן: Authentication Overview.

GetSessionRecord

rpc GetSessionRecord(GetSessionRecordRequest) returns (SessionRecord)

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

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/cloud-platform

ניתן למצוא מידע נוסף כאן: Authentication Overview.

GetStore

rpc GetStore(GetStoreRequest) returns (Store)

מקבל חנות.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/cloud-platform

ניתן למצוא מידע נוסף כאן: Authentication Overview.

GetStoreRevision

rpc GetStoreRevision(GetStoreRevisionRequest) returns (StoreRevision)

מקבל StoreRevision.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/cloud-platform

ניתן למצוא מידע נוסף כאן: Authentication Overview.

ListBrandHistory

rpc ListBrandHistory(ListBrandHistoryRequest) returns (ListBrandHistoryResponse)

הצגת רשומות ההיסטוריה של מותג.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/cloud-platform

ניתן למצוא מידע נוסף כאן: Authentication Overview.

ListBrandRevisions

rpc ListBrandRevisions(ListBrandRevisionsRequest) returns (ListBrandRevisionsResponse)

הצגת רשימה של BrandRevisions.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/cloud-platform

ניתן למצוא מידע נוסף כאן: Authentication Overview.

ListBrands

rpc ListBrands(ListBrandsRequest) returns (ListBrandsResponse)

רשימת מותגים.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/cloud-platform

ניתן למצוא מידע נוסף כאן: Authentication Overview.

ListChannelConfigRevisions

rpc ListChannelConfigRevisions(ListChannelConfigRevisionsRequest) returns (ListChannelConfigRevisionsResponse)

מציג רשימה של ChannelConfigRevisions.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/cloud-platform

ניתן למצוא מידע נוסף כאן: Authentication Overview.

ListChannelConfigs

rpc ListChannelConfigs(ListChannelConfigsRequest) returns (ListChannelConfigsResponse)

הצגת רשימה של ChannelConfigs.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/cloud-platform

ניתן למצוא מידע נוסף כאן: Authentication Overview.

ListConfigApplicationRuleRevisions

rpc ListConfigApplicationRuleRevisions(ListConfigApplicationRuleRevisionsRequest) returns (ListConfigApplicationRuleRevisionsResponse)

הצגת רשימה של ConfigApplicationRuleRevisions.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/cloud-platform

ניתן למצוא מידע נוסף כאן: Authentication Overview.

ListConfigApplicationRules

rpc ListConfigApplicationRules(ListConfigApplicationRulesRequest) returns (ListConfigApplicationRulesResponse)

הצגת רשימה של ConfigApplicationRules.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/cloud-platform

ניתן למצוא מידע נוסף כאן: Authentication Overview.

ListDiscounts

rpc ListDiscounts(ListDiscountsRequest) returns (ListDiscountsResponse)

רשימת הנחות.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/cloud-platform

ניתן למצוא מידע נוסף כאן: Authentication Overview.

ListEvaluationCaseResults

rpc ListEvaluationCaseResults(ListEvaluationCaseResultsRequest) returns (ListEvaluationCaseResultsResponse)

הצגת רשימה של EvaluationCaseResults.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/cloud-platform

ניתן למצוא מידע נוסף כאן: Authentication Overview.

ListEvaluationCases

rpc ListEvaluationCases(ListEvaluationCasesRequest) returns (ListEvaluationCasesResponse)

הצגת רשימה של EvaluationCases.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/cloud-platform

ניתן למצוא מידע נוסף כאן: Authentication Overview.

ListEvaluationContexts

rpc ListEvaluationContexts(ListEvaluationContextsRequest) returns (ListEvaluationContextsResponse)

הצגת רשימה של EvaluationContexts.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/cloud-platform

ניתן למצוא מידע נוסף כאן: Authentication Overview.

ListEvaluationDatasetResults

rpc ListEvaluationDatasetResults(ListEvaluationDatasetResultsRequest) returns (ListEvaluationDatasetResultsResponse)

הצגת רשימה של EvaluationDatasetResults.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/cloud-platform

ניתן למצוא מידע נוסף כאן: Authentication Overview.

ListEvaluationDatasets

rpc ListEvaluationDatasets(ListEvaluationDatasetsRequest) returns (ListEvaluationDatasetsResponse)

הצגת רשימה של EvaluationDatasets.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/cloud-platform

ניתן למצוא מידע נוסף כאן: Authentication Overview.

ListEvaluationMatchers

rpc ListEvaluationMatchers(ListEvaluationMatchersRequest) returns (ListEvaluationMatchersResponse)

הצגת רשימה של EvaluationMatchers.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/cloud-platform

ניתן למצוא מידע נוסף כאן: Authentication Overview.

ListIngestionLogs

rpc ListIngestionLogs(ListIngestionLogsRequest) returns (ListIngestionLogsResponse)

הצגת רשימה של יומני הטמעה.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/cloud-platform

ניתן למצוא מידע נוסף כאן: Authentication Overview.

ListInventories

rpc ListInventories(ListInventoriesRequest) returns (ListInventoriesResponse)

הצגת רשימה של מלאי.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/cloud-platform

ניתן למצוא מידע נוסף כאן: Authentication Overview.

ListMenus

rpc ListMenus(ListMenusRequest) returns (ListMenusResponse)

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

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/cloud-platform

ניתן למצוא מידע נוסף כאן: Authentication Overview.

ListSessionRecords

rpc ListSessionRecords(ListSessionRecordsRequest) returns (ListSessionRecordsResponse)

הצגת רשימה של SessionRecords של מותג מסוים.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/cloud-platform

ניתן למצוא מידע נוסף כאן: Authentication Overview.

ListStoreRevisions

rpc ListStoreRevisions(ListStoreRevisionsRequest) returns (ListStoreRevisionsResponse)

הצגת רשימה של StoreRevisions.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/cloud-platform

ניתן למצוא מידע נוסף כאן: Authentication Overview.

ListStores

rpc ListStores(ListStoresRequest) returns (ListStoresResponse)

רשימת חנויות.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/cloud-platform

ניתן למצוא מידע נוסף כאן: Authentication Overview.

PromoteChannelConfig

rpc PromoteChannelConfig(PromoteChannelConfigRequest) returns (PromoteChannelConfigResponse)

מקדם את הגדרת הערוץ שצוינה.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/cloud-platform

ניתן למצוא מידע נוסף כאן: Authentication Overview.

UpdateBrand

rpc UpdateBrand(UpdateBrandRequest) returns (Brand)

מעדכן את המותג שצוין.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/cloud-platform

ניתן למצוא מידע נוסף כאן: Authentication Overview.

UpdateChannelConfig

rpc UpdateChannelConfig(UpdateChannelConfigRequest) returns (ChannelConfig)

עדכון של ChannelConfig שצוין.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/cloud-platform

ניתן למצוא מידע נוסף כאן: Authentication Overview.

UpdateConfigApplicationRule

rpc UpdateConfigApplicationRule(UpdateConfigApplicationRuleRequest) returns (ConfigApplicationRule)

עדכון של ConfigApplicationRule שצוין.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/cloud-platform

ניתן למצוא מידע נוסף כאן: Authentication Overview.

UpdateDiscount

rpc UpdateDiscount(UpdateDiscountRequest) returns (Discount)

מעדכנת את ההנחה שצוינה.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/cloud-platform

ניתן למצוא מידע נוסף כאן: Authentication Overview.

UpdateEvaluationCase

rpc UpdateEvaluationCase(UpdateEvaluationCaseRequest) returns (EvaluationCase)

עדכון של EvaluationCase שצוין.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/cloud-platform

ניתן למצוא מידע נוסף כאן: Authentication Overview.

UpdateEvaluationContext

rpc UpdateEvaluationContext(UpdateEvaluationContextRequest) returns (EvaluationContext)

מעדכן את ה-EvaluationContext שצוין.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/cloud-platform

ניתן למצוא מידע נוסף כאן: Authentication Overview.

UpdateEvaluationDataset

rpc UpdateEvaluationDataset(UpdateEvaluationDatasetRequest) returns (EvaluationDataset)

מעדכן את ה-EvaluationDataset שצוין.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/cloud-platform

ניתן למצוא מידע נוסף כאן: Authentication Overview.

UpdateEvaluationMatcher

rpc UpdateEvaluationMatcher(UpdateEvaluationMatcherRequest) returns (EvaluationMatcher)

מעדכן את ה-EvaluationMatcher שצוין.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/cloud-platform

ניתן למצוא מידע נוסף כאן: Authentication Overview.

UpdateInventory

rpc UpdateInventory(UpdateInventoryRequest) returns (Inventory)

עדכון המלאי שצוין.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/cloud-platform

ניתן למצוא מידע נוסף כאן: Authentication Overview.

UpdateStore

rpc UpdateStore(UpdateStoreRequest) returns (Store)

מעדכנים את החנות שצוינה.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/cloud-platform

ניתן למצוא מידע נוסף כאן: Authentication Overview.

AgentAudio

התשובה הקולית מהסוכן.

שדות
agent_audio

bytes

נתוני האודיו מהסוכן.

AgentEvent

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

שדות
שדה של איחוד event. האירוע מהסוכן. הערך event יכול להיות רק אחד מהבאים:
restart_order

RestartOrder

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

AgentText

התשובה הכתובה מהסוכן.

שדות
text

string

התשובה הכתובה מהסוכן.

AnalyticsMetrics

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

שדות
interval_metrics[]

IntervalMetrics

מדדים למרווחי הזמן.

AppendIngestionPhaseRequest

הודעת בקשה עבור MenuService.AppendIngestionPhase.

שדות
name

string

חובה. שם יומן ההטמעה שאליו רוצים להוסיף את השלב. פורמט: projects/{project}/locations/{location}/brands/{brand}/ingestionLogs/{ingestion_log}

ingestion_phase

IngestionPhase

חובה. שלב הטמעת הנתונים שרוצים להוסיף.

AudioInput

קלט האודיו מהלקוח. יכול להיות שקלט האודיו יכלול כמה ערוצים ללקוח, לצוות וכו'. כולם צריכים להיות מסונכרנים ובפורמט שצוין בהגדרות האישיות. אין לכלול כותרות אודיו. כברירת מחדל, האודיו צריך להשתמש בקידוד אודיו PCM לינארי של 16 ביט ובתדירות דגימה של 16,000Hz. הגודל הכולל של כל הערוצים צריך להיות קטן מ-25,600 בייטים.

שדות
customer_audio

bytes

חובה. נתוני אודיו של לקוחות.

crew_audio

bytes

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

זמינות

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

שדות
daypart_availability

DaypartAvailability

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

menu_schedule_availability

MenuScheduleAvailability

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

status

Status

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

fulfillment_availability

FulfillmentMethodAvailability

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

DaypartAvailability

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

שדות
daypart_ids[]

string

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

FulfillmentMethodAvailability

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

שדות
fulfillment_methods[]

FulfillmentMethod

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

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

שדות
menu_schedule_ids[]

string

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

סטטוס

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

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

BatchCreateEvaluationCasesRequest

הודעת בקשה עבור MenuService.BatchCreateEvaluationCases.

שדות
parent

string

חובה. משאב ההורה שמשותף לכל מקרי ההערכה שנוצרים. פורמט: projects/{project}/locations/{location}/brands/{brand} אם השדה הזה מוגדר, ההורה של כל מקרי ההערכה שצוינו ב-requests חייב להתאים לשדה הזה.

requests[]

CreateEvaluationCaseRequest

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

BatchCreateEvaluationCasesResponse

הודעת התשובה של MenuService.BatchCreateEvaluationCases.

שדות
evaluation_cases[]

EvaluationCase

נוצרו EvaluationCases.

BatchDeleteStoresRequest

הודעת בקשה עבור MenuService.BatchDeleteStores.

שדות
parent

string

חובה. משאב ההורה שמשותף לכל החנויות שנמחקות. פורמט: projects/{project}/locations/{location}/brands/{brand}

names[]

string

חובה. שמות החנויות שרוצים למחוק. אפשר למחוק עד 1,000 חנויות בבת אחת. פורמט: projects/{project}/locations/{location}/brands/{brand}/stores/{store}

BatchGetMenuEntitiesRequest

הודעת בקשה עבור MenuService.BatchGetMenuEntities.

שדות
parent

string

חובה. שם התפריט שממנו רוצים לאחזר ישויות. פורמט: projects/{project}/locations/{location}/menus/{menu}

item_ids[]

string

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

modifier_ids[]

string

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

modifier_group_ids[]

string

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

category_ids[]

string

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

BatchGetMenuEntitiesResponse

הודעת התשובה של MenuService.BatchGetMenuEntities.

שדות
items[]

Item

הפריטים שביקשתם.

modifiers[]

Modifier

מאפייני השינוי שנכללים בבקשה.

modifier_groups[]

ModifierGroup

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

categories[]

MenuCategory

הקטגוריות שנכללות בבקשה.

BatchUpdateEvaluationCasesRequest

הודעת בקשה עבור MenuService.BatchUpdateEvaluationCases.

שדות
parent

string

חובה. המשאב הראשי שמשותף לכל בקשות ההערכה שמתעדכנות. פורמט: projects/{project}/locations/{location}/brands/{brand} אם השדה הזה מוגדר, ההורה של כל מקרי ההערכה שצוינו ב-requests חייב להתאים לשדה הזה.

requests[]

UpdateEvaluationCaseRequest

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

BatchUpdateEvaluationCasesResponse

הודעת התשובה של MenuService.BatchUpdateEvaluationCases.

שדות
evaluation_cases[]

EvaluationCase

ה-EvaluationCases עודכנו.

BatchUpdateStoresRequest

הודעת בקשה עבור MenuService.BatchUpdateStores.

שדות
parent

string

חובה. משאב ההורה שמשותף לכל החנויות שמתעדכנות. פורמט: projects/{project}/locations/{location}/brands/{brand} אם השדה הזה מוגדר, ההורה של כל החנויות שצוינו בשדה requests חייב להתאים לשדה הזה.

requests[]

UpdateStoreRequest

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

BatchUpdateStoresResponse

הודעת התשובה של MenuService.BatchUpdateStores.

שדות
stores[]

Store

החנויות עודכנו.

BidiProcessOrderRequest

ההודעה ברמה העליונה שנשלחה על ידי הלקוח עבור השיטה FoodOrderingService.BidiProcessOrder.

שדות
שדה של איחוד message. ההודעה מהלקוח. הלקוח צריך לשלוח הודעת config לפני שהוא שולח הודעות אחרות. הערך message יכול להיות רק אחד מהבאים:
config

Config

ההגדרות של מאפייני הסשן וההזמנה ממסעדה.

text_input

TextInput

קלט הטקסט מהלקוח.

audio_input

AudioInput

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

event_input

EventInput

האירוע שהוזן מהלקוח.

client_execution_result

ClientExecutionResult

התוצאה של בקשת ביצוע של לקוח.

BidiProcessOrderResponse

ההודעה ברמה העליונה שהוחזרה מה-method‏ FoodOrderingService.BidiProcessOrder.

שדות
שדה של איחוד response. תשובת הסוכן. הערך response יכול להיות רק אחד מהבאים:
agent_audio

AgentAudio

התשובה הקולית מהסוכן.

speech_recognition

SpeechRecognition

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

legacy_order_state_response

Struct

התגובה של מצב ההזמנה הקודם בסשן.

interruption_signal

InterruptionSignal

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

agent_event

AgentEvent

אירוע מהסוכן.

client_execution_request

ClientExecutionRequest

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

updated_order_state

UpdatedOrderState

מציין עדכון במצב ההזמנה. כולל את המצב המלא של ההזמנה.

agent_text

AgentText

התשובה הכתובה מהסוכן.

suggested_options

SuggestedOptions

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

sentiment_measurement

SentimentMeasurement

ציון הסנטימנט בזמן אמת שנמדד בתור הזה.

turn_completed

TurnCompleted

הודעה על סיום הפנייה.

end_session

EndSession

מציין שהסשן מסתיים, ושהתור הזה יהיה האחרון.

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

  • תור 1
  • קלט של לקוח 1
  • ‫... הודעות על תגובות של נציגים ועל סטטוס ההזמנה
  • turn_completed
  • תור 2
  • קלט 2 של הלקוח
  • ‫... הודעות על תגובות של נציגים ועל סטטוס ההזמנה
  • end_session
  • ‫... הודעות על סטטוס ההזמנה והמתנה לתשובה מהנציג
  • turn_completed
recommended_orders

RecommendedOrders

ההזמנות המומלצות מהסוכן.

כתם

מייצג קלט או פלט של blob בשיחה.

שדות
mime_type

string

חובה. סוג ה-MIME הסטנדרטי של IANA של נתוני המקור.

data

bytes

חובה. בייטים גולמיים של ה-blob.

מותג

מותג, שיכול להיות רשת מסעדות או מסעדה בודדת.

שדות
name

string

מזהה. שם המותג. פורמט: projects/{project}/locations/{location}/brands/{brand}

display_name

string

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

create_time

Timestamp

פלט בלבד. השעה שבה המותג נוצר.

update_time

Timestamp

פלט בלבד. המועד שבו המותג עודכן לאחרונה.

BrandRevision

גרסה של מותג.

שדות
name

string

מזהה. שם המשאב של גרסת המותג. פורמט: projects/{project}/locations/{location}/brands/{brand}/revisions/{revision}

snapshot

Brand

פלט בלבד. מצב המשאב של המותג בגרסה הזו.

create_time

Timestamp

פלט בלבד. מתי הגרסה נוצרה.

created_by

string

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

alternate_ids[]

string

פלט בלבד. מזהים חלופיים לגרסה הזו.

action

RevisionAction

פלט בלבד. הפעולה שיצרה את הגרסה הזו.

CelUpsell

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

שדות
condition_expression

string

חובה. מחרוזת CEL (Common Expression Language) שמוערכת ביחס למצב הסשן הנוכחי (Order ו-ClientSessionMetadata). אם היא מוערכת כ-True, הכלל מופעל. דוגמה: "context.weather_condition == 'HOT' && order.items.size() > 0"

suggested_menu_items[]

string

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

trigger_reason

string

זה שינוי אופציונלי. הוראה בשפה טבעית שניתנת למודל ה-LLM לשיחה, שמסבירה למה מתבצעת מכירת השדרוג הזו, כדי שהמודל יוכל לנסח מכירת שדרוג טבעית. לדוגמה: "Suggest a cold drink because it is a hot day."

priority

int32

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

suggested_modifiers[]

string

זה שינוי אופציונלי. השמות הסמנטיים של ה-modifiers שיוצעו אם הכלל הזה יופעל.

suggested_modifier_groups[]

SuggestedModifierGroup

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

max_modifier_per_group

int32

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

suggestion_only

bool

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

SuggestedModifierGroup

קבוצת שינויים מוצעת.

שדות
name

string

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

suggested_modifiers[]

string

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

ChannelConfig

הגדרת ערוץ מייצגת הגדרה של אסטרטגיה תפעולית. מחזור החיים של הגדרת הערוץ: * טיוטה: הגדרה נמצאת במצב טיוטה כשאין לה כללי יישום של הגדרות משויכים והיא לא מוגדרת כברירת המחדל של המותג. ‫* ACTIVE: הגדרה נמצאת במצב פעיל כשהיא משויכת לכלל כלשהו של אפליקציית הגדרות או מוגדרת כברירת המחדל של המותג. * כשהוא פעיל, זמן הריצה מחיל את הגדרת הערוץ על החנויות התואמות. כדי להבטיח גמישות, הקשר בין הגדרת הערוץ לבין כלל החלת ההגדרות הוא אחד לרבים בכל רמת משאב: * ברמת המותג, יש קשר של אחד לרבים בין הגדרות הערוץ לבין כללי החלת ההגדרות. ‫* ברמת החנות, יש עוד קשר של אחד לרבים בין הגדרות הערוצים לבין כללי החלת ההגדרות. אם אפשר להחיל כמה הגדרות של ערוצים, זמן הריצה קובע איזו הגדרה להחיל לפי סדר העדיפות הבא (האחרון מבטל את הקודם במקרה של התנגשות): 1. ברירת מחדל 2 ברמת המותג. קישור ברמת המותג 3. ברירת המחדל ברמת החנות היא 4. קישור ברמת החנות

שדות
name

string

מזהה. שם הגדרת הערוץ. פורמט: projects/{project}/locations/{location}/brands/{brand}/channelConfigs/{channel_config}

display_name

string

זה שינוי אופציונלי. שם תצוגה אופציונלי להגדרת הערוץ הזו בממשקי משתמש. הערך מוגבל ל-63 תווים.

create_time

Timestamp

פלט בלבד. השעה שבה נוצרה הגדרת הערוץ הזו.

update_time

Timestamp

פלט בלבד. השעה שבה הגדרת הערוץ עודכנה לאחרונה.

operations_config

OperationsConfig

זה שינוי אופציונלי. האסטרטגיה התפעולית של הגדרת הערוץ.

state

State

פלט בלבד. הסטטוס של הגדרת הערוץ.

type

Type

חובה. סוג הגדרת הערוץ.

supplemental_instructions

SupplementalInstructions

זה שינוי אופציונלי. הוראות נוספות להגדרת הערוץ.

tone

Tone

זה שינוי אופציונלי. טון הדיבור של הנציג.

config_application_rules[]

ConfigApplicationRule

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

מדינה

הסטטוס של הגדרת הערוץ.

טיפוסים בני מנייה (enum)
STATE_UNSPECIFIED הסטטוס לא צוין.
DRAFT הגדרת הערוץ היא טיוטה ועדיין לא מוכנה לשימוש.
ACTIVE הגדרת הערוץ פעילה ואפשר להשתמש בה.
PROMOTED הגדרת הערוץ מקודמת.

SupplementalInstructions

הגדרות להוראות נוספות.

שדות
freeform_instructions

string

זה שינוי אופציונלי. הוראות חופשיות שכלולות בהנחיה.

טון

טון הדיבור של הנציג.

טיפוסים בני מנייה (enum)
TONE_UNSPECIFIED הטון לא צוין.
CONCISE_AND_DIRECT הסוכן עונה בצורה תמציתית וישירה.
PROFESSIONAL_AND_FORMAL הטון של הנציג מקצועי ורשמי.
FRIENDLY הטון של הסוכן ידידותי.

סוג

סוג הגדרת הערוץ.

טיפוסים בני מנייה (enum)
TYPE_UNSPECIFIED לא צוין סוג.
UPSELL_STRATEGY הגדרת הערוץ מיועדת לאסטרטגיית מכירת מוצר או שירות נוסף (upsell).
AGENT_CUSTOMIZATION הגדרת הערוץ מיועדת להתאמה אישית של הנציג.

ChannelConfigRevision

גרסה של הגדרת ערוץ.

שדות
name

string

מזהה. שם המשאב של גרסת הגדרת הערוץ. פורמט: projects/{project}/locations/{location}/brands/{brand}/channelConfigs/{channel_config}/revisions/{revision}

snapshot

ChannelConfig

פלט בלבד. המצב של משאב הגדרת הערוץ בגרסה הזו.

create_time

Timestamp

פלט בלבד. מתי הגרסה נוצרה.

created_by

string

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

alternate_ids[]

string

פלט בלבד. מזהים חלופיים לגרסה הזו.

action

RevisionAction

פלט בלבד. הפעולה שיצרה את הגרסה הזו.

ChannelType

סוג הערוץ שמשמש לתקשורת עם הנציג. סוג הערוץ כולל גם את הפלטפורמה (למשל, אפליקציה לנייד, אפליקציית אינטרנט) וגם את מצב השיחה, בפלטפורמות שתומכות בכמה מצבי שיחה. בפלטפורמות לנייד ולאינטרנט, הערך הבסיסי (למשל CHANNEL_TYPE_MOBILE_APP) מציין את מצב השיחה הקולית, והווריאציה "_TEXT" מציינת את מצב השיחה בטקסט (או במצב מולטי-מודאלי, למשל לחיצה כדי לדבר). טיפוסים בני מנייה (enum) זה לא קבוע, וייתכן שיתווספו ערכים חדשים בעתיד.

טיפוסים בני מנייה (enum)
CHANNEL_TYPE_UNSPECIFIED סוג הערוץ לא צוין.
CHANNEL_TYPE_DRIVE_THROUGH ערוץ Drive through (קולי).
CHANNEL_TYPE_MOBILE_APP ערוץ אפליקציה לנייד שמשתמש במצב שיחה קולית.
CHANNEL_TYPE_PHONE_CALL ערוץ שיחות טלפון (קול).
CHANNEL_TYPE_WEB_APP ערוץ של אפליקציית אינטרנט שמשתמש במצב שיחה קולית.
CHANNEL_TYPE_MOBILE_APP_TEXT ערוץ של אפליקציה לנייד שמשתמש במצב שיחה בטקסט (או במצב מולטי-מודאלי, למשל לחיצה כדי לדבר).
CHANNEL_TYPE_WEB_APP_TEXT ערוץ של אפליקציית אינטרנט שמשתמש במצב שיחה בטקסט (או במצב מולטי-מודאלי, למשל "לחיצה כדי לדבר").

ClientAppInfo

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

שדות
device_model

string

זה שינוי אופציונלי. דגם המכשיר של הלקוח (למשל, "iPhone 13",‏ "Pixel 7",‏ "Kiosk v2").

os_version

string

זה שינוי אופציונלי. גרסת מערכת ההפעלה של הלקוח (למשל, "iOS 16.1",‏ "Android 13").

sdk_version

string

זה שינוי אופציונלי. גרסת ה-SDK של הלקוח או של האפליקציה.

ClientExecutionRequest

בקשה לצד הלקוח להריץ פקודה.

שדות
execution_id

string

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

שדה של איחוד request. הבקשה הספציפית לביצוע. הערך request יכול להיות רק אחד מהבאים:
finalize_order_request

FinalizeOrderRequest

בקשה להשלמת ההזמנה.

submit_order_request

SubmitOrderRequest

בקשה לשלוח את ההזמנה.

order_prices_request

OrderPricesRequest

בקשה לקבלת מחירי ההזמנה.

validate_delivery_address_request

ValidateDeliveryAddressRequest

בקשה לאמת את הכתובת למשלוח.

order_status_request

OrderStatusRequest

בקשה לקבלת סטטוס ההזמנה.

ClientExecutionResult

התוצאה של בקשת ביצוע של לקוח.

שדות
execution_id

string

חובה. המזהה של בקשת ההרצה שהתוצאה הזו שייכת לה.

שדה של איחוד response. התוצאה הספציפית של ההרצה. הערך response יכול להיות רק אחד מהבאים:
finalize_order_response

FinalizeOrderResponse

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

submit_order_response

SubmitOrderResponse

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

order_prices_response

OrderPricesResponse

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

validate_delivery_address_response

ValidateDeliveryAddressResponse

תוצאת האימות של הכתובת למשלוח.

order_status_response

OrderStatusResponse

התוצאה של קבלת סטטוס ההזמנה.

ClosingOffer

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

שדות
closing_messages[]

ClosingMessage

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

ClosingMessage

סגירת ההגדרה של הודעת המכירה השיווקית.

שדות
offer_message

OfferMessage

חובה. הגדרת הודעת ההצעה.

skip_terms[]

string

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

ComputeAnalyticsMetricsRequest

הודעת בקשה עבור MenuService.ComputeAnalyticsMetrics.

שדות
brand

string

חובה. המותג שעבורו רוצים לקבל מדדי ניתוח נתונים. פורמט: projects/{project}/locations/{location}/brands/{brand}

timestamps[]

Timestamp

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

store_ids[]

string

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

analytics_types[]

AnalyticsType

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

feature_gate

FeatureGate

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

AnalyticsType

סוג הניתוח שרוצים לחשב.

טיפוסים בני מנייה (enum)
ANALYTICS_TYPE_UNSPECIFIED סוג ניתוח לא מזוהה.
GENERIC לחשב מדדים כלליים (למשל, מספר ההזמנות, מספר ההעברות לטיפול ברמה גבוהה יותר, מספר המכירות של מוצר או שירות משודרג).
DAILY לחשב מדדים יומיים (למשל, מספר ההזמנות וההעברות לטיפול ברמה גבוהה יותר).
PREDICTED_FAILURE_CATEGORIES חישוב מדדים של קטגוריית כשל חזויה (למשל, ספירת קטגוריית כשל חזויה).

FeatureGate

‫Feature Gates לשליטה בהתנהגות של חישוב ניתוח הנתונים.

שדות
enable_aggregation_data

bool

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

ComputeAnalyticsMetricsResponse

הודעת התשובה של MenuService.ComputeAnalyticsMetrics.

שדות
analytics_metrics

AnalyticsMetrics

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

הגדרה

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

שדות
session

string

חובה. הסשן של ההזמנה. פורמט: projects/{project}/locations/{location}/sessions/{session}

store

string

חובה. החנות שבה מתבצעת ההזמנה. פורמט: projects/{project}/locations/{location}/brands/{brand}/stores/{store}

lane_id

string

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

enable_echo_cancellation

bool

זה שינוי אופציונלי. אם להפעיל ביטול הד בסשן. אם האפשרות מופעלת, הלקוח צריך לספק את customer_audio ואת crew_audio ב-AudioInput.

daypart_id

string

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

user_info

UserInfo

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

order_type
(deprecated)

OrderType

זה שינוי אופציונלי. הוצא משימוש: צריך להשתמש במקום זאת ב-initial_order.fulfillment.fulfillment_type. סוג ההזמנה שרוצים לבצע.

initial_order

Order

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

feature_gate

FeatureGate

זה שינוי אופציונלי. ה-Feature Gates של הסשן. הוא משמש להפעלה או להשבתה של תכונות בסשן.

initial_utterance

string

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

client_app_info

ClientAppInfo

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

mode

SessionMode

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

channel_type

ChannelType

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

enable_listen_only_dual_channel

bool

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

test_session_start_time

Timestamp

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

SessionMode

מצב הסשן.

טיפוסים בני מנייה (enum)
SESSION_MODE_UNSPECIFIED מצב הסשן לא צוין.
HYBRID הסשן תומך גם באודיו וגם בטקסט. (זוהי ברירת המחדל)
TEXT הסשן הוא בטקסט בלבד.

TrafficType

סוג התנועה בסשן. השם הזה משמש לתיוג מדדי המעקב, הרישום ביומן והניראות (observability).

טיפוסים בני מנייה (enum)
TRAFFIC_TYPE_UNSPECIFIED סוג התנועה לא צוין.
EXTERNAL התנועה מגיעה מלקוח חיצוני.
INTEGRATION_TEST התנועה מגיעה מבדיקת שילוב.
EVAL התנועה מגיעה מכלי ההערכה.
PROBER התנועה מגיעה מהבודק.
MANUAL_TEST התנועה מגיעה מבדיקות ידניות.
INTERNAL_TOOL התנועה מגיעה מכלי פנימי.
CONSOLE התנועה מגיעה מהמסוף של AI בתחום המזון.

ConfigApplicationRule

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

שדות
name

string

מזהה. שם הכלל של הגדרת האפליקציה. פורמט: projects/{project}/locations/{location}/brands/{brand}/configApplicationRules/{config_application_rule}

display_name

string

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

create_time

Timestamp

פלט בלבד. השעה שבה נוצר כלל ההגדרה הזה של האפליקציה.

update_time

Timestamp

פלט בלבד. המועד שבו כלל ההגדרה הזה עודכן לאחרונה.

ConfigApplicationRuleRevision

גרסה של כלל להגדרת אפליקציה.

שדות
name

string

מזהה. שם המשאב של גרסת כלל האפליקציה להגדרה. פורמט: projects/{project}/locations/{location}/brands/{brand}/configApplicationRules/{config_application_rule}/revisions/{revision}

snapshot

ConfigApplicationRule

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

create_time

Timestamp

פלט בלבד. מתי הגרסה נוצרה.

created_by

string

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

alternate_ids[]

string

פלט בלבד. מזהים חלופיים לגרסה הזו.

action

RevisionAction

פלט בלבד. הפעולה שיצרה את הגרסה הזו.

CreateBrandRequest

הודעת בקשה עבור MenuService.CreateBrand.

שדות
parent

string

חובה. חברת האם, שהיא הבעלים של קבוצת המותגים הזו. פורמט: projects/{project}/locations/{location}

brand

Brand

חובה. המותג שרוצים ליצור.

brand_id

string

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

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

CreateChannelConfigRequest

הודעת בקשה עבור MenuService.CreateChannelConfig.

שדות
parent

string

חובה. מותג האם, שבבעלותו אוסף הגדרות הערוצים הזה. פורמט: projects/{project}/locations/{location}/brands/{brand}

channel_config

ChannelConfig

חובה. הגדרת הערוץ שרוצים ליצור.

channel_config_id

string

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

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

CreateConfigApplicationRuleRequest

הודעת בקשה עבור MenuService.CreateConfigApplicationRule.

שדות
parent

string

חובה. המותג הראשי, שהאוסף הזה של כללי הגדרת האפליקציה שייך לו. פורמט: projects/{project}/locations/{location}/brands/{brand}

config_application_rule

ConfigApplicationRule

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

config_application_rule_id

string

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

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

CreateDiscountRequest

הודעת בקשה עבור MenuService.CreateDiscount.

שדות
parent

string

חובה. החנות הראשית, שהיא הבעלים של אוסף ההנחות הזה. פורמט: projects/{project}/locations/{location}/brands/{brand}/stores/{store}

discount_id

string

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

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

discount

Discount

חובה. ההנחה שרוצים ליצור.

CreateEvaluationCaseRequest

הודעת בקשה עבור MenuService.CreateEvaluationCase.

שדות
parent

string

חובה. המותג הראשי, שבבעלותו אוסף מקרי ההערכה הזה. פורמט: projects/{project}/locations/{location}/brands/{brand}

evaluation_case

EvaluationCase

חובה. בקשת התמיכה להערכה שרוצים ליצור.

evaluation_case_id

string

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

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

CreateEvaluationContextRequest

הודעת בקשה עבור MenuService.CreateEvaluationContext.

שדות
parent

string

חובה. מותג האב, שבבעלותו אוסף הקשרי ההערכה הזה. פורמט: projects/{project}/locations/{location}/brands/{brand}

evaluation_context

EvaluationContext

חובה. הקשר ההערכה שרוצים ליצור.

evaluation_context_id

string

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

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

CreateEvaluationDatasetRequest

הודעת בקשה עבור MenuService.CreateEvaluationDataset.

שדות
parent

string

חובה. מותג האם, שבבעלותו אוסף מערכי הנתונים להערכה. פורמט: projects/{project}/locations/{location}/brands/{brand}

evaluation_dataset

EvaluationDataset

חובה. קבוצת הנתונים להערכה שרוצים ליצור.

evaluation_dataset_id

string

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

CreateEvaluationMatcherRequest

הודעת בקשה עבור MenuService.CreateEvaluationMatcher.

שדות
parent

string

חובה. מותג האב, שבבעלותו אוסף ההתאמות להערכה. פורמט: projects/{project}/locations/{location}/brands/{brand}

evaluation_matcher

EvaluationMatcher

חובה. התאמת ההערכה שרוצים ליצור.

evaluation_matcher_id

string

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

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

CreateIngestionLogRequest

הודעת בקשה עבור MenuService.CreateIngestionLog.

שדות
parent

string

חובה. משאב ההורה שבו ייווצר יומן ההטמעה הזה. פורמט: projects/{project}/locations/{location}/brands/{brand}

ingestion_log

IngestionLog

חובה. יומן ההטמעה שרוצים ליצור.

ingestion_log_id

string

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

CreateInventoryRequest

הודעת בקשה עבור MenuService.CreateInventory.

שדות
parent

string

חובה. החנות הראשית, שהיא הבעלים של אוסף המלאי הזה. פורמט: projects/{project}/locations/{location}/brands/{brand}/stores/{store}

inventory_id

string

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

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

inventory

Inventory

חובה. המלאי שרוצים ליצור.

CreateMenuRequest

הודעת בקשה עבור MenuService.CreateMenu.

שדות
parent

string

חובה. ההורה, שהוא הבעלים של אוסף התפריטים הזה. פורמט: projects/{project}/locations/{location}

menu_id

string

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

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

menu

Menu

חובה. התפריט שרוצים ליצור.

CreateStoreRequest

הודעת בקשה עבור MenuService.CreateStore.

שדות
parent

string

חובה. מותג האם שבבעלותו קבוצת החנויות הזו. פורמט: projects/{project}/locations/{location}/brands/{brand}

store_id

string

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

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

store

Store

חובה. החנות שרוצים ליצור.

DateRange

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

שדות
start_date

Date

חובה. תאריך ההתחלה של הטווח, כולל.

end_date

Date

חובה. תאריך הסיום של הטווח, כולל.

DeleteBrandRequest

הודעת בקשה עבור MenuService.DeleteBrand.

שדות
name

string

חובה. שם המותג שרוצים למחוק. פורמט: projects/{project}/locations/{location}/brands/{brand}

DeleteBrandRevisionRequest

הודעת בקשה עבור MenuService.DeleteBrandRevision.

שדות
name

string

חובה. שם גרסת המותג שרוצים למחוק. פורמט: projects/{project}/locations/{location}/brands/{brand}/revisions/{revision}

DeleteChannelConfigRequest

הודעת בקשה עבור MenuService.DeleteChannelConfig.

שדות
name

string

חובה. שם הגדרת הערוץ שרוצים למחוק. פורמט: projects/{project}/locations/{location}/brands/{brand}/channelConfigs/{channel_config}

DeleteChannelConfigRevisionRequest

הודעת בקשה עבור MenuService.DeleteChannelConfigRevision.

שדות
name

string

חובה. השם של גרסת הגדרת הערוץ שרוצים למחוק. פורמט: projects/{project}/locations/{location}/brands/{brand}/channelConfigs/{channel_config}/revisions/{revision}

DeleteConfigApplicationRuleRequest

הודעת בקשה עבור MenuService.DeleteConfigApplicationRule.

שדות
name

string

חובה. שם הכלל של הגדרת האפליקציה שרוצים למחוק. פורמט: projects/{project}/locations/{location}/brands/{brand}/configApplicationRules/{config_application_rule}

DeleteConfigApplicationRuleRevisionRequest

הודעת בקשה עבור MenuService.DeleteConfigApplicationRuleRevision.

שדות
name

string

חובה. השם של גרסת כלל האפליקציה שרוצים למחוק. פורמט: projects/{project}/locations/{location}/brands/{brand}/configApplicationRules/{config_application_rule}/revisions/{revision}

DeleteDiscountRequest

הודעת בקשה עבור MenuService.DeleteDiscount.

שדות
name

string

חובה. שם ההנחה שרוצים למחוק. פורמט: projects/{project}/locations/{location}/brands/{brand}/stores/{store}/discounts/{discount}

DeleteEvaluationCaseRequest

הודעת בקשה עבור MenuService.DeleteEvaluationCase.

שדות
name

string

חובה. שם בקשת ההערכה שרוצים למחוק. פורמט: projects/{project}/locations/{location}/brands/{brand}/evaluationCases/{evaluation_case}

DeleteEvaluationCaseResultRequest

הודעת בקשה עבור MenuService.DeleteEvaluationCaseResult.

שדות
name

string

חובה. השם של תוצאת מקרה ההערכה שרוצים למחוק. פורמט: projects/{project}/locations/{location}/brands/{brand}/evaluationCaseResults/{evaluation_case_result}

DeleteEvaluationContextRequest

הודעת בקשה עבור MenuService.DeleteEvaluationContext.

שדות
name

string

חובה. שם הקשר ההערכה שרוצים למחוק. פורמט: projects/{project}/locations/{location}/brands/{brand}/evaluationContexts/{evaluation_context}

DeleteEvaluationDatasetRequest

הודעת בקשה עבור MenuService.DeleteEvaluationDataset.

שדות
name

string

חובה. שם מערך הנתונים להערכה שרוצים למחוק. פורמט: projects/{project}/locations/{location}/brands/{brand}/evaluationDatasets/{evaluation_dataset}

DeleteEvaluationDatasetResultRequest

הודעת בקשה עבור MenuService.DeleteEvaluationDatasetResult.

שדות
name

string

חובה. השם של תוצאת קבוצת הנתונים להערכה שרוצים למחוק. פורמט: projects/{project}/locations/{location}/brands/{brand}/evaluationDatasetResults/{evaluation_dataset_result}

DeleteEvaluationMatcherRequest

הודעת בקשה עבור MenuService.DeleteEvaluationMatcher.

שדות
name

string

חובה. השם של ההתאמה להערכה שרוצים למחוק. פורמט: projects/{project}/locations/{location}/brands/{brand}/evaluationMatchers/{evaluation_matcher}

DeleteIngestionLogRequest

הודעת בקשה עבור MenuService.DeleteIngestionLog.

שדות
name

string

חובה. שם יומן ההטמעה שרוצים למחוק. פורמט: projects/{project}/locations/{location}/brands/{brand}/ingestionLogs/{ingestion_log}

DeleteInventoryRequest

הודעת בקשה עבור MenuService.DeleteInventory.

שדות
name

string

חובה. שם המלאי שרוצים למחוק. פורמט: projects/{project}/locations/{location}/brands/{brand}/stores/{store}/inventories/{inventory}

DeleteMenuRequest

הודעת בקשה עבור MenuService.DeleteMenu.

שדות
name

string

חובה. שם התפריט שרוצים למחוק. פורמט: projects/{project}/locations/{location}/menus/{menu}

DeleteSessionRecordRequest

הודעת בקשה ל-[SessionRecordService.DeleteSessionRecord][].

שדות
name

string

חובה. שם רשומת הסשן שרוצים למחוק. פורמט: projects/{project}/locations/{location}/brands/{brand}/sessionRecords/{session_record}

DeleteStoreRequest

הודעת בקשה עבור MenuService.DeleteStore.

שדות
name

string

חובה. שם החנות שרוצים למחוק. פורמט: projects/{project}/locations/{location}/brands/{brand}/stores/{store}

DeleteStoreRevisionRequest

הודעת בקשה עבור MenuService.DeleteStoreRevision.

שדות
name

string

חובה. השם של גרסת החנות שרוצים למחוק. פורמט: projects/{project}/locations/{location}/brands/{brand}/stores/{store}/revisions/{revision}

DeliveryAddress

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

שדות
address

PostalAddress

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

validation_status

ValidationStatus

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

coordinates

LatLng

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

ValidationStatus

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

טיפוסים בני מנייה (enum)
VALIDATION_STATUS_UNSPECIFIED הכתובת עדיין לא אומתה.
VALIDATION_STATUS_VALID הכתובת תקינה.
VALIDATION_STATUS_INVALID הכתובת לא תקינה (לא קיימת, לא ניתן לנתח אותה וכו')
VALIDATION_STATUS_OUT_OF_RANGE הכתובת קיימת ופוענחה, אבל היא מחוץ לטווח של החנות.
VALIDATION_STATUS_INCOMPLETE_ADDRESS בכתובת חסרים שדות חובה (חסר מספר הבית, שם הרחוב, העיר, המדינה, המיקוד וכו')

DisambiguationMapping

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

שדות
type

Type

חובה. סוג הפעולה של כלל הפגת העמימות.

customer_terms[]

string

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

targets[]

TargetItem

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

custom_instruction

string

זה שינוי אופציונלי. הוראות מותנות מותאמות אישית או רמזים לניסוח (אופציונלי).

סוג

סוג הפעולה של כלל הפגת העמימות.

טיפוסים בני מנייה (enum)
TYPE_UNSPECIFIED סוג הכלל לא צוין.
SINGLE_TARGET משמש למיפויים של יעד יחיד (מקשי קיצור, הגדרות של שילובים מותאמים אישית או מילים נרדפות חוקיות).
INVALID_ITEM משמש לפריטים לא חוקיים, לפריטים שחסרים במלאי או למוצרים של מתחרים.
DISAMBIGUATION משמש לקלט לא ברור שדורש הבהרה בין כמה אפשרויות יעד חוקיות.

DisambiguationStrategy

הגדרת האסטרטגיה של בקרת הפגת העמימות.

שדות
mappings[]

DisambiguationMapping

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

הנחה

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

שדות
name

string

מזהה. שם ההנחה. פורמט: projects/{project}/locations/{location}/brands/{brand}/stores/{store}/discounts/{discount}

display_name

string

חובה. השם של ההנחה שגלוי למשתמשים (למשל, "20% הנחה על ההזמנה").

type

DiscountType

חובה. סוג ההנחה שמוחלת.

scope

Scope

חובה. ההיקף שבו ההנחה חלה.

schedule

Schedule

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

fixed_amount

Money

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

percent

float

זה שינוי אופציונלי. ערך ההנחה באחוזים (מ-0.0 עד 100.0). צריך להגדיר את המאפיין הזה אם הערך של "type" הוא PERCENT_OFF.

max_discount_value

Money

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

applied_items

ItemGroup

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

required_items

ItemGroup

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

auto_apply

bool

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

promo_code

string

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

additional_constraint

Constraint

זה שינוי אופציונלי. אילוץ נוסף להחלת ההנחה הזו.

integration_attributes

DiscountIntegrationAttributes

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

image

Image

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

המגבלה

אילוץ נוסף להחלת ההנחה הזו.

שדות
min_spend

Money

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

max_uses_per_order

int32

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

allowed_channels[]

ChannelType

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

requires_customer_signin

bool

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

is_stackable

bool

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

היקף

מגדיר את הרמה שבה ההנחה חלה.

טיפוסים בני מנייה (enum)
SCOPE_UNSPECIFIED היקף ההרשאות לא צוין.
ORDER ההנחה חלה על כל ההזמנה.
ITEM חלה על פריטים ספציפיים.

DiscountIntegrationAttributes

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

שדות
custom_integration_attributes

Struct

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

DiscountType

סוג ההנחה.

טיפוסים בני מנייה (enum)
DISCOUNT_TYPE_UNSPECIFIED סוג ההנחה לא צוין.
BOGO קונים X ומקבלים את Y בחינם/ב-Z אחוזי הנחה/בסכום Z.
FIXED_OFF הנחה בסכום כספי קבוע (לדוגמה, הנחה של 20 ש"ח על פריט או הזמנה).
PERCENT_OFF הנחה באחוזים (לדוגמה, 20% הנחה על פריט או הזמנה).
FIXED_TOTAL הגדרת המחיר הסופי של הפריטים המוזלים לסכום קבוע (לדוגמה: 2 פריטים ב-40 ש"ח).
FREE_DELIVERY מוותר על דמי המשלוח של ההזמנה.

EndSession

מציין שהסוכן סיים את הסשן, בגלל השלמה מוצלחת (למשל, המשתמש אומר "להתראות!" ) או העברה לנציג.

שדות
type

EndType

סוג האירוע של סיום הסשן.

reason

string

הסיבה לסיום הסשן.

pos_response

string

זה שינוי אופציונלי. התגובה של נקודת המכירה (POS) מהצ'ק-אין של ההזמנה (אופציונלי). זוהי מחרוזת מטען ייעודי (payload) אטומה שמייצגת את סטטוס העסקה בנקודת המכירה.

agent_response

string

זה שינוי אופציונלי. הודעת התשובה הסופית של הנציג שתושמע או תוצג למשתמש (אופציונלי).

store_schedule

Schedule

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

EndType

סוג האירוע של סיום הסשן.

טיפוסים בני מנייה (enum)
END_TYPE_UNSPECIFIED סוג הסיום לא צוין.
DRIVE_OFF הלקוח נסע מהמקום.
AGENT_ESCALATION הסוכן העביר את הסשן לנציג אנושי.
CREW_INTERJECTION אחד מאנשי הצוות התערב בסשן.
ORDER_COMPLETED ההזמנה הושלמה בהצלחה ואין צורך בפעולה נוספת.
PAYMENT_FLOW_SUCCESS תהליך התשלום הושלם בהצלחה ואין צורך בפעולה נוספת.
PAYMENT_FLOW_FAILURE תהליך התשלום נכשל.
CLIENT_ESCALATION הלקוח העביר את הסשן לנציג אנושי.
CALLER_HANGUP הלקוח ניתק את השיחה לפני הזמן.
REQUESTED_CHECKOUT הלקוח ביקש לשלם.
REQUESTED_ORDER_STATUS הלקוח שאל לגבי סטטוס ההזמנה שלו.
STORE_CLOSED החנות סגורה.

EvaluationCase

מקרה הערכה ספציפי.

שדות
name

string

מזהה. שם המשאב של מקרה ההערכה. פורמט: projects/{project}/locations/{location}/brands/{brand}/evaluationCases/{evaluation_case}

display_name

string

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

description

string

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

evaluation_context

string

חובה. שם המשאב של הקשר ההערכה שהפנייה הזו משויכת אליו. פורמט: projects/{project}/locations/{location}/brands/{brand}/evaluationContexts/{evaluation_context}

evaluation_matchers[]

string

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

שדה של איחוד test_case. מקרה הבדיקה שבו משתמשים במקרה ההערכה. הערך test_case יכול להיות רק אחד מהבאים:
static_text_turn_case

StaticTextTurnCase

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

dynamic_text_turn_case

DynamicTextTurnCase

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

DynamicTextTurnCase

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

שדות
ordering_instruction

string

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

StaticTextTurnCase

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

שדות
text_turns[]

TextTurn

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

TextTurn

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

שדות
user_text_input

string

חובה. הטקסט שהמשתמש הזין בתור הזה.

example_agent_response

string

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

EvaluationCaseResult

תוצאה של מקרה הערכה.

שדות
name

string

מזהה. שם המשאב של תוצאת מקרה ההערכה. פורמט: projects/{project}/locations/{location}/brands/{brand}/evaluationCaseResults/{evaluation_case_result}

evaluation_case

EvaluationCase

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

evaluation_context

EvaluationContext

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

evaluation_dataset

string

פלט בלבד. ההפניה לקבוצת הנתונים להערכה שהתוצאה הזו משויכת אליה. אם לא מגדירים את השדה, מקרה הבדיקה מופעל כבדיקה עצמאית, ולא כחלק ממערך נתונים להערכה. פורמט: projects/{project}/locations/{location}/brands/{brand}/evaluationDatasets/{evaluation_dataset}

session_record

string

פלט בלבד. שם המשאב של רשומת הסשן שהתוצאה הזו משויכת אליה. פורמט: projects/{project}/locations/{location}/brands/{brand}/sessionRecords/{session_record}

status

Status

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

matcher_results[]

MatcherResult

פלט בלבד. רשימת התוצאות של ההתאמות לבדיקה במקרה הבדיקה. התוצאות של ההתאמות להערכה.

create_time

Timestamp

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

MatcherResult

תוצאה של התאמת הערכה.

שדות
evaluation_matcher

EvaluationMatcher

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

שדה של איחוד result. התוצאה של התאמת ההערכה. הערך result יכול להיות רק אחד מהבאים:
order_result_matcher_result

OrderResultMatcherResult

פלט בלבד. התוצאה של התאמת תוצאות ההזמנה.

agent_utterance_string_matcher_result

AgentUtteranceStringMatcherResult

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

llm_judgement_matcher_result

LLMJudgementMatcherResult

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

AgentUtteranceStringMatcherResult

תוצאה של התאמת מחרוזת של אמירה של נציג.

שדות
match

bool

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

LLMJudgementMatcherResult

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

שדות
match

bool

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

reasoning

string

פלט בלבד. מתאר את הסיבה לכך שההערכה של ה-LLM תאמה או נכשלה.

OrderResultMatcherResult

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

שדות
match

bool

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

difference

string

פלט בלבד. ההבדל המודפס בצורה יפה בין הסדר הצפוי לסדר בפועל בהתאמה של תוצאת הסדר בפורמט (‎-want +got).

סטטוס

סטטוס בקשת התמיכה להערכה.

טיפוסים בני מנייה (enum)
STATUS_UNSPECIFIED סטטוס לא חוקי.
PASS כל ההתאמות של ההערכה מתקיימות.
FAIL לפחות אחד מהתנאים של ההערכה לא מתקיים.
ERROR הייתה שגיאה שגרמה לסשן BidiProcessOrder להסתיים באופן בלתי צפוי, ולא ניתן היה להשלים את ההערכה.

EvaluationContext

הקשר של הערכה לחבילת הערכה או למקרה.

שדות
name

string

מזהה. השם המלא של המשאב של הקשר ההערכה. פורמט: projects/{project}/locations/{location}/brands/{brand}/evaluationContexts/{evaluation_context}

display_name

string

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

description

string

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

store

string

חובה. השם המלא של המשאב של החנות שמשמשת למקרה ההערכה. פורמט: projects/{project_id}/locations/{location}/brands/{brand_id}/stores/{store_id}

menu

string

זה שינוי אופציונלי. תפריט אפשרויות לשימוש בהקשר של ההערכה. אם לא תציינו תפריט, המערכת תשתמש בתפריט ברירת המחדל של החנות. פורמט: projects/{project_id}/locations/{location}/brands/{brand_id}/menus/{menu_id}

test_session_start_time

Timestamp

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

mock_client_executions[]

MockClientExecution

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

daypart_id

string

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

EvaluationDataset

מערך נתונים של מקרי הערכה.

שדות
name

string

מזהה. שם המשאב של מערך הנתונים להערכה. פורמט: projects/{project}/locations/{location}/brands/{brand}/evaluationDatasets/{evaluation_dataset}

display_name

string

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

description

string

זה שינוי אופציונלי. תיאור מערך הנתונים להערכה.

evaluation_cases[]

string

זה שינוי אופציונלי. רשימת ההפניות למקרי ההערכה של מערך הנתונים הזה. כל מקרה בפורמט הבא: projects/{project}/locations/{location}/brands/{brand}/evaluationCases/{evaluation_case}

evaluation_context

string

זה שינוי אופציונלי. הקשר הערכה אופציונלי לשימוש במערך הנתונים להערכה. אם מגדירים את השדה הזה, הוא מבטל את הקשר ההערכה שמוגדר במקרי ההערכה הנפרדים. פורמט: projects/{project}/locations/{location}/brands/{brand}/evaluationContexts/{evaluation_context}

EvaluationDatasetResult

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

שדות
name

string

מזהה. שם המשאב של תוצאת מערך הנתונים להערכה. פורמט: projects/{project}/locations/{location}/brands/{brand}/evaluationDatasetResults/{evaluation_dataset_result}

evaluation_dataset

string

פלט בלבד. ההפניה לקבוצת הנתונים להערכה שהתוצאה הזו משויכת אליה. פורמט: projects/{project}/locations/{location}/brands/{brand}/evaluationDatasets/{evaluation_dataset}

evaluation_case_results[]

string

פלט בלבד. רשימת התוצאות של מקרי ההערכה של מערך נתוני ההערכה. פורמט: projects/{project}/locations/{location}/brands/{brand}/evaluationCaseResults/{evaluation_case_result}

EvaluationMatcher

התאמה להערכה.

שדות
name

string

מזהה. שם המשאב של ההתאמה להערכה.

display_name

string

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

description

string

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

שדה של איחוד matcher. ההתאמה שבה משתמשים להתאמת ההערכה. ההתאמה צריכה להפיק תוצאה בוליאנית שמציינת אם ההתאמה של ההערכה עברה או לא. הערך matcher יכול להיות רק אחד מהבאים:
order_result_matcher

OrderResultMatcher

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

agent_utterance_string_matcher

AgentUtteranceStringMatcher

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

llm_judgement_matcher

LLMJudgementMatcher

זה שינוי אופציונלי. התאמה להערכה באמצעות שיפוט של מודל שפה גדול (LLM).

AgentUtteranceStringMatcher

התאמת הערכה למחרוזת של אמירה של נציג.

שדות
invert

bool

זה שינוי אופציונלי. אם הערך הוא True, תנאי ההתאמה הפוך (למשל, "לא מכיל" או "לא תואם").

שדה של איחוד match_pattern.

הערך match_pattern יכול להיות רק אחד מהבאים:

contains

string

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

regex

string

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

LLMJudgementMatcher

התאמה להערכה באמצעות שיפוט של LLM עם ההנחיה הבאה: "אתה עוזר אישי שמסייע למשתמשים לבצע הזמנות ממסעדה. יוצגו לך קלט של משתמשים ותשובות של סוכנים. המשימה שלך היא לקבוע אם התשובה של הנציג עומדת בקריטריונים הבאים: {criteria}"

שדות
criteria

string

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

invert

bool

זה שינוי אופציונלי. אם הערך הוא True, תנאי ההתאמה הפוך (למשל, "לא מכיל").

OrderResultMatcher

התאמה של הערכה לתוצאה של הזמנה.

שדות
expected_order

Order

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

expected_legacy_order

Struct

זה שינוי אופציונלי. מצב ההזמנה הקודם שצפוי להתאים. הערך הזה משמש כשההקשר של ההערכה כולל את use_legacy_order_state שמוגדר כ-true.

EventInput

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

שדות
שדה של איחוד event. המזהה הבא: 10 האירוע שיופעל. הערך event יכול להיות רק אחד מהבאים:
drive_off_event

DriveOffEvent

אירוע של נסיעה בלי לשלם.

crew_interjection_event

CrewInterjectionEvent

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

update_order_state_event

OrderStateUpdateEvent

עדכון בצד הלקוח של מצב ההזמנה.

client_escalation_event

ClientEscalationEvent

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

customized_input_event

CustomizedInputEvent

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

caller_hangup_event

CallerHangupEvent

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

pos_error_input

PosErrorEvent

זה שינוי אופציונלי. אירוע שגיאה ב-POS.

CallerHangupEvent

בסוג הזה אין שדות.

מציין שהלקוח ניתק את השיחה מוקדם מדי (למשל, בגלל סלידה מ-AI).

ClientEscalationEvent

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

שדות
reason

string

זה שינוי אופציונלי. הסיבה להעברת הלקוח לטיפול ברמה גבוהה יותר, למשל: "payment-declined",‏ "pos-error",‏ "integration-error" וכו'.

CrewInterjectionEvent

אירוע של התפרצות לשיחה של הצוות. זה מציין שחבר צוות התערב בסשן. הסשן ייסגר אחרי האירוע הזה.

שדות
mode

string

זה שינוי אופציונלי. המצב שבו איש הצוות התערב, למשל "אוזניות", "pos".

CustomizedInputEvent

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

שדות
input

Struct

חובה. קלט מהלקוח לסוכן.

DriveOffEvent

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

שדות
reason

string

זה שינוי אופציונלי. הסיבה לעזיבה, למשל "ההזמנה הושלמה", "עזיבה לא צפויה".

OrderStateUpdateEvent

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

שדות
order

Order

חובה. הסטטוס המעודכן של ההזמנה שמשויכת לסשן הזה.

PosErrorEvent

כשלים ספציפיים לנקודת מכירה (POS).

שדות
error_messages[]

string

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

affected_item_uids[]

string

זה שינוי אופציונלי. מזהי פריטים ייחודיים שנוצרו על ידי סוכן ה-AI להזמנה ממסעדות וגרמו לשגיאה. תואם ל-UpdatedOrderState.OrderItem.uid.

affected_external_ids[]

string

זה שינוי אופציונלי. רשימה של מזהים חיצוניים (מהתפריט) שגרמו לשגיאה. הערך צריך להיות זהה לייצוגים בפועל בנקודת המכירה, שבדרך כלל נמצאים במאפייני השילוב ב-menu.proto (למשל, ב-ItemIntegrationAttributes או ב-ModifierIntegrationAttributes).

metadata

map<string, string>

זה שינוי אופציונלי. מטא-נתונים בפורמט חופשי לניפוי באגים או לאיתות ספציפי למותג. אפשר להשתמש בו כדי להעביר קטגוריות או קודי שגיאה ספציפיים למותג (למשל, {"BRAND_ERROR_CODE": "OUT_OF_STOCK"}).

FeatureGate

ה-Feature Gates של הסשן. הוא משמש להפעלה או להשבתה של תכונות בסשן.

שדות
trigger_offer_engine_on_demand

bool

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

trigger_loyalty_on_demand

bool

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

trigger_order_media_assistant_on_demand

bool

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

menu_response_enabled

bool

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

revamped_payment_flow_enabled

bool

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

updated_order_state_enabled

bool

זה שינוי אופציונלי. אם השדה מוגדר, מוחזר updated_order_state במקום legacy_order_state_response.

enable_order_status_retrieval

bool

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

FeaturesConfig

הגדרות של תכונות הנציג. רשימת feature flag שמשמשת ליצירת הוראות וכלים בהתאמה אישית של הסוכן.

שדות
order_pickup

OrderPickup

זה שינוי אופציונלי. הגדרת התכונה "איסוף הזמנה".

order_dine_in

OrderDineIn

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

name_collection

NameCollection

זה שינוי אופציונלי. הגדרת התכונה "איסוף שמות".

confirm_order_info_at_start
(deprecated)

bool

זה שינוי אופציונלי. אם לאשר את פרטי ההזמנה בתחילת הסשן. הוצא משימוש: הוחלף על ידי confirm_order_info_on_finalize.

confirm_order_info_on_finalize

bool

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

get_order_prices

GetOrderPrices

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

end_session_with_checkout_request

EndSessionWithCheckoutRequest

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

enable_address_collection

EnableAddressCollection

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

support_cash_payment

SupportCashPayment

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

budget_based_ordering

bool

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

EnableAddressCollection

בסוג הזה אין שדות.

הנציג יכול לאסוף את הכתובת למשלוח של הלקוח במהלך הסשן.

EndSessionWithCheckoutRequest

בסוג הזה אין שדות.

הסוכן יכול לסיים את הסשן עם בקשת תשלום.

GetOrderPrices

בסוג הזה אין שדות.

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

NameCollection

בסוג הזה אין שדות.

הנציג יכול לאסוף את שם הלקוח במהלך השיחה.

OrderDineIn

בסוג הזה אין שדות.

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

OrderPickup

בסוג הזה אין שדות.

הלקוחות יכולים להזמין אוכל לאיסוף עצמי באמצעות הנציג.

SupportCashPayment

בסוג הזה אין שדות.

הסוכן יכול לתמוך בתשלום במזומן.

FinalizeOrderRequest

בסוג הזה אין שדות.

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

FinalizeOrderResponse

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

שדות
payment_flow_enabled

bool

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

payment_info

PaymentInfo

זה שינוי אופציונלי. פרטי התשלום של הלקוח. אם הערך של payment_flow_enabled הוא false, לא תתבצע פעולה.

total_amount_due

Money

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

order_price_info

OrderPriceInfo

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

FulfillmentMethod

שיטת המילוי של הזמנה.

טיפוסים בני מנייה (enum)
FULFILLMENT_METHOD_UNSPECIFIED שיטת מילוי ההזמנה לא צוינה.
FULFILLMENT_METHOD_DINE_IN הזמנה שהלקוח יצרוך בחנות.
FULFILLMENT_METHOD_PICKUP הזמנה שהלקוח יאסוף מהחנות.
FULFILLMENT_METHOD_DRIVE_THRU הזמנה שבוצעה ב-drive thru.
FULFILLMENT_METHOD_DELIVERY הזמנה שתסופק ללקוח.
FULFILLMENT_METHOD_CURBSIDE הזמנה באיסוף מדלת העסק. הלקוח יחנה את הרכב במקום ייעודי מחוץ לחנות, וההזמנה תובא אליו.

GetBrandRequest

הודעת בקשה עבור MenuService.GetBrand.

שדות
name

string

חובה. שם המותג שרוצים לאחזר. פורמט: projects/{project}/locations/{location}/brands/{brand}

GetBrandRevisionRequest

הודעת בקשה עבור MenuService.GetBrandRevision.

שדות
name

string

חובה. השם של גרסת המותג שרוצים לאחזר. פורמט: projects/{project}/locations/{location}/brands/{brand}/revisions/{revision}

GetChannelConfigRequest

הודעת בקשה עבור MenuService.GetChannelConfig.

שדות
name

string

חובה. השם של הגדרת הערוץ שרוצים לאחזר. פורמט: projects/{project}/locations/{location}/brands/{brand}/channelConfigs/{channel_config}

GetChannelConfigRevisionRequest

הודעת בקשה עבור MenuService.GetChannelConfigRevision.

שדות
name

string

חובה. השם של גרסת הגדרת הערוץ שרוצים לאחזר. פורמט: projects/{project}/locations/{location}/brands/{brand}/channelConfigs/{channel_config}/revisions/{revision}

GetConfigApplicationRuleRequest

הודעת בקשה עבור MenuService.GetConfigApplicationRule.

שדות
name

string

חובה. שם כלל הגדרת האפליקציה שרוצים לאחזר. פורמט: projects/{project}/locations/{location}/brands/{brand}/configApplicationRules/{config_application_rule}

GetConfigApplicationRuleRevisionRequest

הודעת בקשה עבור MenuService.GetConfigApplicationRuleRevision.

שדות
name

string

חובה. השם של גרסת הכלל של הגדרת האפליקציה שרוצים לאחזר. פורמט: projects/{project}/locations/{location}/brands/{brand}/configApplicationRules/{config_application_rule}/revisions/{revision}

GetDiscountRequest

הודעת בקשה עבור MenuService.GetDiscount.

שדות
name

string

חובה. שם ההנחה שרוצים לאחזר. פורמט: projects/{project}/locations/{location}/brands/{brand}/stores/{store}/discounts/{discount}

GetEvaluationCaseRequest

הודעת בקשה עבור MenuService.GetEvaluationCase.

שדות
name

string

חובה. שם מקרה ההערכה שרוצים לאחזר. פורמט: projects/{project}/locations/{location}/brands/{brand}/evaluationCases/{evaluation_case}

GetEvaluationCaseResultRequest

הודעת בקשה עבור MenuService.GetEvaluationCaseResult.

שדות
name

string

חובה. שם התוצאה של מקרה ההערכה שרוצים לאחזר. פורמט: projects/{project}/locations/{location}/brands/{brand}/evaluationCaseResults/{evaluation_case_result}

GetEvaluationContextRequest

הודעת בקשה עבור MenuService.GetEvaluationContext.

שדות
name

string

חובה. שם הקשר ההערכה שרוצים לאחזר. פורמט: projects/{project}/locations/{location}/brands/{brand}/evaluationContexts/{evaluation_context}

GetEvaluationDatasetRequest

הודעת בקשה עבור MenuService.GetEvaluationDataset.

שדות
name

string

חובה. שם קבוצת הנתונים להערכה שרוצים לאחזר. פורמט: projects/{project}/locations/{location}/brands/{brand}/evaluationDatasets/{evaluation_dataset}

GetEvaluationDatasetResultRequest

הודעת בקשה עבור MenuService.GetEvaluationDatasetResult.

שדות
name

string

חובה. שם התוצאה של מערך הנתונים להערכה שרוצים לאחזר. פורמט: projects/{project}/locations/{location}/brands/{brand}/evaluationDatasetResults/{evaluation_dataset_result}

GetEvaluationMatcherRequest

הודעת בקשה עבור MenuService.GetEvaluationMatcher.

שדות
name

string

חובה. השם של ההתאמה להערכה שרוצים לאחזר. פורמט: projects/{project}/locations/{location}/brands/{brand}/evaluationMatchers/{evaluation_matcher}

GetIngestionLogRequest

הודעת בקשה עבור MenuService.GetIngestionLog.

שדות
name

string

חובה. שם יומן ההטמעה שרוצים לאחזר. פורמט: projects/{project}/locations/{location}/brands/{brand}/ingestionLogs/{ingestion_log}

GetInventoryRequest

הודעת בקשה עבור MenuService.GetInventory.

שדות
name

string

חובה. שם המלאי שרוצים לאחזר. פורמט: projects/{project}/locations/{location}/brands/{brand}/stores/{store}/inventories/{inventory}

GetMenuRequest

הודעת בקשה עבור MenuService.GetMenu.

שדות
name

string

חובה. שם התפריט שרוצים לאחזר. פורמט: projects/{project}/locations/{location}/menus/{menu}

GetSessionRecordRequest

הודעת בקשה ל-[SessionRecordService.GetSessionRecord][].

שדות
name

string

חובה. שם רשומת הסשן שרוצים לאחזר. פורמט: projects/{project}/locations/{location}/brands/{brand}/sessionRecords/{session_record}

GetStoreRequest

הודעת בקשה עבור MenuService.GetStore.

שדות
name

string

חובה. שם החנות שרוצים לאחזר. פורמט: projects/{project}/locations/{location}/brands/{brand}/stores/{store}

GetStoreRevisionRequest

הודעת בקשה עבור MenuService.GetStoreRevision.

שדות
name

string

חובה. השם של גרסת החנות שרוצים לאחזר. פורמט: projects/{project}/locations/{location}/brands/{brand}/stores/{store}/revisions/{revision}

GreetingOffer

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

שדות
messages[]

OfferMessage

חובה. הודעות פתיחה למכירת מוצר או שירות לא קשור (upsell).

ברכות

מייצג הודעות פתיחה בשפה ספציפית.

שדות
language_code

string

זה שינוי אופציונלי. קוד השפה של ביטויי הפתיחה. קוד שפה בתקן BCP-47, כמו "en-US" או "fr-CA".

greeting_phrases[]

string

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

HistoryEntry

רשומת היסטוריה של גרסת משאב.

שדות
commit_time

Timestamp

השעה שבה נוצרה הגרסה.

created_by

string

המשתמש או השירות שיצרו את הגרסה.

revision_name

string

שם המשאב המלא של הגרסה.

resource_type

string

סוג המשאב הבסיסי (למשל, "מותג", "חנות", "ChannelConfig").

action

RevisionAction

הפעולה שיצרה את הגרסה הזו.

שדה של איחוד resource_revision. גרסת המשאב. הערך resource_revision יכול להיות רק אחד מהבאים:
brand

Brand

המותג בזמן ה-commit.

store

Store

החנות בזמן השמירה.

channel_config

ChannelConfig

הגדרת הערוץ בזמן השמירה.

config_application_rule

ConfigApplicationRule

כלל הגדרת האפליקציה בזמן השמירה.

תמונה

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

שדות
source_uri

string

חובה. מזהה ה-URI של מקור התמונה.

sources[]

ImageSource

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

ImageSource

כתובת ה-URI של התמונה עם הרזולוציה.

שדות
uri

string

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

width

int32

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

height

int32

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

IngestionLog

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

שדות
name

string

מזהה. שם המשאב של יומן ההטמעה. פורמט: projects/{project}/locations/{location}/brands/{brand}/ingestionLogs/{ingestion_log}

store

string

זה שינוי אופציונלי. שם המשאב של החנות להטמעה. פורמט: projects/{project}/locations/{location}/brands/{brand}/stores/{store}

state

State

פלט בלבד. נתונים על המצב הנוכחי של הטמעת הנתונים.

start_time

Timestamp

פלט בלבד. השעה שבה התחילה משימת ההטמעה.

end_time

Timestamp

פלט בלבד. השעה שבה הסתיימה משימת ההטמעה.

phases[]

IngestionPhase

פלט בלבד. רשימה של זמני ריצה של שלבים.

מדינה

הסטטוס של הטמעת הנתונים.

טיפוסים בני מנייה (enum)
STATE_UNSPECIFIED הסטטוס לא צוין.
SUCCEEDED ההטמעה בוצעה בהצלחה.
FAILED ההטמעה נכשלה.
PROCESSING ההטמעה בתהליך עיבוד.

IngestionPhase

שלב בהרצת הטמעת הנתונים.

שדות
phase

Phase

חובה. שם השלב.

start_time

Timestamp

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

end_time

Timestamp

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

state

State

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

details

string

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

שלב

Enum לשם השלב.

טיפוסים בני מנייה (enum)
PHASE_UNSPECIFIED השלב לא צוין.
READ_SOURCE_MENU תפריט המקורות.
PARSE_SOURCE_MENU ניתוח של תפריט המקור.
BRAND_SPECIFIC_VALIDATION מתבצע אימות של ההגדרות הספציפיות למותג.
BRAND_AGNOSTIC_VALIDATION אימות ההגדרה של המותג האגנוסטי.
CREATE_MENU התפריט נוצר.

מדינה

מצב הביצוע של השלב.

טיפוסים בני מנייה (enum)
STATE_UNSPECIFIED המצב לא צוין.
SUCCEEDED השלב הסתיים בהצלחה.
FAILED השלב נכשל.

אינטראקציה

מייצג אינטראקציה אחת בתור בשיחה.

שדות
turn_position

int64

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

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

UserUtterance

הביטוי של המשתמש.

agent_utterance

AgentUtterance

האמירה של הנציג.

resolve_order

ResolveOrder

הסוכן מבצע קריאה ל-ResolveOrder

submit_order

SubmitOrder

הסוכן ביצע קריאה ל-SubmitOrder

match_intent

MatchIntent

הסוכן ביצע קריאת MatchIntent

client_execution

ClientExecution

הסוכן ביצע קריאת ClientExecution

client_order_update

ClientOrderUpdate

עדכון מצב ההזמנה ביוזמת הלקוח

AgentUtterance

האמירה של הנציג.

שדות
text

string

הטקסט של מה שהנציג אמר.

create_time

Timestamp

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

ClientExecution

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

שדות
tool_name

string

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

input

ClientExecutionInput

הקלט לאינטראקציה של ביצוע הלקוח.

output

ClientExecutionOutput

הפלט של האינטראקציה עם הלקוח.

ClientExecutionInput

הקלט לאינטראקציה של ביצוע הלקוח.

שדות
payload

Struct

המטען הייעודי (payload) של הקלט של אינטראקציית ההרצה בצד הלקוח.

ClientExecutionOutput

הפלט של האינטראקציה עם הלקוח.

שדות
payload

Struct

המטען הייעודי (payload) של פלט האינטראקציה של הרצת הלקוח.

ClientOrderUpdate

עדכון מצב ההזמנה ביוזמת הלקוח.

שדות
order

Order

עדכון סטטוס הזמנה שנשלח על ידי הלקוח.

MatchIntent

האינטראקציה של התאמת הכוונה.

שדות
input

MatchIntentInput

הקלט לאינטראקציה של התאמת כוונה.

output

MatchIntentOutput

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

MatchIntentInput

הקלט לאינטראקציה של התאמת כוונה.

שדות
payload

Struct

המטען הייעודי (payload) של הקלט לאינטראקציה של כוונת ההתאמה.

MatchIntentOutput

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

שדות
payload

Struct

המטען הייעודי (payload) של פלט האינטראקציה של כוונת ההתאמה.

ResolveOrder

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

שדות
input

ResolveOrderInput

הקלט לפעולה של פתרון ההזמנה.

output

ResolveOrderOutput

הפלט של פעולת פתרון ההזמנה.

ResolveOrderInput

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

שדות
payload

Struct

המטען הייעודי (payload) לאינטראקציה של פתרון ההזמנה.

ResolveOrderOutput

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

שדות
payload

Struct

המטען הייעודי (payload) של פלט האינטראקציה לפתרון ההזמנה.

SubmitOrder

בסוג הזה אין שדות.

האינטראקציה של שליחת ההזמנה.

UserUtterance

הביטוי של המשתמש.

שדות
text

string

הטקסט של מה שהמשתמש אמר.

create_time

Timestamp

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

InteractionMode

מצב האינטראקציה של הנציג.

טיפוסים בני מנייה (enum)
INTERACTION_MODE_UNSPECIFIED מצב האינטראקציה לא צוין.
ORDER_TAKING הסוכן משתתף בשיחה דו-כיוונית כדי לקבל הזמנות.
LISTEN_ONLY הנציג רק מקשיב ולא מדבר.

InterruptionSignal

בסוג הזה אין שדות.

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

IntervalMetrics

מייצג מדדי ניתוח נתונים לפרק זמן ספציפי.

שדות
interval

Interval

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

total_order_count

int64

פלט בלבד. המספר הכולל של ההזמנות.

success_order_count

int64

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

avg_order_duration_ms

int64

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

upsell_success_rate

double

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

upsell_revenue

Money

פלט בלבד. ההכנסה ממכירת מוצר או שירות משודרג (upsell).

escalation_count

int64

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

predicted_failure_category_counts[]

PredictedFailureCategoryCount

פלט בלבד. מספר התקלות הצפויות לפי קטגוריה.

invalid_order_count

int64

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

crew_escalation_count

int64

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

PredictedFailureCategoryCount

מספר קטגוריות הכשלים הצפויות.

שדות
category

string

פלט בלבד. קטגוריית הכשל החזויה.

count

int64

פלט בלבד. מספר הסשנים בקטגוריה הזו.

מלאי שטחי פרסום

משאב מלאי של חנות.

שדות
name

string

מזהה. שם המשאב של המלאי. פורמט: projects/{project}/locations/{location}/brands/{brand}/stores/{store}/inventories/{inventory}

item_id

string

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

modifier_id

string

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

pos_id

string

זה שינוי אופציונלי. מזהה נקודת המכירה (POS) שמשויך למלאי הזה.

quantity

int32

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

status

Status

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

סטטוס

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

טיפוסים בני מנייה (enum)
STATUS_UNSPECIFIED סטטוס לא מוגדר.
IN_STOCK הפריט או השינוי זמינים במלאי.
OUT_OF_STOCK הפריט או השינוי חסר במלאי.

פריט

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

שדות
id

string

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

semantic_name

string

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

display_name

string

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

category_ids[]

string

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

description

string

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

image

Image

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

availability

Availability

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

base_price

Money

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

integration_attributes

ItemIntegrationAttributes

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

modifier_groups[]

ModifierGroupReference

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

modifier_constraints

ModifierConstraints

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

ItemGroup

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

שדות
name

string

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

שדה של איחוד type. סוג קבוצת הפריטים. הערך type יכול להיות רק אחד מהבאים:
select_items

SelectItems

רשימה של התאמות. פריט נחשב להתאמה אם הוא עומד באחד מהקריטריונים האלה של ItemMatcher (לוגיקת OR).

all_of

AllOf

מייצג AND לוגי של קבוצות משנה.

any_of

AnyOf

מייצג OR לוגי של קבוצות משנה.

AllOf

מייצג AND לוגי של קבוצות משנה.

שדות
groups[]

ItemGroup

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

AnyOf

מייצג OR לוגי של קבוצות משנה.

שדות
groups[]

ItemGroup

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

SelectItems

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

שדות
matches[]

ItemMatcher

חובה. התאמות לפריטים.

min_quantity

int32

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

max_quantity

int32

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

ItemIntegrationAttributes

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

שדות
custom_integration_attributes

Struct

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

stream_attributes

StreamIntegrationAttributes

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

toast_attributes

ToastIntegrationAttributes

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

StreamIntegrationAttributes

מייצג מאפיינים של פריט מתפריט של סטרימינג.

שדות
taxes[]

Tax

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

item_family_id

string

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

Tax

פרטי שיעור המס שמשויך לפריט הזה.

שדות
stream_id

string

חובה. מזהה המס בתפריט "עדכונים".

is_inclusive

bool

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

rate

float

חובה. שיעור המס באחוזים.

display_name

string

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

is_default

bool

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

ToastIntegrationAttributes

מייצג מאפיינים של פריט מתפריט Toast.

שדות
menu_group_guid

string

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

ItemMatcher

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

שדות
item_id

string

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

modifier_id

string

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

category_id

string

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

modifier_matcher

ModifierMatcher

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

ModifierMatcher

מגדיר את הקריטריונים להתאמת משתני הגישה.

שדות
allowed_modifier_ids[]

string

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

min_modifiers

int32

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

max_modifiers

int32

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

ListBrandHistoryRequest

הודעת בקשה עבור MenuService.ListBrandHistory.

שדות
parent

string

חובה. המותג שרוצים להציג את ההיסטוריה שלו. פורמט: projects/{project}/locations/{location}/brands/{brand}

page_size

int32

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

page_token

string

זה שינוי אופציונלי. טוקן של דף שהתקבל מקריאה קודמת של ListBrandHistory.

filter

string

זה שינוי אופציונלי. ביטוי לסינון התוצאות. מסננים נתמכים: - user: סינון לפי המשתמש שיצר את הפריט. - timestamp: סינון לפי זמן השמירה. ‫- resource_type: סינון לפי סוג המשאב.

ListBrandHistoryResponse

הודעת התשובה של MenuService.ListBrandHistory.

שדות
brand_history[]

HistoryEntry

הרשומות בהיסטוריה.

next_page_token

string

טוקן שאפשר לשלוח כ-page_token כדי לאחזר את הדף הבא.

ListBrandRevisionsRequest

הודעת בקשה עבור MenuService.ListBrandRevisions.

שדות
parent

string

חובה. מותג האב, שהגרסאות האלה שייכות לו. פורמט: projects/{project}/locations/{location}/brands/{brand}

page_size

int32

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

page_token

string

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

ListBrandRevisionsResponse

הודעת התשובה של MenuService.ListBrandRevisions.

שדות
brand_revisions[]

BrandRevision

גרסאות המותג מהאוסף שצוין.

next_page_token

string

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

ListBrandsRequest

הודעת בקשה עבור MenuService.ListBrands.

שדות
parent

string

חובה. חברת האם, שהיא הבעלים של קבוצת המותגים הזו. פורמט: projects/{project}/locations/{location}

page_size

int32

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

page_token

string

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

ListBrandsResponse

הודעת התשובה של MenuService.ListBrands.

שדות
brands[]

Brand

המותגים מהקולקציה שצוינה.

next_page_token

string

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

ListChannelConfigRevisionsRequest

הודעת בקשה עבור MenuService.ListChannelConfigRevisions.

שדות
parent

string

חובה. הגדרת הערוץ הראשי, שבבעלותו אוסף הגרסאות הזה. פורמט: projects/{project}/locations/{location}/brands/{brand}/channelConfigs/{channel_config}

page_size

int32

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

page_token

string

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

ListChannelConfigRevisionsResponse

הודעת התשובה של MenuService.ListChannelConfigRevisions.

שדות
channel_config_revisions[]

ChannelConfigRevision

גרסאות הגדרות הערוץ מהאוסף שצוין.

next_page_token

string

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

ListChannelConfigsRequest

הודעת בקשה עבור MenuService.ListChannelConfigs.

שדות
parent

string

חובה. מותג האם, שבבעלותו אוסף הגדרות הערוצים הזה. פורמט: projects/{project}/locations/{location}/brands/{brand}

page_size

int32

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

page_token

string

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

filter

string

זה שינוי אופציונלי. ביטוי לסינון התוצאות. תחביר הביטוי מתועד בכתובת https://google.aip.dev/160.

השדות הבאים נתמכים: - type

דוגמאות: - type="AGENT_CUSTOMIZATION"

ListChannelConfigsResponse

הודעת התשובה של MenuService.ListChannelConfigs.

שדות
channel_configs[]

ChannelConfig

הגדרות הערוצים מהאוסף שצוין.

next_page_token

string

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

ListConfigApplicationRuleRevisionsRequest

הודעת בקשה עבור MenuService.ListConfigApplicationRuleRevisions.

שדות
parent

string

חובה. כלל האפליקציה של הגדרת ההורה, שבבעלותו אוסף הגרסאות הזה. פורמט: projects/{project}/locations/{location}/brands/{brand}/configApplicationRules/{config_application_rule}

page_size

int32

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

page_token

string

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

ListConfigApplicationRuleRevisionsResponse

הודעת התשובה של MenuService.ListConfigApplicationRuleRevisions.

שדות
config_application_rule_revisions[]

ConfigApplicationRuleRevision

גרסאות הכללים של הגדרות האפליקציה מהאוסף שצוין.

next_page_token

string

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

ListConfigApplicationRulesRequest

הודעת בקשה עבור MenuService.ListConfigApplicationRules.

שדות
parent

string

חובה. המותג הראשי, שהאוסף הזה של כללי הגדרת האפליקציה שייך לו. פורמט: projects/{project}/locations/{location}/brands/{brand}

page_size

int32

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

page_token

string

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

ListConfigApplicationRulesResponse

הודעת התשובה של MenuService.ListConfigApplicationRules.

שדות
config_application_rules[]

ConfigApplicationRule

כללי הגדרת האפליקציה מהאוסף שצוין.

next_page_token

string

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

ListDiscountsRequest

הודעת בקשה עבור MenuService.ListDiscounts.

שדות
parent

string

חובה. החנות הראשית, שהיא הבעלים של אוסף ההנחות הזה. פורמט: projects/{project}/locations/{location}/brands/{brand}/stores/{store}

page_size

int32

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

page_token

string

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

filter

string

זה שינוי אופציונלי. ביטוי סינון שמבוסס על AIP-160.

ListDiscountsResponse

הודעת התשובה של MenuService.ListDiscounts.

שדות
discounts[]

Discount

ההנחות מהאוסף שצוין.

next_page_token

string

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

ListEvaluationCaseResultsRequest

הודעת בקשה עבור MenuService.ListEvaluationCaseResults.

שדות
parent

string

חובה. מותג האב, שבבעלותו אוסף התוצאות של מקרי ההערכה. פורמט: projects/{project}/locations/{location}/brands/{brand}

page_size

int32

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

page_token

string

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

filter

string

זה שינוי אופציונלי. אחזור רק של תוצאות של מקרי הערכה שתואמות למסנן. כרגע יש תמיכה רק בסינון לפי evaluation_case, למשל evaluation_case="projects/{project}/locations/{location}/brands/{brand}/evaluationCases/{case_id}".

ListEvaluationCaseResultsResponse

הודעת התשובה של MenuService.ListEvaluationCaseResults.

שדות
evaluation_case_results[]

EvaluationCaseResult

תוצאות מקרה ההערכה מהאוסף שצוין. [(google.api.field_policy).auditing = "AUDIT_SIZE"];

next_page_token

string

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

ListEvaluationCasesRequest

הודעת בקשה עבור MenuService.ListEvaluationCases.

שדות
parent

string

חובה. המותג הראשי, שבבעלותו אוסף מקרי ההערכה הזה. פורמט: projects/{project}/locations/{location}/brands/{brand}

page_size

int32

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

page_token

string

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

ListEvaluationCasesResponse

הודעת התשובה של MenuService.ListEvaluationCases.

שדות
evaluation_cases[]

EvaluationCase

תרחישי ההערכה מהאוסף שצוין. [(google.api.field_policy).auditing = "AUDIT_SIZE"];

next_page_token

string

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

ListEvaluationContextsRequest

הודעת בקשה עבור MenuService.ListEvaluationContexts.

שדות
parent

string

חובה. מותג האב, שבבעלותו אוסף הקשרי ההערכה הזה. פורמט: projects/{project}/locations/{location}/brands/{brand}

page_size

int32

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

page_token

string

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

ListEvaluationContextsResponse

הודעת התשובה של MenuService.ListEvaluationContexts.

שדות
evaluation_contexts[]

EvaluationContext

הקשרי ההערכה מהאוסף שצוין. [(google.api.field_policy).auditing = "AUDIT_SIZE"];

next_page_token

string

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

ListEvaluationDatasetResultsRequest

הודעת בקשה עבור MenuService.ListEvaluationDatasetResults.

שדות
parent

string

חובה. המותג הראשי, שבבעלותו אוסף התוצאות הזה של מערך נתוני ההערכה. פורמט: projects/{project}/locations/{location}/brands/{brand}

page_size

int32

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

page_token

string

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

ListEvaluationDatasetResultsResponse

הודעת התשובה של MenuService.ListEvaluationDatasetResults.

שדות
evaluation_dataset_results[]

EvaluationDatasetResult

תוצאות מערך הנתונים להערכה מהאוסף שצוין. [(google.api.field_policy).auditing = "AUDIT_SIZE"];

next_page_token

string

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

ListEvaluationDatasetsRequest

הודעת בקשה עבור MenuService.ListEvaluationDatasets.

שדות
parent

string

חובה. מותג האם, שבבעלותו אוסף מערכי הנתונים להערכה. פורמט: projects/{project}/locations/{location}/brands/{brand}

page_size

int32

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

page_token

string

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

ListEvaluationDatasetsResponse

הודעת התשובה של MenuService.ListEvaluationDatasets.

שדות
evaluation_datasets[]

EvaluationDataset

קבוצות הנתונים להערכה מהאוסף שצוין. [(google.api.field_policy).auditing = "AUDIT_SIZE"];

next_page_token

string

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

ListEvaluationMatchersRequest

הודעת בקשה עבור MenuService.ListEvaluationMatchers.

שדות
parent

string

חובה. מותג האב, שבבעלותו אוסף ההתאמות להערכה. פורמט: projects/{project}/locations/{location}/brands/{brand}

page_size

int32

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

page_token

string

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

ListEvaluationMatchersResponse

הודעת התשובה של MenuService.ListEvaluationMatchers.

שדות
evaluation_matchers[]

EvaluationMatcher

ההתאמות להערכה מהאוסף שצוין. [(google.api.field_policy).auditing = "AUDIT_SIZE"];

next_page_token

string

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

ListIngestionLogsRequest

הודעת בקשה עבור MenuService.ListIngestionLogs.

שדות
parent

string

חובה. משאב ההורה, שבבעלותו אוסף יומני ההטמעה האלה. פורמט: projects/{project}/locations/{location}/brands/{brand}

page_size

int32

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

page_token

string

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

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

filter

string

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

ListIngestionLogsResponse

הודעת התשובה של MenuService.ListIngestionLogs.

שדות
ingestion_logs[]

IngestionLog

יומני הטמעת הנתונים מהאוסף שצוין.

next_page_token

string

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

ListInventoriesRequest

הודעת בקשה עבור MenuService.ListInventories.

שדות
parent

string

חובה. החנות הראשית, שהיא הבעלים של אוסף המלאי הזה. פורמט: projects/{project}/locations/{location}/brands/{brand}/stores/{store}

page_size

int32

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

page_token

string

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

filter

string

זה שינוי אופציונלי. ביטוי סינון שמבוסס על AIP-160.

ListInventoriesResponse

הודעת התשובה של MenuService.ListInventories.

שדות
inventories[]

Inventory

המלאי מהאוסף שצוין.

next_page_token

string

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

ListMenusRequest

הודעת בקשה עבור MenuService.ListMenus.

שדות
parent

string

חובה. ההורה, שהוא הבעלים של אוסף התפריטים הזה. פורמט: projects/{project}/locations/{location}

page_size

int32

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

page_token

string

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

filter

string

זה שינוי אופציונלי. ביטוי לסינון התוצאות. תחביר הביטוי מתועד בכתובת https://google.aip.dev/160.

השדות הבאים נתמכים: - store - brand

store=projects/my-project/locations/us-central1/brands/my-brand/stores/my-store - brand=projects/my-project/locations/us-central1/brands/my-brand

view

MenuView

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

ListMenusResponse

הודעת התשובה של MenuService.ListMenus.

שדות
menus[]

Menu

התפריטים מהאוסף שצוין.

next_page_token

string

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

ListSessionRecordsRequest

הודעת בקשה ל-[SessionRecordService.ListSessionRecords][].

שדות
parent

string

חובה. המותג שרוצים להציג את סשני ההזמנות שלו. פורמט: projects/{project}/locations/{location}/brands/{brand}

page_size

int32

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

page_token

string

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

filter

string

זה שינוי אופציונלי. ביטוי סינון שמבוסס על AIP-160. השדה הזה מאפשר לסנן רשומות של סשנים על סמך מאפיינים שונים.

שדות סינון נתמכים:

  • ‫session_id (מחרוזת): המזהה של הסשן. אופרטורים: = דוגמה: session_id = "session-123"

  • ‫store_id (מחרוזת): מזהה החנות. אופרטורים: =, != דוגמה: store_id = "store-123"

  • ‫store_ids (מחרוזת): רשימה מופרדת בפסיקים של מזהי חנויות. אופרטורים: =, !=, : דוגמה: store_ids = "store-123,store-456"

  • ‫session_start_time (חותמת זמן): שעת ההתחלה של הסשן. חותמות הזמן צריכות להיות מחרוזת בפורמט RFC-3339 (למשל, 2012-04-21T11:30:00-04:00). אפשר להשתמש בהפרשים מ-UTC. אופרטורים: =, !=,

    , >=, <, <= דוגמה: session_start_time >= "2025-10-01T00:00:00Z"

  • outcome_label (מחרוזת): התווית של התוצאה הסופית של הסשן. אופרטורים: =, != דוגמה: outcome_label = "SUCCESS"

  • ‫outcome_group_label (מחרוזת): תווית הקבוצה של תוצאת הסשן. אופרטורים: =, != דוגמה: outcome_group_label = "SUCCESS"

  • ‫predicted_failure_category (מחרוזת): קטגוריית הכשל החזויה של הסשן מניתוח ההתערבות. אופרטורים: =, != דוגמה: predicted_failure_category = "Menu"

  • ‫agent_utterances (מחרוזת): הטקסט שהנציג אמר. אופרטור: : (אסימון HAS/חיפוש טקסט מלא) דוגמה: agent_utterances:"anything else"

  • ‫user_utterances (מחרוזת): הטקסט שהמשתמש אמר. אופרטור: : (אסימון HAS/חיפוש טקסט מלא) דוגמה: user_utterances:"burger"

אופרטורים לוגיים:

אפשר לשלב תנאים באמצעות AND,‏ OR ו-NOT. אפשר להשתמש בסוגריים () כדי לקבץ ביטויים ולשלוט בסדר ההערכה. לדוגמה: (user_utterances:"help" OR agent_utterances:"issue") AND store_id != "test-store" דוגמה: user_utterances:"order" AND session_start_time >= "2025-10-03T00:00:00Z"

ListSessionRecordsResponse

הודעת התגובה ל-[SessionRecordService.ListSessionRecords][].

שדות
session_records[]

SessionRecord

רשימת רשומות הסשנים.

next_page_token

string

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

ListStoreRevisionsRequest

הודעת בקשה עבור MenuService.ListStoreRevisions.

שדות
parent

string

חובה. חנות האב, שהיא הבעלים של אוסף הגרסאות הזה. פורמט: projects/{project}/locations/{location}/brands/{brand}/stores/{store}

page_size

int32

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

page_token

string

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

ListStoreRevisionsResponse

הודעת התשובה של MenuService.ListStoreRevisions.

שדות
store_revisions[]

StoreRevision

גרסאות החנות מהאוסף שצוין.

next_page_token

string

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

ListStoresRequest

הודעת בקשה עבור MenuService.ListStores.

שדות
parent

string

חובה. מותג האם שבבעלותו קבוצת החנויות הזו. פורמט: projects/{project}/locations/{location}/brands/{brand}

page_size

int32

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

page_token

string

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

filter

string

זה שינוי אופציונלי. ביטוי סינון שמבוסס על AIP-160. מאפשר לסנן חנויות על סמך מאפיינים שונים. שדות סינון נתמכים:

  • status (מחרוזת): סטטוס החנות. אופרטורים: =, != דוגמה: status = "ACTIVE" (ערך enum)

  • ‫update_time (חותמת זמן): מועד העדכון האחרון של החנות. חותמות הזמן צריכות להיות מחרוזת בפורמט RFC-3339 (למשל, 2012-04-21T11:30:00-04:00). אופרטורים נתמכים להפרשים מ-UTC: ‏=, !=, >, >=, <, <= דוגמה: update_time >= "2025-10-01T00:00:00Z"

  • תגים (מחרוזת): תגים שמשויכים לחנות. אופרטור: : (HAS) דוגמה: tags:"store-tag"

  • city (מחרוזת): העיר שבה נמצאת החנות. אופרטורים: =, != דוגמה: city = "Mountain View"

  • state (מחרוזת): המדינה (state) של כתובת החנות. אופרטורים: =, != דוגמה: state = "CA"

אופרטורים לוגיים:

אפשר לשלב תנאים באמצעות AND,‏ OR ו-NOT. אפשר להשתמש בסוגריים () כדי לקבץ ביטויים ולשלוט בסדר ההערכה. דוגמה: status = "ACTIVE" AND state = "CA"

ListStoresResponse

הודעת התשובה של MenuService.ListStores.

שדות
stores[]

Store

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

next_page_token

string

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

LoyaltyAmount

מייצג את סכום הנאמנות של הלקוח.

שדות
units

int64

חובה. נקודות המועדון.

LoyaltyInfo

מייצג את פרטי מועדון הלקוחות של הלקוח.

שדות
loyalty_amount

LoyaltyAmount

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

מגדיר תפריט של מה שאפשר להזמין ממסעדה.

שדות
name

string

מזהה. שם התפריט. פורמט: projects/{project}/locations/{location}/menus/{menu}

store

string

זה שינוי אופציונלי. שם המשאב של החנות שהתפריט הזה משויך אליה. פורמט: projects/{project}/locations/{location}/brands/{brand}/stores/{store}

display_name

string

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

items[]

Item

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

modifiers[]

Modifier

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

modifier_groups[]

ModifierGroup

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

categories[]

MenuCategory

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

create_time

Timestamp

פלט בלבד. השעה שבה התפריט נוצר.

update_time

Timestamp

פלט בלבד. השעה שבה התפריט עודכן לאחרונה.

labels[]

MenuLabel

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

menu_schedules[]

MenuSchedule

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

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

שדות
id

string

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

display_name

string

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

description

string

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

parent_id

string

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

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

שדות
name

string

חובה. שם התווית.

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

שדות
id

string

זה שינוי אופציונלי. מזהה לוח הזמנים, למשל "BREAKFAST",‏ "LUNCH" וכו'.

schedules[]

Schedule

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

display_name

string

זה שינוי אופציונלי. מציין שם אופציונלי לתצוגה של לוח הזמנים הזה.

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

טיפוסים בני מנייה (enum)
MENU_VIEW_UNSPECIFIED ערך ברירת המחדל / ערך שלא הוגדר. כברירת מחדל, ה-API יציג את התצוגה המלאה (FULL).
MENU_VIEW_BASIC לכלול מטא-נתונים בסיסיים על התפריט.
MENU_VIEW_NAME_ONLY לכלול רק את שם התפריט
MENU_VIEW_FULL לכלול את כל הפרטים. זה ערך ברירת המחדל.

MessageConfig

הודעה בשפה ספציפית שמשמשת למכירת מוצר או שירות לא קשור (upsell).

שדות
language_code

string

חובה. קוד השפה שבה ההודעה הזו תוצג. קוד שפה בתקן BCP-47, כמו "en-US" או "fr-CA".

message_text

string

חובה. טקסט ההודעה בשפה ספציפית.

MockClientExecution

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

שדות
raw_json_request

Struct

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

raw_json_response

Struct

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

הרחבה

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

שדות
id

string

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

display_name

string

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

description

string

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

image

Image

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

semantic_name

string

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

category_ids[]

string

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

availability

Availability

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

price_adjustment

Money

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

integration_attributes

ModifierIntegrationAttributes

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

modifier_groups[]

ModifierGroupReference

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

modifier_constraints

ModifierConstraints

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

ModifierAction

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

שדות
name

string

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

ModifierConstraints

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

שדות
min_quantity

int32

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

max_quantity

int32

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

ModifierGroup

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

שדות
id

string

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

display_name

string

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

semantic_name

string

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

modifier_ids[]

string

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

modifier_actions[]

ModifierAction

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

min_selection_count

int32

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

max_selection_count

int32

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

max_selection_count_per_modifier

int32

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

integration_attributes

ModifierGroupIntegrationAttributes

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

ModifierGroupIntegrationAttributes

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

שדות
custom_integration_attributes

Struct

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

toast_attributes

ToastModifierGroupIntegrationAttributes

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

ToastModifierGroupIntegrationAttributes

מייצג מאפיינים של ModifierGroup מתפריט Toast.

שדות
guid

string

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

is_pre_modifier_group

bool

זה שינוי אופציונלי. אם הערך הוא True, קבוצת השינויים הזו מייצגת Toast PreModifierGroup.

ModifierGroupReference

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

שדות
id

string

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

default_modifiers[]

DefaultModifierSelection

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

min_selection_count

int32

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

max_selection_count

int32

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

DefaultModifierSelection

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

שדות
id

string

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

quantity

int32

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

ModifierIntegrationAttributes

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

שדות
custom_integration_attributes

Struct

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

toast_attributes

ToastModifierIntegrationAttributes

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

ToastModifierIntegrationAttributes

מייצג מאפיינים של משתנה מתפריט Toast.

שדות
guid

string

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

is_pre_modifier

bool

זה שינוי אופציונלי. אם הערך הוא True, המגדיר הזה מייצג מגדיר מראש של טוסט.

OfferMessage

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

שדות
display_name

string

זה שינוי אופציונלי. השם שיוצג ויופיע בניתוח הנתונים.

message_frequency

float

זה שינוי אופציונלי. חלק מהזמן שבו צריך להשתמש בהודעה הזו. לדוגמה: אם הערך של message_frequency הוא 0.2, ההודעה הזו תוצג ב-20% מהסשנים. אם כל הערכים של message_frequency לא מוגדרים (0.0), כל הודעה תוצג בשיעור של 1/n מהסשנים, כאשר n הוא מספר האובייקטים מסוג OfferMessage שהוגדרו לסוג המבצע. אם רק חלק מהערכים של message_frequency מוגדרים, המערכת לא תשתמש ב-OfferMessages עם ערכי message_frequency שלא הוגדרו.

upsold_items[]

string

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

message_configs[]

MessageConfig

חובה. הודעות שיווקיות לפי שפה.

upsold_item_ids[]

string

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

OperationsConfig

הגדרות לקביעת אסטרטגיה תפעולית.

שדות
display_name

string

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

description

string

זה שינוי אופציונלי. תיאור של האסטרטגיה התפעולית הזו.

upsell_strategy

UpsellStrategy

זה שינוי אופציונלי. הגדרת ההתנהגות של מכירת מוצר או שירות נוסף.

greetings[]

Greetings

זה שינוי אופציונלי. הודעות פתיחה בהתאמה אישית (לכל שפה).

default_language_code

string

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

features_config

FeaturesConfig

זה שינוי אופציונלי. הגדרת התכונות של הנציג.

interaction_mode

InteractionMode

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

disambiguation_strategy

DisambiguationStrategy

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

הזמנה

ההזמנה מייצגת את התוכן של הזמנה בתהליך או הזמנה שהושלמה של משתמש.

שדות
items[]

OrderItem

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

metadata

OrderMetadata

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

fulfillment

OrderFulfillment

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

price_info

OrderPriceInfo

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

external_order_id

string

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

order_payment

OrderPayment

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

OrderFulfillment

המאפיין OrderFulfillment מכיל מידע על אספקת הזמנות.

שדות
fulfillment_method

FulfillmentMethod

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

create_time

Timestamp

פלט בלבד. השעה שבה ההזמנה נוצרה.

target_fulfillment_time

Timestamp

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

OrderItem

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

שדות
uid

string

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

item_id

string

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

display_name

string

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

image

Image

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

base_price

Money

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

integration_attributes

ItemIntegrationAttributes

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

modifier_groups[]

OrderModifierGroup

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

quantity

int32

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

total_price

Money

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

category_ids[]

string

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

OrderMetadata

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

שדות
collected_customer_name

string

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

caller_phone_number

string

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

delivery_address

DeliveryAddress

זה שינוי אופציונלי. הכתובת למשלוח, אם ההזמנה היא למשלוח.

OrderModifier

‫OrderModifier מציין את המצב של Modifier שהוא חלק מ-OrderModifierGroup.

שדות
uid

string

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

modifier_id

string

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

display_name

string

פלט בלבד. השם המוצג של המאפיין שיוצג בממשקי המשתמש.

price_adjustment

Money

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

quantity

int32

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

modifier_action

OrderModifierAction

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

image

Image

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

integration_attributes

ModifierIntegrationAttributes

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

modifier_groups[]

OrderModifierGroup

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

is_default

bool

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

OrderModifierAction

השדה OrderModifierAction מציין את ה-ModifierAction שמשויך ל-OrderModifier שהוחל.

שדות
name

string

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

OrderModifierGroup

‫OrderModifierGroup מציין את המצב של ModifierGroup שהוא חלק מ-OrderItem.

שדות
modifier_group_id

string

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

display_name

string

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

integration_attributes

ModifierGroupIntegrationAttributes

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

modifiers[]

OrderModifier

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

OrderPayment

המידע שקשור לתשלום על הזמנה.

שדות
tipping_info

TippingInfo

זה שינוי אופציונלי. מידע על מתן טיפים.

loyalty_consumed

LoyaltyAmount

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

payment_info

PaymentInfo

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

OrderPriceInfo

‫OrderPriceInfo כולל את רכיבי המחיר השונים של הזמנה.

שדות
total_price

Money

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

subtotal_price

Money

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

tax_price

Money

זה שינוי אופציונלי. סכום המס שנוסף להזמנה.

discount

Money

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

saving

Money

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

fees

Money

זה שינוי אופציונלי. סך העמלות שחלות על ההזמנה

OrderPricesRequest

בקשה לקבלת מחירי ההזמנה.

שדות
order

Order

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

OrderPricesResponse

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

שדות
success

bool

חובה. אם מחירי ההזמנות אוחזרו בהצלחה.

order_price_info

OrderPriceInfo

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

OrderStatusRequest

בסוג הזה אין שדות.

בקשה לקבלת סטטוס ההזמנה.

OrderStatusResponse

התוצאה של קבלת סטטוס ההזמנה.

שדות
success

bool

חובה. אם סטטוס ההזמנה אוחזר בהצלחה.

OrderType

סוג ההזמנה שרוצים לבצע.

טיפוסים בני מנייה (enum)
ORDER_TYPE_UNSPECIFIED סוג ההזמנה לא צוין.
ORDER_TYPE_DRIVE_THROUGH ההזמנה היא לאיסוף עצמי מהרכב.
ORDER_TYPE_CARRY_OUT ההזמנה היא לטייק אוויי.
ORDER_TYPE_DELIVERY ההזמנה היא למשלוח.

PastOrder

ההזמנה הקודמת של המשתמש.

שדות
order

Order

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

PaymentInfo

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

שדות
credit_card_last_four_digits

string

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

credit_card_cvv

string

זה שינוי אופציונלי. קוד האימות (CVV) של כרטיס האשראי.

payment_method

PaymentMethod

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

PaymentMethod

סוג אמצעי התשלום.

טיפוסים בני מנייה (enum)
PAYMENT_METHOD_UNSPECIFIED אמצעי תשלום לא מוגדר.
PAYMENT_METHOD_CREDIT_CARD כרטיס אשראי.
PAYMENT_METHOD_CASH מזומן.

ProcessOrderRequest

הודעת בקשה עבור FoodOrderingService.ProcessOrder.

שדות
config

Config

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

turn_type

TurnType

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

שדה של איחוד input. הקלט מהלקוח. הערך input יכול להיות רק אחד מהבאים:
text_input

TextInput

קלט הטקסט מהלקוח.

audio_input

AudioInput

קלט האודיו מהלקוח.

event_input

EventInput

האירוע שהוזן מהלקוח.

client_execution_result

ClientExecutionResult

התוצאה של בקשת ביצוע של לקוח.

blob_input

Blob

קלט של נתונים בינאריים כלליים. מראות http://google3/google/cloud/ces/v1main/session_service.proto?l=720

TurnType

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

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

ProcessOrderResponse

הודעת התשובה של FoodOrderingService.ProcessOrder. מכיל פונקציונלית שדות מ-BidiProcessOrderResponse, למעט שדות ספציפיים לסטרימינג.

שדות
responses[]

BidiProcessOrderResponse

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

PromoteChannelConfigRequest

הודעת בקשה עבור MenuService.PromoteChannelConfig.

שדות
name

string

חובה. השם של הגדרת הערוץ שרוצים לקדם. פורמט: projects/{project}/locations/{location}/brands/{brand}/channelConfigs/{channel_config}

destination_brand

string

זה שינוי אופציונלי. המותג שאליו רוצים לקדם את הגדרת הערוץ. פורמט: projects/{project}/locations/{location}/brands/{brand}

אם צוין destination_brand והוא שונה מהמותג ב-name, ייווצר עותק של הגדרות הערוץ ב-destination_brand. אחרת, לא ייווצר עותק.

PromoteChannelConfigResponse

הודעת התשובה של MenuService.PromoteChannelConfig.

שדות
channel_config

ChannelConfig

הגדרת הערוץ המקודם.

RecommendedOrder

הזמנה שהסוכן המליץ עליה למשתמש.

שדות
order

Order

הסדר המומלץ שיוצג למשתמש.

RecommendedOrders

רשימת הזמנות שהסוכן ממליץ עליהן למשתמש.

שדות
recommended_orders[]

RecommendedOrder

ההזמנות המומלצות שיוצגו למשתמש.

RestartOrder

הלקוח מבקש להתחיל את ההזמנה מחדש.

שדות
confirmation_step

bool

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

RevisionAction

הפעולה שיצרה גרסה.

טיפוסים בני מנייה (enum)
REVISION_ACTION_UNSPECIFIED פעולה לא מוגדרת.
CREATE הגרסה נוצרה כי המשאב נוצר.
UPDATE הגרסה נוצרה כי המשאב עודכן.

RunEvaluationCaseMetadata

הודעת מטא-נתונים של EvaluationRunService.RunEvaluationCase.

שדות
evaluation_case

EvaluationCase

פלט בלבד. מקרה ההערכה שמופעל.

create_time

Timestamp

פלט בלבד. שעת ההתחלה של הפעולה.

RunEvaluationCaseRequest

הודעת בקשה עבור EvaluationRunService.RunEvaluationCase.

שדות
name

string

חובה. שם המשאב של מקרה ההערכה שרוצים להריץ. פורמט: projects/{project}/locations/{location}/brands/{brand}/evaluationCases/{evaluation_case}

RunEvaluationCaseResponse

הודעת התשובה של EvaluationRunService.RunEvaluationCase.

שדות
result

EvaluationCaseResult

פלט בלבד. התוצאה של הרצת מקרה ההערכה.

RunEvaluationDatasetMetadata

הודעת מטא-נתונים של EvaluationRunService.RunEvaluationDataset.

שדות
evaluation_dataset

EvaluationDataset

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

completed_cases_count

int32

פלט בלבד. מספר מקרי ההערכה שהושלמו.

passed_cases_count

int32

פלט בלבד. מספר מקרי ההערכה שעברו עד עכשיו.

create_time

Timestamp

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

completed_case_details[]

CompletedCase

פלט בלבד. הפניות שהטיפול בהן הסתיים.

CompletedCase

תרחיש שההרצה שלו הסתיימה.

שדות
evaluation_case

string

פלט בלבד. שם המשאב של מקרה ההערכה. פורמט: projects/{project}/locations/{location}/brands/{brand}/evaluationCases/{evaluation_case}

evaluation_case_result

string

פלט בלבד. שם המשאב של תוצאת מקרה ההערכה. פורמט: projects/{project}/locations/{location}/brands/{brand}/evaluationCaseResults/{evaluation_case_result}

RunEvaluationDatasetRequest

הודעת בקשה עבור EvaluationRunService.RunEvaluationDataset.

שדות
name

string

חובה. שם המשאב של מערך נתוני ההערכה שרוצים להריץ. פורמט: projects/{project}/locations/{location}/brands/{brand}/evaluationDatasets/{evaluation_dataset}

RunEvaluationDatasetResponse

הודעת התשובה של EvaluationRunService.RunEvaluationDataset.

שדות
result

EvaluationDatasetResult

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

תזמון

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

שדות
days[]

DayOfWeek

זה שינוי אופציונלי. הימים בשבוע שבהם לוח הזמנים יחול.

date_ranges[]

DateRange

זה שינוי אופציונלי. טווחי התאריכים שבהם לוח הזמנים יחול. אם מגדירים את האפשרות הזו, לוח הזמנים פעיל רק בטווחי התאריכים הספציפיים האלה. אם גם days וגם date_ranges מוגדרים, לוח הזמנים פעיל כששני התנאים מתקיימים. לדוגמה, אם days הוא [MONDAY] ו-date_ranges הוא [2026-01-01, 2026-01-31], לוח הזמנים פעיל בכל ימי שני בינואר.

time_ranges[]

TimeOfDayRange

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

SentimentMeasurement

ציון הסנטימנט בזמן אמת שנמדד בתור הזה.

שדות
score

float

זה שינוי אופציונלי. ציון סנטימנט בין ‎-1.0 (סנטימנט שלילי) ל-1.0 (סנטימנט חיובי).

magnitude

float

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

SessionRecord

מייצג רשומת סשן אחת.

שדות
name

string

מזהה. שם המשאב של SessionRecord. פורמט: projects/{project}/locations/{location}/brands/{brand}/sessionRecords/{session_record}

session_start_time

Timestamp

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

store_id

string

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

lane_id

string

לא ניתן לשינוי. מזהה הנתיב של סשן ההזמנה.

interactions[]

Interaction

פלט בלבד. השלבים בשיחה.

outcome_label

string

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

outcome_group_label

string

פלט בלבד. תווית הקבוצה של התוצאה.

audio_recording_path

string

פלט בלבד. הנתיב להקלטת האודיו המלאה.

order

Order

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

session_duration

Duration

פלט בלבד. משך הזמן הכולל של הסשן.

upsell_attempt_records[]

UpsellAttemptRecord

פלט בלבד. מכירות של מוצרים משודרגים שבוצעו במהלך הסשן.

audio_recording

bytes

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

traffic_type

TrafficType

פלט בלבד. סוג התנועה בסשן.

channel_type

ChannelType

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

SpeechRecognition

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

שדות
transcript

string

טקסט מתומלל מקלט האודיו בשפה שזוהתה.

language_code

string

קוד השפה של התמליל. קוד השפה צריך להיות בפורמט BCP-47, למשל "en-US".

is_final

bool

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

חנות

חנות ספציפית של מותג.

שדות
name

string

מזהה. שם החנות. פורמט: projects/{project}/locations/{location}/brands/{brand}/stores/{store}

create_time

Timestamp

פלט בלבד. השעה שבה החנות נוצרה.

update_time

Timestamp

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

status

StoreStatus

חובה. סטטוס החנות.

time_zone

TimeZone

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

store_metadata

StoreMetadata

זה שינוי אופציונלי. מטא-נתונים של החנות.

tags[]

string

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

StoreHours

שעות הפעילות של החנות.

שדות
fulfillment_method

FulfillmentMethod

זה שינוי אופציונלי. שיטת מילוי ההזמנה בשעות הפעילות של החנות, למשל "PICKUP",‏ "DELIVERY" וכו'. אם לא מציינים שיטה, ההנחה היא ששעות הפעילות של החנות רלוונטיות לכל שיטות מילוי ההזמנה.

schedules[]

Schedule

זה שינוי אופציונלי. שעות הפעילות של החנות לפי שיטת המילוי (fulfillment_method) שצוינה.

StoreMetadata

מטא-נתונים של החנות.

שדות
display_name

string

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

contact_email

string

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

address

Address

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

store_hours[]

StoreHours

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

dayparts[]

Daypart

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

phone_number

string

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

כתובת

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

שדות
street_address

string

זה שינוי אופציונלי. הכתובת של החנות.

city

string

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

state

string

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

country

string

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

postal_code

string

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

latitude

double

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

longitude

double

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

google_maps_url

string

זה שינוי אופציונלי. כתובת ה-URL של החנות במפות Google.

חלק ביום

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

שדות
id

string

זה שינוי אופציונלי. מזהה החלק של היום, למשל "BREAKFAST",‏ "LUNCH" וכו'.

schedules[]

Schedule

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

display_name

string

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

StoreRevision

גרסה של חנות.

שדות
name

string

מזהה. שם המשאב של גרסת החנות. פורמט: projects/{project}/locations/{location}/brands/{brand}/stores/{store}/revisions/{revision}

snapshot

Store

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

create_time

Timestamp

פלט בלבד. מתי הגרסה נוצרה.

created_by

string

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

alternate_ids[]

string

פלט בלבד. מזהים חלופיים לגרסה הזו.

action

RevisionAction

פלט בלבד. הפעולה שיצרה את הגרסה הזו.

StoreStatus

סטטוס החנות.

שדות
state

State

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

מדינה

סטטוס החנות.

טיפוסים בני מנייה (enum)
STATE_UNSPECIFIED החנות במצב לא מוגדר.
ACTIVE החנות פעילה.
DISABLED החנות מושבתת.

SubmitOrderRequest

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

שדות
payment_info

PaymentInfo

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

loyalty_info

LoyaltyInfo

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

tip_amount

Money

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

SubmitOrderResponse

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

שדות
success

bool

חובה. אם ההזמנה נשלחה בהצלחה.

estimated_ready_duration

Duration

זה שינוי אופציונלי. משך הזמן המשוער עד שההזמנה תהיה מוכנה.

SuggestedItem

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

שדות
item_id

string

מזהה הפריט בתפריט.

display_name

string

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

image

Image

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

base_price

Money

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

integration_attributes

ItemIntegrationAttributes

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

SuggestedItems

רשימת פריטים להציע ללקוח.

שדות
items[]

SuggestedItem

הפריטים שיוצעו ללקוח.

SuggestedModGroup

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

שדות
modifier_group_id

string

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

display_name

string

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

modifiers[]

SuggestedModifier

מקשי הצירוף בקבוצה הזו.

max_selection_count

int32

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

min_selection_count

int32

המספר המינימלי של מקשי צירוף שצריך לבחור מהקבוצה הזו.

max_selection_count_per_modifier

int32

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

SuggestedModifier

הצעה לשינוי שמוצגת ללקוח.

שדות
modifier_id

string

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

modifier_group_id

string

המזהה של קבוצת השינויים שאליה צריך להוסיף את השינוי הזה אם ההצעה תתקבל.

modifier_group_display_name

string

השם המוצג של קבוצת השינויים שאליה שייך השינוי הזה.

display_name

string

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

image

Image

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

price_adjustment

Money

התאמת המחיר שמשויכת לשינוי הזה, אם יש כזו. זה המחיר ליחידה של השינוי.

integration_attributes

ModifierIntegrationAttributes

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

already_included

bool

אם המגדיר הזה כבר כלול בהזמנה.

SuggestedModifierGroups

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

שדות
modifier_groups[]

SuggestedModGroup

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

SuggestedModifiers

רשימה של שינויים שאפשר להציע ללקוח.

שדות
modifiers[]

SuggestedModifier

השינויים שיוצעו ללקוח.

parent_uid

string

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

SuggestedOptions

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

שדות
suggested_modifier_groups

SuggestedModifierGroups

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

שדה של איחוד suggested_options. האפשרויות המוצעות. הערך suggested_options יכול להיות רק אחד מהבאים:
suggested_items

SuggestedItems

רשימת פריטים להציע ללקוח.

suggested_modifiers

SuggestedModifiers

רשימה של שינויים שאפשר להציע ללקוח.

TargetItem

יעד חלופי לפריט מובנה.

שדות
item_name

string

חובה. שם הפריט בקטלוג התפריט.

modifiers[]

TargetModifier

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

item_id

string

זה שינוי אופציונלי. המזהה הייחודי של הפריט בקטלוג התפריט (קישור ישיר אל menu.proto).

TargetModifier

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

שדות
modifier_name

string

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

modifier_group_name

string

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

modifier_id

string

זה שינוי אופציונלי. המזהה הייחודי של השינוי בקטלוג התפריט (קישור ישיר אל menu.proto).

modifier_group_id

string

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

TextInput

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

שדות
text

string

חובה. האמירה בטקסט מהלקוח.

TimeOfDayRange

מייצג תקופה בין שתי שעות ביום בתאריך לא מוגדר. לדוגמה, שעות פעילות כמו 09:00 עד 17:00.

שדות
start_time

TimeOfDay

חובה. ההתחלה של טווח התאריכים, כולל.

end_time

TimeOfDay

חובה. סוף טווח התאריכים, לא כולל. אם הערך של end_time מוקדם מהערך של start_time, זה אומר ששעת הסיום היא ביום הבא.

TippingInfo

מידע על מתן טיפים.

שדות
שדה של איחוד tip_type. סכום הטיפ או אחוז הטיפ. הערך tip_type יכול להיות רק אחד מהבאים:
amount

Money

זה שינוי אופציונלי. סכום כסף ספציפי לטיפ.

percentage_bps

int32

זה שינוי אופציונלי. אחוז בנקודות בסיס, לדוגמה: 450 = 4.5%.

TurnCompleted

בסוג הזה אין שדות.

מציין שסוכן ה-AI לזיהוי אוכל זיהה את סוף התור הנוכחי בשיחה ולא יספק פלט נוסף בתור הזה.

UpdateBrandRequest

הודעת בקשה עבור MenuService.UpdateBrand.

שדות
brand

Brand

חובה. המותג שרוצים לעדכן.

השדה name של המותג משמש לזיהוי המותג שצריך לעדכן. פורמט: projects/{project}/locations/{location}/brands/{brand}

update_mask

FieldMask

זה שינוי אופציונלי. רשימת השדות שרוצים לעדכן

UpdateChannelConfigRequest

הודעת בקשה עבור MenuService.UpdateChannelConfig.

שדות
channel_config

ChannelConfig

חובה. הגדרת הערוץ שרוצים לעדכן.

השדה name של הגדרת הערוץ משמש לזיהוי הגדרת הערוץ שצריך לעדכן. פורמט: projects/{project}/locations/{location}/brands/{brand}/channelConfigs/{channel_config}

update_mask

FieldMask

זה שינוי אופציונלי. רשימת השדות שרוצים לעדכן

UpdateConfigApplicationRuleRequest

הודעת בקשה עבור MenuService.UpdateConfigApplicationRule.

שדות
config_application_rule

ConfigApplicationRule

חובה. כלל האפליקציה שצריך לעדכן.

השדה name של כלל הגדרת האפליקציה משמש לזיהוי כלל הגדרת האפליקציה שצריך לעדכן. פורמט: projects/{project}/locations/{location}/brands/{brand}/configApplicationRules/{config_application_rule}

update_mask

FieldMask

זה שינוי אופציונלי. רשימת השדות שרוצים לעדכן

UpdateDiscountRequest

הודעת בקשה עבור MenuService.UpdateDiscount.

שדות
discount

Discount

חובה. ההנחה שרוצים לעדכן.

השדה name של ההנחה משמש לזיהוי ההנחה שצריך לעדכן. פורמט: projects/{project}/locations/{location}/brands/{brand}/stores/{store}/discounts/{discount}

update_mask

FieldMask

זה שינוי אופציונלי. רשימת השדות שרוצים לעדכן

allow_missing

bool

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

UpdateEvaluationCaseRequest

הודעת בקשה עבור MenuService.UpdateEvaluationCase.

שדות
evaluation_case

EvaluationCase

חובה. בקשת ההערכה שרוצים לעדכן.

השדה name של מקרה ההערכה משמש לזיהוי מקרה ההערכה שצריך לעדכן. פורמט: projects/{project}/locations/{location}/brands/{brand}/evaluationCases/{evaluation_case}

update_mask

FieldMask

זה שינוי אופציונלי. רשימת השדות שרוצים לעדכן

allow_missing

bool

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

UpdateEvaluationContextRequest

הודעת בקשה עבור MenuService.UpdateEvaluationContext.

שדות
evaluation_context

EvaluationContext

חובה. ההקשר של ההערכה שצריך לעדכן.

השדה name של הקשר ההערכה משמש לזיהוי הקשר ההערכה שצריך לעדכן. פורמט: projects/{project}/locations/{location}/brands/{brand}/evaluationContexts/{evaluation_context}

update_mask

FieldMask

זה שינוי אופציונלי. רשימת השדות שרוצים לעדכן

UpdateEvaluationDatasetRequest

הודעת בקשה עבור MenuService.UpdateEvaluationDataset.

שדות
evaluation_dataset

EvaluationDataset

חובה. קבוצת הנתונים להערכה שרוצים לעדכן.

השדה name של קבוצת נתוני ההערכה משמש לזיהוי קבוצת נתוני ההערכה שצריך לעדכן. פורמט: projects/{project}/locations/{location}/brands/{brand}/evaluationDatasets/{evaluation_dataset}

update_mask

FieldMask

זה שינוי אופציונלי. רשימת השדות שרוצים לעדכן

UpdateEvaluationMatcherRequest

הודעת בקשה עבור MenuService.UpdateEvaluationMatcher.

שדות
evaluation_matcher

EvaluationMatcher

חובה. ההתאמה להערכה שרוצים לעדכן.

השדה name של ההתאמה להערכה משמש לזיהוי ההתאמה להערכה שצריך לעדכן. פורמט: projects/{project}/locations/{location}/brands/{brand}/evaluationMatchers/{evaluation_matcher}

update_mask

FieldMask

זה שינוי אופציונלי. רשימת השדות שרוצים לעדכן

UpdateInventoryRequest

הודעת בקשה עבור MenuService.UpdateInventory.

שדות
inventory

Inventory

חובה. המלאי שצריך לעדכן.

השדה name של המלאי משמש לזיהוי המלאי שצריך לעדכן. פורמט: projects/{project}/locations/{location}/brands/{brand}/stores/{store}/inventories/{inventory}

update_mask

FieldMask

זה שינוי אופציונלי. רשימת השדות שרוצים לעדכן

allow_missing

bool

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

UpdateStoreRequest

הודעת בקשה עבור MenuService.UpdateStore.

שדות
store

Store

חובה. החנות שרוצים לעדכן.

השדה name של החנות משמש לזיהוי החנות שצריך לעדכן. פורמט: projects/{project}/locations/{location}/brands/{brand}/stores/{store}

update_mask

FieldMask

זה שינוי אופציונלי. רשימת השדות שרוצים לעדכן

allow_missing

bool

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

UpdatedOrderState

אירוע שהוחזר על ידי הנציג ומייצג עדכון של מצב ההזמנה.

שדות
order

Order

הסטטוס המעודכן של ההזמנה שמשויכת לסשן הזה.

changed

bool

פלט בלבד. אם יש עדכונים בסטטוס ההזמנה.

UpsellAttemptRecord

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

שדות
turn_id

int32

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

upsell_type

string

פלט בלבד. סוג האירוע של מכירת מוצר או שירות לא קשור (upsell).

accepted

bool

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

UpsellConfig

מגדיר את התצורה של מופע מכירת אפסל.

שדות
display_name

string

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

priority

int32

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

  • הערכים יכולים להיות בטווח [1, inf).
  • ערכים נמוכים יותר הם בעדיפות גבוהה יותר. לדוגמה, תמיד ננסה קודם את UpsellConfig עם עדיפות 1 ב-UpsellStrategy.
  • בתוך UpsellStrategy, לכל UpsellConfig חייבת להיות עדיפות עם ערך ייחודי (לדוגמה: רק ל-UpsellConfig אחד יכולה להיות עדיפות של 3).
  • ערכי העדיפות לא חייבים להיות רציפים בתוך UpsellStrategy (לדוגמה: יכולים להיות UpsellConfigs עם ערכי העדיפות: {1, 2, 5, 6, 9}). העדיפות של הגדרות המכירה השדרוג נקבעת על בסיס יחסי (מהדוגמה הקודמת: 1 < 2 < 5 < 6 < 9).
skip_on_multi_quantity_upsold_from_item

bool

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

skip_on_previous_turn_upsell

bool

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

disabled

bool

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

שדה של איחוד upsell_type_config. ההגדרה הספציפית לסוג של מכירת השדרוג. הערך upsell_type_config יכול להיות רק אחד מהבאים:
greeting_offer

GreetingOffer

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

closing_offer

ClosingOffer

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

cel_upsell

CelUpsell

כלל מכירת אפסייל שמוערך באופן דינמי על סמך Common Expression Language ‏ (CEL).

UpsellStrategy

מגדיר את האסטרטגיה למכירת מוצר או שירות משודרג (upsell).

שדות
max_upsell_offers

int32

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

max_upsell_declines

int32

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

max_items_in_cart

int32

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

upsells[]

UpsellConfig

זה שינוי אופציונלי. מכירות ה-upsell שהוגדרו.

catering_guidelines

string

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

UserInfo

מידע אישי של משתמש הקצה ששותף עם סוכן ה-AI של Food.

שדות
preferred_name

string

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

payment_info

PaymentInfo

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

delivery_address
(deprecated)

string

זה שינוי אופציונלי. הוצא משימוש: צריך להשתמש ב-saved_delivery_address במקום זאת. הכתובת למשלוח שהמשתמש שמר.

past_orders[]

PastOrder

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

loyalty_info

LoyaltyInfo

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

phone_number

string

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

user_id

string

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

saved_delivery_address

DeliveryAddress

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

ValidateDeliveryAddressRequest

בקשה לאמת כתובת למשלוח שנאספה במהלך הסשן.

שדות
delivery_address

DeliveryAddress

חובה. הכתובת למשלוח שצריך לאמת.

ValidateDeliveryAddressResponse

התוצאה של אימות כתובת למשלוח.

שדות
success

bool

חובה. אם האימות הושלם בלי שגיאה או לא.

validation_status

ValidationStatus

חובה. סטטוס האימות של הכתובת למשלוח.