Trình kích hoạt Apps Script 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 riêng.
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 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 một 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 bất kỳ hành động nào phù 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 đ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 sẽ triển khai một hàm gọi lại 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 cách sử dụ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 điều kiện kích hoạt trong dự án tiện ích bổ sung 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.
Các điều kiện 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ề các điều kiện 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.
- Sự kiện trên lịchMở các điều kiện kích hoạt hiển thị thẻ mới hoặc thực hiện các hành động khác khi một sự kiện trên Lịch được mở.
- Sự kiện trên lịchKích hoạt sự kiện cập nhật hiển thị 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 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 hành động 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 sẽ 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 bối cảnh của Gmail sẽ 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ư trong Gmail.
- Editor onFileScopeGranted triggers hiển thị một thẻ mới khi người dùng cấp quyền uỷ quyền cho phạm vi OAuth
drive.filetrong tài liệu Editor hiện tại.
Trong danh sách trên, chỉ có trình kích hoạt trang chủ là không theo bối cảnh; các trình kích hoạt còn lại là trình kích hoạt theo bối cảnh. Hãy xem Tệp kê khai để biết thêm thông tin về các định nghĩa về điều kiện kích hoạt tệp kê khai.
Ngoài các 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ế
Các điều kiện kích hoạt trong tệp kê khai có một số hạn chế khi 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 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ụ
ScriptApps Script để tạo hoặc sửa đổi các trình kích hoạt này. - Hiện tại, các điều kiện kích hoạt theo bối cảnh của Gmail chỉ có thể có tiêu chí
unconditional. Điều này có nghĩa là các điều kiện kích hoạt theo ngữ cảnh sẽ kích hoạt cho mọi thư 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 thuộc mỗi loại, cho mỗi người dùng, cho mỗi tài liệu.