ייצוג JSON | |
---|---|
{ "name": string, "rawText": string, "textValue": string, "status": { object ( |
שדות | ||
---|---|---|
name |
שם הארגומנט שניתן לקלט. |
|
rawText |
הטקסט הגולמי, שהוקלד או נאמר, שסיפק את ערך הארגומנט. |
|
textValue |
יש לציין כשדפוס השאילתה כולל סוג |
|
status |
יש לציין מתי אירעה שגיאה במהלך חישוב הארגומנט. לדוגמה, אובייקט ה-Intent המובנה 'actions.intent.PLACE' יכול להחזיר סטטוס שגיאה אם המשתמש דחה את ההרשאה לגשת למיקום המכשיר שלו. |
|
שדה איחוד value . אחת מהאפשרויות הבאות מפורטת. הערך של value יכול להיות רק אחת מהאפשרויות הבאות: |
||
intValue |
יש לציין כשדפוס השאילתה כולל סוג של $org.schema.type.Number או בקלט צפוי שיש בו אובייקט מסוג Intent מובנה: "assistant.intent.action.NUMBER". |
|
floatValue |
צוין עבור Intent מובנה: "actions.intent.NUMBER" |
|
boolValue |
יש לציין כשדפוס השאילתה כולל סוג |
|
datetimeValue |
צוין עבור ה-Intent המובנה: |
|
placeValue |
יש לציין כשדפוס השאילתה כולל סוג של $org.schema.type.Location או כשבקלט הצפוי יש אובייקט Intent מובנה: "actions.intent.PLACE". |
|
extension |
תוסף שהסוג שלו תלוי בארגומנט. לדוגמה, אם שם הארגומנט הוא אובייקט שמכיל שדות מסוג שרירותי. שדה נוסף |
|
structuredValue |
יש לציין מתי Google צריכה להעביר ערך נתונים בפורמט JSON. |
סטטוס
הסוג Status
מגדיר מודל שגיאה לוגית שמתאים לסביבות תכנות שונות, כולל ממשקי REST API ו-RPC API. הוא משמש את gRPC. כל הודעת Status
מכילה שלושה קטעי נתונים: קוד שגיאה, הודעת שגיאה ופרטי שגיאה.
מידע נוסף על מודל השגיאה הזה והסבר על השימוש בו זמין במדריך לעיצוב API.
ייצוג JSON | |
---|---|
{ "code": integer, "message": string, "details": [ { "@type": string, field1: ..., ... } ] } |
שדות | |
---|---|
code |
קוד הסטטוס, שצריך להיות ערך 'טיפוסים בני מנייה (enum)' |
message |
הודעת שגיאה למפתחים, שאמורה להיות באנגלית. כל הודעת שגיאה שמוצגת למשתמש צריכה להיות מותאמת לשוק המקומי ולשלוח אותה בשדה |
details[] |
רשימת ההודעות עם פרטי השגיאה. יש קבוצה משותפת של סוגי הודעות שבהם אפשר להשתמש בממשקי API. אובייקט שמכיל שדות מסוג שרירותי. שדה נוסף |
DateTime
ערך הארגומנט תאריך ושעה שנותח מקלט של משתמש. לא כולל מידע על אזור זמן.
ייצוג JSON | |
---|---|
{ "date": { object ( |
שדות | |
---|---|
date |
ערך תאריך |
time |
ערך זמן |
תאריך
מייצג תאריך קלנדרי מלא או חלקי, למשל יום הולדת. השעה ביום ואזור הזמן מצוינים במקום אחר או שאינם משמעותיים. התאריך הזה יחסי ללוח השנה הגרגוריאני הפרולפטית. הערך הזה יכול לייצג את:
- תאריך מלא, עם ערכים שונים של שנה, חודש ויום
- ערך של חודש ויום, עם שנה של אפס, למשל יום נישואין
- שנה בפני עצמה, עם אפס ערכים של חודש ויום
- ערך של שנה וחודש, עם אפס יום, למשל תאריך תפוגה של כרטיס אשראי
הסוגים הקשורים הם google.type.TimeOfDay
ו-google.protobuf.Timestamp
.
ייצוג JSON | |
---|---|
{ "year": integer, "month": integer, "day": integer } |
שדות | |
---|---|
year |
שנת התאריך. חייב להיות בין 1 ל-9999, או 0 אם מציינים תאריך שלא כולל שנה. |
month |
החודש בשנה. חייב להיות בין 1 ל-12, או 0 אם מציינים שנה ללא חודש ויום. |
day |
היום בחודש. הערך צריך להיות בין 1 ל-31 והוא תקף לשנה ולחודש, או הערך 0 אם מציינים שנה בלבד או שנה וחודש שהיום הזה לא משמעותי. |
TimeOfDay
מייצג את השעה ביום. התאריך ואזור הזמן אינם משמעותיים או מצוינים במקום אחר. ממשק API עשוי לבחור לאפשר שניות מעבר. הסוגים הקשורים הם google.type.Date
ו-google.protobuf.Timestamp
.
ייצוג JSON | |
---|---|
{ "hours": integer, "minutes": integer, "seconds": integer, "nanos": integer } |
שדות | |
---|---|
hours |
שעות ביום בפורמט 24 שעות. צריך להיות בין 0 ל-23. ממשק API עשוי לאפשר את הערך '24:00:00' בתרחישים כמו שעת הסגירה של העסק. |
minutes |
דקות בשעה ביום. הערך חייב להיות בין 0 ל-59. |
seconds |
שניות של דקות מזמן. בדרך כלל צריך להיות מספר בין 0 ל-59. ממשק API עשוי להתיר את הערך 60 אם הוא מאפשר שניות מדלגות. |
nanos |
שברים של שניות בננו-שניות. חייב להיות בין 0 ל-999,999,999. |