Objetos de eventos

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

Los objetos de eventos son estructuras JSON que se crean automáticamente y se pasan como parámetros para activar o devolver funciones de devolución de llamada cuando un usuario interactúa con un complemento. Los objetos de evento llevan 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 automáticamente un objeto de evento cuando se activa la función de activación de la página principal. Puedes usar este objeto en la función del activador 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 que se crean cuando se activan los activadores de la página principal no contienen todos los campos incluidos en los otros dos casos. Se omiten los campos relacionados con los 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 a 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 evento creados cuando los activadores contextuales se activan contienen todos los campos incluidos en los objetos de evento activador de la página principal, además de los campos que contienen información contextual.

  • Acciones del widget: Los objetos de evento también se usan para proporcionar interactividad del widget, con 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 de acción. Sin embargo, en los complementos de Google Workspace, los objetos de evento 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 evento creados como resultado de las acciones del widget contienen todos los campos incluidos en los objetos de eventos del activador contextuales, además de los campos que contienen información del widget.

  • Obtén una vista previa de los activadores de vínculos. En Documentos, Hojas de cálculo y Presentaciones de Google, puedes configurar vistas previas de vínculos para servicios de terceros en función de patrones de URL específicos. Cuando los usuarios interactúan con un vínculo que cumple con el patrón, se activa linkPreviewTriggers, y un objeto de evento que contiene el vínculo se pasa a la función de devolución de llamada del activador. El complemento puede usar este objeto de evento para crear un chip inteligente y una tarjeta que muestren información sobre el vínculo dentro de la aplicación host. También puedes compilar acciones de widgets 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 la 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, determinados 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 utilizados en los objetos de eventos de acción del complemento de Gmail. Estos campos se enumeran en la siguiente tabla, en "Campos del complemento de Gmail original". La información de estos campos se reproduce en la nueva estructura de objeto.

Objeto de evento
eventObject.commonEventObject Common fields object
Un 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 presente si el organizador que realiza la llamada es Calendario de Google. Es un objeto que contiene información de calendarios y eventos.
eventObject.drive Drive event object
Solo presente si el host que realiza la llamada es Google Drive. Un objeto que contiene información de Drive.
eventObject.gmail Gmail event object
Solo presente si el host que realiza la llamada es Gmail. Un objeto que contiene información de Gmail
eventObject.docs Docs event object
Solo está presente si el host que realiza la llamada es Documentos de Google. Un objeto que contiene información de Documentos.
eventObject.sheets Sheets event object
Solo está presente si el host que realiza la llamada es Hojas de cálculo de Google. Un objeto que contiene información de Hojas de cálculo.
eventObject.slides Slides event object
Solo presente si el organizador que realiza la llamada es Presentaciones de Google. Es un objeto que contiene información de Presentaciones.
Campos del complemento original 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 los permisos temporales del complemento 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. ID del mensaje de la conversación abierta 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. Un mapa de los valores actuales de todos los widgets de formulario en la tarjeta, restringido a un valor por widget. Las claves son los IDs de cadena asociados con los widgets, y los valores son cadenas. El objeto de evento proporciona formInput como una opción conveniente para cuando necesitas leer datos de varios widgets con valores singulares esperados, como interruptores y entradas de texto. Para widgets con varios valores, como las casillas de verificación, puedes leer cada valor desde formInputs en su lugar.

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. Es un mapa de los valores actuales de los widgets en la tarjeta, presentado como listas de cadenas. Las claves son los IDs de cadena asociados con el widget. En el caso de los widgets con un solo valor, el valor se presenta en un array de un solo elemento. En el caso de los widgets con valores múltiples, 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. Un mapa de los parámetros adicionales que proporcionas a 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
Obsoleto e 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
Obsoleto e inhabilitado de forma predeterminada. El código ISO 639 de dos letras que indica el idioma del usuario Consulta Cómo acceder a la configuración regional y a la zona horaria del usuario para obtener más detalles.

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

eventObject.userTimezone.id string
Obsoleto e inhabilitado de forma predeterminada. Es el identificador de la zona horaria de la zona horaria del usuario. Los siguientes son algunos ejemplos: America/New_York, Europe/Vienna y Asia/Seoul. Consulta Cómo acceder a la configuración regional y a la zona horaria del usuario para obtener más detalles.

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

