StaticPrompt

代表候選提示清單，其中會選為要向使用者顯示的提示。這則訊息可以本地化。

JSON 表示法 
{
  "candidates": [
    {
      object (StaticPromptCandidate)
    }
  ]
}
欄位
candidates[]

object (StaticPromptCandidate)

要傳送至用戶端的候選提示清單。每個提示都有決定使用時機的選取器。系統會傳送第一個與請求相符的選取器，並忽略其餘的選取器。

StaticPromptCandidate

代表靜態提示候選項目。

JSON 表示法 
{
  "selector": {
    object (Selector)
  },
  "promptResponse": {
    object (StaticPromptResponse)
  }
}
欄位
selector

object (Selector)

選用設定。此提示是否與要求相符的條件。如果選取器沒有內容，一律會觸發提示。
promptResponse

object (StaticPromptResponse)

與選取器相關聯的提示回應。

選取器

定義提示是否與要求比對的條件。

JSON 表示法 
{
  "surfaceCapabilities": {
    object (SurfaceCapabilities)
  }
}
欄位
surfaceCapabilities

object (SurfaceCapabilities)

一組必要的表面功能。

SurfaceCapabilities

代表使用者用來要求動作的途徑。

JSON 表示法 
{
  "capabilities": [
    enum (Capability)
  ]
}
欄位
capabilities[]

enum (Capability)

必要欄位。途徑向動作發出要求的功能。

StaticPromptResponse

代表要傳送給使用者的結構化回應，例如文字、語音、資訊卡、畫布資料、建議方塊等。

JSON 表示法 
{
  "firstSimple": {
    object (StaticSimplePrompt)
  },
  "content": {
    object (StaticContentPrompt)
  },
  "lastSimple": {
    object (StaticSimplePrompt)
  },
  "suggestions": [
    {
      object (Suggestion)
    }
  ],
  "link": {
    object (StaticLinkPrompt)
  },
  "override": boolean,
  "canvas": {
    object (StaticCanvasPrompt)
  }
}
欄位
firstSimple

object (StaticSimplePrompt)

選用設定。第一個語音和純文字回應。
content

object (StaticContentPrompt)

選用設定。要向使用者顯示的資訊卡、清單或媒體等內容。
lastSimple

object (StaticSimplePrompt)

選用設定。最後一個語音和純文字回應。
suggestions[]

object (Suggestion)

選用設定。向使用者顯示的建議，且一律會顯示在回應結尾。如果內含提示的「附加」欄位為「true」，這個欄位中定義的標題會新增至先前定義建議提示中定義的標題，重複值則會移除。
override

boolean

選用設定。這個模式用於將這則訊息與先前定義的訊息合併。如果設為「true」，系統會清除先前定義的所有訊息 (第一個和最後一行、內容、建議連結和畫布)，並新增這個提示中定義的訊息。「false」則會將這個提示中定義的訊息新增至先前回應中定義的訊息。將這個欄位設為「false」也會啟用在簡易提示、建議提示和 Canvas 提示 (屬於「內容」提示) 中的部分欄位。如果在提示中定義了內容和連結訊息，系統一律會覆寫內容和連結訊息。預設值為「false」。
canvas

object (StaticCanvasPrompt)

用於互動式畫布體驗的回應。

StaticSimplePrompt

代表要傳送給使用者的簡單提示。

JSON 表示法 
{
  "variants": [
    {
      object (Variant)
    }
  ]
}
欄位
variants[]

object (Variant)

可能的變化版本清單。

Variant

代表簡易提示中的變化版本。

JSON 表示法 
{
  "speech": string,
  "text": string
}
欄位
speech

string

選用設定。代表要向使用者顯示的語音。可以是 SSML 或文字轉語音。如果內含提示中的「附加」欄位為「true」，這個欄位中定義的語音會附加至上一個簡單提示的語音。
text

string

選用設定。要在即時通訊泡泡中顯示的文字。如未指定，系統會使用上述的語音欄位顯示內容。最長不得超過 640 個半形字元。如果內含提示中的「append」欄位為「true」，這個欄位中定義的文字會附加到前一個簡單提示的文字。

StaticContentPrompt

