Method: projects.sendInteraction

string

必須。テスト対象のプロジェクト。プロジェクト ID で指定します。形式: projects/{project}

{
  "query": string,
  "type": enum (InputType)
}

string

ユーザーが送信した入力の内容。

enum (InputType)

入力の型。

{
  "surface": enum (Surface),
  "location": {
    object (Location)
  },
  "locale": string,
  "timeZone": string
}

enum (Surface)

アクションの操作に使用されるサーフェス。

object (Location)

デバイスの位置情報（緯度、経度、フォーマット済み住所など）。

string

デバイスに設定されている言語 / 地域。形式は BCP 47（https://tools.ietf.org/html/bcp47）に準拠している必要があります。例: en、en-US、es-419（その他の例: https://tools.ietf.org/html/bcp47#appendix-A)）

string

デバイスに設定されているタイムゾーン。形式は IANA タイムゾーン データベースに準拠している必要があります（例: America/New_York: https://www.iana.org/time-zones）。

{
  "coordinates": {
    object (LatLng)
  },
  "formattedAddress": string,
  "zipCode": string,
  "city": string
}

object (LatLng)

地理座標。[DEVICE_PRECISE_LOCATION] [google.actions.v2.Permission.DEVICE_PRECISE_LOCATION] 権限が必要です。

string

表示住所。例: 「1600 Amphitheatre Pkwy, Mountain View, CA 94043」。[DEVICE_PRECISE_LOCATION] [google.actions.v2.Permission.DEVICE_PRECISE_LOCATION] 権限が必要です。

string

郵便番号。[DEVICE_PRECISE_LOCATION] [google.actions.v2.Permission.DEVICE_PRECISE_LOCATION] または [DEVICE_COARSE_LOCATION] [google.actions.v2.Permission.DEVICE_COARSE_LOCATION] のアクセス許可を求めています。

string

市区町村。[DEVICE_PRECISE_LOCATION] [google.actions.v2.Permission.DEVICE_PRECISE_LOCATION] または [DEVICE_COARSE_LOCATION] [google.actions.v2.Permission.DEVICE_COARSE_LOCATION] のアクセス許可を求めています。

{
  "latitude": number,
  "longitude": number
}

number

緯度（度単位）。範囲 [-90.0, +90.0] 内になければなりません。

number

経度（度単位）。範囲 [-180.0, +180.0] 内になければなりません。

{
  "text": string,
  "speech": [
    string
  ],
  "canvas": {
    object (Canvas)
  },
  "actionsBuilderPrompt": {
    object (Prompt)
  }
}

string

書式なし文字列としてユーザーに送信される音声レスポンス。

string

アクションによって生成された音声コンテンツ。これには、SSML などのマークアップ要素が含まれる場合があります。

object (Canvas)

インタラクティブ キャンバス コンテンツ。

object (Prompt)

会話ラウンドの最後におけるプロンプトの状態。プロンプトの詳細: https://developers.google.com/assistant/conversational/prompts

{
  "url": string,
  "data": [
    value
  ],
  "suppressMic": boolean,
  "enableFullScreen": boolean
}

string

読み込むインタラクティブ キャンバス ウェブアプリの URL。設定しない場合、現在アクティブなキャンバスの URL が再利用されます。

value (Value format)

（省略可）没入型エクスペリエンスのウェブページにイベントとして渡される JSON データ。含まれているプロンプトの「override」フィールドが「false」であれば、この Canvas プロンプトで定義されているデータ値は、以前の Canvas プロンプトで定義したデータ値の後に追加されます。

boolean

（省略可）デフォルト値: false

boolean

true の場合、キャンバス アプリケーションが全画面表示され、上部にヘッダーは表示されません。読み込み画面にトースト メッセージも表示され、アクションの表示名、デベロッパーの名前、アクションの終了手順などを確認できます。デフォルト値: false

{
  "append": boolean,
  "override": boolean,
  "firstSimple": {
    object (Simple)
  },
  "content": {
    object (Content)
  },
  "lastSimple": {
    object (Simple)
  },
  "suggestions": [
    {
      object (Suggestion)
    }
  ],
  "link": {
    object (Link)
  },
  "canvas": {
    object (Canvas)
  }
}