eventObject.userTimezone.offset string
Obsoleto e inhabilitado de forma predeterminada. Es la diferencia horaria del tiempo universal coordinado (UTC) de la zona horaria del usuario, medida en milisegundos. Consulta Cómo acceder a la configuración regional y a la zona horaria del usuario para obtener más detalles.

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, la app host y la plataforma del usuario.

Además de la página principal y los activadores contextuales, los complementos crean y pasan objetos de eventos a 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 evento comunes
commonEventObject.platform string
Indica dónde se origina el evento ("WEB", "IOS" o "ANDROID").
commonEventObject.formInputs object
Mapa que contiene los valores actuales de los widgets en la tarjeta que se muestra. Las claves del mapa son los IDs de cadena 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 cadenas (solo un elemento)

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

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

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

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

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

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

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

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

    Ejemplo: Para un selector con el ID 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
Inhabilitada de forma predeterminada. Indica el idioma y el identificador del país o región del usuario con el formato del código de idioma ISO 639 o el código de país o región ISO 3166. Por ejemplo, en-US.

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

commonEventObject.timeZone string
Inhabilitada de forma predeterminada. El ID y el desplazamiento de la zona horaria Para activar este campo, debes establecer addOns.common.useLocaleFromApp como true en el manifiesto de tu complemento. La lista de permisos de tu complemento también debe incluir https://www.googleapis.com/auth/script.locale. Consulta Cómo acceder a la configuración regional y a la zona horaria del usuario para obtener más detalles.
commonEventObject.timeZone.id string
Es el identificador de zona horaria de la zona horaria del usuario. Los siguientes son algunos ejemplos: America/New_York, Europe/Vienna y Asia/Seoul. Para activar este campo, debes establecer addOns.common.useLocaleFromApp como true en el manifiesto de tu complemento. La lista de permisos de tu complemento también debe incluir https://www.googleapis.com/auth/script.locale. Consulta Cómo acceder a la configuración regional y a la zona horaria del usuario para obtener más detalles.
commonEventObject.timeZone.offset string
La diferencia horaria del tiempo universal coordinado (UTC) de la zona horaria del usuario, medida en milisegundos. Consulta Cómo acceder a la configuración regional y a la zona horaria del usuario para obtener más detalles.

Entradas del formulario del selector de fecha y hora

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

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

Objeto de evento de calendario

El objeto de evento de Calendario es la parte del objeto de evento general que lleva información sobre el calendario y los eventos del calendario de un usuario. Solo está presente en un objeto de evento si la aplicación host es el 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 addOns.calendar.currentEventAccess manifiesto como READ o READ_WRITE.

Objeto de evento de calendario
calendar.attendees[] list of attendee objects
Datos generados por usuarios. Una lista de los asistentes al evento de calendario.
calendar.calendarId string
El ID del calendario
calendar.capabilities object
Datos generados por los usuarios. Es un objeto que describe las capacidades del complemento para ver o actualizar información de eventos.
calendar.capabilities.canAddAttendees boolean
Datos generados por los usuarios. true si el complemento puede agregar nuevos asistentes a la lista de asistentes al evento; de lo contrario, false.
calendar.capabilities.canSeeAttendees boolean
Datos generados por los usuarios. true si el complemento puede leer la lista de asistentes al evento; false de lo contrario.
calendar.capabilities.canSeeConferenceData boolean
Datos generados por los usuarios. true si el complemento puede leer los datos de la conferencia del evento; false de lo contrario.
calendar.capabilities.canSetConferenceData boolean
Datos generados por los usuarios. true si el complemento puede actualizar los datos de la conferencia del evento; false de lo contrario.
calendar.capabilities.canAddAttachments boolean
Datos generados por los usuarios. true si el complemento puede agregar nuevos archivos adjuntos al evento; de lo contrario, false.
calendar.conferenceData Conference data object
Datos generados por usuarios. Un objeto que representa los datos de la conferencia asociados con este evento, como los detalles de la conferencia de Google Meet.
calendar.id string
El ID del evento
calendar.organizer object
Es un 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
El ID de un evento recurrente.

Asistente

Los objetos de asistentes llevan información sobre asistentes individuales a los eventos del Calendario de Google. 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 establece su campo addOns.calendar.currentEventAccess manifest en READ o READ_WRITE.

