Los activadores de Apps Script hacen que se ejecute una función de secuencia de comandos específica (la función activadora) cada vez que se produce 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 un parámetro a la función activador. La función de activación 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 Google Workspace que extiende Gmail, puedes definir un activador que cree una interfaz de tarjeta nueva cuando el usuario abra un subproceso de mensaje. En este caso, implementarás una función de devolución de llamada contextual para crear las tarjetas que conforman la nueva IU y usar los datos que se pasaron en el objeto de evento.
En esta página, se proporcionan lineamientos sobre el uso de activadores en proyectos complementarios de Google Workspace.
Activadores del manifiesto
A diferencia de los complementos de Editores, los complementos de Google Workspace actualmente no pueden usar 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 completamente en el manifiesto del complemento de Google Workspace. Los siguientes son algunos ejemplos de activadores de manifiesto:
- Activadores de la página principal que crean y muestran la página principal del complemento
- Activadores de OpenEvent de Calendario que muestran una tarjeta nueva o realizan otras acciones cuando se abre un evento de Calendario.
- Activadores de UpdateEvent que muestran una tarjeta nueva o realizan otras acciones cuando un usuario edita y guarda un evento de Calendario.
- Activadores de 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 Gmail Compose que muestran un 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 alcance de OAuth
drive.fileen el documento de Editor actual.
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 del activador de manifiesto.
Además de los activadores de manifiesto, los complementos de Google Workspace también pueden usar activadores instalables de Apps Script.
Restricciones
Los activadores de manifiesto tienen ciertas restricciones en relación con su uso.
- Estos activadores solo se usan en los 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. - Por el momento, 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.