Cards v1

Card

資訊卡是一種 UI 元素，可包含文字和圖片等 UI 小工具。

JSON 表示法 
{
  "header": {
    object (CardHeader)
  },
  "sections": [
    {
      object (Section)
    }
  ],
  "cardActions": [
    {
      object (CardAction)
    }
  ],
  "name": string
}
欄位
header

object (CardHeader)

資訊卡的標題。標題通常包含標題和圖片。

sections[]

object (Section)

各區塊會以分隔線分隔。

cardActions[]

object (CardAction)

這張資訊卡的動作。

name

string

資訊卡名稱。

CardHeader

JSON 表示法 
{
  "title": string,
  "subtitle": string,
  "imageStyle": enum (ImageStyle),
  "imageUrl": string
}
欄位
title

string

必須指定標題。標題的高度固定，如果同時指定標題和副標題，兩者各占一行。如果只指定標題，則會佔用兩行。

subtitle

string

資訊卡標題的子標題。

imageStyle

enum (ImageStyle)

圖片類型 (例如正方形或圓形邊框)。

imageUrl

string

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

ImageStyle

列舉
IMAGE_STYLE_UNSPECIFIED
IMAGE 方塊邊框。
AVATAR 圓形邊框。

章節

一個區段包含一組小工具，這些小工具會按照指定順序 (垂直) 顯示。在所有平台上，資訊卡的寬度都是固定的，因此目前不需要版面配置屬性 (例如 float)。

JSON 表示法 
{
  "header": string,
  "widgets": [
    {
      object (WidgetMarkup)
    }
  ]
}
欄位
header

string

該部分的標題。系統支援格式化文字。如要進一步瞭解如何設定文字格式，請參閱「在 Google Chat 應用程式中設定文字格式」 和「在 Google Workspace 外掛程式中設定文字格式」。

widgets[]

object (WidgetMarkup)

每個區段至少要包含一個小工具。

WidgetMarkup

小工具是呈現文字和圖片的 UI 元素。

JSON 表示法 
{
  "buttons": [
    {
      object (Button)
    }
  ],

  "textParagraph": {
    object (TextParagraph)
  },
  "image": {
    object (Image)
  },
  "keyValue": {
    object (KeyValue)
  }
}
欄位
buttons[]

object (Button)

按鈕清單。按鈕也是 oneof data ，而且只能設定其中一個欄位。

A WidgetMarkup 只能包含下列其中一個項目。您可以使用多個 WidgetMarkup 欄位顯示更多項目。以下列出互斥的欄位。回應中最多只會設定一個欄位：
textParagraph

object (TextParagraph)

在這個小工具中顯示一段文字。

image

object (Image)

在這個小工具中顯示圖片。

keyValue

object (KeyValue)

在這個小工具中顯示鍵值項目。

互斥欄位的結尾。

TextParagraph

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

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

string

圖片

圖片由網址指定，且可執行onclick動作。

JSON 表示法 
{
  "imageUrl": string,
  "onClick": {
    object (OnClick)
  },
  "aspectRatio": number
}
欄位
imageUrl

string

圖片的網址。

onClick

object (OnClick)

onclick動作。
aspectRatio

number

這張圖片的長寬比 (寬度和高度)。這個欄位可讓您在等待圖片載入時，預留正確的高度。這項屬性並非用來覆寫圖片的內建長寬比，如未設定，伺服器會預先擷取圖片，填入這個欄位。

OnClick

onclick動作 (例如開啟連結)。

JSON 表示法 
{

  "action": {
    object (FormAction)
  },
  "openLink": {
    object (OpenLink)
  }
}
欄位
以下列出互斥的欄位。回應中最多會設定一個欄位：
action

object (FormAction)

如果指定了表單動作，系統會透過這個 onclick 動作觸發表單動作。
互斥欄位的結尾。

FormAction

表單動作說明表單提交時的行為。舉例來說，您可以叫用 Apps Script 來處理表單。

JSON 表示法 
{
  "actionMethodName": string,
  "parameters": [
    {
      object (ActionParameter)
    }
  ]
}
欄位
actionMethodName

string

方法名稱用於識別觸發表單提交的表單部分。這項資訊會回傳至 Chat 應用程式，做為資訊卡點擊事件的一部分。您可以為觸發相同行為的數個元素使用相同的方法名稱。

parameters[]

object (ActionParameter)

動作參數清單。

ActionParameter

