Cards v1

Thẻ

Thẻ là một phần tử trên giao diện người dùng có thể chứa các tiện ích trên giao diện người dùng, chẳng hạn như văn bản và hình ảnh.

Biểu diễn dưới dạng JSON 
{
  "header": {
    object (CardHeader)
  },
  "sections": [
    {
      object (Section)
    }
  ],
  "cardActions": [
    {
      object (CardAction)
    }
  ],
  "name": string
}
Trường
header

object (CardHeader)

Tiêu đề của thẻ. Tiêu đề thường chứa một tiêu đề và một hình ảnh.

sections[]

object (Section)

Các phần được phân tách bằng một đường kẻ phân chia.

cardActions[]

object (CardAction)

Các thao tác của thẻ này.

name

string

Tên của thẻ.

CardHeader

Biểu diễn dưới dạng JSON 
{
  "title": string,
  "subtitle": string,
  "imageStyle": enum (ImageStyle),
  "imageUrl": string
}
Trường
title

string

Bạn phải chỉ định tiêu đề. Tiêu đề có chiều cao cố định: nếu bạn chỉ định cả tiêu đề và phụ đề, mỗi thành phần sẽ chiếm một dòng. Nếu bạn chỉ chỉ định tiêu đề, thì tiêu đề sẽ chiếm cả hai dòng.

subtitle

string

Phụ đề của tiêu đề thẻ.

imageStyle

enum (ImageStyle)

Loại hình ảnh (ví dụ: đường viền vuông hoặc đường viền tròn).

imageUrl

string

URL của hình ảnh trong tiêu đề thẻ.

ImageStyle

Enum
IMAGE_STYLE_UNSPECIFIED
IMAGE Đường viền hình vuông.
AVATAR Đường viền hình tròn.

Phần

Một phần chứa một tập hợp các tiện ích được kết xuất (theo chiều dọc) theo thứ tự mà chúng được chỉ định. Trên tất cả các nền tảng, thẻ có chiều rộng cố định hẹp, nên hiện không cần đến các thuộc tính bố cục (ví dụ: float).

Biểu diễn dưới dạng JSON 
{
  "header": string,
  "widgets": [
    {
      object (WidgetMarkup)
    }
  ]
}
Trường
header

string

Tiêu đề của phần. Hỗ trợ văn bản được định dạng. Để biết thêm thông tin về cách định dạng văn bản, hãy xem phần Định dạng văn bản trong các ứng dụng Google Chat và Định dạng văn bản trong Tiện ích bổ sung cho Google Workspace.

widgets[]

object (WidgetMarkup)

Mỗi phần phải chứa ít nhất một tiện ích.

WidgetMarkup

Tiện ích là một phần tử trên giao diện người dùng trình bày văn bản và hình ảnh.

Biểu diễn dưới dạng JSON 
{
  "buttons": [
    {
      object (Button)
    }
  ],

  "textParagraph": {
    object (TextParagraph)
  },
  "image": {
    object (Image)
  },
  "keyValue": {
    object (KeyValue)
  }
}
Trường
buttons[]

object (Button)

Danh sách các nút. Nút cũng là oneof data và bạn chỉ nên đặt một trong các trường này.

WidgetMarkup chỉ có thể có một trong các mục sau. Bạn có thể dùng nhiều trường WidgetMarkup để hiển thị thêm các mục. Sau đây là danh sách các trường loại trừ lẫn nhau. Tối đa một trong các trường sẽ được đặt trong phản hồi:
textParagraph

object (TextParagraph)

Hiển thị một đoạn văn bản trong tiện ích này.

image

object (Image)

Hiển thị hình ảnh trong tiện ích này.

keyValue

object (KeyValue)

Hiển thị một mục khoá-giá trị trong tiện ích này.

Kết thúc các trường xung khắc.

TextParagraph

Một đoạn văn bản. Hỗ trợ văn bản được định dạng. Để biết thêm thông tin về cách định dạng văn bản, hãy xem phần Định dạng văn bản trong các ứng dụng Google Chat và Định dạng văn bản trong Tiện ích bổ sung cho Google Workspace.

