Activadores instalables

Al igual que los activadores simples, los activadores instalables permiten que Apps Script ejecute una función automáticamente cuando se produce un evento determinado, como abrir un documento. Sin embargo, los activadores instalables ofrecen más flexibilidad que los activadores simples: pueden llamar a servicios que requieren autorización, ofrecen varios tipos adicionales de eventos, incluidos los activadores basados en el tiempo (reloj), y se pueden controlar de forma programática. Tanto para los activadores simples como para los instalables, Apps Script pasa a la función activada un objeto de evento que contiene información sobre el contexto en el que ocurrió el evento.

Restricciones

Si bien los activadores instalables ofrecen más flexibilidad que los activadores simples, aún están sujetos a varias restricciones:

  • No se ejecutan si un archivo se abre en modo de solo lectura (para ver o comentar). En el caso de las secuencias de comandos independientes, los usuarios necesitan al menos acceso de visualización al archivo de secuencia de comandos para que los activadores se ejecuten correctamente.

  • Las ejecuciones de secuencias de comandos y las solicitudes a la API no hacen que se ejecuten los activadores. Por ejemplo, llamar a FormResponse.submit() para enviar una respuesta de formulario nueva no hace que se ejecute el activador de envío del formulario.

  • Los activadores instalables siempre se ejecutan en la cuenta de la persona que los creó. Por ejemplo, si creas un activador abierto instalable, se ejecutará cuando tu colega abra el documento (si tiene acceso de edición), pero se ejecutará como tu cuenta. Esto significa que, si creas un activador para enviar un correo electrónico cuando se abre un documento, el correo electrónico siempre se enviará desde tu cuenta, no necesariamente desde la cuenta que abrió el documento. Sin embargo, puedes crear un activador instalable para cada cuenta, lo que generaría un correo electrónico enviado desde cada cuenta.

  • Una cuenta determinada no puede ver los activadores instalados desde una segunda cuenta, aunque la primera cuenta sí pueda activar esos activadores.

  • Los activadores instalables están sujetos a los límites de cuota de los activadores de Apps Script.

Activadores basados en el tiempo

Un activador controlado por tiempo (también llamado activador de reloj) es similar a un trabajo cron en Unix. Los activadores basados en el tiempo permiten que las secuencias de comandos se ejecuten en un momento determinado o en un intervalo recurrente, con una frecuencia de hasta cada minuto o de una vez al mes. (Ten en cuenta que un complemento puede usar un activador basado en el tiempo como máximo una vez por hora). La hora puede ser ligeramente aleatoria. Por ejemplo, si creas un activador recurrente a las 9 a.m., Apps Script elige una hora entre las 9 a.m. y las 10 a.m., y luego mantiene esa hora de forma coherente día a día para que transcurran 24 horas antes de que se vuelva a activar el activador.

Activadores basados en eventos

Los activadores basados en eventos instalables son conceptualmente similares a los activadores simples, como onOpen(), pero pueden responder a eventos adicionales y se comportan de manera diferente.

Por ejemplo, el activador abierto instalable para Hojas de cálculo de Google se activa cada vez que cualquier usuario con acceso de edición abre la hoja de cálculo, al igual que el activador onOpen() simple. Sin embargo, la versión instalable puede llamar a servicios que requieren autorización. La versión instalable se ejecuta con la autorización del usuario que creó el activador, incluso si otro usuario con acceso de edición abre la hoja de cálculo.

Existen varios activadores instalables para las aplicaciones deGoogle Workspace :

  • Un activador abrir instalable se ejecuta cuando un usuario abre una hoja de cálculo, un documento o un formulario que tiene permiso para editar.
  • Un activador de edición instalable se ejecuta cuando un usuario modifica un valor en una hoja de cálculo.
  • Un activador de cambio instalable se ejecuta cuando un usuario modifica la estructura de una hoja de cálculo, por ejemplo, cuando agrega una hoja nueva o quita una columna.
  • Un activador de envío de formulario instalable se ejecuta cuando un usuario responde a un formulario. Existen dos versiones del activador de envío de formulario: una para Formularios de Google y otra para Hojas de cálculo si el formulario se envía a una hoja de cálculo.
  • Un activador de evento de calendario instalable se ejecuta cuando se actualizan los eventos del calendario de un usuario, es decir, cuando se crean, editan o borran.

Puedes usar activadores instalables en secuencias de comandos independientes y vinculadas. Por ejemplo, una secuencia de comandos independiente puede crear de forma programática un activador instalable para un archivo arbitrario de Hojas de cálculo de Google llamando a TriggerBuilder.forSpreadsheet(key) y pasando el ID de la hoja de cálculo.

Administra activadores de forma manual

Para crear manualmente un activador instalable en el editor de secuencias de comandos, sigue estos pasos:

  1. Abre tu proyecto de Apps Script.
  2. A la izquierda, haz clic en Activadores .
  3. En la esquina inferior derecha, haz clic en Agregar activador.
  4. Selecciona y configura el tipo de activador que deseas crear.
  5. Haz clic en Guardar.

Administra activadores de forma programática

También puedes crear y borrar activadores de forma programática con el servicio de secuencias de comandos. Comienza llamando a ScriptApp.newTrigger(functionName), que devuelve un TriggerBuilder.

En el siguiente ejemplo, se muestra cómo crear dos activadores basados en el tiempo: uno que se activa cada 6 horas y otro que se activa todos los lunes a las 9 a.m. (en la zona horaria en la que está configurado tu secuencia de comandos).

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();
}

En el siguiente ejemplo, se muestra cómo crear un activador de apertura instalable para una hoja de cálculo. Ten en cuenta que, a diferencia de un activador onOpen() simple, la secuencia de comandos del activador instalable no necesita estar vinculada a la hoja de cálculo. Para crear este activador a partir de una secuencia de comandos independiente, simplemente reemplaza SpreadsheetApp.getActive() por una llamada a 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();
}

Para modificar de forma programática un activador instalable existente, debes borrarlo y crear uno nuevo. Si ya almacenaste el ID de un activador, puedes borrarlo pasando el ID como argumento a la siguiente función.

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;
    }
  }
}

Antes de crear un activador, te recomendamos que verifiques que la función asociada tenga todos los permisos de OAuth necesarios.

Errores en los activadores

Cuando se activa un activador instalable, pero la función arroja una excepción o no se ejecuta correctamente, no verás un mensaje de error en la pantalla. Después de todo, cuando se ejecuta un activador basado en el tiempo o cuando otro usuario activa el activador de envío de formulario, es posible que ni siquiera estés frente a la computadora.

En cambio, Apps Script te envía un correo electrónico como el siguiente:

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.

El correo electrónico incluye un vínculo para desactivar o volver a configurar el activador. Si la secuencia de comandos está vinculada a un archivo de Hojas de cálculo, Documentos o Formularios de Google, el correo electrónico también incluye un vínculo a ese archivo. Estos vínculos te permiten desactivar el activador o editar la secuencia de comandos para corregir el error.

Para revisar todos los activadores asociados con tu Cuenta de Google y desactivar los que ya no necesites, sigue estos pasos:

  1. Ve a script.google.com.
  2. A la izquierda, haz clic en Mis activadores.

  3. Para borrar un activador, haz clic en Más > Borrar activador a la derecha del activador.

Activadores en complementos

Además de los activadores instalables, puedes usar activadores de manifiesto en los complementos. Para obtener más información, consulta Activadores para complementos de Google Workspace.