Package google.apps.card.v1

Chỉ mục

Hành động

Thao tác mô tả hành vi khi biểu mẫu được gửi. Ví dụ: bạn có thể gọi một tập lệnh Apps Script để xử lý biểu mẫu. Nếu hành động được kích hoạt, các giá trị trong biểu mẫu sẽ được gửi đến máy chủ.

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

Trường
function

string

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

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

parameters[]

ActionParameter

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

loadIndicator

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.

persistValues

bool

Cho biết liệu giá trị của biểu mẫu có còn sau thao tác này hay không. Giá trị mặc định là false.

Nếu giá trị là true, các giá trị của biểu mẫu sẽ vẫn tồn tại sau khi bạn kích hoạt hành động. Để 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 hành động đang được xử lý, hãy đặt LoadIndicator thành SPINNER.

interaction

Interaction

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

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

Nếu bạn không chỉ định, ứng dụng sẽ phản hồi bằng cách thực thi một action (chẳng hạn như mở một đườ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 các 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 bạn chỉ định cho một tiện ích bổ sung, thì toàn bộ thẻ sẽ bị xoá và không có nội dung nào hiển thị trong ứng dụng.

Có trong 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.

requiredWidgets[]

string

Không bắt buộc. Điền tên của các tiện ích cần thiết cho Hành động này để gửi một lượt gửi hợp lệ vào danh sách này.

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ỷ.

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

allWidgetsAreRequired

bool

Không bắt buộc. Nếu đúng, thì thao tác này sẽ coi tất cả tiện ích đều là bắt buộc.

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

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 hoặc 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 tạm ẩn và thời gian tạm ẩn trong danh sách tham số chuỗi.

Để tìm hiểu thêm, hãy xem CommonEventObject.

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

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ố.

Tương tác

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

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

Nếu bạn không chỉ định, ứng dụng sẽ phản hồi bằng cách thực thi một action (chẳng hạn như mở một đườ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 các 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 bạn chỉ định cho một tiện ích bổ sung, thì toàn bộ thẻ sẽ bị xoá và không có nội dung nào hiển thị trong ứng dụng.

Có trong 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.

Enum
INTERACTION_UNSPECIFIED Giá trị mặc định. action thực thi như bình thường.
OPEN_DIALOG

Mở một hộp thoại, một giao diện cửa sổ dựa trên thẻ mà các ứng dụng trong Chat dùng để tương tác với người dùng.

Chỉ được các ứng dụng trong Chat hỗ trợ khi người dùng nhấp vào các nút trong tin nhắn trên thẻ. Nếu bạn chỉ định cho một tiện ích bổ sung, thì toàn bộ thẻ sẽ bị xoá và không có nội dung nào hiển thị trong ứng dụng.

Có trong 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.

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.

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

Enum
SPINNER Hiển thị vòng quay để cho biết nội dung đang tải.
NONE Không có nội dung nào hiển thị.

BorderStyle

Các lựa chọn kiểu cho đường viền của thẻ hoặc tiện ích, bao gồm cả loại đường viền và màu sắc.

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

Trường
type

BorderType

Loại đường viền.

strokeColor

Color

Màu sẽ được 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, greenblue. Giá trị này phải là số thực có độ chính xác đơn từ 0 đến 1 dựa trên giá trị màu RGB, trong đó 0 (0/255) thể hiện trường hợp không có màu và 1 (255/255) thể hiện cường độ màu tối đa.

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 áp dụng được cho màu nét vẽ. Nếu bạn chỉ định, trường này sẽ bị bỏ qua.

cornerRadius

int32

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

BorderType

Biểu thị các loại đường viền được áp dụng cho tiện ích.

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

Enum
BORDER_TYPE_UNSPECIFIED Không sử dụng. Không xác định.
NO_BORDER Giá trị mặc định. Không có đường viền.
STROKE Outline.

Nút

Người dùng có thể nhấp vào một nút văn bản, biểu tượng hoặc văn bản và biểu tượng. Để xem ví dụ trong các ứng dụng Google Chat, hãy xem phần Thêm nút.

Để hình ảnh trở thành một nút có thể nhấp vào, hãy chỉ định Image (không phải ImageComponent) và đặt một hành động onClick.

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

Trường
text

string

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

icon

Icon

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

color

Color

Không bắt buộc. Màu của nút. Nếu bạn đặt chính sách này, nút type sẽ được đặt thành FILLED, còn màu của trường texticon sẽ được đặt thành màu tương phản để dễ đọc hơn. Ví dụ: nếu màu của 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 đó cũng sẽ đượ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, greenblue. Giá trị này phải là số thực có độ chính xác đơn từ 0 đến 1 dựa trên giá trị màu RGB, trong đó 0 (0/255) thể hiện trường hợp không có màu và 1 (255/255) thể hiện cường độ màu tối đa.

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ành cho màu nút. Nếu bạn chỉ định, trường này sẽ bị bỏ qua.

onClick

OnClick

Bắt buộc. Hành động sẽ được 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.

disabled

bool

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

altText

string

Văn bản thay thế được dùng cho khả năng tiếp cận.

Đặt văn bản mô tả cho người dùng biết chức năng của nút này. Ví dụ: Nếu một nút mở ra một siêu liên kết, thì bạn có thể 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".

type

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ó trong 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.

Loại

Không bắt buộc. Loại nút. Nếu bạn đặt trường color, type sẽ buộc phải là FILLED.

Có trong 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.

Enum
TYPE_UNSPECIFIED Không sử dụng. Không xác định.
OUTLINED Nút có đường viền là các nút có mức độ nhấn mạnh trung bình. Các mục này thường chứa các hành động quan trọng nhưng không phải là hành động chính trong ứng dụng Chat hoặc tiện ích bổ sung.
FILLED Nút tô màu nền có vùng chứa có màu đồng nhất. Đây là mẫu quảng cáo có tác động trực quan nhất và nên dùng cho hành động quan trọng và chính trong ứng dụng Chat hoặc tiện ích bổ sung.
FILLED_TONAL Nút tô màu nền là trung tâm thay thế giữa các nút tô màu nền và có đường viền. Nút này sẽ hữu ích trong những bối cảnh mà nút có mức độ ưu tiên thấp hơn yêu cầu nhấn mạnh hơn một chút so với nút có bố cục.
BORDERLESS Nút không có vùng chứa ẩn ở trạng thái mặc định. Chế độ này thường được dùng cho các hành động có mức độ ưu tiên thấp nhất, đặc biệt là khi trình bày nhiều lựa chọn.

ButtonList

Danh sách các nút được bố trí theo chiều ngang. Để xem ví dụ trong các ứng dụng Google Chat, hãy xem phần Thêm nút.

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

Trường
buttons[]

Button

Một loạt các nút.

Thẻ

Giao diện thẻ xuất hiện trong tin nhắn trong Google Chat hoặc tiện ích bổ sung của Google Workspace.

Thẻ hỗ trợ một bố cục xác định, các phần tử tương tác trên giao diện người dùng như nút và nội dung đa phương tiện như hình ảnh. Sử dụng các thẻ để trình bày thông tin chi tiết, thu thập thông tin từ người dùng và hướng dẫn người dùng thực hiện bước tiếp theo.

Thiết kế và xem trước thẻ bằng Trình tạo thẻ.

Mở Trình tạo thẻ

Để tìm hiểu cách tạo thẻ, hãy xem tài liệu sau:

Ví dụ: Tin nhắn thẻ cho một ứng dụng Google Chat

Ví dụ về thẻ liên hệ

Để tạo tin nhắn mẫu cho thẻ trong Google Chat, hãy dùng tệp JSON sau:

{
  "cardsV2": [
    {
      "cardId": "unique-card-id",
      "card": {
        "header": {
           "title": "Sasha",
           "subtitle": "Software Engineer",
           "imageUrl":
           "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png",
           "imageType": "CIRCLE",
           "imageAltText": "Avatar for Sasha"
         },
         "sections": [
           {
             "header": "Contact Info",
             "collapsible": true,
             "uncollapsibleWidgetsCount": 1,
             "widgets": [
               {
                 "decoratedText": {
                   "startIcon": {
                     "knownIcon": "EMAIL"
                   },
                   "text": "sasha@example.com"
                 }
               },
               {
                 "decoratedText": {
                   "startIcon": {
                     "knownIcon": "PERSON"
                   },
                   "text": "<font color=\"#80e27e\">Online</font>"
                 }
               },
               {
                 "decoratedText": {
                   "startIcon": {
                     "knownIcon": "PHONE"
                   },
                   "text": "+1 (555) 555-1234"
                 }
               },
               {
                 "buttonList": {
                   "buttons": [
                     {
                       "text": "Share",
                       "onClick": {
                        "openLink": {
                           "url": "https://example.com/share"
                         }
                       }
                     },
                     {
                       "text": "Edit",
                       "onClick": {
                         "action": {
                           "function": "goToView",
                           "parameters": [
                             {
                               "key": "viewType",
                               "value": "EDIT"
                             }
                           ]
                         }
                       }
                     }
                   ]
                 }
               }
             ]
           }
         ]
       }
    }
  ]
}
Trường
header

CardHeader

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

sections[]

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 trực quan bằng đường phân cách dòng. Để xem ví dụ trong các ứng dụng Google Chat, hãy xem phần Xác định một mục của thẻ.

sectionDividerStyle

DividerStyle

Kiểu phân cách giữa các phần.

cardActions[]

CardAction

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

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.

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

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

string

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

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.

fixedFooter

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 các ứng dụng nhắn tin, bạn có thể sử dụng chân trang cố định trong hộp thoại, nhưng không thể dùng thẻ tin nhắn.

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

displayStyle

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ó 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.

peekCardHeader

CardHeader

Khi hiển thị nội dung theo ngữ cảnh, tiêu đề của thẻ xem trước hoạt động như một phần giữ chỗ để người dùng có thể di chuyển tiếp 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.

CardAction

Hành động đối với thẻ là hành động liên quan đến thẻ. Ví dụ: thẻ hoá đơn có thể bao gồm các thao tác như xoá hoá đơn, gửi hoá đơn qua email hoặc mở hoá đơn trong trình duyệt.

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.

Trường
actionLabel

string

Nhãn xuất hiện dưới dạng mục trong trình đơn thao tác.

onClick

OnClick

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

CardFixedFooter

Một chân trang cố định (cố định) xuất hiện ở cuối thẻ.

Việc đặt fixedFooter mà không chỉ định primaryButton hoặc secondaryButton sẽ gây ra lỗi.

Đối với các ứng dụng nhắn tin, bạn có thể sử dụng chân trang cố định trong hộp thoại, nhưng không thể dùng thẻ tin nhắn. Để xem ví dụ trong các ứng dụng Google Chat, hãy xem phần Thêm chân trang cố định.

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

Trường
primaryButton

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à được đặt màu.

secondaryButton

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à được đặt màu. Nếu đặt secondaryButton thì bạn cũng phải đặt primaryButton.

CardHeader

Đại diện cho tiêu đề thẻ. Để xem ví dụ trong các ứng dụng Google Chat, hãy xem phần Thêm tiêu đề.

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

Trường
title

string

Bắt buộc. Tiêu đề của tiêu đề thẻ. 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ẻ. Nếu được chỉ định, sẽ xuất hiện trên dòng riêng bên dưới title.

imageType

ImageType

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

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

imageUrl

string

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

imageAltText

string

Văn bản thay thế của hình ảnh này dùng cho việc hỗ trợ tiếp cận.

DisplayStyle

Trong Tiện ích bổ sung của Google Workspace, hãy xác định cách thẻ hiển thị.

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.

Enum
DISPLAY_STYLE_UNSPECIFIED Không sử dụng. Không xác định.
PEEK Tiêu đề của thẻ xuất hiện ở cuối thanh bên, che phủ một phần thẻ trên cùng hiện tại của ngăn xếp. Khi nhấp vào tiêu đề, thẻ sẽ được đẩy vào ngăn xếp thẻ. Nếu thẻ không có tiêu đề, thì tiêu đề được tạo sẽ được sử dụng.
REPLACE Giá trị mặc định. Thẻ này xuất hiện bằng cách thay thế chế độ xem của thẻ trên cùng trong ngăn xếp thẻ.

DividerStyle

Kiểu đường phân chia của một thẻ. Hiện chỉ được dùng cho đường phân cách giữa các phần thẻ.

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

Enum
DIVIDER_STYLE_UNSPECIFIED Không sử dụng. Không xác định.
SOLID_DIVIDER Tùy chọn mặc định. Kết xuất một đường phân chia đồng nhất.
NO_DIVIDER Nếu được đặt, sẽ không có đường phân chia nào hiển thị. Kiểu này loại bỏ hoàn toàn trình phân chia khỏi bố cục. Kết quả tương đương với việc không thêm một đường phân chia nào cả.

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.

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

Trường
header

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Định dạng văn bản trong tiện ích bổ sung cho Google Workspace.

widgets[]

Widget

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

collapsible

bool

Cho biết liệu mục 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. Tuy nhiên, người dùng có thể mở rộng phần này để 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 tiện ích nào bị ẩn, hãy chỉ định uncollapsibleWidgetsCount.

uncollapsibleWidgetsCount

int32

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

Ví dụ: khi một phần chứa 5 tiện ích và uncollapsibleWidgetsCount được đặt 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 xem xét khi collapsibletrue.

collapseControl

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ỉ hiển thị nếu phần đó có thể thu gọn. Nếu bạn không đặt trường này, nút mặc định sẽ được sử dụng. Có trong 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.

Khối

Văn bản, biểu tượng hoặc văn bản và khối biểu tượng mà người dùng có thể nhấp vào.

Có trong 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.

Trường
icon

Icon

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

label

string

Văn bản xuất hiện bên trong khối.

onClick

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.

enabled
(deprecated)

bool

Liệu khối này có ở trạng thái đang hoạt động và phản hồi hành động 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.

disabled

bool

Liệu khối này có đang ở 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.

altText

string

Văn bản thay thế được dùng cho khả năng 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&quot;.

ChipList

Danh sách các khối được bố trí theo chiều ngang. Bạn có thể cuộn theo chiều ngang hoặc gói vào dòng tiếp theo.

Có trong 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.

Trường
layout

Layout

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

chips[]

Chip

Một mảng chip.

Bố cục

Bố cục của danh sách khối.

Enum
LAYOUT_UNSPECIFIED Không sử dụng. Không xác định.
WRAPPED Giá trị mặc định. Danh sách khối sẽ tự động xuống dòng tiếp theo nếu không có đủ không gian theo chiều ngang.
HORIZONTAL_SCROLLABLE Các khối sẽ cuộn theo chiều ngang nếu không vừa với không gian có sẵn.

CollapseControl

Trình bày chế độ kiểm soát mở rộng và thu gọn. Có trong 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.

Trường
horizontalAlignment

HorizontalAlignment

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

expandButton

Button

Không bắt buộc. Hãy xác định nút có thể tuỳ chỉnh để mở rộng phần này. Bạn phải đặt cả trường mở rộng nút và thu gọn nút. 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.

collapseButton

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 mở rộng nút và thu gọn nút. 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.

Cột

Tiện ích Columns hiển thị tối đa 2 cột trong một thẻ hoặc hộp thoại. Bạn có thể thêm tiện ích vào mỗi cột; các tiện ích sẽ xuất hiện theo thứ tự được chỉ định. Để xem ví dụ trong các ứng dụng Google Chat, hãy xem phần Hiển thị thẻ và hộp thoại trong cột.

Chiều cao của mỗi cột do cột cao hơn xác định. Ví dụ: nếu cột đầu tiên cao hơn cột thứ hai, thì cả hai cột đều có chiều cao của cột đầu tiên. Vì mỗi cột có thể chứa một số lượng tiện ích khác nhau, nên bạn không thể xác định hàng hoặc căn chỉnh tiện ích giữa các cột.

Các cột hiển thị cạnh nhau. Bạn có thể tuỳ chỉnh chiều rộng của từng cột bằng trường HorizontalSizeStyle. Nếu chiều rộng màn hình của người dùng quá hẹp, cột thứ hai sẽ gói bên dưới cột đầu tiên:

  • Trên web, cột thứ hai sẽ gói nếu chiều rộng màn hình nhỏ hơn hoặc bằng 480 pixel.
  • Trên thiết bị iOS, cột thứ hai sẽ gói nếu chiều rộng màn hình nhỏ hơn hoặc bằng 300 pt.
  • Trên thiết bị Android, cột thứ hai sẽ gói nếu chiều rộng màn hình nhỏ hơn hoặc bằng 320 dp.

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

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

Trường
columnItems[]

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.

Cột

Một cột.

Tiện ích bổ sung và ứng dụng trong Chat

Trường
horizontalSizeStyle

HorizontalSizeStyle

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

horizontalAlignment

HorizontalAlignment

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

verticalAlignment

VerticalAlignment

Chỉ định xem các tiện ích căn chỉnh theo đầu, cuối hay giữa cột.

widgets[]

Widgets

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

HorizontalSizeStyle

Chỉ định cách một cột lấp đầy chiều rộng của thẻ. Chiều rộng của mỗi cột phụ thuộc vào cả HorizontalSizeStyle và chiều rộng của các tiện ích trong cột.

Tiện ích bổ sung và ứng dụng trong Chat

Enum
HORIZONTAL_SIZE_STYLE_UNSPECIFIED Không sử dụng. Không xác định.
FILL_AVAILABLE_SPACE Giá trị mặc định. Cột lấp đầy không gian có sẵn, tối đa 70% chiều rộng của thẻ. Nếu bạn đặt cả hai cột thành FILL_AVAILABLE_SPACE thì mỗi cột sẽ lấp đầy 50% không gian.
FILL_MINIMUM_SPACE Cột lấp đầy lượng không gian ít nhất có thể và không vượt quá 30% chiều rộng của thẻ.

VerticalAlignment

Chỉ định xem các tiện ích căn chỉnh theo đầu, cuối hay giữa cột.

Tiện ích bổ sung và ứng dụng trong Chat

Enum
VERTICAL_ALIGNMENT_UNSPECIFIED Không sử dụng. Không xác định.
CENTER Giá trị mặc định. Căn chỉnh các tiện ích vào giữa cột.
TOP Căn chỉnh các tiện ích lên đầu cột.
BOTTOM Căn chỉnh các tiện ích xuống cuối cột.

Tiện ích

Các tiện ích được hỗ trợ mà bạn có thể đưa vào trong một cột.

Tiện ích bổ sung và ứng dụng trong Chat

Trường

Trường kết hợp data.

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

textParagraph

TextParagraph

TextParagraph tiện ích.

image

Image

Image tiện ích.

decoratedText

DecoratedText

DecoratedText tiện ích.

buttonList

ButtonList

ButtonList tiện ích.

textInput

TextInput

TextInput tiện ích.

selectionInput

SelectionInput

SelectionInput tiện ích.

dateTimePicker

DateTimePicker

DateTimePicker tiện ích.

chipList

ChipList

ChipList tiện ích. Có trong 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.

DateTimePicker

Cho phép người dùng nhập ngày, giờ hoặc cả ngày và giờ. Để xem ví dụ về các ứng dụng trong Google Chat, hãy xem phần Cho phép người dùng chọn ngày và giờ.

Người dùng có thể nhập văn bản hoặc sử dụng bộ chọn để chọn ngày và giờ. Nếu người dùng nhập ngày hoặc giờ không hợp lệ, bộ chọn sẽ hiển thị lỗi nhắc người dùng nhập thông tin chính xác.

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

Trường
name

string

Tên mà DateTimePicker được xác định trong một sự kiện nhập vào biểu mẫu.

Để biết thông tin chi tiết về cách làm việc với thông tin nhập vào biểu mẫu, hãy xem phần Nhận dữ liệu biểu mẫu.

label

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 một nhãn như Appointment date hoặc Appointment date and time.

type

DateTimePickerType

Tiện ích này có hỗ trợ nhập ngày, giờ hoặc ngày và giờ hay không.

valueMsEpoch

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ụ:để thể hiện lúc 12 giờ đêm ngày 1 tháng 1 năm 2023 (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ụ: để thể hiện 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 đêm, hãy sử dụng 43200000 (hoặc 12 * 60 * 60 * 1000).
timezoneOffsetDate

int32

Số biểu thị chênh 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 chính sách này, giá trị này sẽ được đặt mặc định thành chế độ cài đặt múi giờ của người dùng.

onChangeAction

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

Validation

Không bắt buộc. Chỉ định xác thực bắt buộc cho bộ chọn bộ chọn ngày giờ này.

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

DateTimePickerType

Định dạng của ngày và giờ trong tiện ích DateTimePicker. Xác định xem người dùng có thể nhập ngày, giờ hay cả ngày và giờ.

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

Enum
DATE_AND_TIME Người dùng nhập ngày và giờ.
DATE_ONLY Người dùng nhập một ngày.
TIME_ONLY Người dùng nhập thời gian.

DecoratedText

Tiện ích hiển thị văn bản với thành phần trang trí tuỳ chọn như nhãn bên trên hoặc bên dưới văn bản, biểu tượng phía trước văn bản, tiện ích lựa chọn hoặc nút sau văn bản. Để xem ví dụ về các ứng dụng Google Chat, hãy xem phần Hiển thị văn bản cùng văn bản trang trí.

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

Trường
icon
(deprecated)

Icon

Không dùng nữa và thay bằng startIcon.

startIcon

Icon

Biểu tượng xuất hiện ở phía trước văn bản.

topLabel

string

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

text

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Định dạng văn bản trong tiện ích bổ sung cho Google Workspace.

wrapText

bool

Chế độ cài đặt xuống dòng tự động. Nếu là true, văn bản sẽ gói 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 topLabelbottomLabel.

bottomLabel

string

Văn bản xuất hiện bên dưới text. Luôn kết thúc.

onClick

OnClick

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

Trường kết hợp control. Một nút, công tắc, hộp đánh dấu hoặc hình ảnh xuất hiện ở bên phải văn bản trong tiện ích decoratedText. control chỉ có thể là một trong những trạng thái sau đây:
button

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

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.

endIcon

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.

SwitchControl

Nút bật/tắt kiểu bật/tắt hoặc hộp đánh dấu bên trong tiện ích decoratedText.

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

Chỉ được hỗ trợ trong tiện ích decoratedText.

Trường
name

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 làm việc với thông tin nhập vào biểu mẫu, hãy xem phần Nhận dữ liệu biểu mẫu.

value

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 làm việc với thông tin nhập vào biểu mẫu, hãy xem phần Nhận dữ liệu biểu mẫu.

selected

bool

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

onChangeAction

Action

Hành động sẽ thực hiện khi trạng thái chuyển đổi thay đổi, chẳng hạn như hàm nào sẽ chạy.

controlType

ControlType

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

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

ControlType

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

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

Enum
SWITCH Nút bật/tắt kiểu bật/tắt.
CHECKBOX Không dùng nữa và thay bằng CHECK_BOX.
CHECK_BOX Một hộp đánh dấu.

Dải phân cách

Loại này không có trường nào.

Hiện đường phân chia giữa các tiện ích dưới dạng đường ngang. Để xem ví dụ trong các ứng dụng Google Chat, hãy xem bài viết Thêm một đường phân chia theo chiều ngang giữa các tiện ích.

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

Ví dụ: JSON sau đây tạo một bộ chia:

"divider": {}

EndNavigation

Thao tác trong luồng hộp thoại.

Có trong 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.

Trường
action

Action

Hành động kết xuất để ứng dụng kết thúc luồng hộp thoại.

Có trong 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.

Hành động

Các loại thao tác kết xuất để ứng dụng kết thúc luồng hộp thoại.

Có trong 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.

Enum
ACTION_UNSPECIFIED Chưa xác định hành động.
CLOSE_DIALOG Đóng quy trình hộp thoại.
CLOSE_DIALOG_AND_EXECUTE Đóng luồng hộp thoại rồi làm mới thẻ đã mở luồng hội thoại đó.

GetAutocompletionResponse

Phản hồi cho việc nhận vùng chứa tự động hoàn thành, bao gồm các phần tử cần thiết để hiển thị các mục tự động hoàn thành cho trường văn bản.

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. Ví dụ:

{
  "autoComplete": {
    "items": [
      {
        "text": "C++"
      },
      {
        "text": "Java"
      },
      {
        "text": "JavaScript"
      },
      {
        "text": "Python"
      }
    ]
  }
}
Trường
autoComplete

Suggestions

schema

string

Đây là trường giản đồ không hoạt động có thể xuất hiện trong thẻ đánh dấu để kiểm tra cú pháp.

Lưới

Hiển thị lưới có một tập hợp các mục. Mục chỉ có thể bao gồm văn bản hoặc hình ảnh. Đối với các cột thích ứng hoặc bao gồm nhiều hơn văn bản hay hình ảnh, hãy sử dụng Columns. Để xem ví dụ trong các ứng dụng Google Chat, hãy xem phần Hiển thị lưới với một tập hợ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 theo số mục chia cho cột. Một lưới gồm 10 mục và 2 cột sẽ có 5 hàng. Một lưới gồm 11 mục và 2 cột sẽ có 6 hàng.

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

Ví dụ: JSON sau đây tạo một lưới gồm 2 cột chứa 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"
    }
  }
}
Trường
title

