Objetos de eventos

En esta página, se describe la estructura de los objetos de eventos 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 devolver funciones cuando un usuario interactúa con un complemento. Los objetos de evento llevan información del cliente sobre la app host y la el contexto actual a la función de devolución de llamada del servidor del complemento.

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

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

    Los objetos de evento creados cuando la página principal activa el incendio no contienen todos los campos incluidos en los otros dos casos; campos pertenecientes a los widgets y se omite la información contextual.

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

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

  • Acciones del widget. Objetos de evento también se usan para proporcionar widgets interactividad con los mismos modelo de acción que los complementos de Gmail usar. Los complementos de Google Workspace usan las mismas funciones de controlador de widgets, Objetos y acción Action de respuestas ante incidentes. Sin embargo, en los complementos de Google Workspace, objetos de eventos de acción Incluye más información sobre la que pueda actuar una función de devolución de llamada.

    Los objetos de evento creados como resultado de las acciones del widget contienen todas las campos incluidos en objetos de eventos activadores contextuales, más 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 hacer lo siguiente: 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 el patrón, la linkPreviewTriggers se activa y un objeto de evento que contiene el vínculo se pasa al estado función de devolución de llamada. Tu complemento puede usar este objeto de evento para construir un Chip inteligente y tarjeta que muestra información sobre el vínculo en el host y mantener la integridad de su aplicación. También puedes compilar acciones de widget para permitir que los usuarios interactúen con la tarjeta de vista previa y su contenido.

Estructura de objetos de eventos

La siguiente tabla describe la estructura de nivel superior de Objetos de evento de complementos de Google Workspace. El evento de objetos incluye un commonEventObject campo de nivel superior 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 el app host activa: gmailEventObject, calendarEventObject o driveEventObject.

Para ofrecer retrocompatibilidad, los complementos de Google Workspace los objetos de evento también incluyen todos los campos originales utilizados en Objetos de eventos de acción de complementos de Gmail. Estos campos se enumeran en la tabla que aparece a continuación en "Campos originales de los complementos de Gmail" la información de estos campos se reproduce en una 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 evento. sin importar la aplicación de host.
eventObject.calendar Calendar event object de
Solo está presente si el host que realiza la llamada es el Calendario de Google. Un objeto que contiene información de calendarios y eventos.
eventObject.drive Drive event object de
Solo está presente si el host que realiza la llamada es Google Drive. Un objeto con información de Drive.
eventObject.gmail Gmail event object de
Solo está presente si el host que realiza la llamada es Gmail. Un objeto con información de Gmail.
eventObject.docs Docs event object de
Solo está presente si el host que realiza la llamada es Documentos de Google. Un objeto con información de Docs.
eventObject.sheets Sheets event object de
Solo está presente si el host que realiza la llamada es Hojas de cálculo de Google. Un objeto con información de Hojas de cálculo.
eventObject.slides Slides event object de
Solo está presente si el organizador que realiza la llamada es Presentaciones de Google. Un objeto con información de Presentaciones.
Campos originales del complemento de Gmail
eventObject.messageMetadata.accessToken string
Obsoleto. Un token de acceso. Puedes usar esta acción para activar el acceso a los datos del usuario por medio de permisos temporales de complementos de Gmail.

Para los complementos de Google Workspace, busca esta información en la eventObject.gmail.accessToken .

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

Para los complementos de Google Workspace, busca esta información en la eventObject.gmail.messageId .

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

Para los complementos de Google Workspace, busca esta información en la eventObject.commonEventObject.platform .

eventObject.formInput object
Obsoleto. Un mapa de los valores actuales de todos los widgets de forma en la tarjeta, restringidos a un valor por widget. El son los IDs de cadena asociados con los widgets, y los valores se cadenas. El objeto event proporciona formInput como conveniente para cuando necesitas leer datos de varios widgets con los valores singulares esperados, como entradas de texto e interruptores. Para widgets de varios valores, como casillas de verificación, puedes leer cada valor desde formInputs en su lugar.

