Package google.apps.card.v1

string

Hàm tuỳ chỉnh để gọi khi phần tử chứa được nhấp hoặc kích hoạt.

Để biết ví dụ về cách sử dụng, hãy xem phần Đọc dữ liệu biểu mẫu.

ActionParameter

Danh sách tham số hành động.

LoadIndicator

Chỉ định chỉ báo tải mà hành động hiển thị trong khi thực hiện lệnh gọi hành động.

bool

Cho biết liệu các giá trị biểu mẫu có tồn tại sau hành động hay không. Giá trị mặc định là false.

Nếu là true, các giá trị biểu mẫu sẽ vẫn còn sau khi hành động được kích hoạt. Để cho phép người dùng thay đổi trong khi thao tác đang được xử lý, hãy đặt LoadIndicator thành NONE. Đối với tin nhắn thẻ trong các ứng dụng trong Chat, bạn cũng phải đặt ResponseType của thao tác thành UPDATE_MESSAGE và sử dụng chính card_id trên thẻ chứa thao tác đó.

Nếu là false, các giá trị biểu mẫu sẽ bị xoá khi hành động được kích hoạt. Để ngăn người dùng thực hiện thay đổi trong khi thao tác đang được xử lý, hãy đặt LoadIndicator thành SPINNER.

Interaction

Không bắt buộc. Bắt buộc khi mở hộp thoại.

Việc cần làm để phản hồi một lượt tương tác với người dùng, chẳng hạn như người dùng nhấp vào một nút trong thông báo dạng thẻ.

Nếu không được chỉ định, ứng dụng sẽ phản hồi bằng cách thực thi action (như mở đường liên kết hoặc chạy một hàm) như bình thường.

Bằng cách chỉ định interaction, ứng dụng có thể phản hồi theo những cách tương tác đặc biệt. Ví dụ: khi đặt interaction thành OPEN_DIALOG, ứng dụng có thể mở một hộp thoại. Khi được chỉ định, chỉ báo tải sẽ không hiển thị. Nếu được chỉ định cho một tiện ích bổ sung, toàn bộ thẻ sẽ bị xoá và không có nội dung nào xuất hiện trong ứng dụng.

Dùng được trên các ứng dụng Google Chat và không dùng được cho các tiện ích bổ sung của Google Workspace.

string

Nếu các tiện ích được liệt kê ở đây không có giá trị khi Hành động này được gọi, thì quá trình gửi biểu mẫu sẽ bị huỷ.

Có sẵn cho các ứng dụng Google Chat và tiện ích bổ sung của Google Workspace.

bool

Có sẵn cho các ứng dụng Google Chat và tiện ích bổ sung của Google Workspace.

string

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

string

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

BorderType

Loại đường viền.

Color

Màu sắc cần sử dụng khi loại là BORDER_TYPE_STROKE.

Để đặt màu nét vẽ, hãy chỉ định một giá trị cho các trường red, green và blue. Giá trị phải là số thực từ 0 đến 1 dựa trên giá trị màu RGB, trong đó 0 (0/255) thể hiện không có màu và 1 (255/255) thể hiện cường độ tối đa của màu.

Ví dụ: mã sau đây đặt màu thành màu đỏ ở cường độ tối đa:

"color": {
   "red": 1,
   "green": 0,
   "blue": 0,
}

Trường alpha không dùng được cho màu nét vẽ. Nếu được chỉ định, trường này sẽ bị bỏ qua.

int32

Bán kính góc cho đường viền.

string

Văn bản xuất hiện bên trong nút.

Icon

Một biểu tượng xuất hiện bên trong nút. Nếu bạn đặt cả icon và text, thì biểu tượng sẽ xuất hiện trước văn bản.

Color

Không bắt buộc. Màu của nút. Nếu được đặt, nút type sẽ được đặt thành FILLED và màu của các trường text và icon sẽ được đặt thành màu tương phản để dễ đọc. Ví dụ: nếu màu nút được đặt thành màu xanh dương, thì mọi văn bản hoặc biểu tượng trong nút đều được đặt thành màu trắng.

Để đặt màu cho nút, hãy chỉ định giá trị cho các trường red, green và blue. Giá trị phải là số thực từ 0 đến 1 dựa trên giá trị màu RGB, trong đó 0 (0/255) thể hiện không có màu và 1 (255/255) thể hiện cường độ tối đa của màu.

Ví dụ: mã sau đây đặt màu thành màu đỏ ở cường độ tối đa:

"color": {
   "red": 1,
   "green": 0,
   "blue": 0,
}

Trường alpha không có sẵn cho màu nút. Nếu được chỉ định, trường này sẽ bị bỏ qua.

OnClick

Bắt buộc. Hành động sẽ thực hiện khi người dùng nhấp vào nút, chẳng hạn như mở siêu liên kết hoặc chạy hàm tuỳ chỉnh.

bool

Nếu là true, nút sẽ hiển thị ở trạng thái không hoạt động và không phản hồi thao tác của người dùng.

string

Văn bản thay thế dùng cho tính năng hỗ trợ tiếp cận.

Đặt văn bản mô tả để người dùng biết chức năng của nút. Ví dụ: nếu một nút mở một siêu liên kết, bạn có thể viết: "Mở một thẻ trình duyệt mới và chuyển đến tài liệu dành cho nhà phát triển Google Chat tại https://developers.google.com/workspace/chat".

Type

