Package google.apps.card.v1

string

當包含元素遭到點選或以其他方式啟用時，要叫用的自訂函式。

如需使用範例，請參閱「讀取表單資料」。

ActionParameter

動作參數清單。

LoadIndicator

指定在呼叫動作時，動作顯示的載入指標。

bool

指出表單值是否會在動作後保留。預設值為 false。

如果為 true，表單值會在觸發動作後保留。如要讓使用者在處理動作期間進行變更，請將 LoadIndicator 設為 NONE。如要使用 Chat 應用程式中的資訊卡訊息，您必須將動作的 ResponseType 設為 UPDATE_MESSAGE，並使用包含動作的資訊卡中的相同 card_id。

如果為 false，則在觸發動作時會清除表單值。如要避免使用者在處理動作期間進行變更，請將 LoadIndicator 設為 SPINNER。

Interaction

選用設定。開啟對話方塊時必須使用。

回應與使用者互動 (例如使用者按下資訊卡訊息中的按鈕) 時的動作。

如果未指定，應用程式會執行 action 來回應，例如開啟連結或執行函式。

指定 interaction 後，應用程式就能以特殊互動方式回應。舉例來說，將 interaction 設為 OPEN_DIALOG，應用程式就能開啟對話方塊。指定後，系統就不會顯示載入指標。如果指定為外掛程式，整張資訊卡都會遭到移除，用戶端不會顯示任何內容。

適用於 Google Chat 應用程式，但不適用於 Google Workspace 外掛程式。

string

選用設定。在這個清單中填入這個動作需要的有效提交小工具名稱。

如果在叫用此動作時，此處所列的資訊方塊沒有值，表單提交作業就會中止。

適用於 Google Chat 應用程式和 Google Workspace 外掛程式。

bool

選用設定。如果為 true，則系統會將所有小工具視為這項動作的必要條件。

適用於 Google Chat 應用程式和 Google Workspace 外掛程式。

string

動作指令碼的參數名稱。

string

參數的值。

BorderType

邊框類型。

Color

當類型為 BORDER_TYPE_STROKE 時使用的顏色。

如要設定筆劃顏色，請為 red、green 和 blue 欄位指定值。值必須是介於 0 和 1 之間的浮點數，並以 RGB 顏色值為依據，其中 0 (0/255) 代表沒有顏色，而 1 (255/255) 代表顏色的最大濃度。

例如，以下程式碼會將顏色設為最高強度的紅色：

"color": {
   "red": 1,
   "green": 0,
   "blue": 0,
}

alpha 欄位無法用於描邊顏色。如果指定此欄位，系統會忽略這個欄位。

int32

邊框的圓角半徑。

string

按鈕內顯示的文字。

Icon

按鈕中顯示的圖示。如果同時設定 icon 和 text，圖示會顯示在文字前方。

Color

選用設定。按鈕的顏色。如果已設為此值，按鈕 type 會設為 FILLED，而 text 和 icon 欄位的顏色會設為對比色，以利閱讀。舉例來說，如果按鈕顏色設為藍色，按鈕中的任何文字或圖示都會設為白色。

如要設定按鈕顏色，請為 red、green 和 blue 欄位指定值。值必須是介於 0 和 1 之間的浮點數，並以 RGB 顏色值為依據，其中 0 (0/255) 代表沒有顏色，而 1 (255/255) 代表顏色的最大濃度。

例如，以下程式碼會將顏色設為最高強度的紅色：

"color": {
   "red": 1,
   "green": 0,
   "blue": 0,
}

alpha 欄位無法用於按鈕顏色。如果指定此欄位，系統會忽略這個欄位。

OnClick

必要欄位。使用者按下按鈕時要執行的動作，例如開啟超連結或執行自訂函式。

bool

如果為 true，按鈕會顯示為非活動狀態，且不會回應使用者動作。

string

用於無障礙功能的替代文字。

