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 đườ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 hình 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 đế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ề 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 của Google Chat và Định dạng văn bản trong Tiện ích bổ sung cho Google Workspace.

widgets[]

object (WidgetMarkup)

Một 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 hiển thị 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à chỉ nên đặt một trong các trường này.

Trường kết 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ị thêm các mục. data chỉ có thể là một trong những giá trị 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. 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 bài viết Định dạng văn bản trong ứng dụng Google Chat và Đị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

Hình ảnh

Hình ảnh do một URL chỉ định 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)

Thao tác 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 đặt trước chiều cao phù hợp cho hình ảnh trong khi chờ hình ảnh tải. Tỷ lệ khung hình này không được 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 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 kết hợp data.

data chỉ được có thể là một trong những trạng thái sau đây:

action

object (FormAction)

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

FormAction

Hành động trong 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 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ụ: 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ể sử dụng action method = snooze(), truyền loại lệnh tạm ẩn và thời gian tạm ẩn vào 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

Một thành phần 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 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. 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 bài viết Định dạng văn bản trong ứng dụng Google Chat và Đị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ề 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 của Google Chat và Định dạng văn bản trong Tiện ích bổ sung cho 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ề 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 của 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. 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 hợp hợp nhất icons. Bạn phải xác định ít nhất một trong các biểu tượng top_label và bottom_label. icons chỉ được có thể là một trong những trạng thái sau đây:
icon

enum (Icon)

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 URL chỉ định.

Trường hợp hợp nhất control. 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. control chỉ được có thể là một trong những trạng thái sau đây:
button

object (Button)

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

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 
{

  // 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 hợp nhất type.

type chỉ được có thể là một trong những trạng thái sau đây:

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.

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,

  // 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 cho chức nă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 kết hợp icons. Bạn có thể chỉ định biểu tượng này bằng một Icon enum hoặc một URL. icons chỉ có thể là một trong những giá trị sau:
icon

enum (Icon)

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

iconUrl

string

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

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.

Ứng dụng Google Chat không hỗ trợ tính năng này.

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.