- JSON 表示法
- CardHeader
- Section
- 小工具
- TextParagraph
- TextSyntax
- 圖片
- DecoratedText
- VerticalAlignment
- SwitchControl
- ControlType
- TextInput
- 類型
- 建議
- SuggestionItem
- 驗證
- InputType
- HostAppDataSourceMarkup
- ChatClientDataSourceMarkup
- SpaceDataSource
- WorkflowDataSourceMarkup
- 類型
- SelectionInput
- SelectionType
- PlatformDataSource
- CommonDataSource
- DataSourceConfig
- DateTimePicker
- DateTimePickerType
- Divider
- 格狀檢視
- GridItem
- ImageComponent
- ImageCropStyle
- ImageCropType
- BorderStyle
- BorderType
- GridItemLayout
- 資料欄
- Column
- HorizontalSizeStyle
- HorizontalAlignment
- VerticalAlignment
- 小工具
- ChipList
- 版面配置
- 方塊
- 輪轉介面
- CarouselCard
- NestedWidget
- 瀏覽權限
- EventAction
- 觸發條件
- CommonWidgetAction
- UpdateVisibilityAction
- CollapseControl
- DividerStyle
- CardAction
- CardFixedFooter
- DisplayStyle
- ExpressionData
- 條件
- ExpressionDataCondition
- ConditionType
Google Chat 即時通訊訊息或 Google Workspace 外掛程式中顯示的資訊卡介面。
資訊卡支援定義的版面配置、按鈕等互動式 UI 元素,以及圖片等互動式多媒體。使用資訊卡呈現詳細資訊、收集使用者資訊,以及引導使用者採取下一步。
使用資訊卡建構工具設計及預覽資訊卡。
開啟資訊卡建立工具如要瞭解如何建構資訊卡,請參閱下列說明文件:
- 如果是 Google Chat 應用程式,請參閱「設計資訊卡或對話方塊的元件」。
- 如要瞭解 Google Workspace 外掛程式,請參閱「資訊卡介面」。
注意:每張資訊卡最多可加入 100 個小工具。如果某個區段的小工具導致總數超過 100 個,系統會忽略整個區段和後續所有區段。這項限制適用於 Google Chat 應用程式中的資訊卡訊息和對話方塊,以及 Google Workspace 外掛程式中的資訊卡。
範例:Google Chat 應用程式的資訊卡訊息