Không bắt buộc. Loại nút. Nếu bạn không đặt chính sách này, thì loại nút sẽ đặt mặc định thành OUTLINED. Nếu bạn đặt trường color, thì loại nút này sẽ buộc phải là FILLED và mọi giá trị đã đặt cho trường này sẽ bị bỏ qua.

Có sẵn cho các ứng dụng Google Chat và không có sẵn cho các tiện ích bổ sung của Google Workspace.

Button

Một mảng các nút.

CardHeader

Tiêu đề thẻ. Tiêu đề thường chứa một hình ảnh ở đầu và một tiêu đề. Tiêu đề luôn xuất hiện ở đầu thẻ.

Section

Chứa một bộ sưu tập tiện ích. Mỗi phần có tiêu đề riêng, không bắt buộc. Các phần được phân tách bằng một đường phân chia. Để xem ví dụ trong ứng dụng Google Chat, hãy xem phần Xác định một phần của thẻ.

DividerStyle

Kiểu phân chia giữa tiêu đề, các phần và chân trang.

CardAction

Thao tác của thẻ. Các thao tác sẽ được thêm vào trình đơn thanh công cụ của thẻ.

Có sẵn cho các tiện ích bổ sung của Google Workspace và không có sẵn cho các ứng dụng Google Chat.

Ví dụ: JSON sau đây tạo một trình đơn thao tác trên thẻ có các tuỳ chọn Settings và Send Feedback:

"card_actions": [
  {
    "actionLabel": "Settings",
    "onClick": {
      "action": {
        "functionName": "goToView",
        "parameters": [
          {
            "key": "viewType",
            "value": "SETTING"
         }
        ],
        "loadIndicator": "LoadIndicator.SPINNER"
      }
    }
  },
  {
    "actionLabel": "Send Feedback",
    "onClick": {
      "openLink": {
        "url": "https://example.com/feedback"
      }
    }
  }
]

string

Tên thẻ. Dùng làm giá trị nhận dạng thẻ trong thao tác điều hướng thẻ.

Có sẵn cho các tiện ích bổ sung của Google Workspace và không có sẵn cho các ứng dụng Google Chat.

CardFixedFooter

Chân trang cố định hiển thị ở cuối thẻ này.

Việc đặt fixedFooter mà không chỉ định primaryButton hoặc secondaryButton sẽ gây ra lỗi. Đối với ứng dụng Chat, bạn có thể sử dụng chân trang cố định trong hộp thoại, nhưng không thể sử dụng trong tin nhắn dạng thẻ.

Có sẵn cho các ứng dụng Google Chat và tiện ích bổ sung của Google Workspace.

DisplayStyle

Trong tiện ích bổ sung của Google Workspace, hãy thiết lập các thuộc tính hiển thị của peekCardHeader.

Có sẵn cho các tiện ích bổ sung của Google Workspace và không có sẵn cho các ứng dụng Google Chat.

CardHeader

Khi hiển thị nội dung theo bối cảnh, tiêu đề thẻ xem trước đóng vai trò là phần giữ chỗ để người dùng có thể di chuyển giữa các thẻ trang chủ và thẻ theo bối cảnh.

Có trong các tiện ích bổ sung của Google Workspace và không dùng được trong các ứng dụng Google Chat.

string

Nhãn hiển thị dưới dạng mục trong trình đơn thao tác.

OnClick

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

Button

Nút chính của chân trang cố định. Nút phải là nút văn bản có văn bản và màu được đặt.

Button

Nút phụ của chân trang cố định. Nút phải là nút văn bản có văn bản và màu được đặt. Nếu đặt secondaryButton thì bạn cũng phải đặt primaryButton.

string

Bắt buộc. Tiêu đề của tiêu đề thẻ. 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ỉ chỉ định tiêu đề, tiêu đề sẽ chiếm cả hai dòng.

string

Phụ đề của tiêu đề thẻ. Nếu được chỉ định, sẽ xuất hiện trên dòng riêng bên dưới title.

ImageType

Hình dạng dùng để cắt hình ảnh.

Có sẵn cho các ứng dụng Google Chat và tiện ích bổ sung của Google Workspace.

string

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

string

Văn bản thay thế của hình ảnh này dùng cho mục đích hỗ trợ tiếp cận.

string

Văn bản xuất hiện ở đầu một mục. Hỗ trợ văn bản có định dạng HTML đơn giả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 của Google Chat và Định dạng văn bản trong tiện ích bổ sung cho Google Workspace.

Widget

Tất cả tiện ích trong phần này. Phải chứa ít nhất một tiện ích.

bool

Cho biết liệu phần này có thể thu gọn hay không.

Các phần có thể thu gọn sẽ ẩn một số hoặc tất cả tiện ích, nhưng người dùng có thể mở rộng phần đó để hiển thị các tiện ích bị ẩn bằng cách nhấp vào Hiện thêm. Người dùng có thể ẩn các tiện ích một lần nữa bằng cách nhấp vào Ẩn bớt.

Để xác định các tiện ích nào bị ẩn, hãy chỉ định uncollapsibleWidgetsCount.

int32

Số lượng tiện ích không thể thu gọn vẫn hiển thị ngay cả khi một phần bị thu gọn.

Ví dụ: khi một mục chứa 5 tiện ích và đặt uncollapsibleWidgetsCount thành 2, thì 2 tiện ích đầu tiên sẽ luôn hiển thị còn 3 tiện ích cuối cùng sẽ được thu gọn theo mặc định. uncollapsibleWidgetsCount chỉ được tính đến khi collapsible là true.

