Pemicu yang Dapat Diinstal

Seperti pemicu sederhana, pemicu yang dapat diinstal memungkinkan Apps Script menjalankan fungsi secara otomatis saat peristiwa tertentu, seperti membuka dokumen, terjadi. Namun, pemicu yang dapat diinstal menawarkan lebih banyak fleksibilitas daripada pemicu sederhana: pemicu dapat memanggil layanan yang memerlukan otorisasi, pemicu tersebut menawarkan beberapa jenis peristiwa tambahan termasuk pemicu berbasis waktu (jam), dan dapat dikontrol secara terprogram. Untuk pemicu sederhana dan dapat diinstal, Apps Script meneruskan fungsi yang dipicu objek peristiwa yang berisi informasi tentang konteks tempat peristiwa terjadi.

Batasan

Meskipun pemicu yang dapat diinstal menawarkan lebih banyak fleksibilitas daripada pemicu sederhana, pemicu tersebut tunduk pada beberapa batasan:

  • Cookie tidak berjalan jika file dibuka dalam mode hanya baca (lihat atau komentar). Untuk skrip mandiri, pengguna memerlukan setidaknya akses lihat ke file skrip agar pemicu berjalan dengan benar.
  • Eksekusi skrip dan permintaan API tidak menyebabkan pemicu berjalan. Misalnya, memanggil FormResponse.submit() untuk mengirimkan respons formulir baru tidak akan menyebabkan pemicu pengiriman formulir berjalan.

  • Pemicu yang dapat diinstal selalu berjalan di bawah akun pengguna yang membuatnya. Misalnya, jika Anda membuat pemicu terbuka yang dapat diinstal, pemicu tersebut akan berjalan saat rekan kerja membuka dokumen (jika rekan kerja Anda memiliki akses edit), tetapi akan berjalan sebagai akun Anda. Artinya, jika Anda membuat pemicu untuk mengirim email saat dokumen dibuka, email tersebut akan selalu dikirim dari akun Anda, bukan akun yang membuka dokumen. Namun, Anda dapat membuat pemicu yang dapat diinstal untuk setiap akun, yang akan menghasilkan satu email yang dikirim dari setiap akun.

  • Akun tertentu tidak dapat melihat pemicu yang diinstal dari akun kedua, meskipun akun pertama masih dapat mengaktifkan pemicu tersebut.

  • Pemicu yang dapat diinstal tunduk pada batas kuota pemicu Apps Script.

Pemicu berdasarkan waktu

Pemicu berbasis waktu (juga disebut pemicu jam) mirip dengan cron job di Unix. Pemicu berbasis waktu memungkinkan skrip dieksekusi pada waktu tertentu atau pada interval yang berulang, sesering setiap menit atau jarang sebulan sekali. (Perhatikan bahwa add-on dapat menggunakan pemicu berbasis waktu sekali per jam.) Waktu mungkin sedikit acak — misalnya, jika Anda membuat pemicu berulang pukul 9 pagi, Apps Script akan memilih waktu antara pukul 09.00 dan 10.00, lalu menjaga agar waktu tersebut konsisten dari hari ke hari agar berlalu 24 jam sebelum pemicu diaktifkan lagi.

Pemicu yang didorong peristiwa

Pemicu berbasis peristiwa yang dapat diinstal secara konseptual mirip dengan pemicu sederhana seperti onOpen(), tetapi dapat merespons peristiwa tambahan, dan berperilaku berbeda.

Misalnya, pemicu terbuka yang dapat diinstal untuk Google Spreadsheet akan diaktifkan setiap kali spreadsheet dibuka oleh pengguna yang memiliki akses edit, seperti pemicu onOpen() sederhana. Namun, versi yang dapat diinstal dapat memanggil layanan yang memerlukan otorisasi. Versi yang dapat diinstal berjalan dengan otorisasi pengguna yang membuat pemicu, meskipun pengguna lain dengan akses edit membuka spreadsheet.

Ada beberapa pemicu yang dapat diinstal untuk Google Workspace aplikasi:

  • Pemicu open yang dapat diinstal berjalan saat pengguna membuka spreadsheet, dokumen, atau formulir yang izinnya dapat mereka edit.
  • Pemicu edit yang dapat diinstal berjalan saat pengguna mengubah nilai dalam spreadsheet.
  • Pemicu change yang dapat diinstal berjalan saat pengguna mengubah struktur spreadsheet itu sendiri—misalnya, dengan menambahkan sheet baru atau menghapus kolom.
  • Pemicu pengiriman formulir yang dapat diinstal berjalan saat pengguna merespons formulir. Ada dua versi pemicu pengiriman formulir, versi untuk Google Formulir itu sendiri dan satu untuk Spreadsheet jika formulir dikirim ke spreadsheet.
  • Pemicu acara kalender yang dapat diinstal berjalan saat acara kalender pengguna diperbarui—dibuat, diedit, atau dihapus.

