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 型が含まれる場合、または想定入力に組み込みインテント(actions.intent.TEXT または actions.intent.OPTION)がある場合に指定されます。OPTION インテントでは、textValue をオプションキーとして設定しています。上記の rawText は、ユーザーのクエリ内の未加工のスパンを示します。

status

object (Status)

引数の計算中にエラーが発生したときに指定されます。たとえば、組み込みインテント「actions.intent.PLACE」は、ユーザーがデバイスの位置情報へのアクセスを拒否した場合にエラー ステータスを返すことがあります。

共用体フィールド value。次のいずれかが指定されています。value は次のいずれかになります。
intValue

string (int64 format)

クエリパターンに $org.schema.type.Number タイプが含まれているか、想定入力に組み込みインテント「assistant.intent.action.NUMBER」がある場合に指定されます。

floatValue

number

組み込みインテント「actions.intent.NUMBER」で指定されています。

boolValue

boolean

クエリパターンに $org.schema.type.YesNo 型が含まれているか、想定入力に組み込みインテント actions.intent.CONFIRMATION がある場合に指定します。注: ブール値がない場合は、false を表します。

datetimeValue

object (DateTime)

組み込みインテント actions.intent.DATETIME に指定されています。

placeValue

object (Location)

クエリパターンに $org.schema.type.Location タイプが含まれる場合、または想定される入力に組み込みインテント「actions.intent.PLACE」がある場合に指定されます。

extension

object

その型が引数によって異なる拡張設定。たとえば、actions.intent.SIGN_IN インテントの引数名が SIGN_IN の場合、この拡張機能には SignInValue 値が含まれます。

任意のデータ型のフィールドを含むオブジェクト。タイプを識別する URI を含むフィールド "@type" を追加できます。例: { "id": 1234, "@type": "types.example.com/standard/id" }

structuredValue

object (Struct format)

Google が JSON 形式でデータ値を渡す必要がある場合に指定します。

ステータス

Status 型は、REST API や RPC API など、さまざまなプログラミング環境に適した論理エラーモデルを定義します。gRPC により使用されます。各 Status メッセージには、エラーコード、エラー メッセージ、エラーの詳細という 3 種類のデータが含まれます。

このエラーモデルと操作方法について詳しくは、API 設計ガイドをご覧ください。

JSON 表現
{
  "code": integer,
  "message": string,
  "details": [
    {
      "@type": string,
      field1: ...,
      ...
    }
  ]
}
フィールド
code

integer

ステータス コード。google.rpc.Code の列挙値である必要があります。

message

string

デベロッパー向けのエラー メッセージ。英語で記述します。ユーザー向けのエラー メッセージは、ローカライズして google.rpc.Status.details フィールドで送信するか、クライアントでローカライズする必要があります。

details[]

object

エラーの詳細を保持するメッセージのリスト。API が使用する共通のメッセージ タイプのセットがあります。

任意のデータ型のフィールドを含むオブジェクト。タイプを識別する URI を含むフィールド "@type" を追加できます。例: { "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

1 日のうちの時刻を表します。日付とタイムゾーンは意味を持たないか、他の場所で指定されています。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 がうるう秒を許可する場合、値 60 が許可されます。

nanos

integer

秒の小数部分(ナノ秒単位)。0~999,999,999 である必要があります。