Activadores de los complementos de editor

Los activadores de Apps Script hacen que se ejecute una función de secuencia de comandos específica (la función de activación) cada vez que se produce un evento específico. Solo ciertos eventos pueden activar activadores, y cada aplicación de Google Workspace admite un conjunto diferente de eventos.

Cuando se activa un activador, se crea un objeto de evento. Esta estructura JSON contiene detalles sobre el evento que ocurrió. La información en la estructura del objeto de evento se organiza de manera diferente según el tipo de activador.

Una vez que se crea el objeto de evento, Apps Script lo pasa como parámetro a la función de activador. La función activadora es una función de devolución de llamada que debes implementar a fin de realizar las acciones adecuadas para responder al evento. Por ejemplo, en un complemento de editor, se usa un activador para crear elementos de menú de complementos cuando se abre un documento. En este caso, debes implementar la función activadora onOpen(e) para crear los elementos del menú que el complemento necesita, en los que posiblemente se usen los datos del objeto de evento.

En esta página, se proporcionan lineamientos sobre el uso de activadores en proyectos de complementos de editor.

Tipos de activadores del complemento de editor

Puedes usar la mayoría de los tipos de activadores genéricos disponibles para proyectos de Apps Script en complementos de editor, incluidos los activadores simples y la mayoría de los activadores instalables. El conjunto exacto de tipos de activadores disponibles depende de la aplicación que se extienda.

En la siguiente tabla, se muestran los tipos de activadores simples e instalables que pueden usar los complementos de editor y se proporcionan vínculos a los objetos de evento correspondientes:

Evento Objeto de evento Activadores simples Activadores instalables
Abrir
Se abre un archivo de editor.
Objeto de evento onOpen de Documentos
Objeto de evento de onOpen
Objeto de evento de onOpen
Objeto de evento de onOpen
Documentos
Formularios*
Hojas de cálculo
Presentaciones

function onOpen(e)

Documentos
Formularios*
Hojas de cálculo
Instalar
El complemento está instalado.
Objeto on event onInstall Documentos
Formularios
Hojas de cálculo
Presentaciones

function onInstall(e)

Editar
Se modificó el contenido de las celdas de las hojas de cálculo.
Objeto del evento onEdit de Hojas de cálculo Hojas de cálculo

function onEdit(e)

Hojas de cálculo
Cambiar
El contenido de una hoja se edita o da formato.
Objeto de evento onChange de Hojas de cálculo Hojas de cálculo
Envío de formulario
Se envía un formulario de Google.
Objeto de evento de envío de formulario de Formularios
Objeto de evento de envío de formulario de Hojas de cálculo
Formularios
Hojas de cálculo
Basado en tiempo (reloj)
El activador se activa en un intervalo o hora especificados.
Objeto de evento basado en el tiempo Documentos
Formularios
Hojas de cálculo
Presentaciones

* El evento abierto de Formularios de Google no se produce cuando un usuario abre un formulario para responder, sino cuando un editor lo abre para modificarlo.

Activadores sencillos en complementos

Los activadores simples usan un conjunto de nombres de funciones reservados, no pueden usar servicios que requieren autorización y se habilitan automáticamente para su uso. En algunos casos, un evento de activación simple puede ser controlado por un activador instalable.

Puedes agregar un activador simple a un complemento mediante la implementación de una función con uno de los siguientes nombres reservados:

  • onOpen(e) se ejecuta cuando un usuario abre un documento, una hoja de cálculo o una presentación. onOpen(e) también se puede ejecutar cuando se abre un formulario en el editor (pero no cuando se responde al formulario). Solo se ejecuta si el usuario tiene permiso para editar el archivo en cuestión y se usa con mayor frecuencia para crear elementos de menú.
  • onInstall(e) se ejecuta cuando un usuario instala un complemento. Por lo general, onInstall(e) solo se usa para llamar a onOpen(e); esto garantiza que los menús de complementos aparezcan inmediatamente después de la instalación sin necesidad de que el usuario actualice la página.
  • onEdit(e) se ejecuta cuando un usuario cambia el valor de una celda en una hoja de cálculo. Este activador no se activa en respuesta a movimientos de celdas, formatos ni otros cambios que no alteren los valores de las celdas.

