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.TEXTactions.intent.OPTION)时指定。请注意,对于 OPTION intent,我们将 textValue 设置为选项键,上面的 rawText 将指示用户查询中的原始 span。

status

object (Status)

在计算参数时出错时指定。例如,内置 intent“actions.intent.PLACE”如果用户拒绝授予应用设备位置信息访问权限,则 Google 助理可能会返回错误状态。

联合字段 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

类型取决于参数的扩展。例如,如果 actions.intent.SIGN_IN 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

状态代码,应为 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.TimeOfDaygoogle.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.Dategoogle.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 允许闰秒,则 API 可以允许 60 一值。

nanos

integer

秒数的小数部分(以纳秒为单位)。值必须是介于 0 和 999999999 之间的数字。