Activadores de los complementos de Editores

Los activadores de Apps Script hacen que se ejecute una función de secuencia de comandos especificada (la función de activador) cada vez que ocurre un evento especificado. 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 activadora. La función activadora es una devolución de llamada que debes implementar por tu cuenta a fin de realizar las acciones apropiadas para responder al evento. Por ejemplo, en un complemento de editor, se usa un activador para crear elementos de menú del complemento cuando se abre un documento. En este caso, implementarás la función activadora onOpen(e) para crear los elementos del menú que necesita el complemento, 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 para editores.

Tipos de activadores del complemento de editor

Puedes usar la mayoría de los tipos de activadores genéricos disponibles para los 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.

Nota: A diferencia de los complementos de Editor, en la actualidad, los complementos de Google Workspace no pueden usar activadores genéricos de Apps Script simples ni instalables. En su lugar, usan activadores diseñados específicamente para complementos de Google Workspace. Para obtener más información, consulta Activadores de complementos de Google Workspace.

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

Evento	Objeto de evento	Activadores simples	Activadores instalables
Abrir Se abrirá 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 Se instaló el complemento.	Objeto de evento onInstall	Documentos Formularios Hojas de cálculo Presentaciones function onInstall(e)
Editar Se modificó el contenido de las celdas de la hoja de cálculo.	Objeto de 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 del 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 formularios Objeto de evento de envío de formularios de Hojas de cálculo		Formularios Hojas de cálculo
Basado en tiempo (reloj) El activador se activa a una hora o intervalo especificados.	Objeto de evento controlado por el tiempo		Documentos Formularios Hojas de cálculo Presentaciones

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

Activadores simples 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 activador instalable puede controlar un evento de activador simple.

Puedes agregar un activador simple a un complemento con solo implementar 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 puede ejecutarse 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. Con frecuencia, se usa para crear elementos del 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 los movimientos de las celdas, el formato ni otros cambios que no alteren los valores de las celdas.

Restricciones

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

• Los activadores simples no se ejecutan si un archivo se abre en modo de solo lectura (vista o comentario). Este comportamiento evita que se propaguen los menús del complemento.
• En ciertas circunstancias, los complementos de editor ejecutan sus activadores simples onOpen(e) y onEdit(e) 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 requieren autorización, como se describe en el modelo de autorización de complemento.
• Los activadores simples no pueden ejecutarse 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 activadores instalables de complementos 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 le 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 resolver 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).
• Los activadores instalables Editar 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 formato o a otros cambios que no alteren los valores de las celdas.
• Los activadores instalables Change se ejecutan cuando un usuario realiza cualquier cambio en una hoja de cálculo, incluidos los cambios de formato y las modificaciones en la hoja de cálculo (como agregar una fila).

• Los activadores instalables de formulario de envío se ejecutan cuando se envía una respuesta de formulario de Google.

  Nota: Existen dos versiones de los activadores de envío de formularios, una para Hojas de cálculo (en la que se recopilan las respuestas de los formularios) y otra para los Formularios de Google. El objeto de evento que se pasa a una función activadora de envío de formulario de Hojas de cálculo es más simple y muestra los valores de respuesta en arreglos simples. El objeto de evento que se pasa a una función activadora de envío de formulario de Formularios proporciona más información, incluida en un objeto FormResponse.

• Los activadores basados en el tiempo (también llamados activadores de reloj) se activan en un momento específico o de forma repetida 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 les solicita a los usuarios que vuelvan a autorizar el complemento la próxima vez que lo usen.

Sin embargo, los complementos que usan activadores encuentran 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 el complemento la primera vez que lo usa y, luego, dejar que se ejecute durante meses o años sin volver a abrirlo. 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 nueva autorización porque nunca reabrió el formulario, y el complemento dejaría de funcionar.

A diferencia de los activadores de proyectos normales de Apps Script, los activadores de complementos continúan activándose incluso si necesitan volver a autorizarse. Sin embargo, la secuencia de comandos falla si alcanza una línea de código que requiere autorización que no tiene. Para evitar esta situación, los desarrolladores pueden usar el método ScriptApp.getAuthorizationInfo() a fin de controlar el acceso a 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 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

Ver en GitHub

/**
 * 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

Ver en GitHub

<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 los 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 en los complementos específicos:

• 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 el usuario también puede 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 de Google A no puede crear un activador para supervisar la apertura del Documento B de Google.
• Los activadores basados en el tiempo no pueden ejecutarse con mayor frecuencia que una vez por hora.
• Los complementos no envían automáticamente un correo electrónico al usuario cuando el código que ejecuta un activador instalable genera una excepción. Depende del desarrollador verificar y manejar los casos de fallas con facilidad.
• Los activadores de complemento se activan en cualquiera de las siguientes situaciones:
  • Si el usuario desinstala el complemento, haz lo siguiente:
  • Si el complemento está inhabilitado en un documento (si se vuelve a habilitar, el activador se vuelve a poner en funcionamiento), o
  • Si el desarrollador anula la publicación del complemento o envía una versión dañada a la tienda de complementos.
• Las funciones del activador de complementos se ejecutan hasta que llegan al código que usa un servicio no autorizado y, en ese momento, se detienen. Esto es válido solo si el complemento está publicado; 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 de los activadores de Apps Script.