Cards v1

資訊卡

資訊卡是可包含文字和圖片等 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 圓形邊框。

部分

一個區段包含的資訊方塊集合會依照指定的順序 (垂直) 算繪。在所有平台上，資訊卡的固定寬度都很窄，因此目前不需要版面配置屬性 (例如浮動)。

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

string

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

object (WidgetMarkup)

一個區段至少必須包含一個小工具。

WidgetMarkup

小工具是用於顯示文字和圖片的 UI 元素。

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

  // Union field data can be only one of the following:
  "textParagraph": {
    object (TextParagraph)
  },
  "image": {
    object (Image)
  },
  "keyValue": {
    object (KeyValue)
  }
  // End of list of possible types for union field data.
}
欄位
buttons[]

object (Button)

按鈕清單。Buttons 也是 oneof data，且只能設定其中一個欄位。
聯集欄位 data。WidgetMarkup 只能包含下列其中一個項目。您可以使用多個 WidgetMarkup 欄位來顯示更多項目。data 只能是下列其中一個：
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 表示法 
{

  // Union field data can be only one of the following:
  "action": {
    object (FormAction)
  },
  "openLink": {
    object (OpenLink)
  }
  // End of list of possible types for union field data.
}
欄位

聯集欄位 data。

data 只能是下列其中一個：
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)
  },

  // Union field icons can be only one of the following:
  "icon": enum (Icon),
  "iconUrl": string
  // End of list of possible types for union field icons.

  // Union field control can be only one of the following:
  "button": {
    object (Button)
  }
  // End of list of possible types for union field control.
}
欄位
topLabel

string

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

string

內容文字。系統支援格式化文字，且必須提供。如要進一步瞭解如何設定文字格式，請參閱「在 Google Chat 應用程式中設定文字格式」和「在 Google Workspace 外掛程式中設定文字格式」。
contentMultiline

boolean

內容是否應為多行。

bottomLabel

string

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

object (OnClick)

onclick 動作。只有頂端標籤、底部標籤和內容區域可供點選。
聯集欄位 icons。必須定義至少一個圖示，top_label 和 bottom_label。icons 只能是下列其中一個：
icon

enum (Icon)

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

string

由網址指定的圖示。
聯集欄位 control。控制小工具。您可以設定 button 或 switch_widget，但不能同時設定兩者。control 只能是下列其中一個：
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 表示法 
{

  // Union field type can be only one of the following:
  "textButton": {
    object (TextButton)
  },
  "imageButton": {
    object (ImageButton)
  }
  // End of list of possible types for union field type.
}
欄位

聯集欄位 type。

type 只能是下列其中一個：
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,

  // Union field icons can be only one of the following:
  "icon": enum (Icon),
  "iconUrl": string
  // End of list of possible types for union field icons.
}
欄位
onClick

object (OnClick)

onclick 動作。
name

string

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

聯集欄位 icons。您可以使用 Icon enum 或網址指定圖示。icons 只能是下列其中一個：
icon

enum (Icon)

enum 指定的圖示，可索引 Chat API 提供的圖示。
iconUrl

string

由網址指定的圖示。

CardAction

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

Google Chat 應用程式不支援這項功能。

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

string

用於顯示在動作選單項目中的標籤。
onClick

object (OnClick)

這個動作項目的 onclick 動作。