Objetos de eventos

En esta página, se describe la estructura de los objetos de evento de complementos de Google Workspace.

Los objetos de evento son estructuras JSON que se construyen y pasan automáticamente como parámetros para activar o llamar a funciones de devolución de llamada cuando un usuario interactúa con un complemento. Los objetos de evento contienen información del cliente sobre la app host y el contexto actual a la función de devolución de llamada del servidor del complemento.

Los complementos de Google Workspace usan objetos de eventos en los siguientes lugares:

  • Activadores de la página principal. Cada función homepageTrigger que defines recibe un objeto de evento automáticamente cuando se activa la función activadora de la página principal. Puedes usar este objeto en la función activadora de la página principal para identificar la app host activa, la plataforma del cliente, la configuración regional del usuario y otra información.

    Los objetos de evento creados cuando se activa la página principal no contienen todos los campos incluidos en los otros dos casos; se omiten los campos relacionados con widgets y la información contextual.

  • Activadores contextuales. Cada aplicación de host proporciona un conjunto diferente de activadores contextuales que se activan cuando el usuario ingresa en un contexto específico. Por ejemplo:

    Cuando se activa un activador contextual, la aplicación host llama al runFunction correspondiente que aparece en el manifiesto del complemento y le pasa un objeto de evento como parámetro. Los objetos de eventos creados cuando se activan los activadores contextuales contienen todos los campos incluidos en los objetos de eventos de la página principal, además de los campos que contienen información contextual.

  • Acciones de widgets. Los objetos de evento también se usan para proporcionar interactividad con widgets mediante el mismo modelo de acción que usan los complementos de Gmail. Los complementos de Google Workspace usan las mismas funciones de controlador de widgets, objetos Action y respuestas a acciones. Sin embargo, en los complementos de Google Workspace, los objetos de eventos de acción incluyen aún más información sobre la que puede actuar una función de devolución de llamada.

    Los objetos de eventos creados como resultado de las acciones de widgets contienen todos los campos incluidos en los objetos de eventos de activador contextual, además de campos que contienen información de widgets.

  • Activadores de vínculos de vista previa (Vista previa para desarrolladores) En Documentos de Google, puedes configurar vistas previas de vínculos para servicios de terceros según patrones de URL específicos. Cuando los usuarios interactúan con un vínculo que cumple con el patrón, el previewLinkTrigger se activa y un objeto de evento que contiene el vínculo se pasa a la función de devolución de llamada del activador. Tu complemento puede usar este objeto de evento para construir un chip inteligente y una tarjeta que muestre información sobre el vínculo en la aplicación host. También puedes crear acciones de widget para permitir que los usuarios interactúen con la tarjeta de vista previa y su contenido.

Estructura de objetos de eventos

En la siguiente tabla, se describe la estructura de nivel superior de los objetos de eventos de los complementos de Google Workspace. La estructura del objeto de evento incluye un campo de nivel superior commonEventObject para obtener información independiente del host. Cada objeto de evento también puede tener uno de los siguientes campos de nivel superior específicos del host, determinado por la app host activa: gmailEventObject, calendarEventObject o driveEventObject.

Para ofrecer retrocompatibilidad, los objetos de eventos de los complementos de Google Workspace también incluyen todos los campos originales que se usan en los objetos de eventos de acción del complemento de Gmail. Estos campos se enumeran en la siguiente tabla, en “Campos de complemento de Gmail originales”. La información de estos campos se reproduce en una nueva estructura de objetos.

Objeto de evento
eventObject.commonEventObject Common fields object
Objeto que contiene información común a todos los objetos de eventos, sin importar la aplicación host.
eventObject.calendar Calendar event object
Solo está presente si el organizador es el Calendario de Google. Un objeto que contiene información de calendario y eventos.
eventObject.drive Drive event object
Solo está presente si el host de la llamada es Google Drive. Un objeto que contiene información de Drive.
eventObject.gmail Gmail event object
Solo aparece si el host de llamada es Gmail. Un objeto que contiene información de Gmail.
eventObject.docs Docs event object
Solo está presente si el host de la llamada es Documentos de Google. Un objeto que contiene información de Documentos.
eventObject.sheets Sheets event object
Solo aparece si el host que llama es Hojas de cálculo de Google. Un objeto que contiene información de Hojas de cálculo.
eventObject.slides Slides event object
Solo está presente si el host de la llamada es Presentaciones de Google. Un objeto que contiene información de Presentaciones.
Campos originales del complemento de Gmail
eventObject.messageMetadata.accessToken string
Obsoleto. Un token de acceso. Puedes usar esta opción para activar el acceso a los datos del usuario mediante permisos de complementos temporales de Gmail.