Restricciones

Los activadores simples en los complementos están sujetos a las mismas restricciones que rigen los activadores simples en otros tipos de proyectos de Apps Script. Ten en cuenta en particular las siguientes restricciones cuando diseñes complementos:

  • Los activadores simples no se ejecutan si un archivo está abierto en modo de solo lectura (ver o comentar). Este comportamiento evita que se propaguen los menús complementarios.
  • En ciertas circunstancias, los complementos de editor ejecutan sus activadores onOpen(e) y onEdit(e) simples en un modo sin autorización. Este modo presenta algunas complicaciones adicionales, como se describe en el modelo de autorización de complementos.
  • Los activadores simples no pueden usar servicios ni realizar otras acciones que requieran autorización, excepto como se describe en el modelo de autorización de complemento.
  • Los activadores simples no se pueden ejecutar durante más de 30 segundos. Asegúrate de minimizar la cantidad de procesamiento realizado en una función de activador simple.
  • Los activadores simples están sujetos a los límites de cuota de los activadores de Apps Script.

Activadores instalables en complementos

Los complementos pueden crear y modificar de manera programática activadores instalables con el servicio Script de Apps Script. Los complementos instalables adicionales no se pueden crear de forma manual. A diferencia de los activadores simples, los activadores instalables pueden usar servicios que requieren autorización.

Los activadores instalables en los complementos no envían correos electrónicos de errores al usuario cuando encuentra errores, ya que, en la mayoría de los casos, un usuario no puede abordar el problema. Debido a esto, debes diseñar tu complemento para manejar correctamente los errores en nombre del usuario siempre que sea posible.

Los complementos pueden usar los siguientes activadores instalables:

  • Los activadores instalables abiertos se ejecutan cuando un usuario abre un documento, una hoja de cálculo o cuando se abre un formulario en el editor (pero no cuando se responde al formulario).
  • Editar Los activadores instalables se ejecutan cuando un usuario cambia el valor de una celda en una hoja de cálculo. Este activador no se activa en respuesta al cambio de formato o a otros cambios que no alteren los valores de las celdas.
  • Cambiarlos activadores instalables se ejecutan cuando un usuario realiza un cambio en una hoja de cálculo, incluidos los cambios de formato y las modificaciones de la hoja de cálculo (como agregar una fila).
  • Los activadores instalables de envío de formulario se ejecutan cuando se envía una respuesta de formulario de Google.

  • Los activadores basados en el tiempo (también llamados activadores de reloj) se activan a una hora específica o repetidamente en un intervalo regular.

Autorizar activadores instalables

Por lo general, si un desarrollador actualiza un complemento para usar servicios nuevos que requieren autorización adicional, se le solicita a los usuarios que vuelvan a autorizar el complemento la próxima vez que lo usen.

Sin embargo, los complementos que usan activadores se encuentran con desafíos de autorización especiales. Imagina un complemento que usa un activador para supervisar los envíos de formularios: un creador de formularios puede autorizar al complemento la primera vez que lo usa y, luego, dejar que se ejecute durante meses o años sin tener que volver a abrir el formulario. Si el desarrollador del complemento actualizara el complemento para usar servicios nuevos que requieran autorización adicional, el creador del formulario nunca vería el diálogo de reautorización, ya que nunca reabrió el formulario, y el complemento dejaría de funcionar.

A diferencia de los activadores de los proyectos normales de Apps Script, los activadores en los complementos se siguen activando incluso si necesitan una nueva autorización. Sin embargo, la secuencia de comandos falla si llega a una línea de código que requiere autorización que no tiene. A fin de evitar esta situación, los desarrolladores pueden usar el método ScriptApp.getAuthorizationInfo() para controlar el acceso a las partes de código que cambiaron entre las versiones publicadas del complemento.

A continuación, se muestra un ejemplo de la estructura recomendada para usar en las funciones de activación a fin de evitar errores de autorización. La función activadora de ejemplo responde a un evento de envío de formulario dentro de un complemento de Hojas de cálculo de Google y, si se requiere una nueva autorización, envía al usuario del complemento un correo electrónico de alerta mediante HTML con plantilla.

Code.gs

activadores/form/Code.gs
/**
 * Responds to a form when submitted.
 * @param {event} e The Form submit event.
 */
