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 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 một đường phân chia.

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 bạn chỉ định cả tiêu đề và phụ đề, 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 hình vuông hoặc đường viền hình 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 mục 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 tại không cầ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 mục. 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.

widgets[]

object (WidgetMarkup)

Một mục 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. Buttons 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ể sử dụng nhiều trường WidgetMarkup để hiển thị nhiều mục hơn. 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 một đoạn văn bản trong tiện ích này.

image

object (Image)

Hiện 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 loại trừ lẫn nhau.

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 được chỉ định bằng một URL và có thể có một hành động 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. Thuộc tính 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 bằng cách tìm nạp trước hình ảnh.

OnClick

Một hành động 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)

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

Kết thúc các trường loại trừ lẫn nhau.

FormAction

Hành động của 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 gửi lại cho ứng dụng Chat dưới dạng một phần của 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 một hành vi chung.

parameters[]

object (ActionParameter)

Danh sách các tham 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 ba 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ể sử 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 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 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. Hỗ trợ văn bản được định dạng 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 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.

contentMultiline

boolean

Liệu nội dung có nên 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 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.

onClick

object (OnClick)

Thao tác onclick. 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)

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 được chỉ định bằng một URL.

Kết thúc các trường loại trừ lẫn nhau.
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 loại trừ lẫn nhau.

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

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)

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

Kết thúc các trường loại trừ lẫn nhau.

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

Nút hình ảnh có hành động 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)

Thao tác onclick.

name

string

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

Bạn có thể chỉ định biểu tượng bằng một 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 được chỉ định bằng một enum chỉ mục cho một biểu tượng do API Chat cung cấp.

iconUrl

string

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

Kết thúc các trường loại trừ lẫn nhau.

CardAction

Hành động trên thẻ là hành động liên quan đến thẻ. Đối với thẻ hoá đơn, một hành động 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ợ.

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)

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