CollapseControl

Không bắt buộc. Xác định nút mở rộng và thu gọn của phần. Nút này sẽ chỉ xuất hiện nếu phần đó có thể thu gọn. Nếu bạn không đặt trường này, thì nút mặc định sẽ được sử dụng. Có sẵn cho các ứng dụng Google Chat và không có sẵn cho các tiện ích bổ sung của Google Workspace.

Icon

Hình ảnh biểu tượng. Nếu bạn đặt cả icon và text, thì biểu tượng sẽ xuất hiện trước văn bản.

string

Văn bản hiển thị bên trong khối.

OnClick

Không bắt buộc. Hành động cần thực hiện khi người dùng nhấp vào khối, chẳng hạn như mở siêu liên kết hoặc chạy hàm tuỳ chỉnh.

bool

Liệu khối có ở trạng thái đang hoạt động và phản hồi các thao tác của người dùng hay không. Giá trị mặc định là true. Không dùng nữa. Thay vào đó, hãy sử dụng disabled.

bool

Liệu khối này có ở trạng thái không hoạt động và bỏ qua các thao tác của người dùng hay không. Giá trị mặc định là false.

string

Văn bản thay thế dùng cho tính năng hỗ trợ tiếp cận.

Đặt văn bản mô tả cho người dùng biết chức năng của khối. Ví dụ: Nếu một khối mở ra một siêu liên kết, hãy viết: "Mở một thẻ trình duyệt mới rồi chuyển đến tài liệu dành cho nhà phát triển Google Chat tại https://developers.google.com/workspace/chat".

Layout

Bố cục danh sách khối đã chỉ định.

Chip

Một mảng khối.

HorizontalAlignment

Căn chỉnh theo chiều ngang của nút mở rộng và thu gọn.

Button

Không bắt buộc. Xác định một nút có thể tuỳ chỉnh để mở rộng phần này. Bạn phải đặt cả trường expand_button và collapse_button. Chỉ một nhóm trường sẽ không có hiệu lực. Nếu bạn không đặt trường này, nút mặc định sẽ được sử dụng.

Button

Không bắt buộc. Xác định nút tuỳ chỉnh để thu gọn phần đó. Bạn phải đặt cả trường expand_button và collapse_button. Chỉ một nhóm trường sẽ không có hiệu lực. Nếu bạn không đặt trường này, thì nút mặc định sẽ được sử dụng.

Column

Một mảng cột. Bạn có thể đưa tối đa 2 cột vào một thẻ hoặc hộp thoại.

HorizontalSizeStyle

Chỉ định cách một cột lấp đầy chiều rộng của thẻ.

HorizontalAlignment

Chỉ định việc các tiện ích có căn chỉnh sang trái, phải hay giữa cột hay không.

VerticalAlignment

Chỉ định xem các tiện ích có căn chỉnh với đầu, cuối hay giữa cột hay không.

Widgets

Một mảng các tiện ích có trong một cột. Các tiện ích sẽ xuất hiện theo thứ tự được chỉ định.

TextParagraph

TextParagraph tiện ích.

Image

Image tiện ích.

DecoratedText

DecoratedText tiện ích.

ButtonList

ButtonList tiện ích.

TextInput

TextInput tiện ích.

SelectionInput

SelectionInput tiện ích.

DateTimePicker

DateTimePicker tiện ích.

ChipList

ChipList tiện ích. Có sẵn cho các ứng dụng Google Chat và không có sẵn cho các tiện ích bổ sung của Google Workspace.

string

Tên dùng để xác định DateTimePicker trong sự kiện nhập dữ liệu vào biểu mẫu.

Để biết thông tin chi tiết về cách xử lý dữ liệu đầu vào của biểu mẫu, hãy xem phần Nhận dữ liệu biểu mẫu.

string

Văn bản nhắc người dùng nhập ngày, giờ hoặc ngày và giờ. Ví dụ: nếu người dùng đang lên lịch hẹn, hãy sử dụng nhãn như Appointment date hoặc Appointment date and time.

DateTimePickerType

Liệu tiện ích có hỗ trợ nhập ngày, giờ hay cả ngày và giờ hay không.

int64

Giá trị mặc định hiển thị trong tiện ích, tính bằng mili giây kể từ thời gian bắt đầu của hệ thống Unix.

Chỉ định giá trị dựa trên loại bộ chọn (DateTimePickerType):

• DATE_AND_TIME: ngày và giờ theo lịch theo giờ UTC. Ví dụ: để biểu thị ngày 1 tháng 1 năm 2023 lúc 12:00 trưa theo giờ UTC, hãy sử dụng 1672574400000.
• DATE_ONLY: một ngày theo lịch lúc 00:00:00 giờ UTC. Ví dụ: để biểu thị ngày 1 tháng 1 năm 2023, hãy sử dụng 1672531200000.
• TIME_ONLY: thời gian theo giờ UTC. Ví dụ: để biểu thị 12:00 trưa, hãy sử dụng 43200000 (hoặc 12 * 60 * 60 * 1000).

int32

Số biểu thị độ lệch múi giờ so với giờ UTC, tính bằng phút. Nếu được đặt, value_ms_epoch sẽ hiển thị theo múi giờ đã chỉ định. Nếu bạn không đặt giá trị này, giá trị mặc định sẽ là chế độ cài đặt múi giờ của người dùng.

