ייצוג 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
מגדיר מודל שגיאות לוגי שמתאים לסביבות תכנות שונות, כולל ממשקי API ל-REST וממשקי API ל-RPC. הוא נמצא בשימוש של 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. |