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 後，系統也會在簡易提示、建議提示和 Canvas 提示 (屬於內容提示) 中的部分欄位附加這項功能。如果在提示中定義了內容和連結訊息，系統一律會覆寫內容和連結訊息。預設值為 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

必要欄位。必須提供資訊卡的內文 (除非有圖片)。支援有限的 Markdown 語法組合。

object (StaticImagePrompt)

選用設定。資訊卡的主頁橫幅。高度固定為 192dp。

enum (ImageFill)

選用設定。圖片背景的填滿方式。

object (StaticLinkPrompt)

選用設定。顯示在資訊卡中的可點擊按鈕。

url: string
alt: string
height: integer
width: integer

string

必要欄位。圖片的來源網址。圖片可以是 JPG、PNG 和 GIF (動畫和非動畫)。例如：https://www.agentx.com/logo.png。

string

必要欄位。圖片的文字說明，供無障礙功能使用，例如螢幕閱讀器。

integer

選用設定。圖片的高度 (以像素為單位)。

integer

選用設定。圖片的寬度 (以像素為單位)。

name: string
open: 
  object (OpenUrl)

string

連結名稱

object (OpenUrl)

定義使用者開啟連結時的行為。

url: string
hint: enum (UrlHint)

string

網址欄位，可以是下列任一值：- 用來開啟應用程式連結應用程式或網頁的 http/https 網址

enum (UrlHint)

表示網址類型的提示。

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)

內容 w.r.t 欄的水平對齊。如未指定，內容則會與頂部邊緣對齊。

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)

這個媒體回應工作階段可支援的選用媒體控制項類型。如果設定這個項目，系統會在特定媒體事件發生時向 3p 發出要求。如果未設定，3p 仍必須處理兩個預設控制項類型「FINISHED」和「FAILED」。

object (MediaObject)

媒體物件清單。

enum (RepeatMode)

針對媒體物件清單重複模式。

name: string
description: string
url: string
image: 
  object (MediaImage)

string

此媒體物件的名稱。

string

此媒體物件的說明。

string

指向媒體內容的網址。

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)

顯示在標題右側的小型圖片圖示。大小已調整為 36x36 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

產品素材資源集合項目的頁尾文字，顯示在說明下方。單行文字，以刪節號截斷。

object (StaticImagePrompt)

產品素材資源集合項目的圖片。

object (OpenUrl)

必要欄位。選取項目時要開啟的 URI。

title: string

string

必要欄位。建議方塊中顯示的文字。使用者輕觸這段文字後，系統會將其內容張貼回對話，就像使用者輸入內容一樣。所有標題在一組建議方塊中都不得重複。最多 25 個字元

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

string

必要欄位。要載入的網頁資料檢視網址。

value (Value format)

選用設定。要以事件的形式傳遞至沉浸式體驗網頁的 JSON 資料。如果內含提示中的 override 欄位是這個 Canvas 提示中定義的 false 資料值，則系統會在先前的 Canvas 提示中定義資料值之後新增。

boolean

選用設定。true 值表示使用者看到這項沉浸式回應後，不會開啟麥克風來擷取輸入內容。

boolean

選用設定。如為 true，則會納入對話相關中繼資料，並傳回至畫布應用程式。

boolean

選用設定。如果 true 畫布應用程式佔據整個螢幕，且頂端不會有標頭，載入畫面也會顯示浮動式訊息，內含動作的顯示名稱、開發人員名稱及退出動作的操作說明。預設值為 false。

boolean

選用設定。如果為 True，整個畫布工作階段不會因輕觸畫面而停止 TTS。預設值為 false。