Điều kiện kích hoạt cho tiện ích bổ sung của Google Workspace

Các yếu tố kích hoạt Apps Script khiến một hàm tập lệnh được chỉ định (hàm yếu tố kích hoạt) thực thi bất cứ khi nào một sự kiện được chỉ định xảy ra. Chỉ một số sự kiện nhất định mới có thể khiến các yếu tố kích hoạt hoạt động và mỗi ứng dụng Google Workspace hỗ trợ một tập hợp sự kiện khác nhau.

Khi một điều kiện kích hoạt hoạt động, một đối tượng sự kiện sẽ được tạo. Cấu trúc JSON này chứa thông tin chi tiết về sự kiện đã xảy ra. Thông tin trong cấu trúc đối tượng sự kiện được sắp xếp theo cách khác nhau dựa trên loại điều kiện kích hoạt.

Sau khi đối tượng sự kiện được tạo, Apps Script sẽ truyền đối tượng đó dưới dạng tham số cho hàm kích hoạt. Hàm yếu tố kích hoạt là một hàm callback mà bạn phải tự triển khai để thực hiện mọi hành động thích hợp nhằm phản hồi sự kiện. Ví dụ: trong một tiện ích bổ sung Google Workspace mở rộng Gmail, bạn có thể xác định một yếu tố kích hoạt tạo giao diện thẻ mới khi người dùng mở một chuỗi thư. Trong trường hợp này, bạn triển khai một hàm callback theo bối cảnh để tạo các thẻ tạo nên giao diện người dùng mới bằng dữ liệu được truyền trong đối tượng sự kiện.

Trang này cung cấp hướng dẫn về cách sử dụng các yếu tố kích hoạt trong dự án tiện ích bổ sung Google Workspace.

Yếu tố kích hoạt tệp kê khai

Không giống như tiện ích bổ sung Editor, tiện ích bổ sung Google Workspace không thể sử dụng Google Apps Script các yếu tố kích hoạt đơn giản. Thay vào đó, chúng sử dụng các yếu tố kích hoạt được thiết kế riêng cho tiện ích bổ sung Google Workspace: yếu tố kích hoạt tệp kê khai.

Các yếu tố kích hoạt tệp kê khai được xác định trong tệp kê khai tiện ích bổ sung Google Workspace manifest. Ví dụ:

  • Yếu tố kích hoạt trang chủ tạo và hiển thị trang chủ tiện ích bổ sung.
  • Yếu tố kích hoạt eventOpen của Lịch Google hiển thị một thẻ mới hoặc thực hiện các hành động khác khi một sự kiện được mở.
  • Yếu tố kích hoạt eventUpdate của Lịch hiển thị một thẻ mới hoặc thực hiện các hành động khác khi người dùng chỉnh sửa và lưu một sự kiện.
  • Yếu tố kích hoạt onItemsSelected của Google Drive hiển thị một thẻ mới hoặc thực hiện các hành động khác khi người dùng chọn tệp hoặc thư mục.
  • Yếu tố kích hoạt soạn thư của Gmail hiển thị một thẻ tiện ích bổ sung khi người dùng mở tiện ích bổ sung trong cửa sổ soạn thư.
  • Yếu tố kích hoạt theo bối cảnh của Gmail hiển thị một thẻ mới hoặc thực hiện các hành động khác khi người dùng mở một thư.
  • Yếu tố kích hoạt onFileScopeGranted của Trình chỉnh sửa hiển thị một thẻ mới khi người dùng cấp quyền cho phạm vi OAuth drive.file trong tài liệu.

Trong danh sách, chỉ có yếu tố kích hoạt trang chủ là không theo bối cảnh; các yếu tố còn lại là theo bối cảnh. Hãy xem Tệp kê khai để biết thêm thông tin về định nghĩa điều kiện kích hoạt tệp kê khai.

Ngoài các yếu tố kích hoạt tệp kê khai, tiện ích bổ sung Google Workspace có thể sử dụng các yếu tố kích hoạt có thể cài đặt của Apps Script .

Quy định hạn chế

Các yếu tố kích hoạt tệp kê khai có một số quy định hạn chế đối với việc sử dụng.

  • Các yếu tố kích hoạt này chỉ được sử dụng trong dự án tiện ích bổ sung Google Workspace.
  • Vì các yếu tố này được xác định trong tệp kê khai tiện ích bổ sung chứ không phải trong mã, nên bạn không thể sử dụng dịch vụ Apps Script Script để tạo hoặc sửa đổi các yếu tố này.
  • Yếu tố kích hoạt theo bối cảnh của Gmail hoạt động cho mọi thư email, bất kể nội dung.
  • Mỗi tiện ích bổ sung chỉ có thể có một yếu tố kích hoạt thuộc mỗi loại, cho mỗi người dùng, cho mỗi tài liệu.