InteractiveCanvas（Dialogflow）

interactiveCanvas オブジェクトは、ウェブアプリで利用できる会話アクションのインターフェースです。

注: interactiveCanvas オブジェクトは window オブジェクトにアタッチされます。フロントエンド フレームワークを使用してウェブアプリを開発する場合は、window にアクセスして API を設定できることを確認する必要があります。

Methods

ready

ready(callbacks) returns undefined

コールバックを登録するために読み込まれると、Interactive Canvas ウェブアプリによって呼び出されます。

パラメータ
callbacks	InteractiveCanvasCallbacks メソッド コールバックを含むオブジェクト。

注: ページを読み込んだら、すぐにウェブアプリで ready API を呼び出す必要があります。そうしないと、アクションは終了します。

sendTextQuery

sendTextQuery(textQuery) returns Promise<state>

テキストクエリを会話型アクションに送信します。

パラメータ
textQuery	string 会話アクションに送信するクエリ。
state	string 次のいずれかが表示されます。 READY: リクエストはプラットフォームで受け入れられます。 BLOCKED: 処理中のクエリがあるため、新しいクエリは破棄されます。 UNKNOWN: クエリの現在のステータスを確認できませんでした。

注意: textQuery は 640 文字以下にしてください。

getHeaderHeightPx

getHeaderHeightPx() returns Promise<height>

ディスプレイの上部にあるヘッダーの高さを指定します。

パラメータ
height	number ピクセル単位の高さ。

InteractiveCanvasCallbacks

これらのコールバックは、会話型アクションからの情報やリクエストに応答する手段を提供します。一方、メソッドは、会話型アクションに情報やリクエストを送信する手段を提供します。

onUpdate

onUpdate(data) returns undefined

会話アクションから HtmlResponse が送信されたときに呼び出されます。関数呼び出しが終了すると、TTS がすぐに開始されます。

パラメータ
data	Object Webhook によって送信された更新済みデータ。

onTtsMark

onTtsMark(markName) returns undefined

TTS の再生中に呼び出されるコールバック。

通常トリガーされる特別なマークを以下に示します。

• START は、TTS の開始を示します。
• END は、TTS の終了を示します。
• ERROR は、TTS の再生中にエラーが発生したことを示します。

SSML と <mark> タグ（<mark name="custom"/> など）を使用してカスタムマークを定義することもできます。

注: 次の場合、SSML マークは呼び出されません。

• TTS が開始される前に、ユーザーがマイクをタップするか、Interactive Canvas クライアントが sendTextQuery を呼び出します。TTS はキャンセルされ、TTS 内のすべての SSML マークは無視されます。
• TTS 中に、ユーザーがマイクをタップするか、Interactive Canvas クライアントが sendTextQuery を呼び出します。TTS は中断され、TTS 内の残りの SSML マークは無視されます。

パラメータ
markName	string TTS の再生中に呼び出されたマーク名。