Action

Được kích hoạt khi người dùng nhấp vào Lưu hoặc Xoá trên giao diện DateTimePicker.

Validation

Có sẵn cho các ứng dụng Google Chat và tiện ích bổ sung của Google Workspace.

Icon

Ngừng sử dụng và thay bằng startIcon.

Icon

Biểu tượng hiển thị trước văn bản.

string

Văn bản xuất hiện phía trên text. Luôn cắt ngắn.

string

Bắt buộc. Văn bản chính.

Hỗ trợ định dạng đơn giả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 của Google Chat và Định dạng văn bản trong tiện ích bổ sung cho Google Workspace.

bool

Chế độ cài đặt xuống dòng tự động. Nếu là true, văn bản sẽ xuống dòng và hiển thị trên nhiều dòng. Nếu không, văn bản sẽ bị cắt bớt.

Chỉ áp dụng cho text, không áp dụng cho topLabel và bottomLabel.

string

Văn bản xuất hiện bên dưới text. Luôn gói.

OnClick

Thao tác này được kích hoạt khi người dùng nhấp vào topLabel hoặc bottomLabel.

Button

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

SwitchControl

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

Icon

Một biểu tượng xuất hiện sau văn bản.

Hỗ trợ biểu tượng tích hợp sẵn và biểu tượng tuỳ chỉnh.

string

Tên mà tiện ích nút chuyển được xác định trong một sự kiện nhập biểu mẫu.

Để biết thông tin chi tiết về cách xử lý dữ liệu đầu vào của biểu mẫu, hãy xem phần Nhận dữ liệu biểu mẫu.

string

Giá trị do người dùng nhập, được trả về như một phần của sự kiện nhập biểu mẫu.

Để biết thông tin chi tiết về cách xử lý dữ liệu đầu vào của biểu mẫu, hãy xem phần Nhận dữ liệu biểu mẫu.

bool

Khi true, nút chuyển sẽ được chọn.

Action

Thao tác cần thực hiện khi trạng thái của nút chuyển thay đổi, chẳng hạn như hàm cần chạy.

ControlType

Cách nút chuyển xuất hiện trong giao diện người dùng.

Có sẵn cho các ứng dụng Google Chat và tiện ích bổ sung của Google Workspace.

string

Văn bản xuất hiện trong tiêu đề lưới.

GridItem

Các mục sẽ hiển thị trong lưới.

BorderStyle

Kiểu đường viền áp dụng cho từng mục trong lưới.

int32

Số lượng cột cần hiển thị trong lưới. Giá trị mặc định sẽ được sử dụng nếu bạn không chỉ định trường này và giá trị mặc định đó sẽ khác nhau tuỳ thuộc vào vị trí hiển thị lưới (hộp thoại so với đồng hành).

OnClick

Mỗi mục lưới riêng lẻ sẽ sử dụng lại lệnh gọi lại này, nhưng với giá trị nhận dạng và chỉ mục của mục trong danh sách mục được thêm vào các tham số của lệnh gọi lại.

string

Giá trị nhận dạng do người dùng chỉ định cho mục trong lưới này. Giá trị nhận dạng này được trả về trong các tham số gọi lại onClick của lưới mẹ.

ImageComponent

Hình ảnh hiển thị trong mục lưới.

string

Tiêu đề của mục trong lưới.

string

Phụ đề của mục lưới.

GridItemLayout

Bố cục để sử dụng cho mục trong lưới.

string

Không bắt buộc. Nội dung mô tả biểu tượng dùng cho tính năng hỗ trợ tiếp cận. Nếu không chỉ định, hệ thống sẽ cung cấp giá trị mặc định là Button. Tốt nhất là bạn nên đặt nội dung mô tả hữu ích cho nội dung hiển thị của biểu tượng và chức năng của biểu tượng (nếu có). Ví dụ: A user's account portrait hoặc Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat.

Nếu biểu tượng này được đặt trong Button, thì altText sẽ xuất hiện dưới dạng văn bản trợ giúp khi người dùng di chuột qua nút. Tuy nhiên, nếu nút cũng đặt text, thì altText của biểu tượng sẽ bị bỏ qua.

ImageType

Kiểu cắt được áp dụng cho hình ảnh. Trong một số trường hợp, việc áp dụng tính năng cắt CIRCLE khiến hình ảnh được vẽ lớn hơn biểu tượng tích hợp.

string

Hiển thị một trong các biểu tượng tích hợp sẵn do Google Workspace cung cấp.

Ví dụ: để hiển thị biểu tượng máy bay, hãy chỉ định AIRPLANE. Đối với xe buýt, hãy chỉ định BUS.

Để biết danh sách đầy đủ các biểu tượng được hỗ trợ, hãy xem biểu tượng tích hợp sẵn.

string

Hiển thị một biểu tượng tuỳ chỉnh được lưu trữ tại một URL loại HTTPS.

Ví dụ:

"iconUrl":
"https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png"

Các loại tệp được hỗ trợ bao gồm .png và .jpg.

MaterialIcon

Hiển thị một trong các Biểu tượng Material của Google.

Ví dụ: để hiển thị biểu tượng hộp đánh dấu, hãy sử dụng

"material_icon": {
  "name": "check_box"
}

Có sẵn cho các ứng dụng Google Chat và không có sẵn cho các tiện ích bổ sung của Google Workspace.

string