function respondToFormSubmit(e) {
  const addonTitle = 'My Add-on Title';
  const props = PropertiesService.getDocumentProperties();
  const authInfo = ScriptApp.getAuthorizationInfo(ScriptApp.AuthMode.FULL);

  // Check if the actions of the trigger requires authorization that has not
  // been granted yet; if so, warn the user via email. This check is required
  // when using triggers with add-ons to maintain functional triggers.
  if (authInfo.getAuthorizationStatus() ===
    ScriptApp.AuthorizationStatus.REQUIRED) {
    // Re-authorization is required. In this case, the user needs to be alerted
    // that they need to re-authorize; the normal trigger action is not
    // conducted, since it requires authorization first. Send at most one
    // "Authorization Required" email per day to avoid spamming users.
    const lastAuthEmailDate = props.getProperty('lastAuthEmailDate');
    const today = new Date().toDateString();
    if (lastAuthEmailDate !== today) {
      if (MailApp.getRemainingDailyQuota() > 0) {
        const html = HtmlService.createTemplateFromFile('AuthorizationEmail');
        html.url = authInfo.getAuthorizationUrl();
        html.addonTitle = addonTitle;
        const message = html.evaluate();
        MailApp.sendEmail(Session.getEffectiveUser().getEmail(),
            'Authorization Required',
            message.getContent(), {
              name: addonTitle,
              htmlBody: message.getContent()
            }
        );
      }
      props.setProperty('lastAuthEmailDate', today);
    }
  } else {
    // Authorization has been granted, so continue to respond to the trigger.
    // Main trigger logic here.
  }
}

authorizationemail.html

triggers/form/AuthorizationEmail.html
<p>The Google Sheets add-on <i><?= addonTitle ?></i> is set to run automatically
    whenever a form is submitted. The add-on was recently updated and it needs you
    to re-authorize it to run on your behalf.</p>

<p>The add-on's automatic functions are temporarily disabled until you
    re-authorize it. To do so, open Google Sheets and run the add-on from the
    Add-ons menu. Alternatively, you can click this link to authorize it:</p>

<p><a href="<?= url ?>">Re-authorize the add-on.</a></p>

<p>This notification email will be sent to you at most once per day until the
    add-on is re-authorized.</p>

Restricciones

Los activadores instalables en complementos están sujetos a las mismas restricciones que rigen los activadores instalables en otros tipos de proyectos de Apps Script.

Además de estas restricciones, se aplican varias restricciones a los activadores instalables específicamente en los complementos:

  • Cada complemento solo puede tener un activador de cada tipo, por usuario y por documento. Por ejemplo, en una hoja de cálculo determinada, un usuario determinado solo puede tener un activador de edición, aunque también podría tener un activador de envío de formulario o un activador basado en el tiempo en la misma hoja de cálculo. Un usuario diferente con acceso a la misma hoja de cálculo podría tener su propio conjunto de activadores.
  • Los complementos solo pueden crear activadores para el archivo en el que se usan. Es decir, un complemento que se usa en el Documento A de Google no puede crear un activador para supervisar cuando se abre el Documento B de Google.
  • Los activadores basados en el tiempo no pueden ejecutarse con más frecuencia que una vez por hora.
  • Los complementos no envían automáticamente al usuario un correo electrónico cuando el código que ejecuta un activador instalable genera una excepción. Depende del desarrollador verificar y administrar los casos de fallas con facilidad.
  • Los activadores de complemento dejan de activarse en cualquiera de las siguientes situaciones:
    • Si el usuario desinstala el complemento,
    • Si el complemento está inhabilitado en un documento (si se vuelve a habilitar, el activador se vuelve a poner en funcionamiento)
    • Si el desarrollador anula la publicación del complemento o envía una versión dañada a la tienda de complementos
  • Las funciones de activador de complemento se ejecutan hasta que llegan al código que usa un servicio no autorizado, momento en el que se detienen. Esto es así solo si se publica el complemento; el mismo activador en un proyecto normal de Apps Script o un complemento no publicado no se ejecuta en absoluto si alguna parte de la secuencia de comandos necesita autorización.
  • Los activadores instalables están sujetos a los límites de cuota del activador de Apps Script.