Biểu diễn dưới dạng JSON 
{
  "text": string
}
Trường
text

string

Hình ảnh

Hình ảnh được chỉ định bằng một URL và có thể có thao tác onclick.

Biểu diễn dưới dạng JSON 
{
  "imageUrl": string,
  "onClick": {
    object (OnClick)
  },
  "aspectRatio": number
}
Trường
imageUrl

string

URL của hình ảnh.

onClick

object (OnClick)

Hành động onclick.

aspectRatio

number

Tỷ lệ khung hình của hình ảnh này (chiều rộng và chiều cao). Trường này cho phép bạn dành sẵn chiều cao phù hợp cho hình ảnh trong khi chờ hình ảnh tải. Tham số này không dùng để ghi đè tỷ lệ khung hình tích hợp của hình ảnh. Nếu bạn không đặt, máy chủ sẽ điền thông tin này bằng cách tìm nạp trước hình ảnh.

OnClick

Một thao tác onclick (ví dụ: mở một đường liên kết).

Biểu diễn dưới dạng JSON 
{

  "action": {
    object (FormAction)
  },
  "openLink": {
    object (OpenLink)
  }
}
Trường
Sau đây là danh sách các trường loại trừ lẫn nhau. Tối đa một trong các trường sẽ được đặt trong phản hồi:
action

object (FormAction)

Một thao tác trên biểu mẫu sẽ được kích hoạt bởi thao tác onclick này nếu được chỉ định.

Kết thúc các trường xung khắc.

FormAction

Thao tác trên biểu mẫu mô tả hành vi khi biểu mẫu được gửi. Ví dụ: bạn có thể gọi Apps Script để xử lý biểu mẫu.

Biểu diễn dưới dạng JSON 
{
  "actionMethodName": string,
  "parameters": [
    {
      object (ActionParameter)
    }
  ]
}
Trường
actionMethodName

string

Tên phương thức được dùng để xác định phần nào của biểu mẫu đã kích hoạt việc gửi biểu mẫu. Thông tin này được phản hồi lại cho ứng dụng Chat trong sự kiện nhấp chuột vào thẻ. Bạn có thể sử dụng cùng một tên phương thức cho một số phần tử kích hoạt hành vi chung.

parameters[]

object (ActionParameter)

Danh sách các thông số hành động.

ActionParameter

Danh sách các tham số chuỗi cần cung cấp khi phương thức hành động được gọi. Ví dụ: hãy xem xét 3 nút báo lại: báo lại ngay, báo lại một ngày, báo lại vào tuần tới. Bạn có thể dùng action method = snooze(), truyền loại báo lại và thời gian báo lại trong danh sách các tham số chuỗi.

Biểu diễn dưới dạng JSON 
{
  "key": string,
  "value": string
}
Trường
key

string

Tên của tham số cho tập lệnh hành động.

value

string

Giá trị của tham số.

KeyValue

Một phần tử trên giao diện người dùng chứa một khoá (nhãn) và một giá trị (nội dung). Phần tử này cũng có thể chứa một số thao tác, chẳng hạn như nút onclick.

Biểu diễn dưới dạng JSON 
{
  "topLabel": string,
  "content": string,
  "contentMultiline": boolean,
  "bottomLabel": string,
  "onClick": {
    object (OnClick)
  },

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

  "button": {
    object (Button)
  }
}
Trường
topLabel

string

Văn bản của nhãn trên cùng. Hỗ trợ văn bản được định dạng. Để biết thêm thông tin về cách định dạng văn bản, hãy xem phần Định dạng văn bản trong các ứng dụng Google Chat và Định dạng văn bản trong Tiện ích bổ sung cho Google Workspace.

content

string

Văn bản của nội dung. Văn bản được định dạng được hỗ trợ và luôn bắt buộc. Để biết thêm thông tin về cách định dạng văn bản, hãy xem phần Định dạng văn bản trong các ứng dụng Google Chat và Định dạng văn bản trong Tiện ích bổ sung cho Google Workspace.

