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