Pemicu Apps Script menyebabkan fungsi skrip yang ditentukan (fungsi pemicu) dijalankan setiap kali peristiwa yang ditentukan terjadi. Hanya peristiwa tertentu yang dapat menyebabkan pemicu diaktifkan, dan setiap aplikasi Google Workspace mendukung kumpulan peristiwa yang berbeda.
Saat pemicu diaktifkan, objek peristiwa akan dibuat. Struktur JSON ini berisi detail tentang peristiwa yang terjadi. Informasi dalam struktur objek peristiwa diatur secara berbeda berdasarkan jenis pemicu.
Setelah objek peristiwa dibuat, Apps Script akan meneruskannya sebagai parameter ke fungsi pemicu. Fungsi pemicu adalah fungsi callback yang harus Anda implementasikan sendiri, untuk mengambil tindakan apa pun yang sesuai untuk merespons peristiwa. Misalnya, di add-on Google Workspace yang memperluas Gmail, Anda dapat menentukan pemicu yang membuat antarmuka kartu baru saat pengguna membuka rangkaian pesan. Dalam hal ini, Anda menerapkan fungsi callback kontekstual untuk membuat kartu yang membentuk UI baru menggunakan data yang diteruskan dalam objek peristiwa.
Halaman ini memberikan panduan tentang cara menggunakan pemicu di project add-on Google Workspace.
Pemicu manifes
Tidak seperti add-on Editor, add-on Google Workspace saat ini tidak dapat menggunakan pemicu sederhana Apps Script. Sebagai gantinya, add-on ini menggunakan pemicu yang dirancang khusus untuk add-on Google Workspace: pemicu manifes.
Pemicu manifes ditentukan sepenuhnya dalam manifes add-on Google Workspace. Contoh pemicu manifes mencakup hal berikut:
- Pemicu halaman beranda yang mem-build dan menampilkan halaman beranda add-on.
- Pemicu acaraBuka Kalender yang menampilkan kartu baru atau mengambil tindakan lain saat acara Kalender dibuka.
- Pemicu eventUpdate Kalender yang menampilkan kartu baru atau mengambil tindakan lain saat pengguna mengedit dan menyimpan acara Kalender.
- Pemicu onItemsSelected Drive yang menampilkan kartu baru atau mengambil tindakan lain saat pengguna memilih satu atau beberapa file atau folder di Drive.
- Pemicu compose Gmail yang menampilkan kartu add-on saat pengguna membuka add-on di jendela compose Gmail.
- Pemicu kontekstual Gmail yang menampilkan kartu baru atau melakukan tindakan lain saat pengguna membuka pesan Gmail.
- Pemicu onFileScopeGranted Editor yang menampilkan kartu baru saat pengguna
memberikan otorisasi untuk cakupan OAuth
drive.file
dalam dokumen Editor saat ini.
Dalam daftar di atas, hanya pemicu halaman beranda yang bersifat non-kontekstual; sisanya adalah pemicu kontekstual. Lihat Manifes untuk mengetahui informasi selengkapnya tentang definisi pemicu manifes.
Selain pemicu manifes, add-on Google Workspace juga dapat menggunakan pemicu yang dapat diinstal Apps Script.
Pembatasan
Pemicu manifes memiliki batasan tertentu untuk penggunaannya.
- Pemicu ini hanya digunakan dalam project add-on Google Workspace; pemicu ini tidak memiliki tujuan di aplikasi lain.
- Karena ditentukan dalam manifes add-on, bukan dalam kodenya, Anda tidak dapat
menggunakan layanan
Script
Apps Script untuk membuat atau mengubah pemicu ini. - Pemicu kontekstual Gmail saat ini hanya dapat memiliki kriteria
unconditional
. Artinya, pemicu kontekstual diaktifkan untuk setiap pesan email, terlepas dari kontennya. - Setiap add-on hanya dapat memiliki satu pemicu dari setiap jenis, per pengguna, per dokumen.