string

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

items[]

GridItem

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

borderStyle

BorderStyle

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

columnCount

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 trường này không được chỉ định 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

OnClick

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

GridItem

Đại diện cho một mục trong bố cục lưới. Các mục có thể chứa văn bản, hình ảnh hoặc cả văn bản và hình ảnh.

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

Trường
id

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 tham số gọi lại onClick của lưới mẹ.

image

ImageComponent

Hình ảnh xuất hiện trong mục lưới.

title

string

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

subtitle

string

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

layout

GridItemLayout

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

GridItemLayout

Biểu thị các tuỳ chọn bố cục có sẵn cho một mục trong lưới.

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

Enum
GRID_ITEM_LAYOUT_UNSPECIFIED Không sử dụng. Không xác định.
TEXT_BELOW Tiêu đề và phụ đề hiển thị bên dưới hình ảnh của mục trong lưới.
TEXT_ABOVE Tiêu đề và phụ đề hiển thị ở phía trên hình ảnh của mục trong lưới.

Biểu tượng

Biểu tượng xuất hiện trong tiện ích trên thẻ. Để xem ví dụ trong các ứng dụng Google Chat, hãy xem phần Thêm biểu tượng.

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

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

Trường
altText

string

Không bắt buộc. Nội dung mô tả biểu tượng dùng để hỗ trợ tiếp cận. Nếu bạn không chỉ định, giá trị mặc định Button sẽ được cung cấp. Tốt nhất là bạn nên đặt một đoạn mô tả hữu ích cho nội dung mà biểu tượng hiển thị 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 này cũng đặt text, thì altText của biểu tượng sẽ bị bỏ qua.

