Pemicu yang Dapat Diinstal

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

Batasan

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

  • Pengujian ini 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 dapat berjalan dengan benar.

  • Eksekusi skrip dan permintaan API tidak menyebabkan pemicu dijalankan. Misalnya, memanggil FormResponse.submit() untuk mengirimkan respons formulir baru tidak menyebabkan pemicu pengiriman formulir dijalankan.

  • Pemicu yang dapat diinstal selalu dijalankan di akun orang yang membuatnya. Misalnya, jika Anda membuat pemicu terbuka yang dapat diinstal, pemicu ini akan dijalankan saat rekan kerja Anda membuka dokumen (jika rekan kerja Anda memiliki akses edit), tetapi pemicu tersebut akan dijalankan sebagai akun Anda. Artinya, jika Anda membuat pemicu untuk mengirim email saat dokumen dibuka, email akan selalu dikirim dari akun Anda, tidak harus akun yang membuka dokumen tersebut. 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 (disebut juga pemicu jam) mirip dengan cron job di Unix. Pemicu berdasarkan waktu memungkinkan skrip dieksekusi pada waktu tertentu atau pada interval berulang, sesering setiap menit atau sesering sebulan sekali. (Perhatikan bahwa add-on dapat menggunakan pemicu berbasis waktu paling banyak satu kali per jam.) Waktu mungkin sedikit diacak—misalnya, jika Anda membuat pemicu berulang pukul 09.00, Apps Script akan memilih waktu antara pukul 09.00 hingga 10.00, lalu menjaga waktu tersebut konsisten dari hari ke hari sehingga 24 jam berlalu sebelum pemicu diaktifkan lagi.

Berikut adalah contoh aplikasi Google Chat yang memposting pesan setiap menit ke setiap ruang tempat aplikasi berada:

// Example app for Google Chat that demonstrates app-initiated messages
// by spamming the user every minute.
//
// This app makes use of the Apps Script OAuth2 library at:
//     https://github.com/googlesamples/apps-script-oauth2
//
// Follow the instructions there to add the library to your script.

// When added to a space, we store the space's ID in ScriptProperties.
function onAddToSpace(e) {
  PropertiesService.getScriptProperties()
      .setProperty(e.space.name, '');
  return {
    'text': 'Hi! I\'ll post a message here every minute. ' +
            'Please remove me after testing or I\'ll keep spamming you!'
  };
}

// When removed from a space, we remove the space's ID from ScriptProperties.
function onRemoveFromSpace(e) {
  PropertiesService.getScriptProperties()
      .deleteProperty(e.space.name);
}

// Add a trigger that invokes this function every minute in the
// "Edit > Current Project's Triggers" menu. When it runs, it
// posts in each space the app was added to.
function onTrigger() {
  var spaceIds = PropertiesService.getScriptProperties()
      .getKeys();
  var message = { 'text': 'Hi! It\'s now ' + (new Date()) };
  for (var i = 0; i < spaceIds.length; ++i) {
    postMessage(spaceIds[i], message);
  }
}
var SCOPE = 'https://www.googleapis.com/auth/chat.bot';
// The values below are copied from the JSON file downloaded upon
// service account creation.
// For SERVICE_ACCOUNT_PRIVATE_KEY, remember to include the BEGIN and END lines
// of the private key
var SERVICE_ACCOUNT_PRIVATE_KEY = '...';
var SERVICE_ACCOUNT_EMAIL = 'service-account@project-id.iam.gserviceaccount.com';

// Posts a message into the given space ID via the API, using
// service account authentication.
function postMessage(spaceId, message) {
  var service = OAuth2.createService('chat')
      .setTokenUrl('https://accounts.google.com/o/oauth2/token')
      .setPrivateKey(SERVICE_ACCOUNT_PRIVATE_KEY)
      .setClientId(SERVICE_ACCOUNT_EMAIL)
      .setPropertyStore(PropertiesService.getUserProperties())
      .setScope(SCOPE);
  if (!service.hasAccess()) {
    Logger.log('Authentication error: %s', service.getLastError());
    return;
  }
  var url = 'https://chat.googleapis.com/v1/' + spaceId + '/messages';
  UrlFetchApp.fetch(url, {
    method: 'post',
    headers: { 'Authorization': 'Bearer ' + service.getAccessToken() },
    contentType: 'application/json',
    payload: JSON.stringify(message),
  });
}

Pemicu berbasis peristiwa

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

Misalnya, pemicu terbuka yang dapat diinstal untuk Google Spreadsheet akan aktif 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 akan dijalankan dengan otorisasi pengguna yang membuat pemicu, meskipun jika pengguna lain dengan akses edit membuka spreadsheet.

Ada beberapa pemicu yang dapat diinstal untuk Google Workspace aplikasi:

  • Pemicu terbuka yang dapat diinstal berjalan saat pengguna membuka spreadsheet, dokumen, atau formulir yang boleh diedit oleh pengguna tersebut.
  • Pemicu edit yang dapat diinstal berjalan saat pengguna mengubah nilai di spreadsheet.
  • Pemicu perubahan yang dapat diinstal dijalankan 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, satu 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 secara terprogram membuat pemicu yang dapat diinstal untuk file Google Spreadsheet arbitrer dengan memanggil TriggerBuilder.forSpreadsheet(key) dan meneruskan ID spreadsheet.

Kelola pemicu secara manual

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

  1. Buka project Apps Script.
  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 berdasarkan waktu—satu yang aktif setiap 6 jam, dan satu lagi yang diaktifkan setiap hari Senin pukul 9 pagi (di zona waktu tempat skrip Anda ditetapkan).

triggers/triggers.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 ini 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).

triggers/triggers.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 sudah ada dan dapat diinstal secara terprogram, Anda harus menghapusnya dan membuat yang baru. Jika sebelumnya telah menyimpan ID pemicu, Anda dapat menghapusnya dengan meneruskan ID sebagai argumen ke fungsi di bawah ini.

triggers/triggers.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 dalam pemicu

Jika pemicu yang dapat diinstal diaktifkan tetapi fungsi tersebut menampilkan pengecualian atau tidak berhasil berjalan, 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 sedang berada di depan komputer.

Sebagai gantinya, Apps Script mengirimkan email seperti berikut:

From: noreply-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. Dengan link ini, Anda dapat 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 di add-on

Untuk mengetahui informasi selengkapnya tentang cara menggunakan pemicu yang dapat diinstal di add-on, lihat Pemicu add-on.