Activadores instalables

Al igual que los activadores simples, los activadores instalables permiten que Apps Script ejecute una función automáticamente cuando ocurre 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 activadores basados en el tiempo (reloj), y se pueden controlar de manera programática. Tanto en el caso de los activadores instalables como los simples, Apps Script pasa la función activada un objeto de evento que contiene información sobre el contexto en el que ocurrió el evento.

Restricciones

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

  • No se ejecutan si un archivo se abre en modo de solo lectura (ver o comentar). En el caso de las secuencias de comandos independientes, los usuarios necesitan, como mínimo, acceso de lectura 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 provocan la ejecución de 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 bajo la cuenta de la persona que los creó. Por ejemplo, si creas un activador abierto instalable, este se ejecuta cuando tu colega abre el documento (si tu colega tiene acceso de edición), pero se ejecuta 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 envía desde tu cuenta, no necesariamente desde la cuenta que lo abrió. Sin embargo, puedes crear un activador instalable para cada cuenta, lo que generaría un correo electrónico desde cada una.

  • Una cuenta determinada no puede ver los activadores instalados de una segunda cuenta, aunque la primera cuenta aún pueda activarlos.

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

Activadores basados en el tiempo

Un activador controlado por el 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 a una hora particular o en un intervalo recurrente, con la misma frecuencia que cada minuto o con una menor frecuencia que una vez por mes. (Ten en cuenta que un complemento puede usar un activador controlado por el tiempo una vez por hora como máximo). La hora puede ser un poco aleatoria. Por ejemplo, si creas un activador recurrente de las 9 a.m., Apps Script elige una hora entre las 9 a.m. y las 10 a.m. y, luego, mantiene ese tiempo coherente todos los días para que transcurran 24 horas antes de que el activador vuelva a activarse.

El siguiente es un ejemplo de una app de Google Chat que publica un mensaje cada minuto en cada espacio en el que se encuentra la app:

// 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),
  });
}

Activadores basados en eventos

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

Por ejemplo, el activador de apertura instalable de Hojas de cálculo de Google se activa cada vez que un usuario con acceso de edición abre la hoja de cálculo, al igual que el activador simple onOpen(). 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 aplicacionesGoogle Workspace :

  • Un activador open instalable se ejecuta cuando un usuario abre una hoja de cálculo, un documento o un formulario para los que tiene permiso para editar.
  • Un activador edit 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 una 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, se crean, editan o borran los eventos de calendario de un usuario.

Puedes usar activadores instalables en secuencias de comandos independientes y vinculadas. Por ejemplo, una secuencia de comandos independiente puede crear de manera 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 de forma manual un activador instalable en el editor de secuencia 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 manera programática

También puedes crear y borrar activadores de manera programática con el servicio de secuencias de comandos. Primero, llama a ScriptApp.newTrigger(functionName), que muestra un TriggerBuilder.

En el siguiente ejemplo, se muestra cómo crear dos activadores basados en el tiempo: uno que se active cada 6 horas y otro que se active todos los lunes a las 9 a.m. (en la zona horaria en la que esté configurada la 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 abierto instalable para una hoja de cálculo. Ten en cuenta que, a diferencia de un activador onOpen() simple, no es necesario que la secuencia de comandos del activador instalable esté 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 manera programática un activador instalable existente, debes borrarlo y crear uno nuevo. Si ya almacenaste el ID de un activador, puedes borrarlo si pasas 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;
    }
  }
}

Errores en 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 controlado por el tiempo o cuando otro usuario activa el activador de envío de formulario, es posible que ni siquiera estés en tu 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 incluirá 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 necesitas, sigue estos pasos:

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

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

Activadores en complementos

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