imageType

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 vùng cắt CIRCLE sẽ khiến hình ảnh được vẽ lớn hơn biểu tượng tích hợp.

Trường kết hợp icons. Biểu tượng xuất hiện trong tiện ích trên thẻ. icons chỉ có thể là một trong những trạng thái sau đây:
knownIcon

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.

iconUrl

string

Hiển thị biểu tượng tuỳ chỉnh được lưu trữ trong 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.jpg.

materialIcon

MaterialIcon

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

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

"materialIcon": {
  "name": "check_box"
}

Có trong 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.

Bài đăng có hình ảnh

Hình ảnh do URL chỉ định và có thể có thao tác onClick. Để biết ví dụ, hãy xem nội dung Thêm hình ảnh.

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

Trường
imageUrl

string

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

Ví dụ:

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

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.

altText

string

Văn bản thay thế của hình ảnh này dùng cho việc hỗ trợ tiếp cận.

ImageComponent

Đại diện cho một hình ảnh.

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

Trường
imageUri

string

URL hình ảnh.

altText

string

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

cropStyle

ImageCropStyle

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

borderStyle

BorderStyle

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

ImageCropStyle

Đại diện cho kiểu cắt được áp dụng cho một hình ảnh.

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

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

cropStyle {
 "type": "RECTANGLE_CUSTOM",
 "aspectRatio": 16/9
}
Trường
type

