Cards v1

Thẻ

Thẻ là một thành phần 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 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 tiêu đề và hình ảnh.

sections[]

object (Section)

Các phần được phân tách bằng dấu phân chia dòng.

cardActions[]

object (CardAction)

Các hành động của thẻ này.

name

string

Tên 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 cả tiêu đề và phụ đề đều được chỉ định thì mỗi tiêu đề sẽ chiếm một dòng. Nếu chỉ có tiêu đề được chỉ định thì tiêu đề sẽ bao gồ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 vuông.
AVATAR Đường viền tròn.

Mục

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

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

string

Tiêu đề của phần. Có hỗ trợ định dạng văn bản. Để biết thêm thông tin về việc đị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Định dạng văn bản trong Tiện ích bổ sung của Google Workspace.

widgets[]

object (WidgetMarkup)

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

WidgetMarkup

Tiện ích là một thành phần 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)
    }
  ],

  // 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.
}
Trường
buttons[]

object (Button)

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

Trường hợp data. WidgetMarkup chỉ có thể có một trong các mục sau. Bạn có thể sử dụng nhiều trường WidgetMarkup để hiển thị nhiều mục hơn. data chỉ có thể là một trong các trạng thái sau:
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.

TextParagraph

Một đoạn văn bản. Có hỗ trợ định dạng văn bản. Để biết thêm thông tin về việc đị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Định dạng văn bản trong Tiện ích bổ sung của Google Workspace.

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

string

Bài đăng có 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ệ cỡ ả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 đặt trước chiều cao phù hợp cho hình ảnh trong khi chờ tải. Điều này không nhằm ghi đè tỷ lệ khung hình tích hợp sẵn của hình ảnh. Nếu bạn không đặt chính sách này, máy chủ sẽ điền thông tin bằng cách tìm nạp trước hình ảnh.

OnClick

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

Biểu diễn dưới dạng 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.
}
Trường

Trường hợp data.

data chỉ có thể là một trong các trạng thái sau:

action

object (FormAction)

Thao tác biểu mẫu sẽ được kích hoạt bằng thao tác onclick này nếu được chỉ định.

FormAction

Hành động đối với 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 dùng để xác định phần nào trong biểu mẫu đã kích hoạt lượt gửi biểu mẫu. Thông tin này được lặp lại cho ứng dụng Chat trong sự kiện nhấp 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 một hành vi phổ biến.

parameters[]

object (ActionParameter)

Danh sách 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ụ: xem xét 3 nút tạm ẩn: tạm hoãn ngay bây giờ, tạm hoãn một ngày, tạm ẩn vào tuần tới. Bạn có thể sử dụng action method = snooze() để truyền loại tạm ẩn và thời gian tạm ẩn 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 thông số cho tập lệnh hành động.

value

string

Giá trị của thông số.

KeyValue

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

Biểu diễn dưới dạng 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.
}
Trường
topLabel

string

Văn bản của nhãn trên cùng. Có hỗ trợ định dạng văn bản. Để biết thêm thông tin về việc đị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Định dạng văn bản trong Tiện ích bổ sung của Google Workspace.

content

string

Văn bản của nội dung. Hệ thống luôn hỗ trợ định dạng văn bản và luôn bắt buộc phải có. Để biết thêm thông tin về việc đị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Định dạng văn bản trong Tiện ích bổ sung của Google Workspace.

contentMultiline

boolean

Nội dung có phải nhiều dòng hay không.

bottomLabel

string

Văn bản của nhãn dưới cùng. Có hỗ trợ định dạng văn bản. Để biết thêm thông tin về việc đị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Định dạng văn bản trong Tiện ích bổ sung của Google Workspace.

onClick

object (OnClick)

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

Trường hợp icons. Bạn phải xác định ít nhất một trong các biểu tượng: top_labelbottom_label. icons chỉ có thể là một trong các trạng thái sau:
icon

enum (Icon)

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

iconUrl

string

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

Trường hợp control. Tiện ích điều khiển. Bạn có thể đặt button hoặc switch_widget, nhưng không thể đặt cả hai. control chỉ có thể là một trong các trạng thái sau:
button

object (Button)

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

Biểu tượng

Bộ 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

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
{

  // 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.
}
Trường

Trường hợp type.

type chỉ có thể là một trong các trạng thái sau:

textButton

object (TextButton)

Một nút có văn bản và thao tác onclick.

imageButton

object (ImageButton)

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

TextButton

Một nút có văn bản và thao tác 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)

Hành động onclick của nút.

ImageButton

Nút hình ảnh có thao tác onclick.

Biểu diễn dưới dạng 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.
}
Trường
onClick

object (OnClick)

Hành động onclick.

name

string

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

Trường hợp icons. Biểu tượng này có thể được chỉ định bằng Icon enum hoặc một URL. icons chỉ có thể là một trong các trạng thái sau:
icon

enum (Icon)

Biểu tượng do enum chỉ định và chỉ mục đến biểu tượng do API Chat cung cấp.

iconUrl

string

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

CardAction

Hành động đối với thẻ là một hành động được liên kết với thẻ. Đối với thẻ hoá đơn, thao tác điển hình sẽ 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 dùng để hiển thị trong mục trình đơn thao tác.

onClick

object (OnClick)

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