boolean

（省略可）このメッセージを、以前に定義されたメッセージと統合する方法のモード。「false」は、以前に定義したすべてのメッセージ（最初と最後のシンプル、コンテンツ、候補のリンク、キャンバス）を消去し、このプロンプトで定義されたメッセージを追加します。「true」に設定すると、このプロンプトで定義されたメッセージが、以前のレスポンスで定義されたメッセージに追加されます。このフィールドを「true」に設定すると、Simple プロンプト内の一部のフィールド、Suggestion プロンプト、Canvas プロンプト（Content プロンプトの一部）への追加も可能になります。コンテンツ メッセージとリンク メッセージは、プロンプトで定義されている場合は常に上書きされます。デフォルト値は「false」です。

boolean

（省略可）このメッセージを、以前に定義されたメッセージと統合する方法のモード。「true」に設定すると、以前に定義されたすべてのメッセージ（最初と最後のシンプル、コンテンツ、提案リンク、キャンバス）がクリアされ、このプロンプトで定義されたメッセージが追加されます。「false」を指定すると、このプロンプトで定義されているメッセージが、以前のレスポンスで定義されているメッセージに追加されます。このフィールドを「false」のままにすると、Simple プロンプト、Suggestions プロンプト、Canvas プロンプト（Content プロンプトの一部）内の一部のフィールドへの追加も可能になります。コンテンツ メッセージとリンク メッセージがプロンプトで定義されている場合、常に上書きされます。デフォルト値は「false」です。

object (Simple)

（省略可）最初の音声とテキストのみのレスポンス。

object (Content)

（省略可）ユーザーに表示するカード、リスト、メディアなどのコンテンツ。

object (Simple)

（省略可）最後の音声とテキストのみのレスポンス。

object (Suggestion)

（省略可）ユーザーに表示される候補。レスポンスの最後に常に表示されます。含まれるプロンプトの「override」フィールドが「false」であれば、このフィールドで定義されているタイトルは、以前に定義された候補プロンプトで定義されているタイトルに追加され、重複する値が削除されます。

object (Link)

（省略可）関連するアプリまたはサイトにリンクできる追加の候補ワード。チップは「Open」というタイトルでレンダリングされます。最大 20 文字。

object (Canvas)

（省略可）ユーザーに送信するインタラクティブ キャンバスのレスポンスを表します。

{
  "speech": string,
  "text": string
}

string

（省略可）ユーザーに向けて読み上げられる音声を表します。SSML またはテキスト読み上げが可能です。含まれるプロンプトの「override」フィールドが「true」の場合、このフィールドで定義されている音声が、以前の Simple プロンプトの音声を置き換えます。

string

チャットのふきだしに表示するテキスト（省略可）。指定しない場合、上記の音声フィールドの表示レンダリングが使用されます。最大 640 文字です。含まれるプロンプトの「override」フィールドが「true」の場合、このフィールドで定義されているテキストが、以前の Simple プロンプトのテキストに置き換えられます。

{

  // Union field content can be only one of the following:
  "card": {
    object (Card)
  },
  "image": {
    object (Image)
  },
  "table": {
    object (Table)
  },
  "media": {
    object (Media)
  },
  "canvas": {
    object (Canvas)
  },
  "collection": {
    object (Collection)
  },
  "list": {
    object (List)
  }
  // End of list of possible types for union field content.
}

object (Card)

ベーシック カード。

object (Image)

画像。

object (Table)

テーブルカード。

object (Media)

再生するメディアのセットを示すレスポンス。

object (Canvas)

インタラクティブなキャンバス エクスペリエンスに使用されるレスポンス。

object (Collection)

選択可能なオプションのコレクションを示すカード。

object (List)

選択可能なオプションのリストを示すカード。

{
  "title": string,
  "subtitle": string,
  "text": string,
  "image": {
    object (Image)
  },
  "imageFill": enum (ImageFill),
  "button": {
    object (Link)
  }
}

string

カードの全体的なタイトル。省略可。

string

省略可。

string

カードの本文。書式設定用に限定されたマークダウン構文がサポートされています。画像が存在しない場合は必須。

object (Image)