叫用動作方法時要提供的字串參數清單。舉例來說，假設有三個貪睡按鈕：立即貪睡、貪睡一天、貪睡一週。您可能會使用 action method = snooze()，並在字串參數清單中傳遞暫緩通知類型和暫緩時間。

JSON 表示法 
{
  "key": string,
  "value": string
}
欄位
key

string

動作指令碼的參數名稱。

value

string

參數的值。

KeyValue

UI 元素包含鍵 (標籤) 和值 (內容)。這個元素也可以包含一些動作，例如 onclick 按鈕。

JSON 表示法 
{
  "topLabel": string,
  "content": string,
  "contentMultiline": boolean,
  "bottomLabel": string,
  "onClick": {
    object (OnClick)
  },

  "icon": enum (Icon),
  "iconUrl": string

  "button": {
    object (Button)
  }
}
欄位
topLabel

string

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

content

string

內容的文字。支援格式化文字，且一律為必填。如要進一步瞭解如何設定文字格式，請參閱「在 Google Chat 應用程式中設定文字格式」 和「在 Google Workspace 外掛程式中設定文字格式」。

contentMultiline

boolean

內容是否應為多行。

bottomLabel

string

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

onClick

object (OnClick)

onclick 動作。只有頂端標籤、底部標籤和內容區域可供點選。

至少須定義圖示、top_label 和 bottom_label 其中一項。以下列出互斥的欄位。回應中最多只會設定一個欄位：
icon

enum (Icon)

Chat API 會將這個列舉值替換為相應的圖示圖片。

iconUrl

string

網址指定的圖示。

互斥欄位的結尾。
控制項小工具。您可以設定 button 或 switch_widget，但不能同時設定兩者。以下列出互斥的欄位。回應中最多會設定一個欄位：
button

object (Button)

可點選的按鈕，用於觸發動作。

互斥欄位的結尾。

圖示

支援的圖示集。

列舉
ICON_UNSPECIFIED
AIRPLANE
BOOKMARK
BUS
CAR
CLOCK
CONFIRMATION_NUMBER_ICON
DOLLAR
DESCRIPTION
EMAIL
EVENT_PERFORMER
EVENT_SEAT
FLIGHT_ARRIVAL
FLIGHT_DEPARTURE
HOTEL
HOTEL_ROOM_TYPE
INVITE
MAP_PIN
MEMBERSHIP
MULTIPLE_PEOPLE
OFFER
PERSON
PHONE
RESTAURANT_ICON
SHOPPING_CART
STAR
STORE
TICKET
TRAIN
VIDEO_CAMERA
VIDEO_PLAY

按鈕

按鈕。可以是文字按鈕或圖片按鈕。

JSON 表示法 
{

  "textButton": {
    object (TextButton)
  },
  "imageButton": {
    object (ImageButton)
  }
}
欄位
以下列出互斥的欄位。回應中最多會設定一個欄位：
textButton

object (TextButton)

含有文字和 onclick 動作的按鈕。

imageButton

object (ImageButton)

含有圖片和onclick動作的按鈕。
互斥欄位的結尾。

TextButton

含有文字和 onclick 動作的按鈕。

JSON 表示法 
{
  "text": string,
  "onClick": {
    object (OnClick)
  }
}
欄位
text

string

按鈕文字。

onClick

object (OnClick)

onclick 按鈕的動作。

ImageButton

圖片按鈕，內含 onclick 動作。

JSON 表示法 
{
  "onClick": {
    object (OnClick)
  },
  "name": string,

  "icon": enum (Icon),
  "iconUrl": string
}
欄位
onClick

object (OnClick)

onclick動作。
name

string

這個 imageButton 的名稱，用於無障礙功能。如未指定名稱，系統會提供預設值。

圖示可由 Icon、enum 或網址指定。以下列出互斥的欄位。回應中最多會設定一個欄位：
icon

enum (Icon)

由 enum 指定的圖示，會建立 Chat API 提供的圖示索引。
iconUrl

string

網址指定的圖示。

互斥欄位的結尾。

CardAction

資訊卡動作是指與資訊卡相關聯的動作。如果是月結單資訊卡，常見動作包括：刪除月結單、透過電子郵件傳送月結單，或在瀏覽器中開啟月結單。

Google Chat 應用程式不支援。

JSON 表示法 
{
  "actionLabel": string,
  "onClick": {
    object (OnClick)
  }
}
欄位
actionLabel

string

這個標籤過去會顯示在動作選單項目中。

onClick

object (OnClick)

這項待辦事項的 onclick 動作。