設定說明文字，讓使用者瞭解按鈕的功能。舉例來說，如果按鈕會開啟超連結，您可以寫下「開啟新的瀏覽器分頁，並前往 Google Chat 開發人員說明文件 (網址為 https://developers.google.com/workspace/chat")」。

Type

選用設定。按鈕類型。如果未設定，按鈕類型預設為 OUTLINED。如果已設定 color 欄位，系統會強制將按鈕類型設為 FILLED，並忽略為此欄位設定的任何值。

Button

按鈕陣列。

CardHeader

資訊卡的標頭。標題通常包含開頭圖片和標題。標題一律會顯示在資訊卡頂端。

Section

包含一組小工具。每個部分都有可選的標頭。各個區段會以線條分隔，如需 Google Chat 應用程式的範例，請參閱「定義資訊卡的部分」。

DividerStyle

標題、區段和頁尾之間的分隔符號樣式。

CardAction

資訊卡的動作。動作會新增至資訊卡的工具列選單。

適用於 Google Workspace 外掛程式，但不適用於 Google Chat 應用程式。

舉例來說，下列 JSON 會使用 Settings 和 Send Feedback 選項建構資訊卡動作選單：

"cardActions": [
  {
    "actionLabel": "Settings",
    "onClick": {
      "action": {
        "functionName": "goToView",
        "parameters": [
          {
            "key": "viewType",
            "value": "SETTING"
         }
        ],
        "loadIndicator": "LoadIndicator.SPINNER"
      }
    }
  },
  {
    "actionLabel": "Send Feedback",
    "onClick": {
      "openLink": {
        "url": "https://example.com/feedback"
      }
    }
  }
]

string

資訊卡的名稱。用於資訊卡導覽中的資訊卡 ID。

適用於 Google Workspace 外掛程式，但不適用於 Google Chat 應用程式。

CardFixedFooter

固定在資訊卡底部的頁尾。

如果在設定 fixedFooter 時未指定 primaryButton 或 secondaryButton，系統會發生錯誤。對於 Chat 應用程式，您可以在對話方塊中使用固定頁尾，但無法在資訊卡訊息中使用。

適用於 Google Chat 應用程式和 Google Workspace 外掛程式。

DisplayStyle

在 Google Workspace 外掛程式中，設定 peekCardHeader 的顯示屬性。

適用於 Google Workspace 外掛程式，但不適用於 Google Chat 應用程式。

CardHeader

顯示內容相關內容時，Peek 資訊卡標題會做為預留位置，讓使用者可在首頁資訊卡和內容相關資訊卡之間前進瀏覽。

適用於 Google Workspace 外掛程式，但不適用於 Google Chat 應用程式。

string

顯示為動作選單項目的標籤。

OnClick

這個待辦事項的 onClick 動作。

Button

固定頁尾的主要按鈕。按鈕必須是文字按鈕，且已設定文字和顏色。

Button

固定頁尾的次要按鈕。按鈕必須是文字按鈕，且已設定文字和顏色。如果已設定 secondaryButton，則必須一併設定 primaryButton。

string

必要欄位。資訊卡標題。標頭的高度固定：如果同時指定標題和副標題，每個標題和副標題都會佔用一行。如果只指定標題，系統會將標題放在兩行。

string

資訊卡標題的副標題。如果指定，會顯示在 title 下方的獨立行中。

ImageType

用來裁剪圖片的形狀。

適用於 Google Chat 應用程式和 Google Workspace 外掛程式。

string

資訊卡標題中圖片的 HTTPS 網址。

string

這張圖片的替代文字，用於無障礙功能。

TextParagraph

文字段落小工具。

ButtonList

按鈕清單小工具。

Image

圖片小工具。

string

顯示在區段頂端的文字。支援簡單的 HTML 格式文字。如要進一步瞭解如何設定文字格式，請參閱「在 Google Chat 應用程式中設定文字格式」和「在 Google Workspace 外掛程式中設定文字格式」。

Widget

該區段中的所有小工具。至少須包含一個小工具。

bool

指出這個部分是否可收合。

可摺疊的版面可隱藏部分或所有小工具，但使用者只要按一下「顯示更多」，即可展開該版面，查看隱藏的小工具。使用者可以按一下「顯示較少」，再次隱藏小工具。

如要決定要隱藏哪些小工具，請指定 uncollapsibleWidgetsCount。

int32

即使在摺疊區段時，仍會顯示的不可摺疊小工具數量。

舉例來說，如果某個區段包含五個小工具，且 uncollapsibleWidgetsCount 設為 2，系統一律會顯示前兩個小工具，而最後三個小工具則會預設為收合。只有在 collapsible 為 true 時，系統才會考量 uncollapsibleWidgetsCount。

CollapseControl

選用設定。定義區段的展開和收合按鈕。只有當該部分可摺疊時，這個按鈕才會顯示。如果未設定這個欄位，系統會使用預設按鈕。

CarouselCard

輪轉介面中包含的資訊卡清單。

NestedWidget

輪轉介面資訊卡中顯示的小工具清單。小工具會依指定的順序顯示。

NestedWidget

輪轉介面資訊卡底部顯示的小工具清單。小工具會依指定的順序顯示。

Icon

圖示圖片。如果同時設定 icon 和 text，圖示會顯示在文字前方。

string

方塊內顯示的文字。

OnClick

選用設定。使用者點選方塊時要執行的動作，例如開啟超連結或執行自訂函式。

bool

方塊是否處於有效狀態，並回應使用者操作。預設為 true。已淘汰，改用 disabled。

bool

方塊是否處於停用狀態，並忽略使用者動作。預設值為 false。

string

用於無障礙功能的替代文字。

設定說明性文字，讓使用者瞭解晶片的功能。舉例來說，如果方塊會開啟超連結，請寫下「開啟新的瀏覽器分頁，並前往 Google Chat 開發人員說明文件 (網址為 https://developers.google.com/workspace/chat")」。

Layout

指定的方塊清單版面配置。

Chip

方塊陣列。

HorizontalAlignment

展開和收合按鈕的水平對齊方式。

Button

選用設定。定義可自訂的按鈕，用於展開該部分。必須同時設定 expandButton 和 collapseButton 欄位。只有一個欄位組合不會生效。如果未設定這個欄位，系統會使用預設按鈕。

Button

選用設定。定義可自訂的按鈕，用於收合該部分。必須同時設定 expandButton 和 collapseButton 欄位。只有一個欄位組合不會生效。如果未設定這個欄位，系統會使用預設按鈕。

Column

資料欄的陣列。資訊卡或對話方塊最多可包含 2 個欄。

HorizontalSizeStyle

指定資料欄填滿卡片寬度的做法。

HorizontalAlignment

指定小工具是否要對齊欄的左側、右側或置中。

VerticalAlignment

指定小工具是否要對齊資料欄的頂端、底部或中間。

Widgets

資料欄中包含的 Widget 陣列。小工具會依指定的順序顯示。

TextParagraph

TextParagraph小工具。

Image

Image小工具。

DecoratedText

DecoratedText小工具。

ButtonList

ButtonList小工具。

TextInput

TextInput小工具。

SelectionInput

SelectionInput小工具。

DateTimePicker

DateTimePicker小工具。

ChipList

ChipList小工具。

HostAppDataActionMarkup

定義更新 Google Workspace 資料的方式。

string

在表單輸入事件中，用來識別 DateTimePicker 的名稱。

如要進一步瞭解如何使用表單輸入內容，請參閱「接收表單資料」。

string

提示使用者輸入日期、時間或日期和時間的文字。舉例來說，如果使用者要安排預約，請使用 Appointment date 或 Appointment date and time 等標籤。

DateTimePickerType

小工具是否支援輸入日期、時間或日期和時間。

int64

小工具中顯示的預設值，以自 Unix Epoch 紀元時間起算的毫秒為單位。

根據選擇器類型 (DateTimePickerType) 指定值：

• DATE_AND_TIME：世界標準時間的日期和時間。舉例來說，如要表示世界標準時間 2023 年 1 月 1 日下午 12 點，請使用 1672574400000。
• DATE_ONLY：世界標準時間 00:00:00 的曆法日期。舉例來說，如果要表示 2023 年 1 月 1 日，請使用 1672531200000。
• TIME_ONLY：世界標準時間。舉例來說，如要表示下午 12:00，請使用 43200000 (或 12 * 60 * 60 * 1000)。

int32

代表時區與世界標準時間時差的數字，以分鐘為單位。如果已設定，value_ms_epoch 會以指定時區顯示。如果未設定，則值會預設為使用者的時區設定。

Action

在使用者點選 DateTimePicker 介面中的「儲存」或「清除」時觸發。

Icon

已淘汰，改用 startIcon。

Icon

文字前方顯示的圖示。

string

顯示在 text 上方的文字。一律截斷。

string

必要欄位。主要文字。

支援簡單的格式設定。如要進一步瞭解如何設定文字格式，請參閱「在 Google Chat 應用程式中設定文字格式」和「在 Google Workspace 外掛程式中設定文字格式」。

bool

文字換行設定。如果為 true，文字會斷行並顯示在多行中。否則文字會遭到截斷。

僅適用於 text，不適用於 topLabel 和 bottomLabel。

string

顯示在 text 下方的文字。一律會產生包裝。

OnClick

使用者按一下 topLabel 或 bottomLabel 時，系統會觸發這項動作。

Button

使用者可點選觸發動作的按鈕。

SwitchControl

使用者可點選切換鈕小工具來變更狀態並觸發動作。

Icon

文字後方顯示的圖示。

支援內建和自訂圖示。

string

在表單輸入事件中，系統用來識別切換鈕小工具的名稱。

如要進一步瞭解如何使用表單輸入內容，請參閱「接收表單資料」。

string

使用者輸入的值，會做為表單輸入事件的一部分傳回。

如要進一步瞭解如何使用表單輸入內容，請參閱「接收表單資料」。

bool

當 true 時，表示已選取切換鈕。

Action

當切換狀態變更時要執行的動作，例如要執行的函式。

ControlType

切換鈕在使用者介面中的顯示方式。

適用於 Google Chat 應用程式和 Google Workspace 外掛程式。

Action

對於 Google Chat 中的外掛程式，則是關閉對話方塊的動作。

Suggestions

string

這是一個無操作的結構定義欄位，可能會出現在語法檢查的標記中。

string

顯示在格狀標題中的文字。

GridItem

要顯示在格狀檢視畫面中的項目。

BorderStyle

套用至每個格線項目的邊框樣式。

int32

網格中要顯示的欄數。如果未指定這個欄位，系統會使用預設值，而這個預設值會因顯示格線的位置 (對話方塊或隨附應用程式) 而異。

OnClick

每個個別的格線項目都會重複使用這個回呼，但在回呼的參數中加入項目清單中的項目 ID 和索引。

string

使用者指定的這個格線項目 ID。這個 ID 會在父項格線的 onClick 回呼參數中傳回。

ImageComponent

格狀項目中顯示的圖片。

string

格線項目的標題。

string

格線項目的副標題。

GridItemLayout

格線項目要使用的版面配置。

string

選用設定。用於無障礙功能的圖示說明。如未指定，則會提供預設值 Button。最佳做法是，您應設定有用的說明，說明圖示顯示的內容，以及適用情況下圖示的功能。例如 A user's account portrait 或 Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat。

如果圖示設在 Button 中，當使用者將滑鼠游標懸停在按鈕上時，altText 就會顯示為實用提示文字。不過，如果按鈕也設定了 text，系統會忽略圖示的 altText。

ImageType

套用至圖片的裁剪樣式。在某些情況下，套用 CIRCLE 裁剪功能會導致圖片繪製的大小大於內建圖示。

string

顯示 Google Workspace 提供的內建圖示。

例如，如要顯示飛機圖示，請指定 AIRPLANE。如為公車，請指定 BUS。

如需支援圖示的完整清單，請參閱「內建圖示」。

string

顯示代管在 HTTPS 網址的自訂圖示。

例如：

"iconUrl":
"https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png"

支援的檔案類型包括 .png 和 .jpg。

MaterialIcon

顯示 Google Material 圖示。

舉例來說，如要顯示核取方塊圖示，請使用

"materialIcon": {
  "name": "check_box"
}

適用於 Google Chat 應用程式，但不適用於 Google Workspace 外掛程式。

string

圖片的 HTTPS 網址。

例如：

https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png

OnClick

使用者點選圖片時，點擊會觸發這項動作。

string

這張圖片的替代文字，用於無障礙功能。

string

圖片網址。

string

圖片的無障礙標籤。

ImageCropStyle

要套用至圖片的裁剪樣式。

BorderStyle

要套用至圖片的邊框樣式。

ImageCropType

裁剪類型。

double

如果裁剪類型為 RECTANGLE_CUSTOM，則使用的顯示比例。

舉例來說，以下是如何套用 16:9 的顯示比例：

cropStyle {
 "type": "RECTANGLE_CUSTOM",
 "aspectRatio": 16/9
}

string

返回外掛程式的連結網址。

string

返回外掛程式的連結名稱。

Card

資訊卡會顯示第三方服務連結的相關資訊。

string

連結預覽畫面中顯示的智慧型方塊標題。如果未設定，智慧型方塊會顯示 preview_card 的標題。

string

連結預覽畫面中顯示的標題。如果未設定，連結預覽畫面會顯示 preview_card 的標頭。

string

Google Material 圖示中定義的圖示名稱，例如 check_box。任何無效的名稱都會遭到捨棄，並替換成空字串，導致圖示無法顯示。

bool

是否以填滿格式顯示圖示。預設值為 false。

如要預覽不同的圖示設定，請前往 Google 字型圖示，然後調整「自訂」下方的設定。

int32

圖示的粗細。請選擇 {100, 200, 300, 400, 500, 600, 700}。如未指定，則預設值為 400。如指定其他值，則會使用預設值。

如要預覽不同的圖示設定，請前往 Google 字型圖示，然後調整「自訂」下方的設定。

int32

粗細和等級會影響符號的粗細。等級調整比權重調整更精細，對符號大小的影響也較小。選擇 {-25, 0, 200}。如未指定，預設值為 0。如指定其他值，則會使用預設值。

如要預覽不同的圖示設定，請前往 Google 字型圖示，然後調整「自訂」下方的設定。

UpdateWidget

針對 Google Chat 中的外掛程式，更新資訊卡或對話方塊中的小工具。

SelectionInputWidgetSuggestions

對於 selectionInput 小工具，則是多重選取選單中的建議項目陣列。當多重選取選單使用外部資料來源填入項目時，小工具可以根據使用者在選單中輸入的內容，動態填入建議項目。詳情請參閱「向 Google Chat 使用者收集資訊」。

SelectionItem

使用者在多重選取選單中輸入內容後，系統會顯示可選取的項目陣列。

bool

彈出根卡以外的所有卡片。

bool

彈出一張卡片。

string

使用指定的卡片名稱，彈出指定卡片上方的所有卡片。

Card

將一張牌推到牌堆中。

開發人員預覽版：針對 Google Chat 中的對話方塊，開啟或更新對話方塊。

Card

使用新卡片更新頂端資訊卡，並保留已填寫的表單欄位值。如果是不同欄位，則會捨棄該值。

開發人員預覽版：針對 Google Chat 中的對話方塊，開啟或更新對話方塊。

EndNavigation

對於 Google Chat 中的外掛程式，會關閉對話方塊。

string

通知中顯示的純文字，不含 HTML 標記。

Action

如果指定了這個 onClick，系統就會觸發動作。

OpenLink

如果指定，這個 onClick 會觸發開啟連結動作。

Action

當動作需要開啟連結時，外掛程式會觸發這項動作。這與上述 open_link 不同，因為這需要與伺服器通訊才能取得連結。因此，在開啟連結動作回應傳回之前，網頁用戶端必須先完成一些準備工作。

適用於 Google Workspace 外掛程式，但不適用於 Google Chat 應用程式。

Card

在點選後，系統會將新資訊卡推送至資訊卡堆疊 (如果已指定)。

適用於 Google Workspace 外掛程式，但不適用於 Google Chat 應用程式。

OverflowMenu

如果指定此 onClick，系統會開啟溢位選單。

string

要開啟的網址。

OpenAs

如何開啟連結。

適用於 Google Workspace 外掛程式，但不適用於 Google Chat 應用程式。

OnClose

用戶端是否會在開啟連結後忘記連結，或是觀察連結，直到視窗關閉為止。

適用於 Google Workspace 外掛程式，但不適用於 Google Chat 應用程式。

OverflowMenuItem

必要欄位。選單選項清單。

Icon

文字前方顯示的圖示。

string

必要欄位。向使用者說明或描述商品的文字。

OnClick

必要欄位。選取選單選項時所觸發的動作。這個 OnClick 無法包含 OverflowMenu，任何指定的 OverflowMenu 都會遭到捨棄，且選單項目會停用。

bool

是否停用選單選項。預設值為 false。

Action

外掛程式可用來更新 UI 的動作。

開發人員預覽版：Google Chat 中的外掛程式。

HostAppActionMarkup

由個別主機應用程式處理的動作。

string

這是一個無操作的結構定義欄位，可能會出現在語法檢查的標記中。

Navigation

推送、彈出或更新卡片。

開發人員預覽版：Google Chat 中的外掛程式。

OpenLink

在新分頁或彈出式視窗中開啟目標連結。

Notification

當使用者與資訊卡互動時，在主機 Google Workspace 應用程式中顯示通知。

開發人員預覽：針對 Google Chat 中的外掛程式，在使用者提交及關閉對話方塊時顯示通知。

LinkPreview

適用於 Google 文件、試算表和簡報。使用智慧型方塊和資訊卡預覽連結。詳情請參閱「使用智慧型方塊預覽連結」。

Link

這項功能適用於 Google 文件。傳回第三方資源的連結，並將其轉換為主機應用程式中的智慧型方塊。格式化為包含一個項目的物件陣列。

詳情請參閱「透過 @ 選單建立第三方資源」。

ModifyCard

對於 Google Chat 中的外掛程式，會根據使用者互動情形更新資訊卡。陣列只能包含單一物件。

string

必要欄位。用於識別表單輸入事件中選取輸入內容的名稱。

如要進一步瞭解如何使用表單輸入內容，請參閱「接收表單資料」。

string

使用者介面中選取輸入欄位上方顯示的文字。

指定可協助使用者輸入應用程式所需資訊的文字。舉例來說，如果使用者從下拉式選單中選取工作單據的緊急程度，標籤可能會是「緊急程度」或「選取緊急程度」。

SelectionType

向使用者在 SelectionInput 小工具中顯示的項目類型。選取類型支援不同類型的互動。舉例來說，使用者可以選取一或多個核取方塊，但只能從下拉式選單中選取一個值。

SelectionItem

可選項目的陣列。例如圓形按鈕或核取方塊陣列。最多可支援 100 個項目。

Action

如果指定，系統會在選取項目變更時提交表單。如果未指定，則必須指定用於提交表單的按鈕。

如要進一步瞭解如何使用表單輸入內容，請參閱「接收表單資料」。

int32

針對複選選單，使用者可選取的項目數量上限。最小值為 1 項。如未指定，則預設為 3 個項目。

int32

對於多重選取選單，使用者輸入文字字元數量，系統才會傳回建議的選取項目。

如果未設定，多重選取選單會使用下列預設值：

• 如果選單使用 SelectionInput 項目的靜態陣列，預設為 0 個字元，並立即從陣列填入項目。
• 如果選單使用動態資料來源 (multi_select_data_source)，預設會在查詢資料來源以傳回建議項目之前，先顯示 3 個字元。

Action

外部資料來源，例如關聯資料庫。

PlatformDataSource

Google Workspace 的資料來源。

CommonDataSource

所有 Google Workspace 應用程式 (例如 Google Workspace 機構中的使用者) 共用的資料來源。

HostAppDataSourceMarkup

專屬於 Google Workspace 主機應用程式 (例如 Google Chat 中的聊天室) 的資料來源。

這個欄位支援 Google API 用戶端程式庫，但無法在 Cloud 用戶端程式庫中使用。詳情請參閱「安裝用戶端程式庫」。

string

向使用者說明或描述商品的文字。

string

與此項目相關聯的值。用戶端應將此值做為表單輸入值。

如要進一步瞭解如何使用表單輸入內容，請參閱「接收表單資料」。

bool

該項目是否預設為選取狀態。如果選取輸入內容只接受一個值 (例如圓形按鈕或下拉式選單)，請只為一個項目設定這個欄位。

string

對於多重選取選單，此屬性是項目 text 欄位旁邊顯示的圖示網址。支援 PNG 和 JPEG 檔案。必須是 HTTPS 網址。例如：https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png。

string

對於多重選取選單，則是顯示在項目 text 欄位下方的文字說明或標籤。

RenderActions

一組轉譯指示，可指示資訊卡執行動作，以及/或者指示外掛程式主機應用程式執行特定應用程式動作。

bool

資訊卡的狀態是否已變更，以及現有資訊卡中的資料是否已過時。

string

這是一個無操作的結構定義欄位，可能會出現在語法檢查的標記中。

SuggestionItem

在文字輸入欄位中，用於自動完成建議的建議清單。

string

文字輸入欄位建議輸入內容的值。這與使用者自行輸入的內容相同。

string

在表單輸入事件中，用來識別文字輸入內容的名稱。

如要進一步瞭解如何使用表單輸入內容，請參閱「接收表單資料」。

string

使用者介面中文字輸入欄位上方顯示的文字。

指定可協助使用者輸入應用程式所需資訊的文字。舉例來說，如果您詢問某人的姓名，但需要對方的姓氏，請輸入 surname 而非 name。

如果未指定 hintText，則為必要欄位。否則為選用。

string

文字輸入欄位下方顯示的文字，可協助使用者輸入特定值。這段文字會一直顯示。

如果未指定 label，則為必要欄位。否則為選用。

string

使用者輸入的值，會做為表單輸入事件的一部分傳回。

如要進一步瞭解如何使用表單輸入內容，請參閱「接收表單資料」。

Type

文字輸入欄位在使用者介面中的顯示方式。例如，欄位是單行還是多行。

Action

文字輸入欄位發生變更時的處理方式。例如使用者在欄位中新增或刪除文字。

例如在 Google Chat 中執行自訂函式或開啟對話方塊。

Suggestions

系統建議使用者可輸入的值。使用者點選文字輸入欄位時，就會顯示這些值。當使用者輸入內容時，系統會根據使用者輸入的內容，動態篩選出建議值。

舉例來說，程式設計語言的文字輸入欄位可能會建議 Java、JavaScript、Python 和 C++。當使用者開始輸入 Jav 時，建議清單就會篩選出 Java 和 JavaScript。

建議值可引導使用者輸入應用程式可解讀的值。在 JavaScript 中，有些使用者可能會輸入 javascript，有些則會輸入 java script。建議使用 JavaScript 可讓使用者與應用程式互動的方式標準化。

指定後，TextInput.type 一律為 SINGLE_LINE，即使設為 MULTIPLE_LINE 也不例外。

適用於 Google Chat 應用程式和 Google Workspace 外掛程式。

Action

選用設定。指定當文字輸入欄位向使用者提供建議時，要採取哪些動作。

如果未指定，建議會由 initialSuggestions 設定，並由用戶端處理。

如果指定，應用程式會執行此處指定的動作，例如執行自訂函式。

適用於 Google Workspace 外掛程式，但不適用於 Google Chat 應用程式。

Validation

指定這個文字欄位所需的輸入格式驗證。

適用於 Google Chat 應用程式和 Google Workspace 外掛程式。

string

文字欄位空白時，在文字輸入欄位中顯示的文字。使用這段文字提示使用者輸入值。例如 Enter a number from 0 to 100。

適用於 Google Chat 應用程式，但不適用於 Google Workspace 外掛程式。

string

小工具中顯示的文字。

int32

小工具中顯示的文字行數上限。如果文字超過指定的最大行數，系統會隱藏多餘的內容，並在「顯示更多」按鈕後方顯示。如果文字長度等於或小於指定的最大行數，系統就不會顯示「顯示更多」按鈕。

預設值為 0，在這種情況下，系統會顯示所有內容。系統會忽略負值。

int32

指定文字輸入小工具的字元限制。請注意，這項屬性僅用於文字輸入，其他小工具會忽略這項屬性。

適用於 Google Chat 應用程式和 Google Workspace 外掛程式。

InputType

指定輸入小工具的類型。

適用於 Google Chat 應用程式和 Google Workspace 外掛程式。

HorizontalAlignment

指定小工具是否要對齊欄的左側、右側或置中。

TextParagraph

顯示文字段落。支援簡單的 HTML 格式文字。如要進一步瞭解如何設定文字格式，請參閱「在 Google Chat 應用程式中設定文字格式」和「在 Google Workspace 外掛程式中設定文字格式」。

舉例來說，下列 JSON 會建立加粗的文字：

"textParagraph": {
  "text": "  <b>bold text</b>"
}

Image

顯示圖片。

舉例來說，下列 JSON 會建立附帶替代文字的圖片：

"image": {
  "imageUrl":
  "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png",
  "altText": "Chat app avatar"
}

DecoratedText

顯示經過修飾的文字項目。

例如，下列 JSON 會建立顯示電子郵件地址的修飾文字小工具：

"decoratedText": {
  "icon": {
    "knownIcon": "EMAIL"
  },
  "topLabel": "Email Address",
  "text": "sasha@example.com",
  "bottomLabel": "This is a new Email address!",
  "switchControl": {
    "name": "has_send_welcome_email_to_sasha",
    "selected": false,
    "controlType": "CHECKBOX"
  }
}

ButtonList

按鈕清單。

舉例來說，下列 JSON 會建立兩個按鈕。第一個是藍色文字按鈕，第二個是可開啟連結的圖片按鈕：

"buttonList": {
  "buttons": [
    {
      "text": "Edit",
      "color": {
        "red": 0,
        "green": 0,
        "blue": 1,
      },
      "disabled": true,
    },
    {
      "icon": {
        "knownIcon": "INVITE",
        "altText": "check calendar"
      },
      "onClick": {
        "openLink": {
          "url": "https://example.com/calendar"
        }
      }
    }
  ]
}

TextInput

顯示可供使用者輸入內容的文字方塊。

例如，下列 JSON 會為電子郵件地址建立文字輸入：

"textInput": {
  "name": "mailing_address",
  "label": "Mailing Address"
}

以下 JSON 為另一個範例，可為程式語言建立文字輸入內容，並提供靜態建議：

"textInput": {
  "name": "preferred_programing_language",
  "label": "Preferred Language",
  "initialSuggestions": {
    "items": [
      {
        "text": "C++"
      },
      {
        "text": "Java"
      },
      {
        "text": "JavaScript"
      },
      {
        "text": "Python"
      }
    ]
  }
}

SelectionInput

顯示選取控制項，讓使用者選取項目。選取控制項可以是核取方塊、圓形按鈕、切換按鈕或下拉式選單。

舉例來說，下列 JSON 會建立下拉式選單，讓使用者選擇尺寸：

"selectionInput": {
  "name": "size",
  "label": "Size"
  "type": "DROPDOWN",
  "items": [
    {
      "text": "S",
      "value": "small",
      "selected": false
    },
    {
      "text": "M",
      "value": "medium",
      "selected": true
    },
    {
      "text": "L",
      "value": "large",
      "selected": false
    },
    {
      "text": "XL",
      "value": "extra_large",
      "selected": false
    }
  ]
}

DateTimePicker

顯示小工具，讓使用者輸入日期、時間或日期和時間。

舉例來說，下列 JSON 會建立日期/時間挑選器，用於安排預約：

"dateTimePicker": {
  "name": "appointment_time",
  "label": "Book your appointment at:",
  "type": "DATE_AND_TIME",
  "valueMsEpoch": "796435200000"
}

Divider

在小工具之間顯示水平分隔線。

例如，下列 JSON 會建立分隔符：

"divider": {
}

Grid

顯示包含一組項目的格狀畫面。

格線支援任意數量的欄和項目。列數取決於項目數量上限除以資料欄數。格線包含 10 個項目和 2 個欄，因此有 5 列。格線包含 11 個項目和 2 個欄，因此有 6 列。

適用於 Google Chat 應用程式和 Google Workspace 外掛程式。

舉例來說，下列 JSON 會建立 2 欄格式，其中包含 1 個項目：

"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"
    }
  }
}