Para los complementos de Google Workspace, busca esta información en la eventObject.commonEventObject.formInputs en su lugar; los widgets con valores únicos se representan como arrays con un solo elemento.

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

Para los complementos de Google Workspace, busca esta información en la eventObject.commonEventObject.formInputs .

eventObject.parameters object
Obsoleto. Un mapa de cualquier ubicación parámetros que proporcionas al Action que usa Action.setParameters() Los valores y las claves del mapa son cadenas.

Para los complementos de Google Workspace, busca esta información en la 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 se puede un valor numérico Es el código de país UN M49.

Para los complementos de Google Workspace, busca esta información en la eventObject.commonEventObject.userLocale .

eventObject.userLocale string
Obsoleto e inhabilitado de forma predeterminada. El dos letras ISO 639 que indica el idioma del usuario. Consulta Usuario con acceso configuración regional y zona horaria para obtener más detalles.

Para los complementos de Google Workspace, busca esta información en la eventObject.commonEventObject.userLocale .

eventObject.userTimezone.id string
Obsoleto e inhabilitado de forma predeterminada. El identificador de la zona horaria de la zona horaria del usuario. Los ejemplos incluyen: America/New_York, Europe/Vienna y Asia/Seoul Consulta Accede a la configuración regional y la zona horaria del usuario para obtener más detalles.

Para los complementos de Google Workspace, busca esta información en la eventObject.commonEventObject.timeZone.id .

eventObject.userTimezone.offset string
Obsoleto e inhabilitado de forma predeterminada. El diferencia horaria respecto de la hora universal coordinada (UTC) la zona horaria, medida en milisegundos. Consulta Accede a la configuración regional y la zona horaria del usuario para obtener más detalles.

Para los complementos de Google Workspace, busca esta información en la 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 en el complemento desde el cliente del usuario. Esta incluye detalles como la configuración regional del usuario, la aplicación host y la plataforma.

