Trình kích hoạt Apps Script sẽ khiến một hàm 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 điều kiện kích hoạt và mỗi ứng dụng Google Workspace hỗ trợ một nhóm sự kiện khác nhau.
Khi một điều kiện kích hoạt được 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 cấu trúc đối tượng sự kiện được sắp xếp khác nhau dựa trên loại trình kích hoạt.
Sau khi tạo đối tượng sự kiện, Apps Script sẽ truyền đối tượng đó dưới dạng tham số đến hàm kích hoạt. Hàm kích hoạt là một hàm gọi lại mà bạn phải tự triển khai để thực hiện mọi hành động phù hợp nhằm phản hồi sự kiện. Ví dụ: trong một tiện ích bổ sung của Google Workspace mở rộng Gmail, bạn có thể xác định một điều kiện 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 gọi lại 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 truyền trong đối tượng sự kiện.
Trang này cung cấp nguyên tắc về cách sử dụng trình kích hoạt trong các dự án tiện ích bổ sung của Google Workspace.
Trình kích hoạt tệp kê khai
Không giống như tiện ích bổ sung của Trình chỉnh sửa, tiện ích bổ sung của Google Workspace hiện không thể sử dụng trình kích hoạt đơn giản của Apps Script. Thay vào đó, các tiện ích này sử dụng trình kích hoạt được thiết kế riêng cho tiện ích bổ sung của Google Workspace: trình kích hoạt tệp kê khai.
Trình kích hoạt tệp kê khai được xác định hoàn toàn trong tệp kê khai của tiện ích bổ sung Google Workspace. Sau đây là một số ví dụ về trình kích hoạt tệp kê khai:
- Trình kích hoạt trang chủ tạo và hiển thị trang chủ của tiện ích bổ sung.
- Trình kích hoạt sự kiện Mở Lịch hiển thị một thẻ mới hoặc thực hiện các thao tác khác khi một sự kiện trên Lịch được mở.
- Trình kích hoạt eventUpdate của sự kiện trên Lịch hiển thị một thẻ mới hoặc thực hiện các thao tác khác khi người dùng chỉnh sửa và lưu một sự kiện trên Lịch.
- Trình kích hoạt Drive onItemsSelected hiển thị một thẻ mới hoặc thực hiện 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.
- Trình kích hoạt soạn thư trong 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 của Gmail hiển thị một thẻ mới hoặc thực hiện các thao tác khác khi người dùng mở một thư trong Gmail.
- Trình 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.filetrong tài liệu Trình chỉnh sửa hiện tại.
Trong danh sách trên, chỉ trình kích hoạt trang chủ là không theo bối cảnh; còn lại là trình kích hoạt theo bối cảnh. Hãy xem phần Tệp kê khai để biết thêm thông tin về định nghĩa điều kiện kích hoạt trong tệp kê khai.
Ngoài trình kích hoạt tệp kê khai, các tiện ích bổ sung của Google Workspace cũng có thể sử dụng trình kích hoạt có thể cài đặt của Apps Script.
Quy định hạn chế
Trình kích hoạt tệp kê khai có một số hạn chế nhất định đối với việc sử dụng.
- Các trình 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 nào trong bất kỳ ứng dụng nào khác.
- Vì các trình kích hoạt này đượ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 dịch vụ
Scriptcủa Apps 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 bối cảnh của Gmail hiện chỉ có thể có 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 của mỗi loại, cho mỗi người dùng, cho mỗi tài liệu.