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 圓形邊框。

Section

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

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，且只能設定其中一個欄位。
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 動作。