カードのヒーロー画像。高さは 192 dp に固定されています。省略可。

enum (ImageFill)

画像の背景の塗りつぶし方法。省略可。

object (Link)

ボタン省略可。

{
  "url": string,
  "alt": string,
  "height": integer,
  "width": integer
}

string

画像のソース URL。JPG、PNG、GIF（アニメーション GIF と非アニメーション GIF）を使用できます。例: https://www.agentx.com/logo.png。必須。

string

スクリーン リーダーなどのユーザー補助機能で使用される画像の説明テキスト。必須。

integer

画像の高さ（ピクセル単位）。省略可。

integer

画像の幅（ピクセル単位）。省略可。

{
  "name": string,
  "open": {
    object (OpenUrl)
  }
}

string

リンクの名前

object (OpenUrl)

ユーザーがリンクを開いた場合

{
  "url": string,
  "hint": enum (UrlHint)
}

string

url フィールドでは、次のいずれかを指定できます。- アプリとリンクしたアプリまたはウェブページを開くための http または https の URL

enum (UrlHint)

URL タイプのヒントを示します。

{
  "title": string,
  "subtitle": string,
  "image": {
    object (Image)
  },
  "columns": [
    {
      object (TableColumn)
    }
  ],
  "rows": [
    {
      object (TableRow)
    }
  ],
  "button": {
    object (Link)
  }
}

string

テーブルの全体的なタイトル。省略できますが、サブタイトルが設定されている場合は必ず設定する必要があります。

string

テーブルのサブタイトル。省略可。

object (Image)

テーブルに関連付けられた画像。省略可。

object (TableColumn)

ヘッダーと列の配置。

object (TableRow)

テーブルの行データ。最初の 3 行は表示されることが保証されますが、その他の行はサーフェスによっては切り捨てられる場合があります。特定のサーフェスに対してどの行が表示されるかをシミュレータでテストしてください。WEB_BROWSER 機能をサポートするサーフェスでは、詳細なデータを示すウェブページを開くことができます。

object (Link)

ボタン。

{
  "header": string,
  "align": enum (HorizontalAlignment)
}

string

列のヘッダー テキスト。

enum (HorizontalAlignment)

列に対するコンテンツの水平方向の配置。省略した場合、内容は前端に揃えられます。

{
  "cells": [
    {
      object (TableCell)
    }
  ],
  "divider": boolean
}

object (TableCell)

この行のセル。最初の 3 つのセルは表示されることが保証されますが、その他のセルはサーフェスによっては切り捨てられる場合があります。特定のサーフェスに対してどのセルが表示されるかをシミュレータでテストしてください。

boolean

各行の後に分割線を配置するかどうかを示します。

{
  "text": string
}

string

セルのテキスト コンテンツ。

{
  "mediaType": enum (MediaType),
  "startOffset": string,
  "optionalMediaControls": [
    enum (OptionalMediaControls)
  ],
  "mediaObjects": [
    {
      object (MediaObject)
    }
  ]
}

enum (MediaType)

メディアタイプ。

string (Duration format)

最初のメディア オブジェクトの開始オフセット。

小数点以下 9 桁まで、「s」で終わる秒単位の期間（例: "3.5s"）。

enum (OptionalMediaControls)

このメディア レスポンス セッションがサポートするオプションのメディア コントロール タイプ。設定すると、特定のメディア イベントが発生したときにサードパーティにリクエストが送信されます。設定しない場合、3p は引き続き 2 つのデフォルトのコントロール タイプ（FINISHED と FAILED）を処理する必要があります。

object (MediaObject)

メディア オブジェクトのリスト

{
  "name": string,
  "description": string,
  "url": string,
  "image": {
    object (MediaImage)
  }
}

string

このメディア オブジェクトの名前。

string

このメディア オブジェクトの説明。

string

メディア コンテンツを指す URL。

object (MediaImage)

メディアカードとともに表示する画像。

{

  // Union field image can be only one of the following:
  "large": {
    object (Image)
  },
  "icon": {
    object (Image)
  }
  // End of list of possible types for union field image.
}

object (Image)

アルバムのカバーなど、大きな画像

object (Image)

