Los activadores de Apps Script hacen que se ejecute una función de secuencia de comandos especificada (la función de activación) cada vez que se produce un evento especificado. Solo ciertos eventos pueden activar los activadores, y cada aplicación de Google Workspace admite un conjunto diferente de eventos.
Cuando se activa un disparador, se crea un objeto de evento. Esta estructura JSON contiene detalles sobre el evento que ocurrió. La información de 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 activación. La función de activación es una función de devolución de llamada que debes implementar por tu cuenta para realizar las acciones adecuadas en respuesta 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 un hilo de mensajes. En este caso, implementarás una función de devolución de llamada contextual para crear las tarjetas que componen la nueva IU con los datos que se pasan en el objeto de 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 del Editor, los complementos de Google Workspace actualmente no pueden usar activadores simples de Apps Script. En cambio, usan activadores diseñados específicamente para los complementos de Google Workspace: los activadores de manifiesto.
Los activadores del manifiesto se definen por completo en el manifiesto del complemento de Google Workspace. Estos son algunos ejemplos de activadores de manifiesto:
- Activadores de la página principal que compilan y muestran la página principal del complemento
- Activadores de apertura de eventos de calendario que muestran una tarjeta nueva o realizan otras acciones cuando se abre un evento de calendario.
- Activadores de Calendar eventUpdate que muestran una tarjeta nueva o realizan otras acciones cuando un usuario edita y guarda un evento de Calendario
- Activadores de Drive onItemsSelected 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
- Editor onFileScopeGranted triggers que muestran una tarjeta nueva cuando los usuarios otorgan autorización para el permiso de OAuth
drive.fileen el documento actual del Editor.
En la lista anterior, solo los activadores de la página principal son no contextuales; el resto son activadores contextuales. Consulta Manifiesto para obtener más información sobre las definiciones de activadores de manifiesto.
Además de los activadores del 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 y no tienen ningún propósito en otras aplicaciones.
- Como 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 de
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.