EventHandler

candidates: 
  - object (StaticPromptCandidate)

object (StaticPromptCandidate)

クライアントに送信するプロンプト候補のリスト。各プロンプトには、いつ使用できるかを決定するセレクタがあります。リクエストに一致する最初のセレクタが送信され、残りは無視されます。

selector: 
  object (Selector)
promptResponse: 
  object (StaticPromptResponse)

object (Selector)

省略可。このプロンプトがリクエストと一致するかどうかの基準。セレクタが空の場合、このプロンプトは常にトリガーされます。

object (StaticPromptResponse)

セレクタに関連付けられたプロンプト レスポンス。

surfaceCapabilities: 
  object (SurfaceCapabilities)

object (SurfaceCapabilities)

必要なサーフェス機能のセット。

capabilities: 
  - enum (Capability)

enum (Capability)

必須。アクションにリクエストを行っているサーフェスの機能。

firstSimple: 
  object (StaticSimplePrompt)
content: 
  object (StaticContentPrompt)
lastSimple: 
  object (StaticSimplePrompt)
suggestions: 
  - object (Suggestion)
link: 
  object (StaticLinkPrompt)
override: boolean
canvas: 
  object (StaticCanvasPrompt)

object (StaticSimplePrompt)

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

object (StaticContentPrompt)

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

object (StaticSimplePrompt)

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

object (Suggestion)

省略可。ユーザーに表示される候補。常にレスポンスの最後に表示されます。含まれるプロンプトの append フィールドが true の場合、このフィールドで定義されたタイトルは、以前に定義された候補プロンプトで定義されたタイトルに追加され、重複する値は削除されます。

object (StaticLinkPrompt)

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

boolean

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

object (StaticCanvasPrompt)

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

variants: 
  - object (Variant)

object (Variant)

可能性のあるバリアントのリスト。

speech: string
text: string

string

省略可。ユーザーに読み上げられる音声を表します。SSML またはテキスト読み上げを使用できます。デフォルトでは、音声は前のシンプル プロンプトの音声に追加されます。含まれるプロンプトの override フィールドが true の場合、このフィールドで定義された音声が、以前のシンプル プロンプトの音声をオーバーライドします。

string

省略可。チャットふきだしに表示するテキスト。指定しない場合は、上記の音声フィールドの表示レンダリングが使用されます。640 文字までです。デフォルトでは、テキストは前のシンプル プロンプトのテキストに追加されます。含まれるプロンプトの override フィールドが true の場合、このフィールドで定義されたテキストが、以前のシンプル プロンプトのテキストをオーバーライドします。

# Union field content can be only one of the following:
card: 
  object (StaticCardPrompt)
image: 
  object (StaticImagePrompt)
table: 
  object (StaticTablePrompt)
media: 
  object (StaticMediaPrompt)
list: 
  object (StaticListPrompt)
collection: 
  object (StaticCollectionPrompt)
collectionBrowse: 
  object (StaticCollectionBrowsePrompt)
# End of list of possible types for union field content.

object (StaticCardPrompt)

ベーシック カード。

object (StaticImagePrompt)

画像。

object (StaticTablePrompt)

テーブルカード。

object (StaticMediaPrompt)

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

object (StaticListPrompt)

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

object (StaticCollectionPrompt)

選択できるオプションのリストを示すカード。

object (StaticCollectionBrowsePrompt)

開くウェブページのコレクションを示すカード。

title: string
subtitle: string
text: string
image: 
  object (StaticImagePrompt)
imageFill: enum (ImageFill)
button: 
  object (StaticLinkPrompt)

string

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

string

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

string

必須。カードの本文。画像がない場合に必須です。書式設定のための一部のマークダウン構文をサポートします。

object (StaticImagePrompt)

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

enum (ImageFill)

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

object (StaticLinkPrompt)

省略可。カードに表示されるクリック可能なボタン。

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 (StaticImagePrompt)
columns: 
  - object (TableColumn)
rows: 
  - object (TableRow)
button: 
  object (StaticLinkPrompt)

