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 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 đề 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 đường phân cách.

cardActions[]

object (CardAction)

Thao tác 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ụ đề đượ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ẽ 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 tròn.

Phần

Phần chứa một 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ả cá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. Văn bản được định dạng được hỗ trợ. Để biết thêm thông tin về cách định dạng văn bản, hãy xem Đị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)

Mỗi mục 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 oneof data và chỉ nên đặt một trong các trường này.

Trường kết hợp data. Đáp WidgetMarkup chỉ có thể có một trong các mục sau. Bạn có thể sử dụng nhiều 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

Đ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 Đị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 do URL chỉ định và có thể có onclick hành động.

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)

Chiến lược phát hành đĩa đơn onclick hành động.

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 đặt trước chiều cao phù hợp cho hình ảnh trong khi chờ tải hình ảnh. Chế độ 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 giá trị bằng cách tìm nạp trước hình ảnh.

OnClick

Một onclick (ví dụ: mở một 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 kết hợp data.

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

action

object (FormAction)

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

FormAction

Tác vụ 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 lặp lại ứng dụng Chat trong sự kiện nhấp 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 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ụ: hãy 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 hoãn vào tuần tiếp theo. Bạn có thể dùng action method = snooze(), truyền loại tạm ẩn và thời gian tạm hoãn trong danh sách 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

Phần tử 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ư 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. 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 Đị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. 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 Đị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 phải có nhiều dòng hay khô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 Đị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)

Chiến lược phát hành đĩa đơn onclick hành động. Chỉ nhãn trên cùng, nhãn dưới cùng và khu vực nội dung là có thể nhấp vào.

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

enum (Icon)

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

iconUrl

string

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

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

object (Button)

Nút mà người dùng có thể nhấp vào để kích hoạt mộ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

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
{

  // 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 kết hợp type.

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

textButton

object (TextButton)

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

imageButton

object (ImageButton)

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

TextButton

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

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)

Chiến lược phát hành đĩa đơn onclick hành động của nút.

ImageButton

Nút hình ảnh có onclick hành động.

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)

Chiến lược phát hành đĩa đơn onclick hành động.

name

string

Tên của sự kiện imageButton dùng cho việc 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 kết hợp icons. Có thể chỉ định biểu tượng 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ỉ mục tới một 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à hành động liên quan đến thẻ. Đối với thẻ hoá đơn, thao tác thông thường 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 từng xuất hiện trong mục trong trình đơn thao tác.

onClick

object (OnClick)

Hành động nhấp cho mục hành động này.