Columns

最多顯示 2 欄。

如要加入超過 2 個資料欄或使用資料列，請使用 Grid 小工具。

例如，以下 JSON 會建立 2 個資料欄，每個資料欄都包含文字段落：

"columns": {
  "columnItems": [
    {
      "horizontalSizeStyle": "FILL_AVAILABLE_SPACE",
      "horizontalAlignment": "CENTER",
      "verticalAlignment": "CENTER",
      "widgets": [
        {
          "textParagraph": {
            "text": "First column text paragraph"
          }
        }
      ]
    },
    {
      "horizontalSizeStyle": "FILL_AVAILABLE_SPACE",
      "horizontalAlignment": "CENTER",
      "verticalAlignment": "CENTER",
      "widgets": [
        {
          "textParagraph": {
            "text": "Second column text paragraph"
          }
        }
      ]
    }
  ]
}

Carousel

輪轉介面包含一組巢狀小工具。以下是輪轉介面 JSON 表示法範例，其中包含兩個文字段落。

{
  "widgets": [
    {
      "textParagraph": {
        "text": "First text paragraph in the carousel."
      }
    },
    {
      "textParagraph": {
        "text": "Second text paragraph in the carousel."
      }
    }
  ]
}

ChipList

方塊清單。

例如，下列 JSON 會建立兩個方塊。第一個是文字方塊，第二個是可開啟連結的圖示方塊：

"chipList": {
  "chips": [
    {
      "text": "Edit",
      "disabled": true,
    },
    {
      "icon": {
        "knownIcon": "INVITE",
        "altText": "check calendar"
      },
      "onClick": {
        "openLink": {
          "url": "https://example.com/calendar"
        }
      }
    }
  ]
}