Action

Một hành động 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ị biểu mẫu sẽ được gửi đến máy chủ.

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

Biểu diễn dưới dạng JSON
{
  "function": string,
  "parameters": [
    {
      object (ActionParameter)
    }
  ],
  "loadIndicator": enum (LoadIndicator),
  "persistValues": boolean,
  "interaction": enum (Interaction),
  "requiredWidgets": [
    string
  ],
  "allWidgetsAreRequired": boolean
}
Trường
function

string

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

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

parameters[]

object (ActionParameter)

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

loadIndicator

enum (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 đến hành động.

persistValues

boolean

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

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

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

interaction

enum (Interaction)

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

Việc cần làm để phản hồi một lượt tương tác với người dùng, chẳng hạn như khi người dùng nhấp vào một nút trong tin nhắn dạng 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 những cách tương tác đặc biệt. Ví dụ: bằng cách đặ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 đang tải sẽ không xuất hiện. Nếu được chỉ định cho một tiện ích bổ sung, toàn bộ thẻ sẽ bị xoá và không có nội dung nào xuất hiện trong ứng dụng.

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

requiredWidgets[]

string

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

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 Google Chat và tiện ích bổ sung của Google Workspace.

allWidgetsAreRequired

boolean

Không bắt buộc. Nếu đúng, thì tất cả các tiện ích đều được coi là bắt buộc đối với hành động này.

Dành cho các ứng dụng 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 ẩn ngay, tạm ẩn một ngày hoặc tạm ẩn vào tuần tới. Bạn có thể sử dụng action method = snooze(), truyền loại báo lại và thời gian báo lại trong danh sách tham số chuỗi.

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

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

Biểu diễn dưới dạng JSON
{
  "key": string,
  "value": string
}
Trường
key

string

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

value

string

Giá trị của tham số.

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 đến hành động.

Dành cho các ứng dụng 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 được hiển thị.

Tương tác

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

Việc cần làm để phản hồi một lượt tương tác với người dùng, chẳng hạn như khi người dùng nhấp vào một nút trong tin nhắn dạng 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 những cách tương tác đặc biệt. Ví dụ: bằng cách đặ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 đang tải sẽ không xuất hiện. Nếu được chỉ định cho một tiện ích bổ sung, toàn bộ thẻ sẽ bị xoá và không có nội dung nào xuất hiện trong ứng dụng.

Có thể dùng cho các ứng dụng Google Chat và không thể dùng 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 dạng cửa sổ, dựa trên thẻ mà các ứng dụng Chat dùng để tương tác với người dùng.

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

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