ImageCropType

Kiểu cắt.

aspectRatio

double

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

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

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

ImageCropType

Đại diện cho kiểu cắt được áp dụng cho một hình ảnh.

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

Enum
IMAGE_CROP_TYPE_UNSPECIFIED Không sử dụng. Không xác định.
SQUARE Giá trị mặc định. Áp dụng cắt hình vuông.
CIRCLE Áp dụng cắt hình tròn.
RECTANGLE_CUSTOM Áp dụng cắt hình chữ nhật với tỷ lệ khung hình tuỳ chỉnh. Đặt tỷ lệ khung hình tuỳ chỉnh bằng aspectRatio.
RECTANGLE_4_3 Áp dụng ảnh cắt hình chữ nhật với tỷ lệ khung hình 4:3.

LinkPreview

Thao tác đối với thẻ giúp xem trước một đường liên kết của bên thứ ba bằng cách cho thấy một thẻ và khối thông minh. Để tìm hiểu thêm, hãy xem bài viết Xem trước đường liên kết bằng khối thông minh.

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.

Ví dụ: JSON sau đây trả về một tiêu đề duy nhất cho bản xem trước đường liên kết và khối thông minh của đường liên kết đó, cũng như một thẻ xem trước có tiêu đề và nội dung mô tả dạng văn bản:

{
  "action": {
    "linkPreview": {
      "title": "Smart chip title",
      "linkPreviewTitle": "Link preview title",
      "previewCard": {
        "header": {
          "title": "Preview card header",
        },
        "sections": [
          {
            "widgets": [
              {
                "textParagraph": {
                  "text": "Description of the link."
                }
              }
            ]
          }
        ]
      }
    }
  }
}

Ví dụ này trả về bản xem trước đường liên kết sau đây:

Bản xem trước đường liên kết mẫu

Trường
previewCard

Card

Thẻ cho thấy thông tin về đường liên kết của một dịch vụ bên thứ ba.

title

string

Tiêu đề xuất hiện trong khối thông minh cho bản xem trước đường liên kết. Nếu bạn không đặt chính sách này, khối thông minh sẽ hiển thị tiêu đề của preview_card.

linkPreviewTitle

string

Tiêu đề hiển thị trong bản xem trước đường liên kết. Nếu bạn không đặt chính sách này, thì bản xem trước đường liên kết sẽ hiển thị tiêu đề của preview_card.

MaterialIcon

Biểu tượng Google Material, bao gồm hơn 2500 lựa chọn.

Ví dụ: để hiển thị biểu tượng hộp đánh dấu với trọng lượng và điểm tuỳ chỉnh, hãy viết những nội dung sau:

{
  "name": "check_box",
  "fill": true,
  "weight": 300,
  "grade": -25
}

Có trong 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.

Trường
name

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ị.

fill

bool

Liệu biểu tượng có hiển thị là đã tô màu nền hay không. Giá trị mặc định là sai.

Để xem trước các cài đặt biểu tượng khác nhau, chuyển đến Biểu tượng phông chữ của Google và điều chỉnh cài đặt trong Tùy chỉnh.

weight

int32

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

Để xem trước các cài đặt biểu tượng khác nhau, chuyển đến Biểu tượng phông chữ của Google và điều chỉnh cài đặt trong Tùy chỉnh.

grade

int32

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

Để xem trước các cài đặt biểu tượng khác nhau, chuyển đến Biểu tượng phông chữ của Google và điều chỉnh cài đặt trong Tùy chỉnh.

Thao tác đối với thẻ thao túng ngăn xếp thẻ.

Ví dụ:

1) Thêm thẻ mới vào nhóm ảnh (điều hướng tiến lên). Đối với các ứng dụng nhắn tin, tính năng này chỉ dùng được trên trang chủ ứng dụng.

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

 navigations : {
    pushCard : CARD
  }

2) Cập nhật thẻ ở đầu ngăn xếp (cập nhật tại chỗ).

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.

  navigations : {
    popCard : true,
  }, {
    pushCard : CARD
  }

3) Quay lại một bước mà không cập nhật.

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.

  navigations : {
    popCard : true,
  }

4) Quay lại nhiều bước và cập nhật thẻ đó.

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.

  navigations : {
    popCard : true,
  }, ... {
    pushCard : CARD
  }

5) Quay lại nhiều bước đối với một CARD_NAME đã xá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.

  navigations : {
    popToCardName : CARD_NAME,
  }, {
    pushCard : CARD
  }

6) Quay lại thư mục gốc và cập nhật thẻ đó.

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.

  navigations : {
    popToRoot : true
  }, {
    pushCard : CARD
  }

7) Di chuyển tới thẻ được chỉ định và cũng kéo thẻ đó.

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.

navigations : { popToCardName : CARD_NAME }, { popCard : true, }

8) Thay thế thẻ trên cùng bằng một thẻ mới. Đối với các ứng dụng nhắn tin, tính năng này chỉ dùng được trên trang chủ ứng dụng.

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

  navigations : {
    updateCard : CARD
  }
Trường

Trường kết hợp navigate_action.

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

popToRoot

bool

Ngăn xếp thẻ bật ra tất cả các thẻ, ngoại trừ thẻ gốc.

pop

bool

Ngăn xếp thẻ bật một thẻ ra.

popToCard

string

Ngăn xếp thẻ đẩy tất cả các thẻ lên trên thẻ được chỉ định có tên thẻ đã cho.

pushCard

Card

Ngăn xếp thẻ đẩy một thẻ vào ngăn xếp thẻ.

updateCard

Card