URL HTTPS lưu trữ hình ảnh.

Ví dụ:

https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png

OnClick

Khi người dùng nhấp vào hình ảnh, lượt nhấp đó sẽ kích hoạt hành động này.

string

Văn bản thay thế của hình ảnh này dùng cho mục đích hỗ trợ tiếp cận.

string

URL của hình ảnh.

string

Nhãn hỗ trợ tiếp cận cho hình ảnh.

ImageCropStyle

Kiểu cắt sẽ áp dụng cho hình ảnh.

BorderStyle

Kiểu đường viền để áp dụng cho hình ảnh.

ImageCropType

Kiểu cắt.

double

Tỷ lệ khung hình cần sử dụng nếu kiểu cắt là RECTANGLE_CUSTOM.

Ví dụ: sau đây là cách áp dụng tỷ lệ khung hình 16:9:

cropStyle {
 "type": "RECTANGLE_CUSTOM",
 "aspectRatio": 16/9
}

string

Tên biểu tượng được xác định trong Biểu tượng Google Material, ví dụ: check_box. Mọi tên không hợp lệ đều bị bỏ qua và thay thế bằng chuỗi trống, khiến biểu tượng không hiển thị.

bool

Biểu tượng có hiển thị đầy hay không. Giá trị mặc định là sai.

Để xem trước các chế độ cài đặt biểu tượng khác nhau, hãy chuyển đến phần Biểu tượng phông chữ của Google rồi điều chỉnh chế độ cài đặt trong phần Tuỳ chỉnh.

int32

Độ đậm của nét vẽ biểu tượng. Chọn {100, 200, 300, 400, 500, 600, 700}. Nếu không có, giá trị mặc định sẽ là 400. Nếu bạn chỉ định giá trị nào khác, giá trị mặc định sẽ được sử dụng.

Để xem trước các chế độ cài đặt biểu tượng khác nhau, hãy chuyển đến phần Biểu tượng phông chữ của Google rồi điều chỉnh chế độ cài đặt trong phần Tuỳ chỉnh.

int32

Độ đậm và độ đậm ảnh hưởng đến độ dày của ký hiệu. Việc điều chỉnh điểm sẽ chi tiết hơn so với việc điều chỉnh trọng số và có tác động nhỏ đến kích thước của ký hiệu. Chọn trong số {-25, 0, 200}. Nếu không có, giá trị mặc định sẽ là 0. Nếu bạn chỉ định giá trị nào khác, giá trị mặc định sẽ được sử dụng.

Để xem trước các chế độ cài đặt biểu tượng khác nhau, hãy chuyển đến phần Biểu tượng phông chữ của Google rồi điều chỉnh chế độ cài đặt trong phần Tuỳ chỉnh.

Action

Nếu được chỉ định, một hành động sẽ được kích hoạt bởi onClick này.

OpenLink

Nếu được chỉ định, onClick này sẽ kích hoạt thao tác mở đường liên kết.

Action

Tiện ích bổ sung kích hoạt hành động này khi hành động cần mở một đường liên kết. Phương thức này khác với open_link ở trên ở chỗ phương thức này cần giao tiếp với máy chủ để lấy đường liên kết. Do đó, ứng dụng web cần thực hiện một số công việc chuẩn bị trước khi phản hồi hành động mở đường liên kết được trả về.

Có sẵn cho các tiện ích bổ sung của Google Workspace và không có sẵn cho các ứng dụng Google Chat.

Card

Thẻ mới sẽ được đẩy vào ngăn xếp thẻ sau khi nhấp nếu được chỉ định.

Có sẵn cho các tiện ích bổ sung của Google Workspace và không có sẵn cho các ứng dụng Google Chat.

OverflowMenu

Nếu được chỉ định, onClick này sẽ mở một trình đơn mục bổ sung. Có sẵn cho các ứng dụng Google Chat và không có sẵn cho các tiện ích bổ sung của Google Workspace.

string

URL cần mở.

OpenAs

Cách mở đường liên kết.

Có sẵn cho các tiện ích bổ sung của Google Workspace và không có sẵn cho các ứng dụng Google Chat.

OnClose

Liệu ứng dụng có quên một đường liên kết sau khi mở hay quan sát đường liên kết đó cho đến khi cửa sổ đóng lại hay không.

Có sẵn cho các tiện ích bổ sung của Google Workspace và không có sẵn cho các ứng dụng Google Chat.

OverflowMenuItem

Bắt buộc. Danh sách các tuỳ chọn trên trình đơn.

Icon

Biểu tượng hiển thị trước văn bản.

string

Bắt buộc. Văn bản giúp người dùng xác định hoặc mô tả mặt hàng.

OnClick

Bắt buộc. Thao tác được gọi khi một mục trong trình đơn được chọn. OnClick này không được chứa OverflowMenu, mọi OverflowMenu được chỉ định sẽ bị loại bỏ và mục trình đơn sẽ bị vô hiệu hoá.

bool

Liệu tuỳ chọn trình đơn có bị tắt hay không. Giá trị mặc định là false.

string

Bắt buộc. Tên xác định dữ liệu đầu vào được chọn trong sự kiện nhập dữ liệu vào biểu mẫu.

Để biết thông tin chi tiết về cách xử lý dữ liệu đầu vào của biểu mẫu, hãy xem phần Nhận dữ liệu biểu mẫu.

string

Văn bản xuất hiện phía trên trường nhập lựa chọn trong giao diện người dùng.