タイトルの右側に表示される小さな画像アイコン。36×36 dp にサイズ変更されます。

{
  "title": string,
  "subtitle": string,
  "items": [
    {
      object (CollectionItem)
    }
  ],
  "imageFill": enum (ImageFill)
}

string

コレクションのタイトル。省略可。

string

コレクションのサブタイトル。省略可。

object (CollectionItem)

最小: 2 最大: 10

enum (ImageFill)

コレクション アイテムの画像背景の塗りつぶし方法。省略可。

{
  "key": string
}

string

必須。関連するタイプのエントリキー名と一致する NLU キー。

{
  "title": string,
  "subtitle": string,
  "items": [
    {
      object (ListItem)
    }
  ]
}

string

リストのタイトル。省略可。

string

リストのサブタイトル。省略可。

object (ListItem)

最小: 2 最大: 30

{
  "key": string
}

string

必須。関連するタイプのエントリキー名と一致する NLU キー。

{
  "title": string
}

string

必須。候補ワードに表示されるテキスト。タップすると、あたかもユーザーがこのテキストをキーボードから入力したかのように、このテキストが会話にそのままポストバックされます。一連の候補ワードの間でタイトルが重複していてはなりません。最大 25 文字

{
  "actionsBuilderEvents": [
    {
      object (ExecutionEvent)
    }
  ]
}

object (ExecutionEvent)

Actions Builder のインタラクション モデルのステージにおける会話ラウンドの処理に関する詳細を含むイベントのリスト。Actions Builder と Actions SDK のアプリについてのみ入力されます。

{
  "eventTime": string,
  "executionState": {
    object (ExecutionState)
  },
  "status": {
    object (Status)
  },
  "warningMessages": [
    string
  ],

  // Union field EventData can be only one of the following:
  "userInput": {
    object (UserConversationInput)
  },
  "intentMatch": {
    object (IntentMatch)
  },
  "conditionsEvaluated": {
    object (ConditionsEvaluated)
  },
  "onSceneEnter": {
    object (OnSceneEnter)
  },
  "webhookRequest": {
    object (WebhookRequest)
  },
  "webhookResponse": {
    object (WebhookResponse)
  },
  "webhookInitiatedTransition": {
    object (WebhookInitiatedTransition)
  },
  "slotMatch": {
    object (SlotMatch)
  },
  "slotRequested": {
    object (SlotRequested)
  },
  "slotValidated": {
    object (SlotValidated)
  },
  "formFilled": {
    object (FormFilled)
  },
  "waitingUserInput": {
    object (WaitingForUserInput)
  },
  "endConversation": {
    object (EndConversation)
  }
  // End of list of possible types for union field EventData.
}

string (Timestamp format)

イベント発生時のタイムスタンプ。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"。

object (ExecutionState)

このイベント中の実行の状態。

object (Status)

特定の実行ステップの結果のステータス。

string

このイベントの実行中に生成された警告のリスト。警告は、会話リクエスト中にデベロッパーが発見したヒントです。通常、これらは重大ではなく、リクエストの実行を停止しません。たとえば、存在しないカスタムのタイプを Webhook がオーバーライドしようとすると、警告が生成されることがあります。エラーは失敗のステータス コードとして報告されますが、ステータスが OK であっても警告が表示される場合があります。

object (UserConversationInput)

ユーザー入力処理イベント。

object (IntentMatch)

インテント マッチング イベント。

object (ConditionsEvaluated)

条件評価イベント。

object (OnSceneEnter)

OnSceneEnter 実行イベント。

object (WebhookRequest)

Webhook リクエストのディスパッチ イベント。

object (WebhookResponse)

Webhook レスポンス受信イベント。

object (WebhookInitiatedTransition)

Webhook で開始された遷移イベント。

object (SlotMatch)

スロット マッチング イベント。

object (SlotRequested)

スロット リクエスト イベント。

object (SlotValidated)

スロット検証イベント。

object (FormFilled)

フォーム入力イベント。

object (WaitingForUserInput)

wait-for-user-input イベント。

object (EndConversation)

会話終了イベント。