StaticPrompt 的「內容」部分預留位置。

JSON 表示法 
{

  // 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)
  }
  // End of list of possible types for union field content.
}
欄位
聯集欄位 content。提示只能顯示一種類型的內容。content 只能是下列其中一項：
card

object (StaticCardPrompt)

基本資訊卡。
image

object (StaticImagePrompt)

圖片。
table

object (StaticTablePrompt)

表格資訊卡。
media

object (StaticMediaPrompt)

回應指出要播放的媒體組合。
list

object (StaticListPrompt)

顯示選項清單的資訊卡。
collection

object (StaticCollectionPrompt)

資訊卡：列出可供選擇的選項。

StaticCardPrompt

顯示部分資訊的基本資訊卡，例如圖片和/或文字。

JSON 表示法 
{
  "title": string,
  "subtitle": string,
  "text": string,
  "image": {
    object (StaticImagePrompt)
  },
  "imageFill": enum (ImageFill),
  "button": {
    object (StaticLinkPrompt)
  }
}
欄位
title

string

選用設定。資訊卡的總標題。
subtitle

string

選用設定。資訊卡的副標題。
text

string

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

object (StaticImagePrompt)

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

enum (ImageFill)

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

object (StaticLinkPrompt)

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

StaticImagePrompt

資訊卡中顯示的圖片。

JSON 表示法 
{
  "url": string,
  "alt": string,
  "height": integer,
  "width": integer
}
欄位
url

string

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

string

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

integer

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

integer

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

StaticLinkPrompt

定義連結，該連結會以建議方塊的形式顯示，並允許使用者開啟。

JSON 表示法 
{
  "name": string,
  "open": {
    object (OpenUrl)
  }
}
欄位
name

string

連結名稱
open

object (OpenUrl)

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

OpenUrl

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

JSON 表示法 
{
  "url": string,
  "hint": enum (UrlHint)
}
欄位
url

string

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

enum (UrlHint)

表示網址類型的提示。

StaticTablePrompt

顯示文字表格的表格資訊卡。

JSON 表示法 
{
  "title": string,
  "subtitle": string,
  "image": {
    object (StaticImagePrompt)
  },
  "columns": [
    {
      object (TableColumn)
    }
  ],
  "rows": [
    {
      object (TableRow)
    }
  ],
  "button": {
    object (StaticLinkPrompt)
  }
}
欄位
title

string

選用設定。表格的整體標題。如果設定了字幕，則必須設定。
subtitle

string

選用設定。資料表的副標題。
image

object (StaticImagePrompt)

選用設定。與表格相關聯的圖片。
columns[]

object (TableColumn)

選用設定。資料欄的標頭和對齊方式。
rows[]

object (TableRow)

選用設定。資料表的資料列資料。前 3 列一定會顯示，但其他內容可能會在特定介面上顯示。請使用模擬工具進行測試，瞭解特定介面會顯示哪些資料列。在支援 WEB_BROWSER 功能的介面上，您可以將使用者導向含有更多資料的網頁。
button

object (StaticLinkPrompt)

選用設定。按鈕。

TableColumn

說明資料表中的資料欄。

JSON 表示法 
{
  "header": string,
  "align": enum (HorizontalAlignment)
}
欄位
header

string

資料欄的標題文字。
align

enum (HorizontalAlignment)

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

TableRow

說明資料表中的資料列。

JSON 表示法 
{
  "cells": [
    {
      object (TableCell)
    }
  ],
  "divider": boolean
}
欄位
cells[]

object (TableCell)

此列的儲存格。我們保證顯示前 3 個儲存格，但其他儲存格可能會截斷。請使用模擬器進行測試，看看在特定表面會顯示哪些儲存格。
divider

boolean

指出每一列後是否應有分隔線。

TableCell

說明資料列中的儲存格。

JSON 表示法 
{
  "text": string
}
欄位
text

string

儲存格的文字內容。

StaticMediaPrompt

包含媒體相關資訊，例如名稱、說明、網址等。下一個 ID：9

JSON 表示法 
{
  "mediaType": enum (MediaType),
  "startOffset": string,
  "optionalMediaControls": [
    enum (OptionalMediaControls)
  ],
  "mediaObjects": [
    {
      object (MediaObject)
    }
  ]
}
欄位
mediaType