Chỉ định văn bản để giúp người dùng nhập thông tin mà ứng dụng của bạn cần. Ví dụ: nếu người dùng đang chọn mức độ khẩn cấp của phiếu yêu cầu hỗ trợ từ trình đơn thả xuống, thì nhãn có thể là "Mức độ khẩn cấp" hoặc "Chọn mức độ khẩn cấp".

SelectionType

Loại mục hiển thị cho người dùng trong tiện ích SelectionInput. Các loại lựa chọn hỗ trợ nhiều loại tương tác. Ví dụ: người dùng có thể chọn một hoặc nhiều hộp đánh dấu, nhưng chỉ có thể chọn một giá trị trong trình đơn thả xuống.

SelectionItem

Một mảng chứa các mục có thể chọn. Ví dụ: một loạt các nút chọn hoặc hộp đánh dấu. Hỗ trợ tối đa 100 mục.

Action

Nếu được chỉ định, biểu mẫu sẽ được gửi khi lựa chọn thay đổi. Nếu không được chỉ định, bạn phải chỉ định một nút riêng biệt gửi biểu mẫu.

Để biết thông tin chi tiết về cách xử lý dữ liệu đầu vào của biểu mẫu, hãy xem phần Nhận dữ liệu biểu mẫu.

int32

Đối với trình đơn chọn nhiều mục, số lượng mục tối đa mà người dùng có thể chọn. Giá trị tối thiểu là 1 mục. Nếu không được chỉ định, giá trị mặc định là 3 mục.

int32

Đối với trình đơn đa lựa chọn, số ký tự văn bản mà người dùng nhập trước khi trình đơn trả về các mục lựa chọn được đề xuất.

Nếu bạn không đặt chính sách này, trình đơn chọn nhiều mục sẽ sử dụng các giá trị mặc định sau:

• Nếu trình đơn sử dụng một mảng tĩnh gồm các mục SelectionInput, thì mặc định là 0 ký tự và sẽ điền ngay các mục từ mảng đó.
• Nếu trình đơn sử dụng nguồn dữ liệu động (multi_select_data_source), thì mặc định là 3 ký tự trước khi truy vấn nguồn dữ liệu để trả về các mục được đề xuất.

Validation

Đối với trình đơn thả xuống, hãy xác thực trường nhập dữ liệu của lựa chọn này.

Có sẵn cho các ứng dụng Google Chat và tiện ích bổ sung của Google Workspace.

Action

Nguồn dữ liệu bên ngoài, chẳng hạn như cơ sở dữ liệu quan hệ.

PlatformDataSource

Một nguồn dữ liệu trên Google Workspace.

CommonDataSource

Một nguồn dữ liệu dùng chung cho tất cả ứng dụng của Google Workspace, chẳng hạn như người dùng trong một tổ chức trên Google Workspace.

HostAppDataSourceMarkup

Một nguồn dữ liệu dành riêng cho ứng dụng lưu trữ Google Workspace, chẳng hạn như các không gian trong Google Chat.

Trường này hỗ trợ Thư viện ứng dụng API của Google nhưng không có trong Thư viện ứng dụng trên đám mây. Để tìm hiểu thêm, hãy xem phần Cài đặt thư viện ứng dụng.

string

Văn bản giúp người dùng xác định hoặc mô tả mặt hàng.

string

Giá trị liên kết với mục này. Khách hàng nên sử dụng giá trị này làm giá trị nhập vào biểu mẫu.

Để biết thông tin chi tiết về cách xử lý dữ liệu đầu vào của biểu mẫu, hãy xem phần Nhận dữ liệu biểu mẫu.

bool

Liệu mục đó có được chọn theo mặc định hay không. Nếu dữ liệu đầu vào lựa chọn chỉ chấp nhận một giá trị (chẳng hạn như đối với nút chọn hoặc trình đơn thả xuống), hãy chỉ đặt trường này cho một mục.

string

Đối với trình đơn đa lựa chọn, URL của biểu tượng sẽ hiển thị bên cạnh trường text của mục. Hỗ trợ tệp PNG và JPEG. Phải là URL HTTPS. Ví dụ: https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png.

string

Đối với trình đơn nhiều lựa chọn, một nhãn hoặc nội dung mô tả văn bản sẽ xuất hiện bên dưới trường text của mục.

SuggestionItem

Danh sách các đề xuất được dùng cho các đề xuất tự động hoàn thành trong các trường nhập dữ liệu văn bản.

string

Giá trị của dữ liệu đầu vào được đề xuất cho trường nhập văn bản. Giá trị này tương đương với giá trị mà người dùng tự nhập.

string

Tên dùng để xác định hoạt động nhập văn bản trong một sự kiện nhập dữ liệu vào biểu mẫu.

Để biết thông tin chi tiết về cách xử lý dữ liệu đầu vào của biểu mẫu, hãy xem phần Nhận dữ liệu biểu mẫu.

string

Văn bản xuất hiện phía trên trường nhập văn bản trong giao diện người dùng.

Chỉ định văn bản để giúp người dùng nhập thông tin mà ứng dụng của bạn cần. Ví dụ: nếu bạn đang hỏi tên một người nhưng lại cần họ của người đó, hãy viết surname thay vì name.

Bắt buộc nếu bạn không chỉ định hintText. Nếu không, không bắt buộc.

string

