Pemicu untuk add-on Google Workspace

Pemicu Apps Script menyebabkan fungsi skrip tertentu (fungsi pemicu) dijalankan setiap kali peristiwa tertentu 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 melakukan tindakan apa pun yang sesuai untuk merespons peristiwa tersebut. 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 penggunaan pemicu dalam project add-on Google Workspace.

Pemicu manifes

Tidak seperti add-on Editor, add-on Google Workspace tidak dapat menggunakan Google Apps Script pemicu sederhana. Sebagai gantinya, add-on Google Workspace menggunakan pemicu yang dirancang khusus untuk add-on Google Workspace: pemicu manifes.

Pemicu manifes ditentukan dalam manifes add-on Google Workspace manifest. Contohnya mencakup:

  • Pemicu halaman beranda yang membuat dan menampilkan halaman beranda add-on.
  • Pemicu eventOpen Google Kalender yang menampilkan kartu baru atau melakukan tindakan lain saat acara dibuka.
  • Pemicu eventUpdate Kalender yang menampilkan kartu baru atau melakukan tindakan lain saat pengguna mengedit dan menyimpan acara.
  • Pemicu onItemsSelected Google Drive yang menampilkan kartu baru atau melakukan tindakan lain saat pengguna memilih file atau folder.
  • Pemicu tulis Gmail yang menampilkan kartu add-on saat pengguna membuka add-on di jendela tulis.
  • Pemicu kontekstual Gmail yang menampilkan kartu baru atau melakukan tindakan lain saat pengguna membuka pesan.
  • Pemicu onFileScopeGranted Editor yang menampilkan kartu baru saat pengguna memberikan otorisasi untuk cakupan OAuth drive.file dalam dokumen.

Dalam daftar, hanya pemicu halaman beranda yang non-kontekstual; sisanya bersifat kontekstual. Lihat Manifes untuk mengetahui informasi selengkapnya tentang definisi pemicu manifes.

Selain pemicu manifes, add-on Google Workspace 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.
  • Karena ditentukan dalam manifes add-on dan bukan dalam kode, Anda tidak dapat menggunakan layanan Apps Script Script untuk membuat atau mengubahnya.
  • Pemicu kontekstual Gmail diaktifkan untuk setiap pesan email, terlepas dari kontennya.
  • Setiap add-on hanya dapat memiliki satu pemicu dari setiap jenis, per pengguna, per dokumen.