如要在 Google Chat 中建立範例資訊卡訊息,請使用下列 JSON:
{
"cardsV2": [
{
"cardId": "unique-card-id",
"card": {
"header": {
"title": "Sasha",
"subtitle": "Software Engineer",
"imageUrl":
"https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png",
"imageType": "CIRCLE",
"imageAltText": "Avatar for Sasha"
},
"sections": [
{
"header": "Contact Info",
"collapsible": true,
"uncollapsibleWidgetsCount": 1,
"widgets": [
{
"decoratedText": {
"startIcon": {
"knownIcon": "EMAIL"
},
"text": "sasha@example.com"
}
},
{
"decoratedText": {
"startIcon": {
"knownIcon": "PERSON"
},
"text": "<font color=\"#80e27e\">Online</font>"
}
},
{
"decoratedText": {
"startIcon": {
"knownIcon": "PHONE"
},
"text": "+1 (555) 555-1234"
}
},
{
"buttonList": {
"buttons": [
{
"text": "Share",
"onClick": {
"openLink": {
"url": "https://example.com/share"
}
}
},
{
"text": "Edit",
"onClick": {
"action": {
"function": "goToView",
"parameters": [
{
"key": "viewType",
"value": "EDIT"
}
]
}
}
}
]
}
}
]
}
]
}
}
]
}
| JSON 表示法 |
|---|
{ "header": { object ( |
| 欄位 | |
|---|---|
header |
資訊卡的標頭。標頭通常包含前置圖片和標題。標頭一律會顯示在資訊卡頂端。 |
sections[] |
包含小工具集合。每個區塊都有專屬的選用標題。各區塊會以分隔線區隔。如需 Google Chat 應用程式的範例,請參閱「定義資訊卡的區段」。 |
sectionDividerStyle |
標頭、各區段和頁尾之間的分隔線樣式。 |
cardActions[] |
資訊卡的動作。動作會新增至資訊卡的工具列選單。最多支援 10 個
舉例來說,下列 JSON 會建構含有 |
name |
卡片名稱。在資訊卡導覽中做為資訊卡 ID。
|
fixedFooter |
這張資訊卡底部顯示的固定頁尾。 如果設定
|
displayStyle |
在 Google Workspace 外掛程式中,設定
|
peekCardHeader |
顯示情境內容時,資訊卡預覽標題會做為預留位置,方便使用者在首頁資訊卡和情境資訊卡之間切換。
|
expressionData[] |
資訊卡的運算式資料。 適用於擴充 Google Workspace Studio 的 Google Workspace 外掛程式。不適用於 Google Chat 應用程式。 |
CardHeader
代表資訊卡標頭。如需 Google Chat 應用程式的範例,請參閱「新增標頭」。
適用於 Google Chat 擴充應用程式和 Google Workspace 外掛程式。
| JSON 表示法 |
|---|
{
"title": string,
"subtitle": string,
"imageType": enum ( |
| 欄位 | |
|---|---|
title |
必填。資訊卡標頭的標題。標頭的高度固定:如果同時指定標題和副標題,兩者會各占一行。如果只指定標題,則會佔用兩行。 |
subtitle |
資訊卡標頭的副標題。如果指定,則會顯示在 |
imageType |
用於裁剪圖片的形狀。
|
imageUrl |
資訊卡標頭中圖片的 HTTPS 網址。 |
imageAltText |
這張圖片的替代文字,用於無障礙功能。 |
區段
一個區段包含一組小工具,這些小工具會按照指定順序垂直顯示。
適用於 Google Chat 擴充應用程式和 Google Workspace 外掛程式。
| JSON 表示法 |
|---|
{ "header": string, "widgets": [ { object ( |
| 欄位 | |
|---|---|
header |
顯示在區段頂端的文字。支援簡單的 HTML 格式文字。如要進一步瞭解如何設定文字格式,請參閱「在 Google Chat 應用程式中設定文字格式」和「在 Google Workspace 外掛程式中設定文字格式」。 |
widgets[] |
該部分的所有小工具。必須包含至少一個小工具。一張資訊卡的所有區塊最多可支援 100 個小工具。 |
collapsible |
指出這個部分是否可收合。 可收合區段會隱藏部分或所有小工具,但使用者只要按一下「顯示更多」,即可展開區段並顯示隱藏的小工具。使用者只要按一下「顯示較少」,即可再次隱藏小工具。 如要判斷哪些小工具會隱藏,請指定 |
uncollapsibleWidgetsCount |
即使收合某個部分,仍會顯示的不可收合小工具數量。 舉例來說,如果某個區段包含五個小工具,且 |
id |
指派給版面的專屬 ID,用於識別要變更的版面。ID 的字元限制為 64 個字元,格式應為 適用於擴充 Google Workspace Studio 的 Google Workspace 外掛程式。不適用於 Google Chat 應用程式。 |
collapseControl |
(選用步驟) 定義區段的展開和收合按鈕。只有在該部分可收合時,才會顯示這個按鈕。如未設定這個欄位,系統會使用預設按鈕。 |
小工具
每張資訊卡都由小工具組成。
小工具是複合式物件,可代表文字、圖片、按鈕和其他物件類型。
| JSON 表示法 |
|---|
{ "horizontalAlignment": enum ( |
| 欄位 | |
|---|---|
horizontalAlignment |
指定小工具要靠左、靠右或置中對齊。 |
id |
指派給小工具的專屬 ID,用於識別要變更的小工具。ID 的字元限制為 64 個字元,格式應為 適用於擴充 Google Workspace Studio 的 Google Workspace 外掛程式。不適用於 Google Chat 應用程式。 |
visibility |
指定小工具是否顯示。預設值為 適用於擴充 Google Workspace Studio 的 Google Workspace 外掛程式。不適用於 Google Chat 應用程式。 |
eventActions[] |
指定可在小工具上執行的事件動作。 適用於擴充 Google Workspace Studio 的 Google Workspace 外掛程式。不適用於 Google Chat 應用程式。 |
| 小工具只能包含下列其中一項。你可以使用多個小工具欄位顯示更多項目。以下是互斥欄位清單。回應中最多會設定下列其中一個欄位: | |
textParagraph |
顯示文字段落。支援簡單的 HTML 格式文字。如要進一步瞭解如何設定文字格式,請參閱「在 Google Chat 應用程式中設定文字格式」和「在 Google Workspace 外掛程式中設定文字格式」。 舉例來說,下列 JSON 會建立粗體文字: |
image |
顯示圖片。 舉例來說,下列 JSON 會建立含有替代文字的圖片: |
decoratedText |
顯示裝飾文字項目。 舉例來說,下列 JSON 會建立顯示電子郵件地址的修飾文字小工具: |
buttonList |
按鈕清單。 舉例來說,下列 JSON 會建立兩個按鈕。第一個是藍色文字按鈕,第二個是可開啟連結的圖片按鈕: |
textInput |
顯示可供使用者輸入內容的文字方塊。 舉例來說,下列 JSON 會建立電子郵件地址的文字輸入: 再舉一個例子,下列 JSON 會為程式設計語言建立文字輸入,並提供靜態建議: |
selectionInput |
顯示選取控制項,讓使用者選取項目。選取控制項可以是核取方塊、圓形按鈕、切換按鈕或下拉式選單。 舉例來說,下列 JSON 會建立下拉式選單,讓使用者選擇大小: |
dateTimePicker |
顯示小工具,讓使用者輸入日期、時間或日期和時間。 舉例來說,下列 JSON 會建立日期時間挑選器,用於預約: |
divider |
在小工具之間顯示水平分隔線。 舉例來說,下列 JSON 會建立分隔線: |
grid |
顯示含有項目集合的格線。 格線支援任意數量的欄和項目。列數取決於項目數量上限除以欄數。有 10 個項目和 2 欄的格線會有 5 列。有 11 個項目和 2 欄的格線會有 6 列。
舉例來說,下列 JSON 會建立含有單一項目的 2 欄格線: |
columns |
最多顯示 2 欄。 如要加入 2 個以上的資料欄,或使用資料列,請使用 舉例來說,下列 JSON 會建立 2 個資料欄,每個資料欄都包含文字段落: |
carousel |
包含 |
chipList |
方塊清單。 舉例來說,下列 JSON 會建立兩個方塊。第一個是文字方塊,第二個是開啟連結的圖示方塊: |
| 互斥欄位結束。 | |
TextParagraph
支援格式設定的文字段落。如需 Google Chat 應用程式的範例,請參閱「新增一段格式化文字」。如要進一步瞭解如何設定文字格式,請參閱「在 Google Chat 應用程式中設定文字格式」和「在 Google Workspace 外掛程式中設定文字格式」。
適用於 Google Chat 擴充應用程式和 Google Workspace 外掛程式。
| JSON 表示法 |
|---|
{
"text": string,
"maxLines": integer,
"textSyntax": enum ( |
| 欄位 | |
|---|---|
text |
小工具中顯示的文字。 |
maxLines |
小工具中顯示的文字行數上限。如果文字超過指定的行數上限,多出的內容會隱藏在「顯示更多」按鈕後方。如果文字長度等於或短於指定的行數上限,系統就不會顯示「顯示更多」按鈕。 預設值為 0,表示會顯示所有內容。系統會忽略負值。 |
textSyntax |
文字的語法。如未設定,文字會以 HTML 格式顯示。
|
TextSyntax
設定文字格式的語法。
適用於 Google Chat 擴充應用程式,不適用於 Google Workspace 外掛程式。
| 列舉 | |
|---|---|
TEXT_SYNTAX_UNSPECIFIED |
如未指定,文字會轉譯為 HTML。 |
HTML |
文字會轉譯為 HTML。這是預設值。 |
MARKDOWN |
文字會以 Markdown 格式顯示。 |
圖片
由網址指定的圖片,可包含 onClick 動作。如需範例,請參閱「新增圖片」。
適用於 Google Chat 擴充應用程式和 Google Workspace 外掛程式。
| JSON 表示法 |
|---|
{
"imageUrl": string,
"onClick": {
object ( |
| 欄位 | |
|---|---|
imageUrl |
含有圖片的 HTTPS 網址。 例如: |
onClick |
使用者點按圖片時,點擊動作會觸發這項動作。 |
altText |
這張圖片的替代文字,用於無障礙功能。 |
DecoratedText
這個小工具會顯示文字,並可選擇加上裝飾,例如在文字上方或下方加上標籤、在文字前方加上圖示、選取小工具,或在文字後方加上按鈕。如需 Google Chat 應用程式範例,請參閱「顯示文字和裝飾文字」。
適用於 Google Chat 擴充應用程式和 Google Workspace 外掛程式。
| JSON 表示法 |
|---|
{ "icon": { object ( |
| 欄位 | |
|---|---|
icon |
已淘汰,改用 |
startIcon |
顯示在文字前方的圖示。 |
startIconVerticalAlignment |
(選用步驟) 起始圖示的垂直對齊方式。如未設定,圖示會垂直置中。
|
topLabel |
顯示在 |
topLabelText |
|
text |
必填。主要文字。 支援簡單的格式設定。如要進一步瞭解如何設定文字格式,請參閱「在 Google Chat 應用程式中設定文字格式」和「在 Google Workspace 外掛程式中設定文字格式」。 |
contentText |
|
wrapText |
文字環繞設定。如果設為 僅適用於 |
bottomLabel |
顯示在 |
bottomLabelText |
|
onClick |
當使用者點選 |
顯示在 decoratedText 小工具中文字右側的按鈕、切換鈕、核取方塊或圖片。以下是互斥欄位清單。回應中最多會設定下列其中一個欄位: |
|
button |
使用者可點選按鈕來觸發動作。 |
switchControl |
使用者可以點選切換鈕小工具,變更其狀態並觸發動作。 |
endIcon |
文字後方顯示的圖示。 |
| 互斥欄位結束。 | |
VerticalAlignment
代表垂直對齊屬性。
| 列舉 | |
|---|---|
VERTICAL_ALIGNMENT_UNSPECIFIED |
未指定類型,請勿使用。 |
TOP |
靠上對齊。 |
MIDDLE |
對齊中間位置。 |
BOTTOM |
對齊底部位置。 |
SwitchControl
decoratedText 小工具中的切換式開關或核取方塊。
適用於 Google Chat 擴充應用程式和 Google Workspace 外掛程式。
僅支援 decoratedText 小工具。
| JSON 表示法 |
|---|
{ "name": string, "value": string, "selected": boolean, "onChangeAction": { object ( |
| 欄位 | |
|---|---|
name |
在表單輸入事件中,用來識別切換鈕小工具的名稱 (做為 如要進一步瞭解如何使用表單輸入內容,請參閱「接收表單資料」。 |
value |
選取切換鈕時, 如要進一步瞭解如何使用表單輸入內容,請參閱「接收表單資料」。 |
selected |
當 |
onChangeAction |
切換鈕狀態變更時要執行的動作,例如要執行的函式。 |
controlType |
切換鈕在使用者介面中的顯示方式。
|
ControlType
切換鈕在使用者介面中的顯示方式。
適用於 Google Chat 擴充應用程式和 Google Workspace 外掛程式。
| 列舉 | |
|---|---|
SWITCH |
切換式開關。 |
CHECKBOX |
已淘汰,改用 CHECK_BOX。 |
CHECK_BOX |
核取方塊。 |
TextInput
使用者可在這個欄位輸入文字。支援建議和變更時動作。支援表單提交驗證。如果 Action.all_widgets_are_required 設為 true,或 Action.required_widgets 指定了這個小工具,則必須輸入值才能提交。如需 Google Chat 應用程式範例,請參閱「新增可供使用者輸入文字的欄位」。
Chat 擴充應用程式會接收並處理表單輸入事件期間輸入的文字值。如要進一步瞭解如何使用表單輸入內容,請參閱「接收表單資料」。
如需向使用者收集未定義或抽象的資料,請使用文字輸入。如要向使用者收集已定義或列舉的資料,請使用 SelectionInput 小工具。
適用於 Google Chat 擴充應用程式和 Google Workspace 外掛程式。
| JSON 表示法 |
|---|
{ "name": string, "label": string, "hintText": string, "value": string, "type": enum ( |
| 欄位 | |
|---|---|
name |
在表單輸入事件中,用來識別文字輸入的名稱。 如要進一步瞭解如何使用表單輸入內容,請參閱「接收表單資料」。 |
label |
使用者介面中,文字輸入欄位上方顯示的文字。 指定文字,協助使用者輸入應用程式所需的資訊。舉例來說,如果您想詢問某人的姓名,但只需要對方的姓氏,請寫 如果未指定 |
hintText |
文字輸入欄位下方顯示的文字,用於提示使用者輸入特定值。這段文字會一直顯示。 如果未指定 |
value |
使用者輸入的值,會做為表單輸入事件的一部分傳回。 如要進一步瞭解如何使用表單輸入內容,請參閱「接收表單資料」。 |
type |
文字輸入欄位在使用者介面中的顯示方式。例如,欄位是單行或多行。 |
onChangeAction |
文字輸入欄位發生變更時要執行的動作。例如使用者在欄位中新增或刪除文字。 可執行的動作包括執行自訂函式,或在 Google Chat 中開啟對話方塊。 |
initialSuggestions |
使用者可輸入的建議值。當使用者點按文字輸入欄位時,就會看到這些值。使用者輸入內容時,系統會動態篩選建議值,找出符合輸入內容的值。 舉例來說,程式設計語言的文字輸入欄位可能會建議 Java、JavaScript、Python 和 C++。當使用者開始輸入 建議值可引導使用者輸入應用程式能理解的值。舉例來說,使用者可能會輸入 指定後,
|
autoCompleteAction |
(選用步驟) 指定文字輸入欄位向互動使用者提供建議時,應採取的動作。 如未指定,建議會由 如果指定,應用程式會執行此處指定的動作,例如執行自訂函式。
|
validation |
指定這個文字欄位所需的輸入格式驗證。
|
placeholderText |
文字輸入欄位空白時,欄位中顯示的文字。這段文字會提示使用者輸入值。例如
|
| 以下是互斥欄位清單。回應中最多會設定下列其中一個欄位: | |
hostAppDataSource |
Google Workspace 代管應用程式專屬的資料來源,例如 Gmail 電子郵件、Google 日曆活動或 Google Chat 即時通訊訊息。 適用於擴充 Google Workspace Studio 的 Google Workspace 外掛程式。不適用於 Google Chat 應用程式。 |
| 互斥欄位結束。 | |
類型
文字輸入欄位在使用者介面中的顯示方式。例如,是單行輸入欄位還是多行輸入欄位。如果指定 initialSuggestions,type 一律為 SINGLE_LINE,即使設為 MULTIPLE_LINE 也一樣。
適用於 Google Chat 擴充應用程式和 Google Workspace 外掛程式。
| 列舉 | |
|---|---|
SINGLE_LINE |
文字輸入欄位的高度固定為一行。 |
MULTIPLE_LINE |
文字輸入欄位的高度固定,可容納多行文字。 |
RenderActions
一組轉譯指令,可指示資訊卡執行動作,或指示外掛程式主機應用程式或 Chat 應用程式執行應用程式專屬動作。
適用於 Google Chat 擴充應用程式和 Google Workspace 外掛程式。
| 欄位 | |
|---|---|
action | |
動作
| 欄位 | |
|---|---|
navigations[] |
推送、彈出或更新資訊卡。 |
建議
使用者可輸入的建議值。當使用者點按文字輸入欄位時,就會看到這些值。使用者輸入內容時,系統會動態篩選建議值,找出符合輸入內容的值。
舉例來說,程式設計語言的文字輸入欄位可能會建議 Java、JavaScript、Python 和 C++。當使用者開始輸入 Jav 時,建議清單會篩選顯示 Java 和 JavaScript。
建議值可引導使用者輸入應用程式能理解的值。舉例來說,使用者可能會輸入 javascript 或 java script 來指稱 JavaScript。建議JavaScript可標準化使用者與應用程式互動的方式。
指定後,TextInput.type 一律為 SINGLE_LINE,即使設為 MULTIPLE_LINE 也一樣。
適用於 Google Chat 擴充應用程式和 Google Workspace 外掛程式。
| JSON 表示法 |
|---|
{
"items": [
{
object ( |
| 欄位 | |
|---|---|
items[] |
文字輸入欄位中,用於自動完成建議的建議清單。 |
SuggestionItem
使用者可在文字輸入欄位中輸入的建議值。
適用於 Google Chat 擴充應用程式和 Google Workspace 外掛程式。
| JSON 表示法 |
|---|
{ "text": string } |
| 欄位 | |
|---|---|
| 以下是互斥欄位清單。回應中最多會設定下列其中一個欄位: | |
text |
文字輸入欄位中建議輸入的值。這與使用者自行輸入的內容相同。 |
| 互斥欄位結束。 | |
驗證
代表驗證附加小工具所需的資料。
適用於 Google Chat 擴充應用程式和 Google Workspace 外掛程式。
| JSON 表示法 |
|---|
{
"characterLimit": integer,
"inputType": enum ( |
| 欄位 | |
|---|---|
characterLimit |
指定文字輸入小工具的字元限制。請注意,這項屬性僅適用於文字輸入,其他小工具會忽略這項屬性。
|
inputType |
指定輸入小工具的類型。
|
InputType
輸入小工具的類型。
| 列舉 | |
|---|---|
INPUT_TYPE_UNSPECIFIED |
未指定類型,請勿使用。 |
TEXT |
可接受所有字元的一般文字。 |
INTEGER |
整數值。 |
FLOAT |
浮點值。 |
EMAIL |
電子郵件地址。 |
EMOJI_PICKER |
從系統提供的表情符號挑選器中選取的表情符號。 |
HostAppDataSourceMarkup
Google Workspace 應用程式的資料來源。資料來源會填入小工具的可用項目。
| JSON 表示法 |
|---|
{ "chatDataSource": { object ( |
| 欄位 | |
|---|---|
| 這個 Google Workspace 應用程式會填入小工具的可用項目。以下是互斥欄位清單。回應中最多會設定下列其中一個欄位: | |
chatDataSource |
Google Chat 的資料來源。 |
workflowDataSource |
Google Workflow 的資料來源。 |
| 互斥欄位結束。 | |
ChatClientDataSourceMarkup
如果是使用多選選單的 小工具,則資料來源為 Google Chat。資料來源會填入多選選單的選項。例如,使用者可以選取自己加入的 Google Chat 聊天室。SelectionInput
適用於 Google Chat 擴充應用程式,不適用於 Google Workspace 外掛程式。
| JSON 表示法 |
|---|
{
"spaceDataSource": {
object ( |
| 欄位 | |
|---|---|
| Google Chat 資料來源。以下是互斥欄位清單。回應中最多會設定下列其中一個欄位: | |
spaceDataSource |
使用者加入的 Google Chat 聊天室。 |
| 互斥欄位結束。 | |
SpaceDataSource
這個資料來源會將 Google Chat 聊天室填入多選選單,做為選項。只會填入使用者所屬的聊天室。
適用於 Google Chat 擴充應用程式,不適用於 Google Workspace 外掛程式。
| JSON 表示法 |
|---|
{ "defaultToCurrentSpace": boolean } |
| 欄位 | |
|---|---|
defaultToCurrentSpace |
如果設為 |
WorkflowDataSourceMarkup
* 僅支援 Google Workspace Workflow,不支援 Google Chat 應用程式或 Google Workspace 外掛程式。
[SELECT_VIEWER_GENDER][FEMALE]在 MULTI_SELECT 類型的 或 TextInput 小工具或 SelectionInput 中,提供 Google 的資料來源。[MALE]在 MULTI_SELECT 類型的 DateTimePicker 或 TextInput 小工具或 SelectionInput 中,提供 Google 的資料來源。[OTHER]在 MULTI_SELECT 類型的 DateTimePicker 或 TextInput 小工具或 SelectionInput 中,提供 Google 的資料來源。[END_SELECT]DateTimePicker
| JSON 表示法 |
|---|
{
"includeVariables": boolean,
"type": enum ( |
| 欄位 | |
|---|---|
includeVariables |
是否要在資料來源中加入上一個步驟的變數。 |
type |
資料來源類型。 |
類型
代表工作流程資料來源類型的列舉。
| 列舉 | |
|---|---|
UNKNOWN |
預設值。請勿使用。 |
USER |
Google Workspace 使用者。使用者只能查看及選取 Google Workspace 組織中的使用者。 |
SPACE |
使用者加入的 Google Chat 聊天室。 |
USER_WITH_FREE_FORM |
使用者可以選擇查看及選取 Google Workspace 機構中的現有成員,也可以手動輸入電子郵件地址或有效網域。 |
SelectionInput
這個小工具可建立一或多個使用者可選取的 UI 項目。僅支援 dropdown 和 multiselect 選單的表單提交驗證。如果 Action.all_widgets_are_required 設為 true,或在 Action.required_widgets 中指定這個小工具,則必須選取值,否則無法提交。例如下拉式選單或核取方塊。您可以使用這個小工具收集可預測或列舉的資料。如需 Google Chat 應用程式範例,請參閱「新增可選取的 UI 元素」。
Chat 擴充應用程式可以處理使用者選取或輸入的項目值。如要進一步瞭解如何使用表單輸入內容,請參閱「接收表單資料」。
如要向使用者收集未定義或抽象的資料,請使用 TextInput 小工具。
適用於 Google Chat 擴充應用程式和 Google Workspace 外掛程式。
| JSON 表示法 |
|---|
{ "name": string, "label": string, "type": enum ( |
| 欄位 | |
|---|---|
name |
必填。表單輸入事件中,用來識別選項輸入內容的名稱。 如要進一步瞭解如何使用表單輸入內容,請參閱「接收表單資料」。 |
label |
使用者介面中顯示在選項輸入欄位上方的文字。 指定文字,協助使用者輸入應用程式所需的資訊。舉例來說,如果使用者要從下拉式選單中選取工作單的緊急程度,標籤可能是「緊急程度」或「選取緊急程度」。 |
type |
在 |
items[] |
可選項目陣列。例如一組圓形按鈕或核取方塊。最多支援 100 個項目。 |
onChangeAction |
如果指定這個屬性,系統會在選取項目變更時提交表單。如未指定,則必須指定另一個按鈕來提交表單。 如要進一步瞭解如何使用表單輸入內容,請參閱「接收表單資料」。 |
multiSelectMinQueryLength |
如果是多選選單,則是指使用者輸入的文字字元數,達到這個數量後,選單才會傳回建議的選項。 如未設定,複選選單會使用下列預設值:
|
dataSourceConfigs[] |
(選用步驟) 選取控制項的資料來源設定。這個欄位可讓您更精細地控管資料來源。 如果指定,系統會忽略 適用於擴充 Google Workspace Studio 的 Google Workspace 外掛程式。 適用於 Google Chat 應用程式中的 |
multiSelectMaxSelectedItems |
如果是複選選單,則為使用者可選取的項目數量上限。值不得小於 1 個項目。如未指定,預設值為 3 個項目。 |
hintText |
(選用步驟) 顯示在選項輸入欄位下方的文字,用於提示使用者輸入特定值。這段文字會一直顯示。 適用於擴充 Google Workspace Studio 的 Google Workspace 外掛程式。不適用於 Google Chat 應用程式。 |
如果是多選選單,則為動態填入選項項目的資料來源。
|
|
externalDataSource |
外部資料來源,例如關聯式資料庫。 |
platformDataSource |
Google Workspace 的資料來源。 |
| 互斥欄位結束。 | |
SelectionType
使用者可選取項目的格式。不同選項支援不同類型的互動。舉例來說,使用者可以選取多個核取方塊,但只能從下拉式選單中選取一個項目。
每個選項輸入項都支援一種選項類型。舉例來說,不支援混合使用核取方塊和切換鈕。
適用於 Google Chat 擴充應用程式和 Google Workspace 外掛程式。
| 列舉 | |
|---|---|
CHECK_BOX |
一組核取方塊。使用者可以選取一或多個核取方塊。 |
RADIO_BUTTON |
一組圓形按鈕。使用者可以選取一個圓形按鈕。 |
SWITCH |
一組切換裝置。使用者可以開啟一或多個切換按鈕。 |
DROPDOWN |
下拉式選單。使用者可以從選單中選取一個項目。 如果是 Google Chat 應用程式,您可以使用動態資料來源填入項目,並在使用者輸入選單時自動建議項目。舉例來說,使用者開始輸入 Google Chat 聊天室名稱時,小工具會自動建議聊天室。如要動態填入下拉式選單的項目,請使用下列其中一種資料來源:
如需 Chat 擴充應用程式下拉式選單的實作範例,請參閱「新增下拉式選單」和「動態填入下拉式選單」。
|
MULTI_SELECT |
含有文字方塊的選單。使用者可以輸入並選取一或多個項目。如果是 Google Workspace 外掛程式,您必須使用 如果是 Google Chat 應用程式,您也可以使用動態資料來源填入項目,並在使用者輸入選單時自動建議項目。舉例來說,使用者開始輸入 Google Chat 聊天室名稱時,小工具會自動建議聊天室。如要為複選選單動態填入項目,請使用下列其中一種資料來源:
如需 Chat 擴充應用程式實作多選選單的範例,請參閱「新增多選選單」。
|
PlatformDataSource
如果是使用複選選單的 小工具,則資料來源來自 Google Workspace。用於填入多選選單中的項目。SelectionInput
適用於 Google Chat 擴充應用程式,不適用於 Google Workspace 外掛程式。
| JSON 表示法 |
|---|
{ "commonDataSource": enum ( |
| 欄位 | |
|---|---|
| 資料來源。以下是互斥欄位清單。回應中最多會設定下列其中一個欄位: | |
commonDataSource |
所有 Google Workspace 應用程式共用的資料來源,例如 Google Workspace 組織中的使用者。 |
hostAppDataSource |
Google Workspace 代管應用程式專屬的資料來源,例如 Google Chat 中的聊天室。 這個欄位支援 Google API 用戶端程式庫,但不適用於 Cloud 用戶端程式庫。詳情請參閱「安裝用戶端程式庫」。 |
| 互斥欄位結束。 | |
CommonDataSource
所有 Google Workspace 應用程式共用的資料來源。
適用於 Google Chat 應用程式,不適用於 Google Workspace 外掛程式。
| 列舉 | |
|---|---|
UNKNOWN |
預設值。請勿使用。 |
USER |
Google Workspace 使用者。使用者只能查看及選取 Google Workspace 組織中的使用者。 |
DataSourceConfig
設定物件,用於設定小工具的資料來源。
適用於 Google Chat 擴充應用程式,以及擴充 Google Workspace Studio 的 Google Workspace 外掛程式。
| JSON 表示法 |
|---|
{ "remoteDataSource": { object ( |
| 欄位 | |
|---|---|
| 資料來源。以下是互斥欄位清單。回應中最多會設定下列其中一個欄位: | |
remoteDataSource |
資料來自遠端資料供應商。 |
platformDataSource |
資料來自 Google Workspace 應用程式。 |
| 互斥欄位結束。 | |
minCharactersTrigger |
使用者必須輸入的字元數下限,達到這個下限後,系統才會觸發這個資料提供者 (也就是開始傳回結果)。 |
DateTimePicker
可讓使用者輸入日期、時間或兩者。支援表單提交驗證。如果 Action.all_widgets_are_required 設為 true,或在 Action.required_widgets 中指定這個小工具,則必須選取值,否則無法提交。如需 Google Chat 應用程式的範例,請參閱「讓使用者選擇日期和時間」。
使用者可以輸入文字,或使用挑選器選取日期和時間。如果使用者輸入無效的日期或時間,挑選器會顯示錯誤訊息,提示使用者正確輸入資訊。
適用於 Google Chat 擴充應用程式和 Google Workspace 外掛程式。
| JSON 表示法 |
|---|
{ "name": string, "label": string, "type": enum ( |
| 欄位 | |
|---|---|
name |
在表單輸入事件中,用來識別 如要進一步瞭解如何使用表單輸入內容,請參閱「接收表單資料」。 |
label |
提示使用者輸入日期、時間或日期和時間的文字。舉例來說,如果使用者正在預約,請使用 |
type |
小工具是否支援輸入日期、時間或日期和時間。 |
valueMsEpoch |
小工具中顯示的預設值,以 Unix 紀元時間起算的毫秒數為單位。 根據挑選器類型 (
|
timezoneOffsetDate |
代表時區與世界標準時間差距的數字,以分鐘為單位。如果設定, 注意:這個欄位以分鐘為單位,而使用者互動事件酬載通常會以毫秒為單位提供時區偏移量 (除以 |
onChangeAction |
使用者在 |
| 指定用來代表日期和時間的資料來源。以下是互斥欄位清單。回應中最多會設定下列其中一個欄位: | |
hostAppDataSource |
Google Workspace 代管應用程式專屬的資料來源,例如 Gmail 電子郵件、Google 日曆活動或 Google Chat 即時通訊訊息。 適用於擴充 Google Workspace Studio 的 Google Workspace 外掛程式。不適用於 Google Chat 應用程式。 |
| 互斥欄位結束。 | |
DateTimePickerType
DateTimePicker 小工具中的日期和時間格式。決定使用者能否輸入日期、時間,或同時輸入日期和時間。
適用於 Google Chat 擴充應用程式和 Google Workspace 外掛程式。
| 列舉 | |
|---|---|
DATE_AND_TIME |
使用者輸入日期和時間。 |
DATE_ONLY |
使用者輸入日期。 |
TIME_ONLY |
使用者輸入時間。 |
分隔線
這個類型沒有任何欄位。
以水平線顯示小工具之間的分隔線。如需 Google Chat 應用程式的範例,請參閱「在小工具之間新增水平分隔線」。
適用於 Google Chat 擴充應用程式和 Google Workspace 外掛程式。
舉例來說,下列 JSON 會建立分隔線:
"divider": {}
格線
顯示含有項目集合的格線。項目只能包含文字或圖片。如要使用回應式資料欄,或加入文字或圖片以外的內容,請使用 。如需 Google Chat 應用程式範例,請參閱「顯示含有項目集合的格線」。Columns
格線支援任意數量的欄和項目。列數取決於項目數除以欄數。有 10 個項目和 2 欄的格線會有 5 列。有 11 個項目和 2 欄的格線會有 6 列。
適用於 Google Chat 擴充應用程式和 Google Workspace 外掛程式。
舉例來說,下列 JSON 會建立含有單一項目的 2 欄格線:
"grid": {
"title": "A fine collection of items",
"columnCount": 2,
"borderStyle": {
"type": "STROKE",
"cornerRadius": 4
},
"items": [
{
"image": {
"imageUri": "https://www.example.com/image.png",
"cropStyle": {
"type": "SQUARE"
},
"borderStyle": {
"type": "STROKE"
}
},
"title": "An item",
"textAlignment": "CENTER"
}
],
"onClick": {
"openLink": {
"url": "https://www.example.com"
}
}
}
| JSON 表示法 |
|---|
{ "title": string, "items": [ { object ( |
| 欄位 | |
|---|---|
title |
格線標頭中顯示的文字。 |
items[] |
要在格狀檢視中顯示的項目。 |
borderStyle |
要套用至每個格線項目的框線樣式。 |
columnCount |
格狀檢視畫面中顯示的資料欄數量。如未指定這個欄位,系統會使用預設值,而預設值會因格線顯示位置 (對話方塊或隨播廣告) 而異。 |
onClick |
每個格線項目都會重複使用這個回呼,但會將項目的 ID 新增至回呼的參數 (位於 |
GridItem
代表格狀版面配置中的項目。項目可以包含文字、圖片,或同時包含文字和圖片。
適用於 Google Chat 擴充應用程式和 Google Workspace 外掛程式。
| JSON 表示法 |
|---|
{ "id": string, "image": { object ( |
| 欄位 | |
|---|---|
id |
使用者為這個格狀項目指定的 ID。這個 ID 會在父項格線的 |
image |
格狀項目中顯示的圖片。 |
title |
格線項目的標題。 |
subtitle |
格線項目的副標題。 |
layout |
格線項目要使用的版面配置。 |
ImageComponent
代表圖片。
適用於 Google Chat 擴充應用程式和 Google Workspace 外掛程式。
| JSON 表示法 |
|---|
{ "imageUri": string, "altText": string, "cropStyle": { object ( |
| 欄位 | |
|---|---|
imageUri |
圖片網址。 |
altText |
圖片的無障礙標籤。 |
cropStyle |
要套用至圖片的裁剪樣式。 |
borderStyle |
要套用至圖片的邊框樣式。 |
ImageCropStyle
代表套用至圖片的裁剪樣式。
適用於 Google Chat 擴充應用程式和 Google Workspace 外掛程式。
舉例來說,以下程式碼會套用 16:9 的顯示比例:
cropStyle {
"type": "RECTANGLE_CUSTOM",
"aspectRatio": 16/9
}
| JSON 表示法 |
|---|
{
"type": enum ( |
| 欄位 | |
|---|---|
type |
作物類型。 |
aspectRatio |
裁剪類型為 舉例來說,以下程式碼會套用 16:9 的顯示比例: |
ImageCropType
代表套用至圖片的裁剪樣式。
適用於 Google Chat 擴充應用程式和 Google Workspace 外掛程式。
| 列舉 | |
|---|---|
IMAGE_CROP_TYPE_UNSPECIFIED |
請勿使用。未指明 |
SQUARE |
預設值。套用正方形裁剪。 |
CIRCLE |
套用圓形裁剪。 |
RECTANGLE_CUSTOM |
以自訂顯示比例裁剪矩形。使用 aspectRatio 設定自訂顯示比例。 |
RECTANGLE_4_3 |
以 4:3 顯示比例裁剪為矩形。 |
BorderStyle
卡片或小工具框線的樣式選項,包括框線類型和顏色。
適用於 Google Chat 擴充應用程式和 Google Workspace 外掛程式。
| JSON 表示法 |
|---|
{ "type": enum ( |
| 欄位 | |
|---|---|
type |
框線類型。 |
strokeColor |
類型為 如要設定筆劃顏色,請為 舉例來說,下列程式碼會將顏色設為紅色,並將強度設為最大值:
|
cornerRadius |
邊框的圓角半徑。 |
BorderType
代表套用至小工具的邊框類型。
適用於 Google Chat 擴充應用程式和 Google Workspace 外掛程式。
| 列舉 | |
|---|---|
BORDER_TYPE_UNSPECIFIED |
請勿使用。未指明 |
NO_BORDER |
無框線。 |
STROKE |
預設值。Outline。 |
GridItemLayout
代表格狀項目可用的各種版面配置選項。
適用於 Google Chat 擴充應用程式和 Google Workspace 外掛程式。
| 列舉 | |
|---|---|
GRID_ITEM_LAYOUT_UNSPECIFIED |
請勿使用。未指明 |
TEXT_BELOW |
標題和副標題會顯示在格狀項目圖片下方。 |
TEXT_ABOVE |
標題和副標題會顯示在格狀項目的圖片上方。 |
欄
Columns 小工具最多可在資訊卡或對話方塊中顯示 2 欄。您可以在每個資料欄中新增小工具,小工具會按照指定的順序顯示。如需 Google Chat 應用程式的範例,請參閱「在資料欄中顯示資訊卡和對話方塊」。
每個資料欄的高度取決於較高的資料欄。舉例來說,如果第一欄高於第二欄,則兩欄的高度都會是第一欄的高度。由於每個資料欄可包含不同數量的小工具,因此您無法定義資料列,也無法對齊各欄之間的小工具。
資料欄會並排顯示。您可以使用 HorizontalSizeStyle 欄位自訂各欄寬度。如果使用者的螢幕寬度太窄,第二欄會換行到第一欄下方:
- 在網頁上,如果螢幕寬度小於或等於 480 像素,第二欄會換行。
- 在 iOS 裝置上,如果螢幕寬度小於或等於 300 pt,第二欄會換行。
- 在 Android 裝置上,如果螢幕寬度小於或等於 320 dp,第二欄會換行。
如要加入兩個以上的資料欄,或使用資料列,請使用 小工具。Grid
適用於 Google Chat 擴充應用程式和 Google Workspace 外掛程式。支援資料欄的外掛程式 UI 包括:
- 使用者從電子郵件草稿開啟外掛程式時,系統會顯示這個對話方塊。
- 使用者從 Google 日曆活動的「新增附件」選單開啟外掛程式時,系統會顯示這個對話方塊。
| JSON 表示法 |
|---|
{
"columnItems": [
{
object ( |
| 欄位 | |
|---|---|
columnItems[] |
資料欄陣列。資訊卡或對話方塊最多可包含 2 欄。 |
欄
資料欄。
| JSON 表示法 |
|---|
{ "horizontalSizeStyle": enum ( |
| 欄位 | |
|---|---|
horizontalSizeStyle |
指定資料欄填滿資訊卡寬度的方式。 |
horizontalAlignment |
指定小工具要靠左、靠右或置中對齊。 |
verticalAlignment |
指定小工具要靠上、靠下或置中對齊資料欄。 |
widgets[] |
資料欄中的小工具陣列。小工具會按照指定順序顯示。 |
HorizontalSizeStyle
指定資料欄填滿資訊卡寬度的方式。每欄的寬度取決於 HorizontalSizeStyle 和欄內小工具的寬度。
| 列舉 | |
|---|---|
HORIZONTAL_SIZE_STYLE_UNSPECIFIED |
請勿使用。未指明 |
FILL_AVAILABLE_SPACE |
預設值。欄會填滿可用空間,最多可達資訊卡寬度的 70%。如果兩個資料欄都設為 FILL_AVAILABLE_SPACE,則每個資料欄會填滿 50% 的空間。 |
FILL_MINIMUM_SPACE |
資料欄會盡可能填滿最少空間,且不超過資訊卡寬度的 30%。 |
HorizontalAlignment
指定小工具要靠左、靠右或置中對齊。
適用於 Google Chat 擴充應用程式,不適用於 Google Workspace 外掛程式。
| 列舉 | |
|---|---|
HORIZONTAL_ALIGNMENT_UNSPECIFIED |
請勿使用。未指明 |
START |
預設值。將小工具對齊資料欄的起始位置。如果是從左到右的版面配置,則會靠左對齊。如果是由右至左的版面配置,則會靠右對齊。 |
CENTER |
將小工具置中對齊資料欄。 |
END |
將小工具對齊資料欄的結尾位置。如果是從左到右的版面配置,則會將小工具靠右對齊。如果是由右至左的版面配置,則會將小工具靠左對齊。 |
VerticalAlignment
指定小工具要靠上、靠下或置中對齊資料欄。
| 列舉 | |
|---|---|
VERTICAL_ALIGNMENT_UNSPECIFIED |
請勿使用。未指明 |
CENTER |
預設值。將小工具置中對齊資料欄。 |
TOP |
將小工具對齊資料欄頂端。 |
BOTTOM |
將小工具對齊資料欄底部。 |
小工具
可加入資料欄的支援小工具。
| JSON 表示法 |
|---|
{ "textParagraph": { object ( |
| 欄位 | |
|---|---|
| 以下是互斥欄位清單。回應中最多會設定下列其中一個欄位: | |
textParagraph |
|
image |
|
decoratedText |
|
buttonList |
|
textInput |
|
selectionInput |
|
dateTimePicker |
|
chipList |
|
| 互斥欄位結束。 | |
ChipList
水平排列的方塊清單,可水平捲動或換行。
適用於 Google Chat 擴充應用程式和 Google Workspace 外掛程式。
| JSON 表示法 |
|---|
{ "layout": enum ( |
| 欄位 | |
|---|---|
layout |
指定的方塊清單版面配置。 |
chips[] |
晶片陣列。 |
版面配置
方塊清單版面配置。
| 列舉 | |
|---|---|
LAYOUT_UNSPECIFIED |
請勿使用。未指明 |
WRAPPED |
預設值。如果水平空間不足,方塊清單會換行。 |
HORIZONTAL_SCROLLABLE |
如果可用空間不足,方塊會水平捲動。 |
方塊
使用者可點選的文字、圖示或文字和圖示方塊。
適用於 Google Chat 擴充應用程式和 Google Workspace 外掛程式。
| JSON 表示法 |
|---|
{ "icon": { object ( |
| 欄位 | |
|---|---|
icon |
圖示圖片。如果同時設定 |
label |
方塊內顯示的文字。 |
onClick |
(選用步驟) 使用者點選方塊時要執行的動作,例如開啟超連結或執行自訂函式。 |
enabled |
已淘汰:請改用 方塊是否處於啟用狀態,並會回應使用者動作。 |
disabled |
方塊是否處於停用狀態,並忽略使用者動作。預設值為 |
altText |
用於無障礙功能的替代文字。 設定說明文字,讓使用者瞭解方塊的功能。舉例來說,如果方塊會開啟超連結,請寫入:「開啟新的瀏覽器分頁,並前往 Google Chat 開發人員說明文件,網址為 https://developers.google.com/workspace/chat"」。 |
輪轉介面
以投影片格式輪流顯示輪轉式資訊卡清單,並提供按鈕,可前往上一張或下一張資訊卡。
舉例來說,以下是包含三個文字段落小工具的輪轉介面 JSON 表示法。
{
"carouselCards": [
{
"widgets": [
{
"textParagraph": {
"text": "First text paragraph in carousel"
}
}
]
},
{
"widgets": [
{
"textParagraph": {
"text": "Second text paragraph in carousel"
}
}
]
},
{
"widgets": [
{
"textParagraph": {
"text": "Third text paragraph in carousel"
}
}
]
}
]
}
適用於 Google Chat 擴充應用程式,不適用於 Google Workspace 外掛程式。
| JSON 表示法 |
|---|
{
"carouselCards": [
{
object ( |
| 欄位 | |
|---|---|
carouselCards[] |
輪轉介面中的資訊卡清單。 |
CarouselCard
可顯示為輪轉介面項目的資訊卡。 適用於 Google Chat 應用程式,不適用於 Google Workspace 外掛程式。
| JSON 表示法 |
|---|
{ "widgets": [ { object ( |
| 欄位 | |
|---|---|
widgets[] |
輪轉介面資訊卡中顯示的小工具清單。小工具會按照指定順序顯示。 |
footerWidgets[] |
輪轉介面資訊卡底部顯示的小工具清單。小工具會按照指定順序顯示。 |
NestedWidget
可在包含版面配置 (例如 CarouselCard) 中顯示的小工具清單。 適用於 Google Chat 應用程式,不適用於 Google Workspace 外掛程式。
| JSON 表示法 |
|---|
{ "textParagraph": { object ( |
| 欄位 | |
|---|---|
| 以下是互斥欄位清單。回應中最多會設定下列其中一個欄位: | |
textParagraph |
文字段落小工具。 |
buttonList |
按鈕清單小工具。 |
image |
圖片小工具。 |
| 互斥欄位結束。 | |
瀏覽權限
指定 UI 元素是否顯示。
適用於擴充 Google Workspace Studio 的 Google Workspace 外掛程式。不適用於 Google Chat 應用程式。
| 列舉 | |
|---|---|
VISIBILITY_UNSPECIFIED |
未指定顯示設定。請勿使用。 |
VISIBLE |
UI 元素會顯示。 |
HIDDEN |
隱藏 UI 元素。 |
EventAction
代表可對 UI 元素執行的動作。
適用於擴充 Google Workspace Studio 的 Google Workspace 外掛程式。不適用於 Google Chat 應用程式。
| JSON 表示法 |
|---|
{ "actionRuleId": string, "postEventTriggers": [ { object ( |
| 欄位 | |
|---|---|
actionRuleId |
ActionRule 的專屬 ID。 |
postEventTriggers[] |
EventAction 執行後會觸發的觸發條件清單。 |
| 要執行的動作。以下是互斥欄位清單。回應中最多會設定下列其中一個欄位: | |
commonWidgetAction |
常見的小工具動作。 |
| 互斥欄位結束。 | |
觸發條件
代表觸發條件。
適用於擴充 Google Workspace Studio 的 Google Workspace 外掛程式。不適用於 Google Chat 應用程式。
| JSON 表示法 |
|---|
{ "actionRuleId": string } |
| 欄位 | |
|---|---|
actionRuleId |
ActionRule 的專屬 ID。 |
CommonWidgetAction
代表不限於特定小工具的操作。
適用於擴充 Google Workspace Studio 的 Google Workspace 外掛程式。不適用於 Google Chat 應用程式。
| JSON 表示法 |
|---|
{
"updateVisibilityAction": {
object ( |
| 欄位 | |
|---|---|
| 要執行的動作。以下是互斥欄位清單。回應中最多會設定下列其中一個欄位: | |
updateVisibilityAction |
更新小工具顯示設定的操作。 |
| 互斥欄位結束。 | |
UpdateVisibilityAction
代表更新小工具顯示設定的動作。
適用於擴充 Google Workspace Studio 的 Google Workspace 外掛程式。不適用於 Google Chat 應用程式。
| JSON 表示法 |
|---|
{
"visibility": enum ( |
| 欄位 | |
|---|---|
visibility |
新的瀏覽權限。 |
CollapseControl
代表展開和收合控制項。
適用於 Google Chat 擴充應用程式和 Google Workspace 外掛程式。
| JSON 表示法 |
|---|
{ "horizontalAlignment": enum ( |
| 欄位 | |
|---|---|
horizontalAlignment |
展開和收合按鈕的水平對齊方式。 |
expandButton |
(選用步驟) 定義自訂按鈕,展開這個部分。必須同時設定 expandButton 和 collapseButton 欄位。只有一個欄位集不會生效。如未設定這個欄位,系統會使用預設按鈕。 |
collapseButton |
(選用步驟) 定義自訂按鈕,用於收合這個部分。必須同時設定 expandButton 和 collapseButton 欄位。只有一個欄位集不會生效。如未設定這個欄位,系統會使用預設按鈕。 |
DividerStyle
資訊卡的分隔線樣式。目前僅用於資訊卡區段之間的分隔線。
適用於 Google Chat 擴充應用程式和 Google Workspace 外掛程式。
| 列舉 | |
|---|---|
DIVIDER_STYLE_UNSPECIFIED |
請勿使用。未指明 |
SOLID_DIVIDER |
預設選項。顯示實線分隔線。 |
NO_DIVIDER |
如果設定,就不會顯示分隔線。這個樣式會從版面配置中完全移除分隔線。結果等同於完全不新增分隔線。 |
CardAction
資訊卡動作是指與資訊卡相關聯的動作。舉例來說,應付憑據資訊卡可能包含刪除應付憑據、透過電子郵件傳送應付憑據,或在瀏覽器中開啟應付憑據等動作。
適用於 Google Workspace 外掛程式,不適用於 Google Chat 應用程式。
| JSON 表示法 |
|---|
{
"actionLabel": string,
"onClick": {
object ( |
| 欄位 | |
|---|---|
actionLabel |
顯示為動作選單項目的標籤。 |
onClick |
這項待辦事項的 |
DisplayStyle
在 Google Workspace 外掛程式中,決定資訊卡的顯示方式。
適用於 Google Workspace 外掛程式,不適用於 Google Chat 應用程式。
| 列舉 | |
|---|---|
DISPLAY_STYLE_UNSPECIFIED |
請勿使用。未指明 |
PEEK |
資訊卡的標頭會顯示在側欄底部,部分覆蓋堆疊中目前的頂端資訊卡。點選標題,資訊卡就會彈出到資訊卡堆疊中。如果資訊卡沒有標題,系統會改用產生的標題。 |
REPLACE |
預設值。系統會取代卡牌堆疊中頂端卡牌的檢視畫面,顯示這張卡牌。 |
ExpressionData
代表用於評估運算式的資料。
適用於擴充 Google Workspace Studio 的 Google Workspace 外掛程式。不適用於 Google Chat 應用程式。
| JSON 表示法 |
|---|
{ "id": string, "expression": string, "conditions": [ { object ( |
| 欄位 | |
|---|---|
id |
ExpressionData 的專屬 ID。 |
expression |
未編譯的運算式。 |
conditions[] |
由運算式評估結果決定的條件清單。 |
eventActions[] |
可使用 ExpressionData 的動作清單。 |
條件
代表可用於觸發動作的條件。
適用於擴充 Google Workspace Studio 的 Google Workspace 外掛程式。不適用於 Google Chat 應用程式。
| JSON 表示法 |
|---|
{
"actionRuleId": string,
"expressionDataCondition": {
object ( |
| 欄位 | |
|---|---|
actionRuleId |
ActionRule 的專屬 ID。 |
| 條件。以下是互斥欄位清單。回應中最多會設定下列其中一個欄位: | |
expressionDataCondition |
由運算式資料決定的條件。 |
| 互斥欄位結束。 | |
ExpressionDataCondition
代表使用 CEL 評估的條件。
適用於擴充 Google Workspace Studio 的 Google Workspace 外掛程式。不適用於 Google Chat 應用程式。
| JSON 表示法 |
|---|
{
"conditionType": enum ( |
| 欄位 | |
|---|---|
conditionType |
條件類型。 |
ConditionType
條件類型。
| 列舉 | |
|---|---|
CONDITION_TYPE_UNSPECIFIED |
未指定條件類型。 |
EXPRESSION_EVALUATION_SUCCESS |
運算式評估成功。 |
EXPRESSION_EVALUATION_FAILURE |
運算式評估失敗。 |