Văn bản xuất hiện bên dưới trường nhập văn bản nhằm hỗ trợ người dùng bằng cách nhắc họ nhập một giá trị nhất định. Văn bản này luôn hiển thị.

Bắt buộc nếu bạn chưa chỉ định label. Nếu không thì không bắt buộc.

string

Giá trị do người dùng nhập, được trả về như một phần của sự kiện nhập biểu mẫu.

Để biết thông tin chi tiết về cách xử lý dữ liệu đầu vào của biểu mẫu, hãy xem phần Nhận dữ liệu biểu mẫu.

Type

Cách trường nhập văn bản xuất hiện trong giao diện người dùng. Ví dụ: trường là một dòng hay nhiều dòng.

Action

Việc cần làm khi có thay đổi trong trường nhập văn bản. Ví dụ: người dùng thêm vào trường hoặc xoá văn bản.

Ví dụ về những hành động cần thực hiện: chạy một hàm tuỳ chỉnh hoặc mở một hộp thoại trong Google Chat.

Suggestions

Giá trị đề xuất mà người dùng có thể nhập. Các giá trị này xuất hiện khi người dùng nhấp vào bên trong trường nhập văn bản. Khi người dùng nhập, các giá trị được đề xuất sẽ lọc một cách linh động để khớp với nội dung mà người dùng đã nhập.

Ví dụ: trường nhập văn bản cho ngôn ngữ lập trình có thể đề xuất Java, JavaScript, Python và C++. Khi người dùng bắt đầu nhập Jav, danh sách bộ lọc đề xuất sẽ chỉ hiển thị Java và JavaScript.

Giá trị đề xuất giúp hướng dẫn người dùng nhập những giá trị mà ứng dụng của bạn có thể hiểu được. Khi tham chiếu đến JavaScript, một số người dùng có thể nhập javascript và một số người dùng khác có thể nhập java script. Việc đề xuất JavaScript có thể chuẩn hoá cách người dùng tương tác với ứng dụng của bạn.

Khi được chỉ định, TextInput.type luôn là SINGLE_LINE, ngay cả khi được đặt thành MULTIPLE_LINE.

Có sẵn cho các ứng dụng Google Chat và tiện ích bổ sung của Google Workspace.

Action

Không bắt buộc. Chỉ định hành động cần thực hiện khi trường nhập văn bản đưa ra đề xuất cho những người dùng tương tác với trường đó.

Nếu không chỉ định, initialSuggestions sẽ đặt các đề xuất và ứng dụng sẽ xử lý các đề xuất đó.

Nếu được chỉ định, ứng dụng sẽ thực hiện thao tác nêu tại đây, chẳng hạn như chạy một hàm tuỳ chỉnh.

Có sẵn cho các tiện ích bổ sung của Google Workspace và không có sẵn cho các ứng dụng Google Chat.

Validation

Dành cho các ứng dụng Google Chat và tiện ích bổ sung của Google Workspace.

string

Văn bản xuất hiện trong trường nhập văn bản khi trường này trống. Sử dụng văn bản này để nhắc người dùng nhập một giá trị. Ví dụ: Enter a number from 0 to 100.

Dùng được trên các ứng dụng Google Chat và không dùng được cho các tiện ích bổ sung của Google Workspace.

string

Văn bản hiển thị trong tiện ích.

int32

Số dòng văn bản tối đa hiển thị trong tiện ích. Nếu văn bản vượt quá số dòng tối đa đã chỉ định, thì nội dung thừa sẽ được ẩn sau nút hiển thị thêm. Nếu văn bản bằng hoặc ngắn hơn số dòng tối đa được chỉ định, thì nút hiện thêm sẽ không xuất hiện.

Giá trị mặc định là 0, trong trường hợp này, tất cả ngữ cảnh sẽ hiển thị. Hệ thống sẽ bỏ qua các giá trị âm. Dùng được trên các ứng dụng Google Chat và không dùng được cho các tiện ích bổ sung của Google Workspace.

int32

Có sẵn cho các ứng dụng Google Chat và tiện ích bổ sung của Google Workspace.

InputType

Có sẵn cho các ứng dụng Google Chat và tiện ích bổ sung của Google Workspace.

HorizontalAlignment

Chỉ định việc các tiện ích có căn chỉnh sang trái, phải hay giữa cột hay không.

TextParagraph

Hiển thị một đoạn văn bản. Hỗ trợ văn bản có định dạng HTML đơn giản. Để 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.

Ví dụ: JSON sau đây sẽ tạo văn bản in đậm:

"textParagraph": {
  "text": "  <b>bold text</b>"
}

Image

Hiển thị hình ảnh.

Ví dụ: JSON sau đây sẽ tạo một hình ảnh có văn bản thay thế:

"image": {
  "imageUrl":
  "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png",
  "altText": "Chat app avatar"
}

DecoratedText

Hiển thị một mục văn bản được trang trí.

Ví dụ: JSON sau đây tạo một tiện ích văn bản được trang trí hiển thị địa chỉ email:

"decoratedText": {
  "icon": {
    "knownIcon": "EMAIL"
  },
  "topLabel": "Email Address",
  "text": "sasha@example.com",
  "bottomLabel": "This is a new Email address!",
  "switchControl": {
    "name": "has_send_welcome_email_to_sasha",
    "selected": false,
    "controlType": "CHECKBOX"
  }
}

ButtonList

Danh sách các nút.