Además de la página de inicio y los activadores contextuales, los complementos construyen 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 widgets abiertos en la cliente. Por ejemplo, tu complemento puede ubicar el texto que un usuario ingresó en un Widget TextInput en 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
Un mapa que contiene los valores actuales de los widgets en la tarjeta que se muestra. Las claves de asignación son los IDs de cadena se asignan con cada widget.

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

  • Widgets de un solo valor (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 texto valor de entrada con e.commonEventObject.formInputs.employeeName.stringInputs.value[0]

  • Widgets de varios valores (por ejemplo, grupos de casillas de verificación): una lista de cadenas.

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

  • A date-time picker: un DateTimeInput object

    Ejemplo: Para un selector con un ID de myDTPicker, acceder a la Objeto DateTimeInput mediante e.commonEventObject.formInputs.myDTPicker.dateTimeInput

  • A date-only picker: un DateInput object

    Ejemplo: Para un selector con un ID de myDatePicker, acceder a la DateInput que usa e.commonEventObject.formInputs.myDatePicker.dateInput

  • A time-only picker: un TimeInput object

    Ejemplo: Para un selector con un ID de myTimePicker, acceder a la TimeInput que usa e.commonEventObject.formInputs.myTimePicker.timeInput
commonEventObject.hostApp string
Indica la aplicación host en la que está activo el complemento. cuando se genera el objeto de evento. Entre los valores posibles, se incluyen lo siguiente:
  • GMAIL
  • CALENDAR
  • DRIVE
  • DOCS
  • SHEETS
  • SLIDES
commonEventObject.parameters object
Cualquier parámetro adicional que suministro a Action mediante Action.setParameters()
commonEventObject.userLocale string
Inhabilitado de forma predeterminada. El idioma del usuario e identificador de país o región con el formato de ISO 639 código de idioma ISO 3166 el código de país o región. 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 de tu complemento también debe incluir https://www.googleapis.com/auth/script.locale. Consulta Accede a la configuración regional y la zona horaria del usuario para obtener más detalles.

commonEventObject.timeZone string
Inhabilitado de forma predeterminada. El ID de la zona horaria y desplazamiento. Para activar este campo, debes configurar addOns.common.useLocaleFromApp por 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 Accede a la configuración regional y la zona horaria del usuario para obtener más detalles.
commonEventObject.timeZone.id string
El identificador de la zona horaria de la zona horaria del usuario. Los ejemplos incluyen: America/New_York, Europe/Vienna y Asia/Seoul Para activar este campo, debes configurar addOns.common.useLocaleFromApp por 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 Accede a la configuración regional y la zona horaria del usuario para obtener más detalles.
commonEventObject.timeZone.offset string
El compensación horaria desde la hora universal coordinada (UTC) de la la zona horaria, medida en milisegundos. Consulta Accede a la configuración regional y la zona horaria del usuario para obtener más detalles.

Entradas del formulario del selector de fecha y hora

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

Objeto DateTimeInput
dateTimeInput.hasDate boolean
true si la fecha y hora ingresadas incluya una fecha; si false solo se incluye una hora.
dateTimeInput.hasTime boolean
true si la fecha y hora ingresadas incluye un tiempo; si false solo se incluye una fecha.
dateTimeInput.msSinceEpoch string
La hora que selecciona 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 selecciona el usuario, en milisegundos desde la época (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 la cantidad 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 contiene información sobre el calendario y los eventos de calendario de un usuario. Es solo 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 calendarEventObject de un objeto de evento. Los campos marcados como Datos generados por el usuario son los siguientes: presente en el objeto event solo si los datos están presentes en el Calendario evento y el complemento establece su addOns.calendar.currentEventAccess manifiesto campo a READ o READ_WRITE.

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

Asistente

Los objetos de los asistentes contienen información sobre cada uno de los asistentes en Calendario de Google eventos. Esta información se encuentra en el objeto de evento solo si los datos está presente en el evento de Calendario y el complemento establece la addOns.calendar.currentEventAccess manifiesto campo a READ o READ_WRITE.

Objeto de asistente
attendee.additionalGuests number
La cantidad de invitados adicionales del asistente habían indicado que están trayendo. La configuración predeterminada es cero.
attendee.comment string
El comentario de la respuesta del asistente, si corresponde
attendee.displayName string
El nombre visible del asistente
attendee.email string
La dirección de correo electrónico del asistente
attendee.optional boolean
true si la asistencia para esto el asistente está marcado 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 equipo; false de lo contrario.
attendee.responseStatus string
El estado de la respuesta del asistente. Posibles incluyen lo siguiente:
  • accepted: El asistente aceptó el evento invitación.
  • declined: El asistente rechazó el evento invitación.
  • needsAction: El asistente no respondió al invitación al evento.
  • tentative: El asistente aceptó provisoriamente las invitación al evento.
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 conferencias contienen información sobre conferencias vinculadas a eventos del Calendario de Google. Pueden ser soluciones de conferencia de Google, como Google Meet o conferencias de terceros. Esta información está presente solo si los datos están presentes en el evento de Calendario el complemento establece su addOns.calendar.currentEventAccess manifiesto campo a READ o READ_WRITE.

Objeto de datos de conferencia
conferenceData.conferenceId string
El ID de la conferencia. Este ID se supone para permitir que las aplicaciones hagan un seguimiento de las conferencias no deberías mostrar este ID a los usuarios.
conferenceData.conferenceSolution object
Un objeto que representa la 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 manera inequívoca al solución de conferencia para este evento.
conferenceData.conferenceSolution.key.type string
El tipo de solución de conferencia. Valores posibles incluyen lo siguiente:
  • eventHangout para Hangouts para consumidores (http://hangouts.google.com).
  • eventNamedHangout para la versión clásica de Hangouts para Usuarios de Google Workspace (http://hangouts.google.com)
  • hangoutsMeet para Google Meet (http://meet.google.com).
conferenceData.conferenceSolution.name string
El nombre visible del usuario de esta reunión (no localizada).
conferenceData.entryPoints[] list of entry point objects
La lista de puntos de entrada de la conferencia, como URLs o números de teléfono.
conferenceData.notes string
Notas adicionales (como las instrucciones de el administrador del dominio o los avisos legales) sobre la conferencia a mostrar al usuario. Puede contener HTML. La longitud máxima es 2,048 caracteres.
conferenceData.parameters object
Un objeto que contiene un mapa de objetos los datos de parámetros para que los use el complemento.
conferenceData.parameters.addOnParameters object
Es un mapa de claves y valores de cadena de parámetros. El desarrollador del complemento define estos valores y claves para adjuntarlos información a una conferencia específica para que la use el complemento.

Punto de entrada

Los objetos de punto de entrada contienen información sobre los medios establecidos para acceder 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. el complemento establece su addOns.calendar.currentEventAccess manifiesto campo a 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 solo puedes usar un subconjunto de {accessCode, meetingCode, passcode, password, pin} a brindan acceso a conferencias. Coincidir y mostrar solo los campos que utiliza el proveedor de conferencias.
entryPoint.entryPointFeatures list
Características del punto de entrada. Actualmente estas Las funciones solo se aplican a phone puntos de entrada:
  • toll: El punto de entrada es una llamada telefónica con cargo.
  • 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 lo siguiente:
  • more: Instrucciones adicionales para unirse a la conferencia. como números de teléfono alternativos. Una conferencia puede tener solo una more punto de entrada; si está presente, al menos, otro tipo de punto de entrada.
  • phone: Únete a la conferencia con un número de teléfono. R puede tener cero o más puntos de entrada phone. El Calendario de Google solo muestra los dos primeros puntos de entrada telefónicos, después de formatear y ordenar alfabéticamente.
  • sip: Únete a la conferencia a través del SIP. Una conferencia puede deben tener, como máximo, un punto de entrada sip.
  • video: Únete a la conferencia a través de HTTP. R la conferencia puede tener como máximo un punto de entrada video.
entryPoint.label string
La etiqueta visible para el usuario correspondiente al URI del punto de entrada (no localizado).
entryPoint.meetingCode string
El código de reunión que se usa para acceder a la conferencia La longitud máxima es de 128 caracteres. Los proveedores de conferencias suelen solo puedes usar un subconjunto de {accessCode, meetingCode, passcode, password, pin} a brindan acceso a conferencias. Coincidir y mostrar solo los campos que utiliza 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 solo puedes usar un subconjunto de {accessCode, meetingCode, passcode, password, pin} a brindan acceso a conferencias. Coincidir y mostrar solo los campos que utiliza el proveedor de conferencias.
entryPoint.password string
La contraseña utilizada para acceder a la conferencia. La longitud máxima es de 128 caracteres. Los proveedores de conferencias suelen solo puedes usar un subconjunto de {accessCode, meetingCode, passcode, password, pin} a brindan acceso a conferencias. Coincidir y mostrar solo los campos que utiliza 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 solo puedes usar un subconjunto de {accessCode, meetingCode, passcode, password, pin} a brindan acceso a conferencias. Coincidir y mostrar solo los campos que utiliza el proveedor de conferencias.
entryPoint.regionCode string
El código regional del número de teléfono. Necesaria para usuarios si el URI no incluye un código de país. Los valores se basan en el público Lista de CLDR de códigos regionales.
entryPoint.uri string
El URI del punto de entrada. El máximo la longitud es de 1,300 caracteres. El formato depende del punto de entrada Tipo:
  • more: Es un http: o https:. es obligatorio ingresar un esquema.
  • phone: Se requiere un esquema tel:. El El URI debe incluir la secuencia de marcado completa (por ejemplo, "tel:+12345678900,,,12345678;1234").
  • sip: Es un sip: o sips:. es obligatorio ingresar un esquema. Por ejemplo, “sip:12345678@miproveedor.com”.
  • video: Es un http: o https:. es obligatorio ingresar un esquema.

Objeto de evento de Drive

El objeto de evento de Drive es la parte del objeto de evento general que transporta información sobre la cuenta de Google Drive del usuario y su contenido. Es solo en un objeto de evento si la aplicación host es Google Drive.

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

Elemento de Drive

Los objetos de elementos de Drive contienen información sobre elementos específicos de Drive, 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 false
item.id string
El ID del elemento seleccionado.
item.iconUrl string
La URL del ícono que representa el el elemento seleccionado.
item.mimeType string
El tipo de MIME del elemento seleccionado.
item.title string
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 GmailApp.setCurrentMessageAccessToken(accessToken) para otorgar a tu complemento acceso temporal a las aplicaciones abrir un mensaje de Gmail o permitir que tu complemento redacte nuevos borradores.
gmail.bccRecipients[] list of strings
Inhabilitado de forma predeterminada. La lista de "Cco:" direcciones de correo electrónico de los destinatarios incluidas actualmente en un borrador complemento está redactando. Para activar este campo, debes configurar la addOns.gmail.composeTrigger.draftAccess en tu manifiesto para METADATA
gmail.ccRecipients[] list of strings
Inhabilitado de forma predeterminada. La lista de "CC:" direcciones de correo electrónico de los destinatarios incluidas actualmente en un borrador complemento está redactando. Para activar este campo, debes configurar la addOns.gmail.composeTrigger.draftAccess en tu manifiesto para METADATA
gmail.messageId string
El ID del mensaje de Gmail abierto actualmente.
gmail.threadId string
El ID de conversación de Gmail actualmente abierto.
gmail.toRecipients[] list of strings
Inhabilitado de forma predeterminada. La lista de "Para:" direcciones de correo electrónico de los destinatarios incluidas actualmente en un borrador complemento está redactando. Para activar este campo, debes configurar la addOns.gmail.composeTrigger.draftAccess en tu manifiesto para 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 se estableció el permiso https://www.googleapis.com/auth/drive.file autorizado por el usuario.
El ID del documento abierto en la IU de Documentos.
docs.title string
Solo está presente si se estableció el permiso https://www.googleapis.com/auth/drive.file autorizado por el usuario.
El título del documento se abre en la IU de Documentos.
docs.addonHasFileScopePermission boolean
Si es true, el complemento solicitó. y recibió https://www.googleapis.com/auth/drive.file la autorización de alcance del documento abierto en la IU de Documentos De lo contrario, esta 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 el LinkPreviewTriggers en el manifiesto de tu complemento. Consulta Obtén 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 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 se estableció el permiso https://www.googleapis.com/auth/drive.file autorizadas por el usuario. El ID de la hoja de cálculo abierta en la IU de Hojas de cálculo.
sheets.title string
Solo está presente si se estableció el permiso https://www.googleapis.com/auth/drive.file autorizadas por el usuario. El título de la hoja de cálculo abierto en Hojas de cálculo de la IU de Google.
sheets.addonHasFileScopePermission boolean
Si es true, el complemento solicitó. y recibió https://www.googleapis.com/auth/drive.file la autorización de alcance 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.

La URL del vínculo que genera una vista previa en Hojas de cálculo de Google. Para usar este campo, debes configurar el LinkPreviewTriggers en el manifiesto de tu complemento. Consulta Obtén 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 información sobre el documento de un usuario y su contenido. Solo está presente en un 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 se estableció el permiso https://www.googleapis.com/auth/drive.file autorizadas por el usuario. El ID de la presentación abierta en Presentaciones de la IU de Google.
slides.title string
Solo está presente si se estableció el permiso https://www.googleapis.com/auth/drive.file autorizadas por el usuario. El título de la presentación abierto en IU de Presentaciones
slides.addonHasFileScopePermission boolean
Si es true, el complemento solicitó. y recibió https://www.googleapis.com/auth/drive.file la 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 el LinkPreviewTriggers en el manifiesto de tu complemento. Consulta Obtén 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"
  }
}