En el caso de los complementos de Google Workspace, busca esta información en el campo eventObject.gmail.accessToken.

eventObject.messageMetadata.messageId string
Obsoleto. El ID de mensaje de la conversación se abre en la IU de Gmail.

En el caso de los complementos de Google Workspace, busca esta información en el campo eventObject.gmail.messageId.

eventObject.clientPlatform string
Obsoleto. Indica dónde se origina el evento (Web, iOS o Android).

En el caso de los complementos de Google Workspace, busca esta información en el campo eventObject.commonEventObject.platform.

eventObject.formInput object
Obsoleto. Mapa de los valores actuales de todos los widgets del formulario en la tarjeta, restringido a un valor por widget. Las claves son los ID de string asociados con los widgets, y los valores son strings. El objeto de evento proporciona formInput para tu comodidad cuando necesitas leer datos de varios widgets con los valores singulares esperados, como interruptores y entradas de texto. En el caso de los widgets con varios valores, como las casillas de verificación, puedes leer cada valor de formInputs.

En el caso de los complementos de Google Workspace, busca esta información en el campo eventObject.commonEventObject.formInputs. Los widgets con valores únicos se representan como arrays con un solo elemento.

eventObject.formInputs object
Obsoleto. Mapa de los valores actuales de los widgets en la tarjeta, presentados como listas de strings. Las claves son los ID de string asociados con el widget. Para los widgets de valor único, el valor se presenta en un array de un solo elemento. En el caso de los widgets con varios valores, como los grupos de casillas de verificación, todos los valores se presentan en una lista.

En el caso de los complementos de Google Workspace, busca esta información en el campo eventObject.commonEventObject.formInputs.

eventObject.parameters object
Obsoleto. Mapa de los parámetros adicionales que proporcionas al Action con Action.setParameters(). Las claves y los valores del mapa son strings.

En el caso de los complementos de Google Workspace, busca esta información en el campo eventObject.commonEventObject.parameters.

eventObject.userCountry string
Inhabilitado y inhabilitado de forma predeterminada. El código de dos letras que indica el país o la región del usuario. También puede ser un código de país numérico UN M49.

En el caso de los complementos de Google Workspace, busca esta información en el campo eventObject.commonEventObject.userLocale.

eventObject.userLocale string
Inhabilitado y inhabilitado de forma predeterminada. Corresponde al código ISO 639 de dos letras que indica el idioma del usuario. Consulta Cómo acceder a la configuración regional y la zona horaria del usuario para obtener más información.

En el caso de los complementos de Google Workspace, busca esta información en el campo eventObject.commonEventObject.userLocale.

eventObject.userTimezone.id string
Inhabilitado y inhabilitado de forma predeterminada. El identificador de zona horaria de la zona horaria del usuario. Los ejemplos incluyen America/New_York, Europe/Vienna y Asia/Seoul. Para obtener más información, consulta Acceso a la configuración regional y la zona horaria del usuario.

En el caso de los complementos de Google Workspace, busca esta información en el campo eventObject.commonEventObject.timeZone.id.

eventObject.userTimezone.offset string
Inhabilitado y inhabilitado de forma predeterminada. Es la desfase de tiempo del tiempo universal coordinado (UTC) de la zona horaria del usuario, medida en milisegundos. Para obtener más información, consulta Acceso a la configuración regional y la zona horaria del usuario.

En el caso de los complementos de Google Workspace, busca esta información en el campo eventObject.commonEventObject.timeZone.offset.

Objeto de evento común

El objeto de evento común es la parte del objeto de evento general que lleva información general independiente del host al complemento desde el cliente del usuario. Esta información incluye detalles como la configuración regional del usuario, la app host y la plataforma.

