- JSON 表現
- ExpectedInput
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表現
- InputPrompt
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表現
- SpeechResponse
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表現
- RichResponse
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表現
- 項目
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表現
- SimpleResponse
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表現
- BasicCard
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表現
- ボタン
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表現
- StructuredResponse
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表現
- OrderUpdate
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表現
- アクション
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表現
- 領収書
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表現
- RejectionInfo
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表現
- CancellationInfo
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表現
- InTransitInfo
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表現
- FulfillmentInfo
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表現
- ReturnInfo
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表現
- UserNotification
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表現
- MediaResponse
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表現
- MediaObject
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表現
- CarouselBrowse
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表現
- 項目
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表現
- TableCard
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表現
- ColumnProperties
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表現
- 行
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表現
- 携帯
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表現
- HtmlResponse
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表現
- 候補
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表現
- LinkOutSuggestion
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表現
- ExpectedIntent
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表現
- FinalResponse
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表現
- CustomPushMessage
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表現
- UserNotification
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表現
- 目標
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表現
AppResponse は、フルフィルメントから Google アシスタントに送信されるレスポンスです。これが Actions on Google でどのように使用されるかの例については、https://developers.google.com/assistant/df-asdk/reference/conversation-webhook-json#conversation-response-body をご覧ください。
JSON 表現 | |
---|---|
{ "conversationToken": string, "userStorage": string, "resetUserStorage": boolean, "expectUserResponse": boolean, "expectedInputs": [ { object ( |
フィールド | |
---|---|
conversationToken |
会話ターンのたびにアクションに再循環される不透明なトークン。 |
userStorage |
特定のユーザーの会話間で維持される、アクションによって制御される不透明トークン。これが空または指定されていない場合、既存の永続トークンは変更されません。文字列の最大サイズは 10 KB です。同じユーザーに対して複数の対話が同時に行われている場合、このトークンを更新すると、他方の保存情報が予期せず上書きされる可能性があります。 |
resetUserStorage |
永続的な userStorage を消去するかどうか。true に設定した場合、ユーザーとの次のやり取りで userStorage フィールドは空になります。 |
expectUserResponse |
アクションがユーザーからの応答を想定しているかどうかを示します。会話が進行中の場合は true、会話が終了した場合は false になります。 |
expectedInputs[] |
アクションが期待する入力のリスト。各入力は、一般的な Actions on Google インテント(「actions.」で始まる)か、想定されるインテントのリストを含む入力です。現時点では、入力は 1 つだけしかサポートされていません。 |
finalResponse |
アクションがユーザーの入力を期待していない場合の最終的なレスポンス。 |
customPushMessage |
デベロッパーが構造化データを Actions on Google に送信できるようにするカスタム プッシュ メッセージ。 |
isInSandbox |
レスポンスをサンドボックス モードで処理する必要があるかどうかを示します。このビットは、構造化データをサンドボックス モードで Google に push するために必要となります。 |
ExpectedInput
JSON 表現 | |
---|---|
{ "inputPrompt": { object ( |
フィールド | |
---|---|
inputPrompt |
ユーザーに入力を求めるために使用されるカスタマイズされたプロンプト。 |
possibleIntents[] |
この入力を処理するために使用できるインテントのリスト。Actions on Google が未加工のユーザー入力を返すだけの場合は、アプリで |
speechBiasingHints[] |
音声バイアス処理にアクションが Google に使用するよう求めるフレーズのリスト。最大 1,000 個のフレーズを指定できます。 |
InputPrompt
アシスタントがユーザーにアプリの質問に対する入力を提供するよう促すために使用される入力プロンプト。
JSON 表現 | |
---|---|
{ "initialPrompts": [ { object ( |
フィールド | |
---|---|
initialPrompts[] |
ユーザーに入力を求める初期プロンプト。単一の initial_prompt のみがサポートされています。 |
richInitialPrompt |
プロンプト ペイロード。 |
noInputPrompts[] |
ユーザーからの入力がないときにユーザーに確認するプロンプト。 |
SpeechResponse
音声のみを含むレスポンス。非推奨。
JSON 表現 | |
---|---|
{ // Union field |
フィールド | ||
---|---|---|
共用体フィールド type 。音声出力のタイプ: テキスト読み上げまたは SSML。type は次のいずれかになります。 |
||
textToSpeech |
音声出力の書式なしテキスト。例:「どこに行きたいですか?」 |
|
ssml |
SSML 形式でのユーザーに対する構造化された音声レスポンス。例:「音の後に動物の名前を言ってください。 |
RichResponse
音声、テキスト、カード、候補、構造化データを含めることができるリッチなレスポンス。
JSON 表現 | |
---|---|
{ "items": [ { object ( |
フィールド | |
---|---|
items[] |
レスポンスを構成する UI 要素のリスト。アイテムは次の要件を満たす必要があります。1.最初のアイテムは |
suggestions[] |
返信文の候補のリスト。これらは常にレスポンスの最後に提示されます。 |
linkOutSuggestion |
関連するアプリやサイトにリンクできる追加の候補ワード。 |
項目
レスポンスの項目。
JSON 表現 | |
---|---|
{ "name": string, // Union field |
フィールド | ||
---|---|---|
name |
このアイテムの名前付き ID(省略可)。 |
|
共用体フィールド item 。アイテムのタイプ。item は次のいずれかになります。 |
||
simpleResponse |
音声とテキストのみのレスポンス。 |
|
basicCard |
ベーシック カード。 |
|
structuredResponse |
Google が処理する構造化ペイロード。 |
|
mediaResponse |
再生するメディアのセットを示すレスポンス。 |
|
carouselBrowse |
カルーセル ブラウジング カード。代わりに collectionBrowse を使用してください。 |
|
tableCard |
テーブルカード。 |
|
htmlResponse |
Canvas でのレンダリングに使用される HTML レスポンス。 |
SimpleResponse
ユーザーに提示する音声またはテキストを含むシンプルなレスポンス。
JSON 表現 | |
---|---|
{ "textToSpeech": string, "ssml": string, "displayText": string } |
フィールド | |
---|---|
textToSpeech |
音声出力の書式なしテキスト。例:「どこに行きたいですか?」ssml とは相互に排他的。 |
ssml |
SSML 形式でのユーザーに対する構造化された音声レスポンス。例: |
displayText |
チャットふきだしに表示するテキスト(省略可)。指定されていない場合は、上記の textToSpeech または ssml の表示レンダリングが使用されます。640 文字に制限されています。 |
BasicCard
画像やテキストなどの情報を表示するための基本的なカード。
JSON 表現 | |
---|---|
{ "title": string, "subtitle": string, "formattedText": string, "image": { object ( |
フィールド | |
---|---|
title |
カードの全体的なタイトル。省略可。 |
subtitle |
省略可。 |
formattedText |
カードの本文。書式設定用に限定されたマークダウン構文がサポートされています。画像が存在しない場合は必須。 |
image |
カードのヒーロー画像。高さは 192 dp に固定されています。省略可。 |
buttons[] |
ボタン。現時点では、最大 1 つのボタンがサポートされています。省略可。 |
imageDisplayOptions |
画像表示オプションの種類です。省略可。 |
Button
通常はカードの一番下に表示されるボタン オブジェクト。
JSON 表現 | |
---|---|
{
"title": string,
"openUrlAction": {
object ( |
フィールド | |
---|---|
title |
ボタンのタイトル。必須。 |
openUrlAction |
ユーザーがボタンをタップしたときに実行されるアクション。必須。 |
StructuredResponse
構造化データで応答するアプリのために定義されたレスポンス。
JSON 表現 | |
---|---|
{ // Union field |
フィールド | ||
---|---|---|
共用体フィールド data 。3P エージェントからのペイロード レスポンスのコンテナ。data は次のいずれかになります。 |
||
orderUpdate |
アプリが注文を受け取った後に、注文の更新( |
|
orderUpdateV3 |
アプリは、注文の受信後に API v3 形式で注文の更新を提供します。 |
OrderUpdate
非推奨: 代わりに V3 Proto を使用してください。注文の更新。
JSON 表現 | |
---|---|
{ "googleOrderId": string, "actionOrderId": string, "orderState": { object ( |
フィールド | ||
---|---|---|
googleOrderId |
注文の ID は Google が発行した ID です。 |
|
actionOrderId |
必須。この注文を参照する正規の注文 ID。インテグレータが独自のシステムで正規の注文 ID を発行しない場合は、注文に含まれている googleOrderId を単にコピーするだけでもかまいません。 |
|
orderState |
注文の新しいステータス。 |
|
orderManagementActions[] |
注文に適用される管理アクションを更新しました。例:管理、変更、サポートにお問い合わせください。 |
|
receipt |
注文の領収書。 |
|
updateTime |
アプリの観点から見て、注文がいつ更新されたかを示します。 RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒例: |
|
totalPrice |
注文の新しい合計金額 |
|
lineItemUpdates |
項目 ID をキーとする項目レベルの変更のマップ。省略可。
|
|
userNotification |
指定すると、指定したタイトルとテキストでユーザーに通知が表示されます。通知を指定することは、ユーザーに通知するよう提案することにすぎず、必ずしも通知が表示されるとは限りません。 |
|
infoExtension |
カスタムの注文状態に基づく追加データ、または標準状態の情報に加えて提供される追加データ。 任意の型のフィールドを含むオブジェクト。型を識別する URI を含むフィールド |
|
共用体フィールド info 。注文の状態に関連する追加情報。info は次のいずれかになります。 |
||
rejectionInfo |
拒否状態に関する情報。 |
|
cancellationInfo |
キャンセル ステータスに関する情報。 |
|
inTransitInfo |
配送中状態に関する情報。 |
|
fulfillmentInfo |
フルフィルメントの状態に関する情報。 |
|
returnInfo |
返品状態に関する情報。 |
アクション
注文更新に関連付けられたフォローアップ アクション。
JSON 表現 | |
---|---|
{ "type": enum ( |
フィールド | |
---|---|
type |
アクションのタイプです。 |
button |
ボタンのラベルとリンク。 |
領収書
非推奨: 代わりに V3 Proto を使用してください。状態が CONFIRMED、またはその他の CONFIRMED 状態を含む状態(例: IN_TRANSIT、FULFILLED)のときの領収書。
JSON 表現 | |
---|---|
{ "confirmedActionOrderId": string, "userVisibleOrderId": string } |
フィールド | |
---|---|
confirmedActionOrderId |
インテグレータが注文を受け取ったときに確定された注文 ID。これは注文を参照するインテグレータのシステムで使用される正規の注文 ID です。後で注文を このフィールドは非推奨です。代わりに OrderUpdate.action_order_id を介してこのフィールド内容を渡してください。 |
userVisibleOrderId |
省略可。領収書カード(存在する場合)に表示される、現在の注文を参照するユーザー向け ID。これは、印刷される領収書またはユーザーのメールアドレスに送信される領収書に通常表示される ID です。ユーザーは、インテグレータが提供するカスタマー サービスを受ける際に、この ID を使用して対象の注文を知らせることができます。このフィールドは、インテグレータが印刷される領収書またはメールによる領収書を伴う注文に対してユーザー向け ID を生成する場合は必ず値を指定する必要があります。 |
RejectionInfo
状態が REJECTED の場合の拒否情報。このメッセージは、会話での最初の注文更新時、またはその後の非同期の注文更新を通じて提供できます。
JSON 表現 | |
---|---|
{
"type": enum ( |
フィールド | |
---|---|
type |
拒否の種類。 |
reason |
エラーの理由。 |
CancellationInfo
非推奨: 代わりに V3 Proto を使用してください。状態が CANCELED の場合のキャンセル情報。
JSON 表現 | |
---|---|
{ "reason": string } |
フィールド | |
---|---|
reason |
キャンセルの理由。 |
InTransitInfo
非推奨: 代わりに V3 Proto を使用してください。状態が IN_TRANSIT の場合の配送情報。
JSON 表現 | |
---|---|
{ "updatedTime": string } |
フィールド | |
---|---|
updatedTime |
配送情報の最後の更新日時。 RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒例: |
FulfillmentInfo
非推奨: 代わりに V3 Proto を使用してください。状態が FULFILLED の場合の履行情報。
JSON 表現 | |
---|---|
{ "deliveryTime": string } |
フィールド | |
---|---|
deliveryTime |
注文が履行される日時。 RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒例: |
ReturnInfo
非推奨: 代わりに V3 Proto を使用してください。状態が REJECTED の場合の返品情報。
JSON 表現 | |
---|---|
{ "reason": string } |
フィールド | |
---|---|
reason |
返送の理由。 |
UserNotification
注文更新の一部として表示する任意指定のユーザー通知。
JSON 表現 | |
---|---|
{ "title": string, "text": string } |
フィールド | |
---|---|
title |
ユーザー通知のタイトル。 |
text |
通知の内容。 |
MediaResponse
会話内で再生されるメディアのセットを示すレスポンス。
JSON 表現 | |
---|---|
{ "mediaType": enum ( |
フィールド | |
---|---|
mediaType |
このレスポンス内のメディアのタイプ。 |
mediaObjects[] |
メディア オブジェクトのリスト。 |
MediaObject
MediaResponse で返される 1 つのメディア オブジェクトを表します。名前、説明、URL などのメディアに関する情報が含まれます。
JSON 表現 | |
---|---|
{ "name": string, "description": string, "contentUrl": string, // Union field |
フィールド | ||
---|---|---|
name |
名前を指定します。 |
|
description |
このメディア オブジェクトの説明です。 |
|
contentUrl |
メディア コンテンツを指す URL。 |
|
共用体フィールド image 。メディアカードとともに表示する画像。image は次のいずれかになります。 |
||
largeImage |
アルバムのカバーなどの大きな画像。 |
|
icon |
タイトルの右側に表示される小さな画像アイコン。36×36 dp にサイズ変更されます。 |
CarouselBrowse
AMP ドキュメントのセットを大きなタイル項目のカルーセルとして提示します。項目が選択されたときに、その項目に対応する AMP ドキュメントを AMP ビューアで開くことができます。
JSON 表現 | |
---|---|
{ "items": [ { object ( |
フィールド | |
---|---|
items[] |
最小: 2。最大 10 個。 |
imageDisplayOptions |
画像表示オプションの種類です。省略可。 |
Item
カルーセル内の項目。
JSON 表現 | |
---|---|
{ "title": string, "description": string, "footer": string, "image": { object ( |
フィールド | |
---|---|
title |
カルーセル アイテムのタイトル。必須。 |
description |
カルーセル アイテムの説明。省略可。 |
footer |
説明の下に表示されるカルーセル アイテムのフッター テキスト。1 行で切り捨てられて省略記号が付きます。省略可。 |
image |
カルーセル アイテムのヒーロー画像。省略可。 |
openUrlAction |
カルーセル アイテムに関連付けられているドキュメントの URL。ドキュメントには HTML コンテンツを含めることができます。「urlTypeHint」が AMP_CONTENT に設定されている場合は、AMP コンテンツを含めることができます。必須。 |
TableCard
テキストの表を表示するためのカード。
JSON 表現 | |
---|---|
{ "title": string, "subtitle": string, "image": { object ( |
フィールド | |
---|---|
title |
テーブルの全体的なタイトル。省略できますが、サブタイトルが設定されている場合は必ず設定する必要があります。 |
subtitle |
テーブルのサブタイトル。省略可。 |
image |
テーブルに関連付けられている画像。省略可。 |
columnProperties[] |
ヘッダーと列の配置。 |
rows[] |
テーブルの行データ。最初の 3 行は表示されることが保証されますが、その他の行はサーフェスによっては切り捨てられる場合があります。特定のサーフェスに対してどの行が表示されるかをシミュレータでテストしてください。WEB_BROWSER 機能をサポートするサーフェスでは、詳細なデータを示すウェブページを開くことができます。 |
buttons[] |
ボタン。現時点では、最大 1 つのボタンがサポートされています。省略可。 |
ColumnProperties
列のプロパティ(見出しを含む)を保持します。
JSON 表現 | |
---|---|
{
"header": string,
"horizontalAlignment": enum ( |
フィールド | |
---|---|
header |
列のヘッダー テキスト。 |
horizontalAlignment |
列に対するコンテンツの水平方向の配置。省略した場合、内容は前端に揃えられます。 |
Row
表の行を記述します。
JSON 表現 | |
---|---|
{
"cells": [
{
object ( |
フィールド | |
---|---|
cells[] |
この行のセル。最初の 3 つのセルは表示されることが保証されますが、その他のセルはサーフェスによっては切り捨てられる場合があります。特定のサーフェスに対してどのセルが表示されるかをシミュレータでテストしてください。 |
dividerAfter |
各行の後に分割線を追加するかどうかを示します。 |
セル
行のセルを記述します。
JSON 表現 | |
---|---|
{ "text": string } |
フィールド | |
---|---|
text |
セルのテキスト コンテンツ。 |
HtmlResponse
インタラクティブ キャンバス機能を使用して HTML を表示するレスポンス。各 Pod の最大サイズは、 レスポンスは 50,000 バイトです。
JSON 表現 | |
---|---|
{ "updatedState": value, "suppressMic": boolean, "url": string } |
フィールド | |
---|---|
updatedState |
次の JSON オブジェクトをアプリに伝えます。 |
suppressMic |
この没入型の応答の後にマイクが開かないようにするオプションを提供してください。 |
url |
アプリケーションの URL。 |
候補
会話にすばやく返答を返すためにユーザーがタップできる候補ワード。
JSON 表現 | |
---|---|
{ "title": string } |
フィールド | |
---|---|
title |
候補ワードに表示されるテキスト。タップすると、あたかもユーザーがこのテキストをキーボードから入力したかのように、このテキストが会話にそのままポストバックされます。一連の候補ワードの間でタイトルが重複していてはなりません。最大 25 文字(必須) |
LinkOutSuggestion
このエージェントに関連付けられたアプリまたはウェブサイトにユーザーをジャンプさせる候補ワードを作成します。
JSON 表現 | |
---|---|
{
"destinationName": string,
"url": string,
"openUrlAction": {
object ( |
フィールド | |
---|---|
destinationName |
このチップのリンク先のアプリまたはサイトの名前。チップは「開く」というタイトルでレンダリングされます。 |
url |
非推奨。代わりに OpenUrlAction を使用してください。 |
openUrlAction |
ユーザーが候補ワードをタップしたときに開くアプリまたはサイトの URL。このアプリ / URL のオーナー権限を Actions on Google Developer Console で検証する必要があります。オーナー権限がないと、候補ワードがユーザーに表示されません。URL を開くアクションは、http、https、インテント URL をサポートしています。インテント URL については、https://developer.chrome.com/multidevice/android/intents をご覧ください。 |
ExpectedIntent
アプリがアシスタントに提供するよう求める期待インテント。
JSON 表現 | |
---|---|
{ "intent": string, "inputValueData": { "@type": string, field1: ..., ... }, "parameterName": string } |
フィールド | |
---|---|
intent |
組み込みインテントの名前(例: |
inputValueData |
組み込みインテントによって必要とされる追加の構成データ。組み込みインテントの有効な値: 任意の型のフィールドを含むオブジェクト。型を識別する URI を含むフィールド |
parameterName |
リクエストされているインテントのパラメータ(省略可)。要求されたインテントに対してのみ有効です。スピーチ バイアスに使用されます。 |
FinalResponse
ユーザー入力が期待されていない最終レスポンス。
JSON 表現 | |
---|---|
{ // Union field |
フィールド | ||
---|---|---|
共用体フィールド response 。有効なレスポンス タイプ。response は次のいずれかになります。 |
||
speechResponse |
ユーザーが入力を求められない音声レスポンス。 |
|
richResponse |
ユーザーによる入力が不要な場合のリッチ レスポンス。 |
CustomPushMessage
Actions Fulfillment API 用に push する構造化データを保持するカスタム push メッセージ。
JSON 表現 | |
---|---|
{ "target": { object ( |
フィールド | ||
---|---|---|
target |
push リクエストの指定されたターゲット。 |
|
共用体フィールド content 。ペイロードのさまざまなタイプ。content は次のいずれかになります。 |
||
orderUpdate |
トランザクション API を通じて行われた注文を更新する注文更新。 |
|
userNotification |
指定すると、指定したタイトルとテキストでユーザーに通知が表示されます。 |
UserNotification
リクエストとともに表示するユーザー通知。
JSON 表現 | |
---|---|
{ "title": string, "text": string } |
フィールド | |
---|---|
title |
通知のタイトル。 |
text |
通知の内容。 |
ターゲット
push リクエストの指定されたターゲット。
JSON 表現 | |
---|---|
{
"userId": string,
"intent": string,
"argument": {
object ( |
フィールド | |
---|---|
userId |
ターゲットとするユーザー。 |
intent |
ターゲットとするインテント。 |
argument |
インテントのターゲットとする引数。V1 では、1 つの引数のみがサポートされています。 |
locale |
ターゲットとする言語 / 地域。IETF BCP-47 言語コードに従います。多言語アプリが、指定されたローカライズされたアプリのユーザーをターゲットにするために使用できます。指定しない場合のデフォルトは en-US です。 |