Argument

ייצוג JSON
{
  "name": string,
  "rawText": string,
  "textValue": string,
  "status": {
    object (Status)
  },

  // Union field value can be only one of the following:
  "intValue": string,
  "floatValue": number,
  "boolValue": boolean,
  "datetimeValue": {
    object (DateTime)
  },
  "placeValue": {
    object (Location)
  },
  "extension": {
    "@type": string,
    field1: ...,
    ...
  },
  "structuredValue": {
    object
  }
  // End of list of possible types for union field value.
}
שדות
name

string

שם הארגומנט שסופק עבור הקלט.

rawText

string

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

textValue

string

מצוין כאשר דפוס השאילתה כולל סוג $org.schema.type.Text או קלט צפוי שיש לו Intent מובנה: actions.intent.TEXT או actions.intent.OPTION. הערה: עבור ה-Intent OPTION אנחנו מגדירים את textValue כמפתח אפשרות, ה-rawText שלמעלה יציין את הטווח הגולמי בשאילתת המשתמש.

status

object (Status)

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

שדה איחוד value. אחד מהפרטים הבאים צוין. value יכול להיות רק אחת מהאפשרויות הבאות:
intValue

string (int64 format)

מצוין כאשר דפוס השאילתה כולל סוג $org.schema.type.Number או הקלט הצפוי כולל Intent מובנה: "assistant.intent.action.NUMBER".

floatValue

number

צוין עבור Intent מובנה: "actions.intent.NUMBER"

boolValue

boolean

מצוין כאשר דפוס השאילתה כולל סוג $org.schema.type.YesNo או קלט צפוי שיש לו Intent מובנה: actions.intent.CONFIRMATION. הערה: אם הערך הבוליאני חסר, הוא מייצג את false.

datetimeValue

object (DateTime)

צוין ל-Intent המובנה: actions.intent.DATETIME.

placeValue

object (Location)

מצוין כאשר דפוס השאילתה כולל סוג $org.schema.type.Location או קלט צפוי עם Intent מובנה: "actions.intent.PLACE".

extension

object

תוסף שהסוג שלו תלוי בארגומנט. לדוגמה, אם שם הארגומנט הוא SIGN_IN עבור ה-Intent actions.intent.SIGN_IN, התוסף הזה יכיל ערך SignInValue.

אובייקט שמכיל שדות מסוג שרירותי. שדה נוסף "@type" מכיל URI המזהה את הסוג. לדוגמה: { "id": 1234, "@type": "types.example.com/standard/id" }.

structuredValue

object (Struct format)

מצוין מתי Google צריכה להעביר ערך נתונים בפורמט JSON.

סטטוס

הסוג Status מגדיר מודל שגיאות לוגי שמתאים לסביבות תכנות שונות, כולל ממשקי API ל-REST וממשקי API ל-RPC. הוא נמצא בשימוש של gRPC. כל הודעת Status מכילה שלושה נתונים: קוד שגיאה, הודעת שגיאה ופרטי שגיאה.

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

ייצוג JSON
{
  "code": integer,
  "message": string,
  "details": [
    {
      "@type": string,
      field1: ...,
      ...
    }
  ]
}
שדות
code

integer

קוד הסטטוס, שצריך להיות ערך enum של google.rpc.Code.

message

string

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

details[]

object

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

אובייקט שמכיל שדות מסוג שרירותי. שדה נוסף "@type" מכיל URI המזהה את הסוג. לדוגמה: { "id": 1234, "@type": "types.example.com/standard/id" }.

DateTime

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

ייצוג JSON
{
  "date": {
    object (Date)
  },
  "time": {
    object (TimeOfDay)
  }
}
שדות
date

object (Date)

ערך תאריך

time

object (TimeOfDay)

ערך זמן

תאריך

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

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

הסוגים הקשורים הם google.type.TimeOfDay ו-google.protobuf.Timestamp.

ייצוג JSON
{
  "year": integer,
  "month": integer,
  "day": integer
}
שדות
year

integer

שנת התאריך. חייב להיות בין 1 ל-9999, או 0 אם מציינים תאריך ללא שנה.

month

integer

החודש בשנה. הערך צריך להיות בין 1 ל-12, או ל-0 אם מציינים שנה בלי חודש ויום.

day

integer

היום בחודש. הערך צריך להיות בין 1 ל-31 ותקף לשנה ולחודש, או 0 אם מציינים שנה בלבד, או שנה וחודש שבהם אין חשיבות לציון היום.

TimeOfDay

מייצג שעה ביום. התאריך ואזור הזמן לא משמעותיים או שהם מצוינים במקום אחר. יכול להיות ש-API יבחר לאפשר שניות מדלגות. הסוגים הקשורים הם google.type.Date ו-google.protobuf.Timestamp.

ייצוג JSON
{
  "hours": integer,
  "minutes": integer,
  "seconds": integer,
  "nanos": integer
}
שדות
hours

integer

שעות ביום בפורמט 24 שעות. צריך להיות מספר בין 0 ל-23. ממשק API עשוי לבחור לאפשר את הערך '24:00:00' לתרחישים כמו שעת הסגירה של העסק.

minutes

integer

דקות בשעה ביום. חייב להיות בין 0 ל-59.

seconds

integer

שניות ודקות. בדרך כלל הערך צריך להיות בין 0 ל-59. ה-API עשוי לאפשר את הערך 60 אם הוא מאפשר שניות מדלגות.

nanos

integer

שברי שניות בננו-שניות. חייב להיות בין 0 ל-999,999,999.