contentMultiline

boolean

Nếu nội dung phải có nhiều dòng.

bottomLabel

string

Văn bản của nhãn dưới cùng. Hỗ trợ văn bản được định dạng. Để biết thêm thông tin về cách định dạng văn bản, hãy xem phần Định dạng văn bản trong các ứng dụng Google Chat và Định dạng văn bản trong Tiện ích bổ sung cho Google Workspace.

onClick

object (OnClick)

Hành động onclick. Bạn chỉ có thể nhấp vào nhãn trên cùng, nhãn dưới cùng và vùng nội dung.

Bạn phải xác định ít nhất một trong các biểu tượng, top_label và bottom_label. Sau đây là danh sách các trường loại trừ lẫn nhau. Tối đa một trong các trường sẽ được đặt trong phản hồi:
icon

enum (Icon)

Một giá trị enum được Chat API thay thế bằng hình ảnh biểu tượng tương ứng.

iconUrl

string

Biểu tượng do một URL chỉ định.

Kết thúc các trường xung khắc.
Một tiện ích điều khiển. Bạn có thể đặt button hoặc switch_widget, nhưng không được đặt cả hai. Sau đây là danh sách các trường loại trừ lẫn nhau. Tối đa một trong các trường sẽ được đặt trong phản hồi:
button

object (Button)

Một nút có thể nhấp vào để kích hoạt một hành động.

Kết thúc các trường xung khắc.

Biểu tượng

Tập hợp các biểu tượng được hỗ trợ.

Enum
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

Nút

Một nút. Có thể là nút văn bản hoặc nút hình ảnh.

Biểu diễn dưới dạng JSON 
{

  "textButton": {
    object (TextButton)
  },
  "imageButton": {
    object (ImageButton)
  }
}
Trường
Sau đây là danh sách các trường loại trừ lẫn nhau. Tối đa một trong các trường sẽ được đặt trong phản hồi:
textButton

object (TextButton)

Một nút có văn bản và hành động onclick.

imageButton

object (ImageButton)

Một nút có hình ảnh và hành động onclick.

Kết thúc các trường xung khắc.

TextButton

Một nút có văn bản và hành động onclick.

Biểu diễn dưới dạng JSON 
{
  "text": string,
  "onClick": {
    object (OnClick)
  }
}
Trường
text

string

Văn bản của nút.

onClick

object (OnClick)

Thao tác onclick của nút.

ImageButton

Một nút hình ảnh có thao tác onclick.

Biểu diễn dưới dạng JSON 
{
  "onClick": {
    object (OnClick)
  },
  "name": string,

  "icon": enum (Icon),
  "iconUrl": string
}
Trường
onClick

object (OnClick)

Hành động onclick.

name

string

Tên của imageButton này được dùng cho chế độ hỗ trợ tiếp cận. Giá trị mặc định được cung cấp nếu bạn không chỉ định tên này.

Bạn có thể chỉ định biểu tượng bằng Icon, enum hoặc một URL. Sau đây là danh sách các trường loại trừ lẫn nhau. Tối đa một trong các trường sẽ được đặt trong phản hồi:
icon

enum (Icon)

Biểu tượng do enum chỉ định, biểu tượng này lập chỉ mục cho một biểu tượng do Chat API cung cấp.

iconUrl

string

Biểu tượng do một URL chỉ định.

Kết thúc các trường xung khắc.

CardAction

Thao tác trên thẻ là thao tác được liên kết với thẻ. Đối với thẻ hoá đơn, một thao tác thường gặp là: xoá hoá đơn, gửi hoá đơn qua email hoặc mở hoá đơn trong trình duyệt.

Không được các ứng dụng Google Chat hỗ trợ.

Biểu diễn dưới dạng JSON 
{
  "actionLabel": string,
  "onClick": {
    object (OnClick)
  }
}
Trường
actionLabel

string

Nhãn này từng xuất hiện trong mục trình đơn thao tác.

onClick

object (OnClick)

Thao tác onclick cho mục hành động này.