Además de los activadores contextuales y la página principal, los complementos crean y pasan objetos de eventos a las funciones de devolución de llamada de acción cuando el usuario interactúa con los widgets. La función de devolución de llamada de tu complemento puede consultar el objeto de evento común para determinar el contenido de los widgets abiertos en el cliente del usuario. Por ejemplo, tu complemento puede ubicar el texto que un usuario ingresó en un widget TextInput en el objeto eventObject.commentEventObject.formInputs.

Campos de objetos de eventos comunes
commonEventObject.platform string
Indica dónde se origina el evento (`WEB`, `IOS` o `ANDROID`).
commonEventObject.formInputs object
Un mapa que contenga los valores actuales de los widgets en la tarjeta que se muestra. Las claves del mapa son los ID de string asignados con cada widget.

La estructura del objeto de valor de mapa depende del tipo de widget:

  • Widgets de valor único (por ejemplo, un cuadro de texto): una lista de strings (solo un elemento).

    Ejemplo: Para un widget de entrada de texto con employeeName como su ID, accede al valor de la entrada de texto con: e.commonEventObject.formInputs.employeeName.stringInputs.value[0]

  • Widgets de valores múltiples (por ejemplo, grupos de casillas de verificación): Una lista de strings.

    Ejemplo: Para un widget de varios valores con participants como su ID, accede al array de valores con lo siguiente: e.commonEventObject.formInputs.participants.stringInputs.value.

  • A date-time picker: Es un DateTimeInput object.

    Ejemplo: Para un selector con un ID de myDTPicker, accede al objeto DateTimeInput mediante e.commonEventObject.formInputs.myDTPicker.dateTimeInput.

  • A date-only picker: Es un DateInput object.

    Ejemplo: Para un selector con un ID de myDatePicker, accede al objeto DateInput mediante e.commonEventObject.formInputs.myDatePicker.dateInput.

  • A time-only picker: Es un TimeInput object.

    Ejemplo: Para un selector con un ID de myTimePicker, accede al objeto TimeInput mediante e.commonEventObject.formInputs.myTimePicker.timeInput.
commonEventObject.hostApp string
Indica la app host en la que está activo el complemento cuando se genera el objeto de evento. Entre los valores posibles, se incluyen los siguientes:
  • GMAIL
  • CALENDAR
  • DRIVE
  • DOCS
  • SHEETS
  • SLIDES
commonEventObject.parameters object
Cualquier parámetro adicional que proporciones a Action mediante Action.setParameters().
commonEventObject.userLocale string
Inhabilitado de forma predeterminada. El idioma del usuario y el identificador de país o región en el formato del código de idioma ISO 639, código de país ISO 3166. Por ejemplo, en-US.

Para activar este campo, debes configurar addOns.common.useLocaleFromApp como true en el manifiesto de tu complemento. La lista de permisos del complemento también debe incluir https://www.googleapis.com/auth/script.locale. Para obtener más detalles, consulta Acceso a la configuración regional y la zona horaria del usuario.

commonEventObject.timeZone string
Inhabilitado de forma predeterminada. El ID de zona horaria y el desplazamiento. Para activar este campo, debes configurar addOns.common.useLocaleFromApp como true en el manifiesto del complemento. La lista de permisos del complemento también debe incluir https://www.googleapis.com/auth/script.locale. Para obtener más detalles, consulta Acceso a la configuración regional y la zona horaria del usuario.
commonEventObject.timeZone.id string
El identificador de zona horaria del usuario. Los ejemplos incluyen America/New_York, Europe/Vienna y Asia/Seoul. Para activar este campo, debes configurar addOns.common.useLocaleFromApp como true en el manifiesto del complemento. La lista de permisos del complemento también debe incluir https://www.googleapis.com/auth/script.locale. Para obtener más información, consulta Acceso a la configuración regional y la zona horaria del usuario.
commonEventObject.timeZone.offset string
Es la compensación horaria a partir de la hora universal coordinada (UTC) de la zona horaria del usuario, medida en milisegundos. Para obtener más información, consulta Acceso a la configuración regional y la zona horaria del usuario.

Entradas del formulario de selector de fecha y hora

Las funciones de devolución de llamada de acción pueden recibir valores de widgets actuales en el campo commonEventObject.formInputs. Esto incluye los valores de fecha y hora seleccionados en los widgets de selector de fecha y hora. Sin embargo, la estructura de la información varía según si el widget se configuró como un selector de fecha y hora, o bien de selector de solo fecha o hora. Las diferencias estructurales se describen en la siguiente tabla:

Objeto DateTimeInput
dateTimeInput.hasDate boolean
true si la fecha y la hora de entrada incluyen una fecha; si false solo se incluye una hora.
dateTimeInput.hasTime boolean
true si la fecha y la hora de entrada incluyen una hora; si false solo se incluye una fecha.
dateTimeInput.msSinceEpoch string
Es la hora que selecciona el usuario, en milisegundos, desde el ciclo de entrenamiento (00:00:00 UTC del 1 de enero de 1970).
Objeto DateInput
dateInput.msSinceEpoch string
Es la hora que selecciona el usuario, en milisegundos, desde el ciclo de entrenamiento (00:00:00 UTC del 1 de enero de 1970).
Objeto TimeInput
timeInput.hours number
Es el número de hora que seleccionó el usuario.
timeInput.minutes number
Es el número de minuto que seleccionó el usuario.

Objeto de evento de calendario

El objeto de evento de Calendario es la parte del objeto de evento general que contiene información sobre el calendario de un usuario y los eventos de calendario. Solo está presente en un objeto de evento si la aplicación host es Calendario de Google.

En la siguiente tabla, se enumeran los campos presentes en el campo calendarEventObject de un objeto de evento. Los campos marcados como Datos generados por el usuario están presentes en el objeto de evento solo si los datos están presentes en el evento de Calendario y el complemento establece su campo manifiesto addOns.calendar.currentEventAccess en READ o READ_WRITE.

Objeto de evento de calendario
calendar.attendees[] list of attendee objects
Datos generados por el usuario. Es una lista de los asistentes al evento de calendario.
calendar.calendarId string
El ID del calendario
calendar.capabilities object
Datos generados por usuarios. Un objeto que describe las capacidades del complemento para ver o actualizar la información de los eventos.
calendar.capabilities.canAddAttendees boolean
Datos generados por usuarios. true si el complemento puede agregar asistentes nuevos a la lista de asistentes del evento; de lo contrario, false.
calendar.capabilities.canSeeAttendees boolean
Datos generados por usuarios. true si el complemento puede leer la lista de asistentes del evento; de lo contrario, false.
calendar.capabilities.canSeeConferenceData boolean
Datos generados por usuarios. true si el complemento puede leer los datos de la conferencia de eventos; de lo contrario, false.
calendar.capabilities.canSetConferenceData boolean
Datos generados por usuarios. true si el complemento puede actualizar los datos de conferencia de eventos; de lo contrario, false.
calendar.capabilities.canAddAttachments boolean
Datos generados por usuarios. true si el complemento puede agregar archivos adjuntos nuevos al evento; de lo contrario, false.
calendar.conferenceData Conference data object
Datos generados por el usuario. Un objeto que representa cualquier dato de conferencia asociado con este evento, como los detalles de conferencia de Google Meet.
calendar.id string
El ID del evento
calendar.organizer object
Objeto que representa al organizador del evento.
calendar.organizer.email string
La dirección de correo electrónico del organizador del evento
calendar.recurringEventId string
Indica el ID de un evento recurrente.

Asistente

Los objetos asistentes llevan información sobre los asistentes a los eventos de Calendario de Google. Esta información se encuentra en el objeto de evento solo si los datos están presentes en el evento de Calendario y el complemento configura su campo manifiesto addOns.calendar.currentEventAccess como READ o READ_WRITE.

Objeto asistente
attendee.additionalGuests number
Indica la cantidad de invitados adicionales que indicó el asistente que traerá. La configuración predeterminada es cero.
attendee.comment string
El comentario de respuesta del asistente, si corresponde
attendee.displayName string
Nombre visible del asistente.
attendee.email string
La dirección de correo electrónico de los asistentes
attendee.optional boolean
true si la asistencia a este asistente está marcada como opcional; de lo contrario, false.
attendee.organizer boolean
true si el asistente es un organizador de este evento.
attendee.resource boolean
true si el asistente representa un recurso, como una sala o un equipo; false de lo contrario.
attendee.responseStatus string
El estado de respuesta del asistente. Entre los valores posibles, se incluyen los siguientes:
  • accepted: El asistente aceptó la invitación al evento.
  • declined: El asistente rechazó la invitación al evento.
  • needsAction: El asistente no respondió a la invitación del evento.
  • tentative: El asistente aceptó la invitación de evento de manera provisoria.
