Activadores para complementos de Google Workspace

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 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 activador, 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 activador. La función de activador es una función de devolución de llamada que debes implementar por tu cuenta para 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 nueva interfaz de tarjeta cuando el usuario abra un hilo de mensajes. En este caso, implementas 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 no pueden usar activadores simples de Google Apps Script. En cambio, usan activadores diseñados específicamente para complementos de Google Workspace: activadores de manifiesto.

Los activadores de manifiesto se definen en el manifiesto del complemento de Google Workspace manifest. Los siguientes son algunos ejemplos:

  • Activadores de la página principal que compilan y muestran la página principal del complemento.
  • Activadores eventOpen del Calendario de Google que muestran una tarjeta nueva o realizan otras acciones cuando se abre un evento.
  • Activadores eventUpdate del Calendario que muestran una tarjeta nueva o realizan otras acciones cuando un usuario edita y guarda un evento.
  • Activadores onItemsSelected de Google Drive que muestran una tarjeta nueva o realizan otras acciones cuando un usuario selecciona archivos o carpetas.
  • Activadores de redacción de Gmail que muestran una tarjeta de complemento cuando el usuario abre el complemento en la ventana de redacción.
  • Activadores contextuales de Gmail que muestran una tarjeta nueva o realizan otras acciones cuando el usuario abre un mensaje.
  • Activadores onFileScopeGranted del Editor que muestran una tarjeta nueva cuando los usuarios otorgan autorización para el permiso de OAuth drive.file en el documento.

En la lista, solo los activadores de la página principal no son contextuales; el resto son contextuales. Consulta Manifiesto para obtener más información sobre las definiciones de activadores de manifiesto.

Además de los activadores de manifiesto, los complementos de Google Workspace pueden usar activadores instalables de Apps Script .

Restricciones

Los activadores de manifiesto tienen ciertas restricciones para su uso.

  • Estos activadores solo se usan en proyectos de complementos de Google Workspace.
  • Como se definen en el manifiesto del complemento y no en el código, no puedes usar el servicio de Apps Script Script para crearlos o modificarlos.
  • Los activadores contextuales de Gmail 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.