Package google.apps.card.v1

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.

ActionParameter

Danh sách thông 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 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

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.

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

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

bool

Dành cho các ứng dụng trong 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 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ị 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.

int32

Bán kính góc của đườ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 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 text và icon 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, green và blue. 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

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.

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.

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

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.

Button

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

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

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

DividerStyle

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

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 Settings và Send 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"
      }
    }
  }
]

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.

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

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.

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.

string

Nhãn xuất hiện 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à được đặt màu.

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.

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.

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.

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

string

URL loại 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 việc 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 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.

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

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 xuất hiện 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 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.

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.

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

Layout

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

Chip

Một mảng chip.

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

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.

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 xem các tiện ích căn chỉnh sang trái, phải hay giữa cột.

VerticalAlignment

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

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.

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

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.

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.

DateTimePickerType

Tiện ích này có hỗ trợ nhập ngày, giờ hoặ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ụ:để 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).

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.

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

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

Icon

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

Icon

Biểu tượng xuất hiện ở phía 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ẽ 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 topLabel và bottomLabel.

string

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

OnClick

Hành động 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 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.

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.

bool

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

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

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.

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.

Suggestions

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.

string

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

GridItem

Các mục để 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 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

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.

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

ImageComponent

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

string

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

string

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

GridItemLayout

Bố cục cần 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 để 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

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.

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ị 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 và .jpg.

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.

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

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 việc hỗ trợ tiếp cận.

string

URL 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 sẽ á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ụ: dưới đây là cách áp dụng tỷ lệ khung hình 16:9:

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

string

URL của đường liên kết để quay lại tiện ích bổ sung.

string

Tiêu đề của đường liên kết để quay lại tiện ích bổ sung.

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.

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.

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.

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

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.

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.

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.

bool

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

bool

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

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.

Card

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

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

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.

string

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

Action

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

OpenLink

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

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

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

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.

string

URL cần mở.

OpenAs

Cách mở đường liên kế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.

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

OverflowMenuItem

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

Icon

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

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

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.

bool

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

Action

HostAppActionMarkup

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

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.

Navigation

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

OpenLink

Mở ngay đường liên kết đích trong thẻ mới hoặc cửa sổ bật lên.

Notification

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

LinkPreview

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

Link

Đường liên kết đến tài nguyên của bên thứ ba được tạo trong một ứng dụng của Google Workspace. Được định dạng dưới dạng một mảng các đối tượng có một mục. Để biết thêm thông tin, hãy xem phần Tạo tài nguyên bên thứ ba qua trình đơn @.

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.

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

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.

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.

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.

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.

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

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

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

string

Văn bản giúp xác định hoặc mô tả mặt hàng cho người dù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 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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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

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.

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.

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ị Java và JavaScript.

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.

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

Dành cho các ứng dụng trong 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 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.

string

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

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.

int32

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

InputType

Dành cho các ứng dụng trong Google Chat và 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.

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 và Đị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

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

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

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

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

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

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

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

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

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

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.