enum (MediaType)

此回應的媒體類型。
startOffset

string (Duration format)

第一個媒體物件的開始偏移。

時間長度以秒為單位，最多可有 9 個小數位數，並應以「s」結尾，例如："3.5s"。
optionalMediaControls[]

enum (OptionalMediaControls)

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

object (MediaObject)

媒體物件清單。

MediaObject

代表單一媒體物件。

JSON 表示法 
{
  "name": string,
  "description": string,
  "url": string,
  "image": {
    object (MediaImage)
  }
}
欄位
name

string

此媒體物件的名稱。
description

string

此媒體物件的說明。
url

string

指向媒體內容的網址。
image

object (MediaImage)

與媒體資訊卡一起顯示的圖片。

MediaImage

顯示在 MediaPrompt 中的圖片。

JSON 表示法 
{

  // 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.
}
欄位
聯集欄位 image。只能使用一種 MediaImage。image 只能是下列其中一項：
large

object (StaticImagePrompt)

大型圖片，例如相簿封面等。
icon

object (StaticImagePrompt)

顯示在標題右側的小型圖片圖示。大小已調整為 36x36 dp。

StaticListPrompt

顯示選項清單的資訊卡。

JSON 表示法 
{
  "title": string,
  "subtitle": string,
  "items": [
    {
      object (ListItem)
    }
  ]
}
欄位
title

string

選用設定。清單的標題。
subtitle

string

選用設定。清單子標題。
items[]

object (ListItem)

必要欄位。清單項目。

ListItem

清單中的項目。

JSON 表示法 
{
  "key": string,
  "title": string,
  "description": string,
  "image": {
    object (StaticImagePrompt)
  }
}
欄位
key

string

必要欄位。與相關聯類型中的項目鍵名稱相符的 NLU 鍵。輕觸項目後，這個鍵會發布為選取選項參數。
title

string

必要欄位。商品的名稱。使用者輕觸這段文字後，系統會將其內容張貼回對話，就像使用者輸入內容一樣。各項項目的名稱不得重複。
description

string

選用設定。商品的內文。
image

object (StaticImagePrompt)

選用設定。項目圖片。

StaticCollectionPrompt

顯示一系列選項的資訊卡。

JSON 表示法 
{
  "title": string,
  "subtitle": string,
  "items": [
    {
      object (CollectionItem)
    }
  ],
  "imageFill": enum (ImageFill)
}
欄位
title

string

選用設定。珍藏內容的名稱。
subtitle

string

選用設定。「系列」的副標題。
items[]

object (CollectionItem)

必要欄位。集合項目。
imageFill

enum (ImageFill)

選用設定。圖片顯示選項類型。

CollectionItem

集合中的項目。

JSON 表示法 
{
  "key": string,
  "title": string,
  "description": string,
  "image": {
    object (StaticImagePrompt)
  }
}
欄位
key

string

必要欄位。與相關類型中項目鍵名稱相符的 NLU 鍵。輕觸項目後，這個鍵會發布為選取選項參數。
title

string

必要欄位。商品的名稱。使用者輕觸這段文字後，系統會將其內容張貼回對話，就像使用者輸入內容一樣。各項項目的名稱不得重複。
description

string

選用設定。商品的內文。
image

object (StaticImagePrompt)

選用設定。項目圖片。

建議

代表建議方塊，這是向使用者顯示的 UI 元素。

JSON 表示法 
{
  "title": string
}
欄位
title

string

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

StaticCanvasPrompt

代表要傳送給使用者的互動式畫布回應。除了顯示互動式畫布回應外，這段標記也可與內含提示中的「firstSimple」欄位搭配使用，讓使用者發言。

JSON 表示法 
{
  "url": string,
  "data": [
    value
  ],
  "suppressMic": boolean
}
欄位
url

string

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

value (Value format)

選用設定。要以事件的形式傳遞至沉浸式體驗網頁的 JSON 資料。如果內含提示的「覆寫」欄位是這個 Canvas 提示中定義的資料值，則系統會將先前 Canvas 提示中定義的資料值加到後方。
suppressMic

boolean

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