string

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

string

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

object (StaticImagePrompt)

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

object (TableColumn)

省略可。ヘッダーと列の配置。

object (TableRow)

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

object (StaticLinkPrompt)

省略可。ボタン。

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)
repeatMode: enum (RepeatMode)

enum (MediaType)

このレスポンスのメディアタイプ。

string (Duration format)

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

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

enum (OptionalMediaControls)

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

object (MediaObject)

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

enum (RepeatMode)

メディア オブジェクトのリストの繰り返しモード。

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 (StaticImagePrompt)
icon: 
  object (StaticImagePrompt)
# End of list of possible types for union field image.

object (StaticImagePrompt)

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

object (StaticImagePrompt)

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

title: string
subtitle: string
items: 
  - object (ListItem)

string

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

string

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

object (ListItem)

必須。リストアイテム。

key: string
title: string
description: string
image: 
  object (StaticImagePrompt)

string

必須。関連付けられたタイプのエントリキー名と一致する NLU キー。アイテムがタップされると、このキーは選択オプション パラメータとしてポストバックされます。

string

必須。商品アイテムのタイトル。タップすると、あたかもユーザーがこのテキストをキーボードから入力したかのように、このテキストが会話にそのままポストバックされます。各タイトルは、一連の商品アイテムの中で一意である必要があります。

string

省略可。アイテムの本文テキスト。

object (StaticImagePrompt)

省略可。アイテムの画像。

title: string
subtitle: string
items: 
  - object (CollectionItem)
imageFill: enum (ImageFill)

string

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

string

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

object (CollectionItem)

必須。コレクションのアイテム。

enum (ImageFill)

省略可。画像表示オプションのタイプ。

key: string
title: string
description: string
image: 
  object (StaticImagePrompt)

string

必須。関連するタイプのエントリキー名と一致する NLU キー。アイテムがタップされると、このキーは選択オプション パラメータとしてポストバックされます。

string

必須。商品アイテムのタイトル。タップすると、あたかもユーザーがこのテキストをキーボードから入力したかのように、このテキストが会話にそのままポストバックされます。各タイトルは、一連の商品アイテムの中で一意である必要があります。

string

省略可。アイテムの本文テキスト。

object (StaticImagePrompt)

省略可。アイテムの画像。

items: 
  - object (CollectionBrowseItem)
imageFill: enum (ImageFill)

object (CollectionBrowseItem)

ブラウズ コレクション内のアイテム。リストサイズは [2, 10] の範囲にする必要があります。

enum (ImageFill)

コレクション内の画像の画像表示オプション。

title: string
description: string
footer: string
image: 
  object (StaticImagePrompt)
openUriAction: 
  object (OpenUrl)

string

必須。コレクション アイテムのタイトル。

string

コレクション アイテムの説明。

string

説明の下に表示されるコレクション アイテムのフッター テキスト。1 行のテキスト。省略記号で切り捨てられます。

object (StaticImagePrompt)

コレクション アイテムの画像。

object (OpenUrl)

必須。アイテムが選択されたときに開く URI。

title: string

string

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

url: string
data: 
  - value
suppressMic: boolean
sendStateDataToCanvasApp: boolean
enableFullScreen: boolean
continueTtsDuringTouch: boolean

string

必須。読み込むウェブビューの URL。

value (Value format)

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

boolean

省略可。値が true の場合、この没入型の応答がユーザーに表示された後、入力をキャプチャするためにマイクが開かないことを意味します。

boolean

省略可。true の場合、会話関連のメタデータが含まれ、キャンバス アプリケーションに返されます。

boolean

省略可。true の場合、キャンバス アプリは全画面表示されるため、上部にヘッダーは表示されません。読み込み画面にトースト メッセージも表示されます。このメッセージには、アクションの表示名、デベロッパーの名前、アクションを終了する手順が含まれています。デフォルト値: false。

boolean

省略可。true の場合、画面をタップしてもキャンバス セッション全体の TTS は停止しません。デフォルト値: false