Ngăn xếp thẻ sẽ cập nhật một thẻ mới vào thẻ trên cùng và giữ lại các giá trị của các trường trong biểu mẫu đã điền. Đối với một trường không tương đương, giá trị sẽ bị loại bỏ.

endNavigation

EndNavigation

Thao tác điều hướng kết thúc luồng hộp thoại. Để biết thêm thông tin, hãy xem bài viết Tạo trang chủ cho ứng dụng Google Chat

Có trong 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.

Thông báo

Thao tác trên thẻ cho thấy một thông báo trong ứng dụng lưu trữ.

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.

Trường
text

string

Văn bản thuần tuý để hiển thị thông báo, không có thẻ HTML.

OnClick

Trình bày cách phản hồi khi người dùng nhấp vào một phần tử tương tác trên thẻ, chẳng hạn như một nút.

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

Trường

Trường kết hợp data.

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

action

Action

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

openDynamicLinkAction

Action

Tiện ích bổ sung sẽ kích hoạt hành động này khi hành động cần mở một đường liên kết. Tính năng này khác với open_link ở trên ở chỗ yêu cầu này cần phải 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 liên kết mở hoạt động trở lại.

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.

card

Card

Một thẻ mới sẽ được đẩy vào ngăn xếp thẻ sau khi nhấp vào nếu được chỉ đị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.

overflowMenu

OverflowMenu

Nếu được chỉ định, onClick này sẽ mở một trình đơn mục bổ sung. Có trong 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.

OnClose

Thao tác của ứng dụng khi người dùng đóng một đường liên kết do thao tác OnClick mở.

Việc triển khai phụ thuộc vào khả năng của nền tảng ứng dụng. Ví dụ: Một trình duyệt web có thể mở một đường liên kết trong cửa sổ bật lên có trình xử lý OnClose.

Nếu bạn đã đặt cả hai trình xử lý OnOpenOnClose, đồng thời nền tảng ứng dụng không thể hỗ trợ cả hai giá trị, thì OnClose sẽ được ưu tiên.

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.

Enum
NOTHING Giá trị mặc định. Thẻ không tải lại được; không có gì xảy ra cả.
RELOAD

Tải lại thẻ sau khi cửa sổ con đóng.

Nếu được dùng cùng với OpenAs.OVERLAY, cửa sổ con sẽ đóng vai trò là hộp thoại phương thức và thẻ mẹ sẽ bị chặn cho đến khi cửa sổ con đóng lại.

OpenAs

Khi thao tác OnClick mở một đường liên kết, thì ứng dụng có thể mở đường liên kết đó dưới dạng cửa sổ có kích thước đầy đủ (nếu đó là khung mà ứng dụng sử dụng) hoặc mở lớp phủ (chẳng hạn như cửa sổ bật lên). Việc triển khai phụ thuộc vào khả năng của nền tảng ứng dụng và giá trị đã chọn có thể bị bỏ qua nếu ứng dụng không hỗ trợ giá trị đó. FULL_SIZE được tất cả ứng dụng hỗ trợ.

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.

Enum
FULL_SIZE Đường liên kết sẽ mở ra dưới dạng cửa sổ có kích thước đầy đủ (nếu đó là khung mà ứng dụng sử dụng).
OVERLAY Đường liên kết sẽ mở ra dưới dạng lớp phủ, chẳng hạn như cửa sổ bật lên.

OverflowMenu

Tiện ích hiển thị trình đơn bật lên có một hoặc nhiều thao tác mà người dùng có thể gọi. Ví dụ: hiển thị các hành động phụ trong một thẻ. Bạn có thể dùng tiện ích này khi các thao tác không phù hợp với không gian hiện có. Để sử dụng, hãy chỉ định tiện ích này trong thao tác OnClick của các tiện ích hỗ trợ tiện ích đó. Ví dụ như trong Button.

Có trong 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.

Trường
items[]

OverflowMenuItem

Bắt buộc. Danh sách các lựa chọn trên trình đơn.

OverflowMenuItem

Một tuỳ chọn mà người dùng có thể gọi trong một trình đơn mục bổ sung.

Có trong 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.

Trường
startIcon

Icon

Biểu tượng xuất hiện ở phía trước văn bản.

text

string

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

onClick

OnClick

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

disabled

bool

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

RenderActions

Một tập hợp hướng dẫn hiển thị để yêu cầu thẻ thực hiện một thao tác hoặc yêu cầu ứng dụng lưu trữ tiện ích bổ sung hay ứng dụng Chat thực hiện một thao tác dành riêng cho ứng dụng.

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

Trường
action

Action

hostAppAction

HostAppActionMarkup

Thao tác do từng ứng dụng lưu trữ xử lý.

schema

string

Đây là trường giản đồ không hoạt động có thể xuất hiện trong thẻ đánh dấu để kiểm tra cú pháp.

Hành động

Trường
navigations[]

Navigation

Đẩy, bật hoặc cập nhật các thẻ được hiển thị.

notification

Notification

Hiển thị thông báo cho người dùng cuối.

linkPreview

LinkPreview

Hiển thị bản xem trước đường liên kết cho người dùng cuối.

SelectionInput

Tiện ích tạo ra một hoặc nhiều mục trên giao diện người dùng mà người dùng có thể chọn. Ví dụ: trình đơn thả xuống hoặc hộp đánh dấu. Bạn có thể sử dụng tiện ích này để thu thập dữ liệu có thể được dự đoán hoặc liệt kê. Để xem ví dụ về các ứng dụng Google Chat, hãy xem nội dung Thêm các thành phần có thể chọn trên giao diện người dùng.

Ứng dụng nhắn tin có thể xử lý giá trị của các mục mà người dùng chọn hoặc nhập. Để biết thông tin chi tiết về cách làm việc với thông tin nhập vào biểu mẫu, hãy xem phần Nhận dữ liệu biểu mẫu.

Để thu thập dữ liệu không xác định hoặc trừu tượng từ người dùng, hãy sử dụng tiện ích TextInput.

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

Trường
name

string

Bắt buộc. Tên xác định mục nhập lựa chọn trong sự kiện nhập biểu mẫu.

Để biết thông tin chi tiết về cách làm việc với thông tin nhập vào biểu mẫu, hãy xem phần Nhận dữ liệu biểu mẫu.

label

string

Văn bản xuất hiện phía trên trường nhập dữ liệu 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ợ trong trình đơn thả xuống, thì nhãn có thể là "Khẩn cấp" hoặc "Chọn sự khẩn cấp".

type

SelectionType

Loại mục mà người dùng nhìn thấy 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.

items[]

SelectionItem

Một mảng 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ợ lên đến 100 mục.

onChangeAction

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 gửi biểu mẫu.

Để biết thông tin chi tiết về cách làm việc với thông tin nhập vào biểu mẫu, hãy xem phần Nhận dữ liệu biểu mẫu.

multiSelectMaxSelectedItems