{
  "currentSceneId": string,
  "sessionStorage": {
    object
  },
  "slots": {
    object (Slots)
  },
  "promptQueue": [
    {
      object (Prompt)
    }
  ],
  "userStorage": {
    object
  },
  "householdStorage": {
    object
  }
}

string

現在アクティブなシーンの ID。

object (Struct format)

セッション ストレージの状態: https://developers.google.com/assistant/conversational/storage-session

object (Slots)

スロットフィルの状態（該当する場合）: https://developers.google.com/assistant/conversational/scenes#slot_filling

object (Prompt)

プロンプト キュー: https://developers.google.com/assistant/conversational/prompts

object (Struct format)

ユーザーのストレージの状態: https://developers.google.com/assistant/conversational/storage-user

object (Struct format)

ホーム ストレージの状態: https://developers.google.com/assistant/conversational/storage-home

{
  "status": enum (SlotFillingStatus),
  "slots": {
    string: {
      object (Slot)
    },
    ...
  }
}

enum (SlotFillingStatus)

スロットフィルの現在のステータス。

map (key: string, value: object (Slot))

現在のシーンに関連付けられているスロット。

"key": value ペアのリストを含むオブジェクト。例: { "name": "wrench", "mass": "1.3kg", "count": "3" }

{
  "mode": enum (SlotMode),
  "status": enum (SlotStatus),
  "value": value,
  "updated": boolean,
  "prompt": {
    object (Prompt)
  }
}

enum (SlotMode)

スロットのモード（必須または省略可）。デベロッパーが設定できます。

enum (SlotStatus)

スロットのステータス。

value (Value format)

スロットの値。レスポンスのこの値を変更すると、スロットフィルの値も変更されます。

boolean

スロット値が最後のターンで収集されたかどうかを示します。このフィールドは読み取り専用です。

object (Prompt)

（省略可）このメッセージは、必須のスロットに広告を配信する必要がある場合に送信されます。このプロンプトは、コンソールで定義されている既存のプロンプトをオーバーライドします。このフィールドは Webhook リクエストに含まれません。

{
  "code": integer,
  "message": string,
  "details": [
    {
      "@type": string,
      field1: ...,
      ...
    }
  ]
}

integer

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

string

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

object

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

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

{
  "type": string,
  "originalQuery": string
}

string

ユーザー入力のタイプ。（キーボード、音声、タップなど）。

string

ユーザーが入力した元のテキスト。

{
  "intentId": string,
  "intentParameters": {
    string: {
      object (IntentParameterValue)
    },
    ...
  },
  "handler": string,
  "nextSceneId": string
}

string

このインタラクションをトリガーしたインテント ID。

map (key: string, value: object (IntentParameterValue))

このインタラクションをトリガーしたインテントのパラメータ。

"key": value ペアのリストを含むオブジェクト。例: { "name": "wrench", "mass": "1.3kg", "count": "3" }

string

このインタラクションにアタッチされているハンドラの名前。

string

このインタラクションにつながるシーン。

{
  "failedConditions": [
    {
      object (Condition)
    }
  ],
  "successCondition": {
    object (Condition)
  }
}

object (Condition)

「false」と評価された条件のリスト。

object (Condition)

「true」と評価された最初の条件（存在する場合）。

{
  "expression": string,
  "handler": string,
  "nextSceneId": string
}

string

この条件で指定された式。

string

評価された条件で指定されたハンドラ名。

string

評価された条件で指定された目的地のシーン。

{
  "handler": string
}

string

onSceneEnter イベントで指定されたハンドラ名。

{
  "requestJson": string
}

string

Webhook リクエストのペイロード。

{
  "responseJson": string
}

string

Webhook レスポンスのペイロード。

{
  "nextSceneId": string
}

string

遷移が行われるシーンの ID。

{
  "nluParameters": {
    string: {
      object (IntentParameterValue)
    },
    ...
  }
}

map (key: string, value: object (IntentParameterValue))

ユーザー入力から NLU が抽出したパラメータ。

"key": value ペアのリストを含むオブジェクト。例: { "name": "wrench", "mass": "1.3kg", "count": "3" }

{
  "slot": string,
  "prompt": {
    object (Prompt)
  }
}

string

リクエストされたスロットの名前。

object (Prompt)

スロット プロンプト