Objeto asistente
attendee.additionalGuests number
La cantidad de invitados adicionales que el asistente indicó que llevarán. La configuración predeterminada es cero.
attendee.comment string
El comentario en la respuesta del asistente, si corresponde
attendee.displayName string
El asistente mostró el nombre.
attendee.email string
La dirección de correo electrónico de los asistentes.
attendee.optional boolean
true si la asistencia de este asistente se marca como opcional; de lo contrario, false.
attendee.organizer boolean
true si el asistente es el organizador de este evento.
attendee.resource boolean
true si el asistente representa un recurso, como una sala de reuniones o un equipo, falseen caso contrario.
attendee.responseStatus string
Estado de la 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 al evento.
  • tentative: El asistente aceptó la invitación al evento de manera provisoria.
attendee.self boolean
true si el asistente representa el calendario en el que aparece el evento; de lo contrario, false.

Datos de la conferencia

Los objetos de datos de conferencias contienen información sobre las conferencias adjuntas a los eventos del 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 del evento solo si los datos están presentes en el evento de Calendario y el complemento establece su campo addOns.calendar.currentEventAccess manifest en READ o READ_WRITE.

Objeto de datos de la conferencia
conferenceData.conferenceId string
El ID de la conferencia El objetivo de este ID es permitir que las aplicaciones hagan un seguimiento de las conferencias. No debes mostrar este ID a los usuarios.
conferenceData.conferenceSolution object
Es un 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
La clave que identifica de manera inequívoca la solución de conferencia para este evento.
conferenceData.conferenceSolution.key.type string
El tipo de solución de conferencia. Entre los valores posibles, se incluyen los siguientes:
  • eventHangout para Hangouts para usuarios (http://hangouts.google.com)
  • eventNamedHangout para la versión clásica de Hangouts para los usuarios de Google Workspace (http://hangouts.google.com).
  • hangoutsMeet para Google Meet (http://meet.google.com).
conferenceData.conferenceSolution.name string
El nombre visible para el usuario de esta solución de conferencia (no localizado).
conferenceData.entryPoints[] list of entry point objects
La lista de puntos de entrada para la conferencia, como URLs o números de teléfono.
conferenceData.notes string
Notas adicionales (como instrucciones del administrador del dominio o avisos legales) sobre la conferencia para mostrar al usuario Puede contener HTML. La longitud máxima es de 2,048 caracteres.
conferenceData.parameters object
Es un objeto que contiene un mapa de datos de parámetros definidos para que los use el complemento.
conferenceData.parameters.addOnParameters object
Un mapa de claves y valores de cadenas de parámetros. El desarrollador del complemento define estas claves y valores para adjuntar información a una conferencia específica para que pueda usar el 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 establece su campo addOns.calendar.currentEventAccess manifest en READ o READ_WRITE.

Objeto de punto de entrada
entryPoint.accessCode string
El código de acceso que se usó para acceder a la conferencia La longitud máxima es de 128 caracteres. Los proveedores de conferencias suelen usar solo un subconjunto de {accessCode, meetingCode, passcode, password, pin} para proporcionar acceso a las conferencias. Haz coincidir y solo muestra los campos que usa el proveedor de conferencias.
entryPoint.entryPointFeatures list
Características 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 con peaje.
  • toll_free: El punto de entrada es una llamada telefónica gratuita.
entryPoint.entryPointType string
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 hay, al menos, otro tipo de punto de entrada también se requiere.
  • phone: Únete a la conferencia con un número de teléfono. Una conferencia puede tener cero o más puntos de entrada phone. Calendario de Google solo muestra los dos primeros puntos de entrada del teléfono, después de formatearlo y ordenarlo alfabéticamente.
  • sip: Únete a la conferencia a través de SIP. Una conferencia puede tener, como máximo, un punto de entrada sip.
  • video: Únete a la conferencia a través de HTTP. Una conferencia puede tener, como máximo, un punto de entrada de video.
entryPoint.label string
La etiqueta visible para el usuario del URI del punto de entrada (no localizada).
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 suelen usar solo un subconjunto de {accessCode, meetingCode, passcode, password, pin} para proporcionar acceso a las conferencias. Haz coincidir y solo muestra los campos que usa el proveedor de conferencias.
entryPoint.passcode string
La contraseña que se usó para acceder a la conferencia. La longitud máxima es de 128 caracteres. Los proveedores de conferencias suelen usar solo un subconjunto de {accessCode, meetingCode, passcode, password, pin} para proporcionar acceso a las conferencias. Haz coincidir y solo muestra los campos que usa el proveedor de conferencias.
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 suelen usar solo un subconjunto de {accessCode, meetingCode, passcode, password, pin} para proporcionar acceso a las conferencias. Haz coincidir y solo muestra los campos que usa el proveedor de conferencias.
entryPoint.pin string
El PIN que se usó para acceder a la conferencia. La longitud máxima es de 128 caracteres. Los proveedores de conferencias suelen usar solo un subconjunto de {accessCode, meetingCode, passcode, password, pin} para proporcionar acceso a las conferencias. Haz coincidir y solo muestra los campos que usa el proveedor de conferencias.
entryPoint.regionCode string
Código de región 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 regionales de 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 cuenta 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 actualmente está activo.
drive.selectedItems[] list of Drive item objects
Una lista de elementos (archivos o carpetas) seleccionados en Drive.

Elemento de Drive

Los objetos de elementos 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ó https://www.googleapis.com/auth/drive.file autorización de alcance para este elemento. De lo contrario, este campo es false.
item.id string
El ID del elemento seleccionado
item.iconUrl string
La URL del ícono que representa el elemento seleccionado.
item.mimeType string
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 del 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 temporal al mensaje de Gmail abierto actualmente de un usuario o dejar que tu complemento redacte nuevos borradores.
gmail.bccRecipients[] list of strings
Inhabilitada de forma predeterminada. La lista de direcciones de correo electrónico de destinatarios en formato "Cco" incluidas actualmente en un borrador que está redactando el complemento. Para activar este campo, debes establecer el campo addOns.gmail.composeTrigger.draftAccess en tu manifiesto como METADATA.
gmail.ccRecipients[] list of strings
Inhabilitada de forma predeterminada. La lista de direcciones de correo electrónico de destinatarios con el valor “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 como METADATA.
gmail.messageId string
El ID del mensaje de Gmail abierto actualmente.
gmail.threadId string
El ID de la conversación de Gmail abierta actualmente.
gmail.toRecipients[] list of strings
Inhabilitada de forma predeterminada. La lista de direcciones de correo electrónico de destinatarios incluidas en el borrador que está redactando el complemento. Para activar este campo, debes establecer el campo addOns.gmail.composeTrigger.draftAccess en tu manifiesto como 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 abierto 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 abierto en la IU de Documentos.
docs.addonHasFileScopePermission boolean
Si es true, el complemento solicitó y recibió https://www.googleapis.com/auth/drive.file autorización de alcance 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.

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 Cómo obtener una vista previa de vínculos con chips inteligentes para obtener más detalles.

Ejemplo de carga útil para cuando 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 de 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 de https://www.googleapis.com/auth/drive.file. Es 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 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.
sheets.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 Hojas de cálculo de Google. Para usar este campo, debes configurar LinkPreviewTriggers en el manifiesto de tu complemento. Consulta Cómo obtener una vista previa de vínculos con chips inteligentes para obtener más detalles.

Ejemplo de carga útil para cuando un usuario obtiene una vista previa del vínculo https://www.example.com/12345:

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

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 de https://www.googleapis.com/auth/drive.file. Es el ID de la presentación abierta en la IU de Presentaciones.
slides.title string
Solo está presente si el usuario autorizó el permiso de https://www.googleapis.com/auth/drive.file. Es el título de la presentación abierto en la IU de Presentaciones.
slides.addonHasFileScopePermission boolean
Si es true, el complemento solicitó y recibió https://www.googleapis.com/auth/drive.file autorización de alcance para la presentación abierta en la IU de Presentaciones. De lo contrario, este campo es false.
slides.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 Presentaciones de Google. Para usar este campo, debes configurar LinkPreviewTriggers en el manifiesto de tu complemento. Consulta Cómo obtener una vista previa de vínculos con chips inteligentes para obtener más detalles.

Ejemplo de carga útil para cuando un usuario obtiene una vista previa del vínculo https://www.example.com/12345:

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