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

Các điều kiện kích hoạt Apps Script gây ra một tập lệnh được chỉ định (hàm 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ể kích hoạt trình kích hoạt và mỗi sự kiện Ứng dụng Google Workspace hỗ trợ một nhóm sự kiện khác.

Khi một điều kiện kích hoạt kích hoạt, 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 sự kiện cấu trúc đối tượng đượ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 thông số đến hàm kích hoạt. Hàm kích hoạt là một hàm callback mà bạn phải tự triển khai, thực hiện bất kỳ hành động nào thích hợp nhằm đối phó với sự kiện. Ví dụ: trong một Tiện ích bổ sung của Google Workspace giúp mở rộng Gmail, bạn có thể xác định điều kiện kích hoạt sẽ tạo giao diện thẻ mới khi người dùng mở một thông báo chuỗi. Trong trường hợp này, bạn triển khai hàm callback theo ngữ cảnh để tạo các thẻ tạo nên giao diện người dùng mới bằng cách sử dụng dữ liệu được chuyển trong đối tượng sự kiện.

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

Điều kiện kích hoạt tệp kê khai

Không giống như Tiện ích bổ sung dành cho Trình chỉnh sửa, Tiện ích bổ sung của Google Workspace hiện không thể sử dụng các trình kích hoạt đơn giản của Apps Script Thay vào đó, chúng sử dụng trình kích hoạt được thiết kế riêng cho Tiện ích bổ sung cho Google Workspace: điều kiện kích hoạt tệp kê khai.

Điều kiện kích hoạt tệp kê khai được xác định hoàn toàn trong Tiện ích bổ sung của Google Workspace tệp kê khai. Ví dụ về trình kích hoạt tệp kê khai bao gồm sau:

  • Trình kích hoạt trang chủ tạo và hiển thị trang chủ tiện ích bổ sung.
  • Sự kiện trên lịchOpen sẽ kích hoạt để hiển thị một thẻ mới hoặc các thao tác khác khi người dùng mở sự kiện trên Lịch.
  • Lịch sự kiện cập nhật trình kích hoạt hiển thị một thẻ mới hoặc các thao tác khác khi người dùng chỉnh sửa và lưu sự kiện trên Lịch.
  • Điều kiện kích hoạt Drive onItemsSelected hiển thị một thẻ mới hoặc lấy các thao tác khác khi người dùng chọn một hoặc nhiều tệp hoặc thư mục trong Drive.
  • Kích hoạt tính năng soạn thư của Gmail hiển thị thẻ tiện ích bổ sung khi người dùng mở tiện ích bổ sung trong cửa sổ soạn thư của Gmail.
  • Trình kích hoạt theo ngữ cảnh trong Gmail hiển thị một thẻ mới hoặc lấy khi người dùng mở thư Gmail.
  • Trình kích hoạt onFileScope Grantsed hiển thị một thẻ mới khi người dùng cấp quyền cho drive.file phạm vi OAuth trong Trình chỉnh sửa hiện tại tài liệu.

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

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

Quy định hạn chế

Điều kiện kích hoạt trong tệp kê khai có một số hạn chế nhất định đối với việc sử dụng.

  • Các điều kiện kích hoạt này chỉ được dùng trong các dự án tiện ích bổ sung của Google Workspace; chúng không có mục đích trong bất kỳ ứng dụng nào khác.
  • Vì các tiện ích đó được xác định trong tệp kê khai tiện ích bổ sung chứ không phải trong mã của tiện ích bổ sung, nên bạn không thể sử dụng Apps Script Script để tạo hoặc sửa đổi các trình kích hoạt này.
  • Trình kích hoạt theo ngữ cảnh của Gmail hiện chỉ có thể có một tiêu chí unconditional. Điều này có nghĩa là trình kích hoạt theo ngữ cảnh sẽ kích hoạt cho mọi email, bất kể nội dung.
  • Mỗi tiện ích bổ sung chỉ có thể có một trình kích hoạt cho mỗi loại, cho mỗi người dùng, cho mỗi tài liệu.