attendee.self boolean
true si este asistente representa el calendario en el que aparece el evento; de lo contrario, false.

Datos de conferencias

Los objetos de datos de conferencia llevan información sobre conferencias que se adjuntan a eventos de Calendario de Google. Pueden ser soluciones de conferencias de Google, como Google Meet, o conferencias de terceros. Esta información está presente en el objeto de evento solo si los datos están presentes en el evento de Calendario y el complemento configura su campo de manifiesto addOns.calendar.currentEventAccess como READ o READ_WRITE.

Objeto de datos de conferencia
conferenceData.conferenceId string
El ID de la conferencia. Este ID está destinado a permitir que las aplicaciones realicen un seguimiento de las conferencias; no debes mostrarlo a los usuarios.
conferenceData.conferenceSolution object
Objeto que representa la solución de conferencia, como Hangouts o Google Meet.
conferenceData.conferenceSolution.iconUri string
El URI del ícono visible para el usuario que representa esta solución de conferencia.
conferenceData.conferenceSolution.key object
Es la clave que identifica de forma exclusiva la solución de conferencia para este evento.
conferenceData.conferenceSolution.key.type string
Tipo de solución de conferencia. Entre los valores posibles, se incluyen los siguientes:
  • eventHangout para Hangouts para consumidores (http://hangouts.google.com).
  • eventNamedHangout para la versión clásica de Hangouts si los usuarios de Google Workspace (http://hangouts.google.com)
  • hangoutsMeet para Google Meet (http://meet.google.com).
conferenceData.conferenceSolution.name string
Es el nombre visible para el usuario de esta solución de conferencia (no localizada).
conferenceData.entryPoints[] list of entry point objects
La lista de puntos de entrada de la conferencia, como URL o números de teléfono.
conferenceData.notes string
Notas adicionales (como instrucciones del administrador del dominio o avisos legales) sobre la conferencia que se mostrarán al usuario. Puede contener HTML. La longitud máxima es de 2,048 caracteres.
conferenceData.parameters object
Un objeto que contiene un mapa de datos de parámetros definidos para que lo use el complemento.
conferenceData.parameters.addOnParameters object
Un mapa de claves y valores de strings de parámetros. El desarrollador del complemento define estos valores y claves a fin de adjuntar información a una conferencia específica para el uso del complemento.

Punto de entrada

Los objetos de punto de entrada contienen información sobre los medios establecidos para acceder a una conferencia determinada, como por teléfono o video. Esta información está presente en el objeto de evento solo si los datos están presentes en el evento de Calendario y el complemento configura su campo manifiesto addOns.calendar.currentEventAccess como READ o READ_WRITE.

Objeto de punto de entrada
entryPoint.accessCode string
El código de acceso que se usa para acceder a la conferencia. La longitud máxima es de 128 caracteres. Los proveedores de conferencias generalmente solo usan un subconjunto de {accessCode, meetingCode, passcode, password, pin} para proporcionar acceso a las conferencias. Busca coincidencias y muestra solo los campos que usa el proveedor de la conferencia.
entryPoint.entryPointFeatures list
Funciones del punto de entrada. Actualmente, estas funciones solo se aplican a phone puntos de entrada:
  • toll: El punto de entrada es una llamada telefónica gratuita.
  • toll_free: El punto de entrada es una llamada telefónica gratuita.
entryPoint.entryPointType string
Es el tipo de punto de entrada. Los valores posibles son los siguientes:
  • more: Instrucciones adicionales para unirse a la conferencia, como números de teléfono alternativos. Una conferencia solo puede tener un punto de entrada more; si está presente, también se requiere al menos otro tipo de punto de entrada.
  • phone: Únete a la conferencia a través de un número de teléfono. Una conferencia puede tener cero o más puntos de entrada phone. El Calendario de Google solo muestra los dos primeros puntos de entrada del teléfono, después de que se aplica formato y se ordena alfabéticamente.
  • sip: Únete a la conferencia por medio de SIP. Una conferencia puede tener como máximo un punto de entrada sip.
  • video: Únete a la conferencia por medio de HTTP. Una conferencia puede tener como máximo un punto de entrada video.
entryPoint.label string
Es la etiqueta visible para el usuario del URI del punto de entrada (no localizado).
entryPoint.meetingCode string
El código de reunión que se usó para acceder a la conferencia La longitud máxima es de 128 caracteres. Los proveedores de conferencias generalmente solo usan un subconjunto de {accessCode, meetingCode, passcode, password, pin} para proporcionar acceso a las conferencias. Busca coincidencias y muestra solo los campos que usa el proveedor de la conferencia.
entryPoint.passcode string
La contraseña utilizada para acceder a la conferencia. La longitud máxima es de 128 caracteres. Los proveedores de conferencias generalmente solo usan un subconjunto de {accessCode, meetingCode, passcode, password, pin} para proporcionar acceso a las conferencias. Busca coincidencias y muestra solo los campos que usa el proveedor de la conferencia.
entryPoint.password string
La contraseña que se usó para acceder a la conferencia. La longitud máxima es de 128 caracteres. Los proveedores de conferencias generalmente solo usan un subconjunto de {accessCode, meetingCode, passcode, password, pin} para proporcionar acceso a las conferencias. Busca coincidencias y muestra solo los campos que usa el proveedor de la conferencia.
entryPoint.pin string
El PIN que se usa para acceder a la conferencia. La longitud máxima es de 128 caracteres. Los proveedores de conferencias generalmente solo usan un subconjunto de {accessCode, meetingCode, passcode, password, pin} para proporcionar acceso a las conferencias. Busca coincidencias y muestra solo los campos que usa el proveedor de la conferencia.
entryPoint.regionCode string
Código regional del número de teléfono. Es necesario para los usuarios si el URI no incluye un código de país. Los valores se basan en la lista pública de códigos de región CLDR.
entryPoint.uri string
El URI del punto de entrada. La longitud máxima es de 1,300 caracteres. El formato depende del tipo de punto de entrada:
  • more: Se requiere un esquema http: o https:.
  • phone: Se requiere un esquema tel:. El URI debe incluir la secuencia de marcado completa (por ejemplo, "tel:+12345678900,,12345678;1234").
  • sip: Se requiere un esquema sip: o sips:. Por ejemplo, “sip:12345678@miproveedor.com”.
  • video: Se requiere un esquema http: o https:.

Objeto de evento de Drive

El objeto de evento de Drive es la parte del objeto de evento general que lleva información sobre la unidad de Google Drive de un usuario y su contenido. Solo está presente en un objeto de evento si la aplicación host es Google Drive.

Objeto de evento de Drive
drive.activeCursorItem Drive item object
El elemento de Drive que está activo actualmente
drive.selectedItems[] list of Drive item objects
Una lista de elementos (archivos o carpetas) seleccionados en Drive

Elemento de Drive

Los objetos de elemento de Drive contienen información sobre elementos de Drive específicos, como archivos o carpetas.

Objeto de elemento de Drive
item.addonHasFileScopePermission boolean
Si es true, el complemento solicitó y recibió la autorización de alcance https://www.googleapis.com/auth/drive.file para este elemento; de lo contrario, este campo es false.
item.id string
El ID del artículo seleccionado.
item.iconUrl string
Es la URL del ícono que representa el elemento seleccionado.
item.mimeType string
Es el tipo de MIME del elemento seleccionado.
item.title string
Es el título del elemento seleccionado.

Objeto de evento de Gmail

El objeto de evento de Gmail es la parte del objeto de evento general que lleva información sobre los mensajes de Gmail de un usuario. Solo está presente en un objeto de evento si la aplicación host es Gmail.

Objeto de evento de Gmail
gmail.accessToken string
El token de acceso específico de Gmail. Puedes usar este token con el método GmailApp.setCurrentMessageAccessToken(accessToken) para otorgar a tu complemento acceso temporario al mensaje de Gmail abierto del usuario o permitir que tu complemento redacte nuevos borradores.
gmail.bccRecipients[] list of strings
Inhabilitado de forma predeterminada. La lista de direcciones de correo electrónico de destinatarios "Cco:" que se incluyen actualmente en un borrador que está redactando el complemento. Para activar este campo, debes establecer el campo addOns.gmail.composeTrigger.draftAccess en tu manifiesto en METADATA.
gmail.ccRecipients[] list of strings
Inhabilitado de forma predeterminada. La lista de direcciones de correo electrónico de destinatarios "CC:" que se incluyen actualmente en un borrador que está redactando el complemento. Para activar este campo, debes establecer el campo addOns.gmail.composeTrigger.draftAccess en tu manifiesto en METADATA.
gmail.messageId string
El ID del mensaje de Gmail que está abierto
gmail.threadId string
El ID de conversación abierta de Gmail.
gmail.toRecipients[] list of strings
Inhabilitado de forma predeterminada. La lista de las direcciones de correo electrónico de destino "Para:" que se incluyen actualmente en un borrador que está redactando el complemento. Para activar este campo, debes establecer el campo addOns.gmail.composeTrigger.draftAccess en tu manifiesto en METADATA.

Objeto de evento de Documentos

El objeto de evento de Documentos es la parte del objeto de evento general que lleva información sobre el documento de un usuario y su contenido. Solo está presente en un objeto de evento si la aplicación host es Documentos de Google.

Objeto de evento de Documentos
docs.id string
Solo está presente si el usuario autorizó el permiso de https://www.googleapis.com/auth/drive.file.
El ID del documento se abre en la IU de Documentos.
docs.title string
Solo está presente si el usuario autorizó el permiso de https://www.googleapis.com/auth/drive.file.
El título del documento se abre en la IU de Documentos.
docs.addonHasFileScopePermission boolean
Si es true, el complemento solicitó y recibió la autorización de alcance https://www.googleapis.com/auth/drive.file para el documento abierto en la IU de Documentos; de lo contrario, este campo es false.
docs.matchedUrl.url string
Solo está presente si se cumplen las siguientes condiciones:
  • El usuario autorizó https://www.googleapis.com/auth/workspace.linkpreview.
  • La URL coincide con el patrón de host especificado en el activador LinkPreviewTriggers.

Es la URL del vínculo que genera una vista previa en Documentos de Google. Para usar este campo, debes configurar LinkPreviewTriggers en el manifiesto de tu complemento. Consulta Vínculos de vista previa en Documentos de Google para obtener más detalles.

Carga útil de ejemplo para el momento en que un usuario obtiene una vista previa del vínculo https://www.example.com/12345: 

"docs" : {
  "matchedUrl" : {
      "url" : "https://www.example.com/12345"
  }
}

Objeto de evento de Hojas de cálculo

El objeto de evento de Hojas de cálculo es la parte del objeto de evento general que lleva información sobre el documento de un usuario y su contenido. Solo está presente en un objeto de evento si la aplicación host es Hojas de cálculo de Google.

Objeto de evento de Hojas de cálculo
sheets.id string
Solo está presente si el usuario autorizó el permiso https://www.googleapis.com/auth/drive.file. El ID de la hoja de cálculo abierta en la IU de Hojas de cálculo.
sheets.title string
Solo está presente si el usuario autorizó el permiso https://www.googleapis.com/auth/drive.file. El título de la hoja de cálculo abierta en la IU de Hojas de cálculo.
sheets.addonHasFileScopePermission boolean
Si es true, el complemento solicitó y recibió la autorización de alcance de https://www.googleapis.com/auth/drive.file para la hoja de cálculo abierta en la IU de Hojas de cálculo. De lo contrario, este campo es false.

Objeto de evento de Presentaciones

El objeto de evento de Presentaciones es la parte del objeto de evento general que lleva información sobre el documento de un usuario y su contenido. Solo está presente en un objeto de evento si la aplicación host es Presentaciones de Google.

Objeto de evento de Presentaciones
slides.id string
Solo está presente si el usuario autorizó el permiso https://www.googleapis.com/auth/drive.file. El ID de la presentación abierta en la IU de Presentaciones.
slides.title string
Solo está presente si el usuario autorizó el permiso https://www.googleapis.com/auth/drive.file. Es el título de la presentación abierta en la IU de Presentaciones.
slides.addonHasFileScopePermission boolean
Si es true, el complemento solicitó y recibió la autorización de alcance de https://www.googleapis.com/auth/drive.file para la presentación abierta en la IU de Presentaciones; de lo contrario, este campo es false.