Ví dụ: tệp JSON sau đây tạo ra hai nút. Đầu tiên là nút văn bản màu xanh dương còn nút thứ hai là nút hình ảnh mở ra một đường liên kết:

"buttonList": {
  "buttons": [
    {
      "text": "Edit",
      "color": {
        "red": 0,
        "green": 0,
        "blue": 1,
      },
      "disabled": true,
    },
    {
      "icon": {
        "knownIcon": "INVITE",
        "altText": "check calendar"
      },
      "onClick": {
        "openLink": {
          "url": "https://example.com/calendar"
        }
      }
    }
  ]
}

TextInput

Hiển thị một hộp văn bản mà người dùng có thể nhập vào.

Ví dụ: JSON sau đây tạo một mục nhập văn bản cho địa chỉ email:

"textInput": {
  "name": "mailing_address",
  "label": "Mailing Address"
}

Ví dụ khác: JSON sau đây tạo một dữ liệu đầu vào văn bản cho một ngôn ngữ lập trình có các đề xuất tĩnh:

"textInput": {
  "name": "preferred_programing_language",
  "label": "Preferred Language",
  "initialSuggestions": {
    "items": [
      {
        "text": "C++"
      },
      {
        "text": "Java"
      },
      {
        "text": "JavaScript"
      },
      {
        "text": "Python"
      }
    ]
  }
}

SelectionInput

Hiển thị một thành phần điều khiển lựa chọn cho phép người dùng chọn các mục. Thành phần điều khiển lựa chọn có thể là hộp đánh dấu, nút chọn, nút chuyển hoặc trình đơn thả xuống.

Ví dụ: JSON sau đây tạo một trình đơn thả xuống cho phép người dùng chọn kích thước:

"selectionInput": {
  "name": "size",
  "label": "Size"
  "type": "DROPDOWN",
  "items": [
    {
      "text": "S",
      "value": "small",
      "selected": false
    },
    {
      "text": "M",
      "value": "medium",
      "selected": true
    },
    {
      "text": "L",
      "value": "large",
      "selected": false
    },
    {
      "text": "XL",
      "value": "extra_large",
      "selected": false
    }
  ]
}

DateTimePicker

Hiển thị một tiện ích cho phép người dùng nhập ngày, giờ hoặc ngày và giờ.

Ví dụ: JSON sau đây tạo một bộ chọn ngày giờ để lên lịch hẹn:

"dateTimePicker": {
  "name": "appointment_time",
  "label": "Book your appointment at:",
  "type": "DATE_AND_TIME",
  "valueMsEpoch": "796435200000"
}

Divider

Hiển thị một đường phân chia theo chiều ngang giữa các tiện ích.

Ví dụ: JSON sau đây tạo một đường phân cách:

"divider": {
}

Grid

Hiển thị một lưới có một bộ sưu tập các mục.

Lưới hỗ trợ số lượng cột và mục bất kỳ. Số hàng được xác định bằng cách lấy giới hạn trên của số mục chia cho số cột. Một lưới có 10 mục và 2 cột sẽ có 5 hàng. Một lưới có 11 mục và 2 cột sẽ có 6 hàng.

Có sẵn cho các ứng dụng Google Chat và tiện ích bổ sung của Google Workspace.

Ví dụ: JSON sau đây tạo một lưới 2 cột với một mục duy nhất:

"grid": {
  "title": "A fine collection of items",
  "columnCount": 2,
  "borderStyle": {
    "type": "STROKE",
    "cornerRadius": 4
  },
  "items": [
    {
      "image": {
        "imageUri": "https://www.example.com/image.png",
        "cropStyle": {
          "type": "SQUARE"
        },
        "borderStyle": {
          "type": "STROKE"
        }
      },
      "title": "An item",
      "textAlignment": "CENTER"
    }
  ],
  "onClick": {
    "openLink": {
      "url": "https://www.example.com"
    }
  }
}

Columns

Hiển thị tối đa 2 cột.

Để thêm nhiều hơn 2 cột hoặc để sử dụng hàng, hãy dùng tiện ích Grid.

Ví dụ: JSON sau đây tạo 2 cột, mỗi cột chứa các đoạn văn bản:

"columns": {
  "columnItems": [
    {
      "horizontalSizeStyle": "FILL_AVAILABLE_SPACE",
      "horizontalAlignment": "CENTER",
      "verticalAlignment": "CENTER",
      "widgets": [
        {
          "textParagraph": {
            "text": "First column text paragraph"
          }
        }
      ]
    },
    {
      "horizontalSizeStyle": "FILL_AVAILABLE_SPACE",
      "horizontalAlignment": "CENTER",
      "verticalAlignment": "CENTER",
      "widgets": [
        {
          "textParagraph": {
            "text": "Second column text paragraph"
          }
        }
      ]
    }
  ]
}

ChipList

Danh sách các khối.

Ví dụ: JSON sau đây sẽ tạo ra hai khối. Thẻ đầu tiên là thẻ văn bản và thẻ thứ hai là thẻ biểu tượng mở đường liên kết:

"chipList": {
  "chips": [
    {
      "text": "Edit",
      "disabled": true,
    },
    {
      "icon": {
        "knownIcon": "INVITE",
        "altText": "check calendar"
      },
      "onClick": {
        "openLink": {
          "url": "https://example.com/calendar"
        }
      }
    }
  ]
}

Dùng được trên các ứng dụng Google Chat và không dùng được cho các tiện ích bổ sung của Google Workspace.