Anda dapat menggunakan pemicu yang dapat diinstal dalam skrip mandiri dan terikat. Misalnya, skrip mandiri dapat membuat pemicu yang dapat diinstal secara terprogram untuk file Google Spreadsheet arbitrer dengan memanggil TriggerBuilder.forSpreadsheet(key) dan meneruskan ID spreadsheet.

Mengelola pemicu secara manual

Untuk membuat pemicu yang dapat diinstal secara manual di editor skrip, ikuti langkah-langkah berikut:

  1. Buka project Apps Script Anda.
  2. Di sebelah kiri, klik Pemicu .
  3. Di kanan bawah, klik Tambahkan Pemicu.
  4. Pilih dan konfigurasikan jenis pemicu yang ingin Anda buat.
  5. Klik Simpan.

Mengelola pemicu secara terprogram

Anda juga dapat membuat dan menghapus pemicu secara terprogram dengan layanan Skrip. Mulai dengan memanggil ScriptApp.newTrigger(functionName), yang menampilkan TriggerBuilder.

Contoh berikut menunjukkan cara membuat dua pemicu berbasis waktu—satu yang diaktifkan setiap 6 jam, dan yang diaktifkan setiap hari Senin pukul 09.00 (di zona waktu yang ditetapkan untuk skrip Anda).

pemicu/pemicu.gs
/**
 * Creates two time-driven triggers.
 * @see https://developers.google.com/apps-script/guides/triggers/installable#time-driven_triggers
 */
function createTimeDrivenTriggers() {
  // Trigger every 6 hours.
  ScriptApp.newTrigger('myFunction')
      .timeBased()
      .everyHours(6)
      .create();
  // Trigger every Monday at 09:00.
  ScriptApp.newTrigger('myFunction')
      .timeBased()
      .onWeekDay(ScriptApp.WeekDay.MONDAY)
      .atHour(9)
      .create();
}

Contoh berikutnya menunjukkan cara membuat pemicu terbuka yang dapat diinstal untuk spreadsheet. Perhatikan bahwa, tidak seperti pemicu onOpen() sederhana, skrip untuk pemicu yang dapat diinstal tidak perlu terikat dengan spreadsheet. Untuk membuat pemicu ini dari skrip mandiri, cukup ganti SpreadsheetApp.getActive() dengan panggilan ke SpreadsheetApp.openById(id).

pemicu/pemicu.gs
/**
 * Creates a trigger for when a spreadsheet opens.
 * @see https://developers.google.com/apps-script/guides/triggers/installable
 */
function createSpreadsheetOpenTrigger() {
  const ss = SpreadsheetApp.getActive();
  ScriptApp.newTrigger('myFunction')
      .forSpreadsheet(ss)
      .onOpen()
      .create();
}

Untuk mengubah pemicu yang dapat diinstal secara terprogram, Anda harus menghapusnya dan membuat pemicu baru. Jika sebelumnya Anda telah menyimpan ID pemicu, Anda dapat menghapusnya dengan meneruskan ID sebagai argumen ke fungsi di bawah ini.

pemicu/pemicu.gs
/**
 * Deletes a trigger.
 * @param {string} triggerId The Trigger ID.
 * @see https://developers.google.com/apps-script/guides/triggers/installable
 */
function deleteTrigger(triggerId) {
  // Loop over all triggers.
  const allTriggers = ScriptApp.getProjectTriggers();
  for (let index = 0; index < allTriggers.length; index++) {
    // If the current trigger is the correct one, delete it.
    if (allTriggers[index].getUniqueId() === triggerId) {
      ScriptApp.deleteTrigger(allTriggers[index]);
      break;
    }
  }
}

Error pada pemicu

Jika pemicu yang dapat diinstal aktif, tetapi fungsi menampilkan pengecualian atau gagal dijalankan, Anda tidak akan melihat pesan error di layar. Lagi pula, saat pemicu berbasis waktu berjalan atau pengguna lain mengaktifkan pemicu pengiriman formulir, Anda bahkan mungkin tidak berada di komputer.

Sebagai gantinya, Apps Script akan mengirimkan email kepada Anda, seperti berikut:

From: apps-scripts-notifications@google.com
Subject: Summary of failures for Google Apps Script
Your script has recently failed to finish successfully.
A summary of the failure(s) is shown below.

Email tersebut menyertakan link untuk menonaktifkan atau mengonfigurasi ulang pemicu. Jika skrip terikat ke file Google Spreadsheet, Dokumen, atau Formulir, email juga menyertakan link ke file tersebut. Link ini memungkinkan Anda menonaktifkan pemicu atau mengedit skrip untuk memperbaiki bug.

Untuk meninjau semua pemicu yang terkait dengan Akun Google Anda dan menonaktifkan pemicu yang tidak diperlukan lagi, ikuti langkah-langkah berikut:

  1. Buka script.google.com.
  2. Di sebelah kiri, klik Pemicu Saya.
  3. Untuk menghapus pemicu, di sebelah kanan pemicu, klik Lainnya > Hapus pemicu.

Pemicu yang dapat diinstal dalam add-on

Untuk mengetahui informasi selengkapnya tentang penggunaan pemicu yang dapat diinstal dalam add-on, lihat Pemicu add-on.