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)

按鈕清單。您也可以使用按鈕 oneof data 且只須設定其中一個欄位

聯集欄位 data。A 罩杯 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_labelbottom_labelicons 只能為下列其中一項:
icon

enum (Icon)

列舉值,Chat API 會替換為對應的圖示圖片。

iconUrl

string

網址指定的圖示。

聯集欄位 control。控制項小工具。您可以設定 buttonswitch_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 動作。