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 determinado. Solo ciertos eventos pueden activar los 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 forma diferente según el tipo de activador.
Una vez que se crea el objeto del evento, Apps Script lo pasa como un parámetro a la función del activador. La función del activador es una función de devolución de llamada que debes implementar por tu cuenta para realizar las acciones adecuadas que permitan responder al evento. Por ejemplo, en un complemento de Google Workspace que extiende Gmail, puedes definir un activador que cree una nueva interfaz de tarjeta cuando el usuario abra una conversación de mensajes. En este caso, implementas una función de devolución de llamada contextual para crear las tarjetas que conforman la IU nueva con los datos que se pasan en el objeto del evento.
En esta página, se proporcionan lineamientos para usar activadores en proyectos de complementos de Google Workspace.
Activadores de manifiesto
A diferencia de los complementos de Editor, los complementos de Google Workspace actualmente no pueden usar los activadores simples de Apps Script. En su lugar, usan activadores diseñados específicamente para complementos de Google Workspace: activadores de manifiesto.
Los activadores de manifiesto se definen por completo en el manifiesto del complemento de Google Workspace. Estos son algunos ejemplos de activadores de manifiestos:
- Activadores de la página principal que compilan y muestran la página principal del complemento.
- Activadores de Calendar eventOpen que muestran una tarjeta nueva o realizan otras acciones cuando se abre un evento de Calendario.
- Activadores de eventUpdate de Calendario que muestran una tarjeta nueva o realizan otras acciones cuando un usuario edita y guarda un evento de Calendario.
- Activadores onItemsSelected de Drive que muestran una tarjeta nueva o realizan otras acciones cuando un usuario selecciona uno o más archivos o carpetas en Drive.
- Activadores de redacción de Gmail que muestran una tarjeta de complemento cuando el usuario abre el complemento en la ventana de redacción de Gmail.
- Activadores contextuales de Gmail que muestran una tarjeta nueva o realizan otras acciones cuando el usuario abre un mensaje de Gmail.
- Activadores onFileScopeGranted de Editor que muestran una tarjeta nueva cuando los usuarios otorgan autorización para el permiso de OAuth
drive.fileen el documento de Editor actual.
En la lista anterior, solo los activadores de la página principal no son contextuales; el resto son activadores contextuales. Consulta Manifiesto para obtener más información sobre las definiciones de activadores de manifiestos.
Además de los activadores de manifiesto, los complementos de Google Workspace también pueden usar los activadores instalables de Apps Script.
Restricciones
Los activadores de manifiesto tienen ciertas restricciones de uso.
- Estos activadores solo se usan en proyectos de complementos de Google Workspace; no tienen ningún propósito en ninguna otra aplicación.
- Dado que se definen en el manifiesto del complemento y no en su código, no puedes usar el servicio
Scriptde Apps Script para crear o modificar estos activadores. - Actualmente, los activadores contextuales de Gmail solo pueden tener un criterio
unconditional. Esto significa que los activadores contextuales se activan para cada mensaje de correo electrónico, independientemente del contenido. - Cada complemento solo puede tener un activador de cada tipo, por usuario y por documento.