int32

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

multiSelectMinQueryLength

int32

Đối với trình đơn chọn nhiều đối tượng, số lượng ký tự văn bản mà người dùng nhập trước khi ứng dụng truy vấn sẽ tự động hoàn thành và hiện các mục đề xuất trong trình đơn.

Nếu bạn không chỉ định, thì mặc định sẽ là 0 ký tự đối với nguồn dữ liệu tĩnh và 3 ký tự đối với nguồn dữ liệu bên ngoài.

validation

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.

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

Trường kết hợp multi_select_data_source. Đối với trình đơn chọn nhiều mục, nguồn dữ liệu sẽ điền sẵn các mục lựa chọn.

Có trong 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. multi_select_data_source chỉ có thể là một trong những trạng thái sau đây:

externalDataSource

Action

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

platformDataSource

PlatformDataSource

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

PlatformDataSource

Đối với tiện ích SelectionInput sử dụng trình đơn chọn nhiều lựa chọn, đó là một nguồn dữ liệu của Google Workspace. Dùng để điền các mục trong trình đơn chọn nhiều mục.

Có trong 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.

Trường
Trường kết hợp data_source. Nguồn dữ liệu. data_source chỉ có thể là một trong những trạng thái sau đây:
commonDataSource

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.

hostAppDataSource

HostAppDataSourceMarkup

Một nguồn dữ liệu chỉ có ở ứng dụng lưu trữ của 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 hỗ trợ Thư viện ứng dụng đám mây. Để tìm hiểu thêm, hãy xem phần Cài đặt thư viện ứng dụng.

CommonDataSource

Một nguồn dữ liệu dùng chung cho tất cả ứng dụng Google Workspace.

Có trong 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.

Enum
UNKNOWN Giá trị mặc định. Không sử dụng.
USER Người dùng Google Workspace. Người dùng này chỉ có thể xem và chọn người dùng trong tổ chức Google Workspace của họ.

SelectionItem

Một mục mà người dùng có thể chọn trong một mục nhập lựa chọn, chẳng hạn như hộp đánh dấu hoặc nút chuyển.

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

Trường
text

string

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

value

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 làm việc với thông tin nhập vào biểu mẫu, hãy xem phần Nhận dữ liệu biểu mẫu.

selected

bool

Liệu mục đó có được chọn theo mặc định hay không. Nếu mục nhập 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), bạn chỉ nên đặt trường này cho một mục.

startIconUri

string

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

bottomText

string

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

SelectionType

Định dạng của các mục mà người dùng có thể chọn. Các tuỳ chọn khác nhau sẽ hỗ trợ các loại tương tác khác nhau. Ví dụ: người dùng có thể chọn nhiều hộp đánh dấu, nhưng chỉ có thể chọn một mục trong trình đơn thả xuống.

Mỗi đầu vào lựa chọn hỗ trợ một kiểu lựa chọn. Ví dụ: không hỗ trợ kết hợp hộp đánh dấu và nút chuyển.

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

Enum
CHECK_BOX Một tập hợp các hộp đánh dấu. Người dùng có thể chọn một hoặc nhiều hộp đánh dấu.
RADIO_BUTTON Một tập hợp các nút chọn. Người dùng có thể chọn một nút chọn.
SWITCH Một bộ công tắc. Người dùng có thể bật một hoặc nhiều công tắc.
DROPDOWN Một trình đơn thả xuống. Người dùng có thể chọn một mục trong trình đơn.
MULTI_SELECT

Trình đơn chọn nhiều đối tượng cho dữ liệu tĩnh hoặc động. Trên thanh trình đơn, người dùng có thể chọn một hoặc nhiều mục. Người dùng cũng có thể nhập các giá trị để điền dữ liệu động. Ví dụ: người dùng có thể bắt đầu nhập tên của một phòng Google Chat và tiện ích này sẽ tự động đề xuất không gian đó.

Để điền các mục cho một trình đơn chọn nhiều mục, bạn có thể sử dụng một trong các loại nguồn dữ liệu sau:

  • Dữ liệu tĩnh: Các mục được chỉ định làm đối tượng SelectionItem trong tiện ích. Tối đa 100 mục.
  • Dữ liệu trên Google Workspace: Các mục được điền sẵn bằng dữ liệu trên Google Workspace, chẳng hạn như người dùng Google Workspace hoặc phòng Google Chat.
  • Dữ liệu bên ngoài: Các mục được điền từ một nguồn dữ liệu bên ngoài không thuộc Google Workspace.

Để biết ví dụ về cách triển khai trình đơn chọn nhiều mục, hãy xem phần Thêm trình đơn chọn nhiều mục.

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

SubmitFormResponse

Phản hồi cho lượt gửi biểu mẫu thay vì nhận vùng chứa tự động hoàn thành, chứa các hành động mà thẻ sẽ thực hiện và/hoặc ứng dụng lưu trữ tiện ích bổ sung sẽ thực hiện, cũng như liệu trạng thái của thẻ có thay đổi hay không.

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. Ví dụ:

{
  "renderActions": {
    "action": {
      "notification": {
        "text": "Email address is added: salam.heba@example.com"
      }
    },
    "hostAppAction": {
      "gmailAction": {
        "openCreatedDraftAction": {
          "draftId": "msg-a:r-79766936926021702",
          "threadServerPermId": "thread-f:15700999851086004"
        }
      }
    }
  }
}
Trường
renderActions

RenderActions

Một tập hợp hướng dẫn hiển thị yêu cầu thẻ thực hiện một thao tác và/hoặc yêu cầu ứng dụng lưu trữ tiện ích bổ sung thực hiện một thao tác dành riêng cho ứng dụng.

stateChanged

bool

Liệu trạng thái thẻ đã thay đổi và dữ liệu trong các thẻ hiện có đã cũ hay chưa.

schema

string

Đây là trường giản đồ không hoạt động có thể xuất hiện trong thẻ đánh dấu để kiểm tra cú pháp.

Nội dung đề xuất

Những giá trị được đề 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 dữ liệu 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ẽ hiển thị JavaJavaScript.

Các giá trị được đề xuất giúp hướng dẫn người dùng nhập các giá trị mà ứng dụng của bạn có thể hiểu được. Khi đề cập đến JavaScript, một số người dùng có thể nhập javascript và những người khác 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.

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

Trường
items[]

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 văn bản.

SuggestionItem

Một giá trị được đề xuất mà người dùng có thể nhập vào trường nhập dữ liệu.

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

Trường

Trường kết hợp content.

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

text

string

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

TextInput

Một trường mà người dùng có thể nhập văn bản. Hỗ trợ các đề xuất và hành động khi thay đổi. Để xem ví dụ trong các ứng dụng Google Chat, hãy xem phần Thêm trường mà người dùng có thể nhập văn bản.

