Pemicu untuk add-on Google Workspace

Tetap teratur dengan koleksi Simpan dan kategorikan konten berdasarkan preferensi Anda.

Pemicu Apps Script menyebabkan fungsi skrip yang ditentukan (fungsi pemicu) dieksekusi 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 terapkan sendiri, untuk mengambil tindakan yang sesuai guna merespons peristiwa. Misalnya, dalam add-on Google Workspace yang memperluas Gmail, Anda dapat menentukan pemicu yang membuat antarmuka kartu baru saat pengguna membuka thread 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, tetapi 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 membuat dan menampilkan halaman beranda add-on.
  • Pemicu peristiwa Kalender yang menampilkan kartu baru atau melakukan tindakan lainnya saat acara Kalender dibuka.
  • Pemicu peristiwa Update yang menampilkan kartu baru atau melakukan tindakan lainnya saat pengguna mengedit dan menyimpan acara Kalender.
  • Pemicu onItemsSelected yang menampilkan kartu baru atau melakukan 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 tulis Gmail.
  • Pemicu kontekstual Gmail yang menampilkan kartu baru atau melakukan tindakan lainnya 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 tidak kontekstual; sisanya adalah pemicu kontekstual. Lihat Manifes untuk informasi selengkapnya tentang definisi pemicu manifes.

Selain pemicu manifes, Add-on Google Workspace juga dapat menggunakan pemicu yang dapat diinstal Apps Script.

Batasan

Pemicu manifes memiliki batasan tertentu dalam penggunaannya.

  • Pemicu ini hanya digunakan dalam project Add-on Google Workspace. Pemicu ini tidak memiliki tujuan dalam aplikasi lainnya.
  • Karena ditentukan dalam manifes add-on dan bukan dalam kodenya, Anda tidak dapat menggunakan layanan Script Skrip Aplikasi untuk membuat atau mengubah pemicu ini.
  • Pemicu kontekstual Gmail saat ini hanya dapat memiliki kriteria unconditional. Ini berarti pemicu kontekstual diaktifkan untuk setiap pesan email, terlepas dari kontennya.