Các ứng dụng trong Chat nhận và có thể xử lý giá trị của văn bản đã nhập trong các sự kiện nhập biểu mẫu. Để biết thông tin chi tiết về cách làm việc với thông tin nhập vào biểu mẫu, hãy xem phần Nhận dữ liệu biểu mẫu.

Khi bạn cần thu thập dữ liệu không xác định hoặc trừu tượng từ người dùng, hãy sử dụng phương thức nhập văn bản. Để thu thập dữ liệu đã xác định hoặc liệt kê từ người dùng, hãy sử dụng tiện ích SelectionInput.

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

Trường
name

string

Tên mà mục nhập văn bả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 làm việc với thông tin nhập vào biểu mẫu, hãy xem phần Nhận dữ liệu biểu mẫu.

label

string

Văn bản xuất hiện phía trên trường nhập dữ liệu 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 chưa chỉ định hintText. Nếu không thì không bắt buộc.

hintText

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.

value

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 làm việc với thông tin nhập vào biểu mẫu, hãy xem phần Nhận dữ liệu biểu mẫu.

type

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ụ: liệu trường này là một dòng hay nhiều dòng.

onChangeAction

Action

Việc cần làm khi trường nhập dữ liệu thay đổi. 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.

initialSuggestions

Suggestions

Những giá trị được đề 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 dữ liệu 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ị JavaJavaScript.

Các giá trị được đề xuất giúp hướng dẫn người dùng nhập các giá trị mà ứng dụng của bạn có thể hiểu được. Khi đề cập đến JavaScript, một số người dùng có thể nhập javascript và những người khác 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.

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

autoCompleteAction

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 cung cấp đề xuất cho người dùng tương tác với trường đó.

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

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ó 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.

validation

Validation

Chỉ định quy trình xác thực cần thiết cho trường nhập dữ liệu văn bản này.

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

placeholderText

string

Văn bản xuất hiện trong trường nhập dữ liệu 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.

Có trong 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.

Loại

Cách trường nhập văn bản xuất hiện trong giao diện người dùng. Ví dụ: cho dù đó là trường nhập một dòng hay nhập nhiều dòng. Nếu bạn chỉ định initialSuggestions, thì type sẽ luôn là SINGLE_LINE, ngay cả khi bạn đặt thành MULTIPLE_LINE.

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

Enum
SINGLE_LINE Trường nhập dữ liệu có chiều cao cố định là một dòng.
MULTIPLE_LINE Trường nhập văn bản có chiều cao cố định gồm nhiều dòng.

TextParagraph

Một đoạn văn bản có hỗ trợ định dạng. Để xem ví dụ trong các ứng dụng Google Chat, hãy xem bài viết Thêm một đoạn 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Định dạng văn bản trong tiện ích bổ sung cho Google Workspace.

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

Trường
text

string

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

maxLines

int32

Số dòng văn bản tối đa được 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 vượt quá sẽ bị ẩn sau nút hiện 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 đó, tất cả ngữ cảnh đều hiển thị. Bỏ qua các giá trị âm. Có trong 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.

Xác thực

Biểu thị dữ liệu cần thiết để xác thực tiện ích đính kèm.

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

Trường
characterLimit

int32

Chỉ định giới hạn ký tự cho các tiện ích nhập văn bản. Lưu ý rằng thuộc tính này chỉ dùng để nhập văn bản và bị bỏ qua đối với các tiện ích khác.

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

inputType

InputType

Chỉ định loại tiện ích nhập.

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

InputType

Loại tiện ích nhập.

Enum
INPUT_TYPE_UNSPECIFIED Loại không xác định. Không được dùng.
TEXT Văn bản thông thường chấp nhận tất cả ký tự.
INTEGER Một giá trị số nguyên.
FLOAT Một giá trị số thực.
EMAIL Địa chỉ email.
EMOJI_PICKER Một biểu tượng cảm xúc được chọn từ bộ chọn biểu tượng cảm xúc do hệ thống cung cấp.

Tiện ích

Mỗi thẻ được tạo thành từ các tiện ích.

Tiện ích là một đối tượng kết hợp có thể đại diện cho một trong các loại văn bản, hình ảnh, nút và các loại đối tượng khác.

Trường
horizontalAlignment

HorizontalAlignment

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

Trường kết hợp data. Mỗi tiện ích chỉ có thể có một trong các mục sau. Bạn có thể sử dụng nhiều trường tiện ích để hiển thị nhiều mục hơn. data chỉ có thể là một trong những trạng thái sau đây:
textParagraph

TextParagraph

Hiển thị đ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ề 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Định dạng văn bản trong tiện ích bổ sung cho Google Workspace.

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

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

Image

Hiển thị hình ảnh.

Ví dụ: JSON sau đây 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

DecoratedText

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

Ví dụ: tệp JSON sau đây tạo một tiện ích văn bản được trang trí và 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

ButtonList

Danh sách các nút.

Ví dụ: JSON sau đây tạo 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

TextInput

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

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

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

Một ví dụ khác: JSON sau đây tạo một mục nhập văn bản cho một ngôn ngữ lập trình với 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

SelectionInput

Cho thấy một tuỳ chọn kiểm soát 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 một 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

DateTimePicker

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

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

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

Divider

Hiện đường phân chia đường ngang giữa các tiện ích.

Ví dụ: JSON sau đây tạo một bộ chia:

"divider": {
}
grid

Grid

Hiển thị lưới có một tập hợ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 giới hạn trên của các mục số chia cho số cột. Một lưới gồm 10 mục và 2 cột sẽ có 5 hàng. Một lưới gồm 11 mục và 2 cột sẽ có 6 hàng.

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

Ví dụ: JSON sau đây tạo một lưới gồm 2 cột chứa 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

Columns

Hiện 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ụ: tệp 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

ChipList

Danh sách khối.

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

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

Có trong 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.

HorizontalAlignment

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

Có trong 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.

Enum
HORIZONTAL_ALIGNMENT_UNSPECIFIED Không sử dụng. Không xác định.
START Giá trị mặc định. Căn chỉnh các tiện ích tới vị trí bắt đầu của cột. Đối với bố cục từ trái sang phải, căn chỉnh sang trái. Đối với bố cục từ phải sang trái, hãy căn chỉnh sang phải.
CENTER Căn chỉnh các tiện ích vào giữa cột.
END Căn chỉnh các tiện ích tới vị trí cuối của cột. Đối với bố cục từ trái sang phải, hãy căn chỉnh tiện ích sang phải. Đối với bố cục từ phải sang trái, hãy căn chỉnh tiện ích sang trái.

ImageType

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

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

Enum
SQUARE Giá trị mặc định. Áp dụng một mặt nạ hình vuông cho hình ảnh. Ví dụ: hình ảnh 4x3 trở thành hình 3x3.
CIRCLE Áp dụng mặt nạ hình tròn cho hình ảnh. Ví dụ: ảnh 4x3 trở thành hình tròn có đường kính là 3.