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 automáticamente y se pasan como parámetros para activar funciones o devolver llamadas 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 evento en los siguientes lugares:

  • Activadores de la página principal: A cada función homepageTrigger que definas se le pasa automáticamente un objeto de evento cuando se activa la función del activador de la página principal. Puedes usar este objeto en tu función de activación de la página principal para identificar la app de 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 los widgets y la información contextual.

  • Activadores contextuales: Cada aplicación 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 se indica en el manifiesto del complemento y le pasa un objeto de evento como parámetro. Los objetos de evento que se crean cuando se activan los activadores contextuales contienen todos los campos incluidos en los objetos de eventos de activación 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 con el 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 acciones. Sin embargo, en los complementos de Google Workspace, los objetos de eventos de acción incluyen aún más información en la que puede actuar una función de devolución de llamada.

    Los objetos de evento creados como resultado de las acciones de widgets contienen todos los campos incluidos en los objetos de eventos de activadores 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 se pasa un objeto de evento que contiene el vínculo a la función de devolución de llamada del activador. Tu complemento puede usar este objeto de evento para crear un chip y una tarjeta inteligentes que muestren información sobre el vínculo dentro de la aplicación anfitrión. También puedes compilar acciones de widgets para permitir que los usuarios interactúen con la tarjeta de vista previa y su contenido.

  • Activadores de la app de Google Chat (versión preliminar para desarrolladores). En Google Chat, el complemento se muestra a los usuarios como una app de Chat, y estos pueden interactuar con él agregándolo a espacios, enviando mensajes, usando comandos de barra y mucho más. Para compilar funciones interactivas, configuras y usas varios activadores de la app de Chat. Cada activador envía una carga útil de objeto de evento diferente que te ayuda a procesar o responder a cada tipo de interacción.

Estructura del objeto de evento

En la siguiente tabla, se describe la estructura de nivel superior de los objetos de eventos de complementos de Google Workspace. La estructura del objeto del 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, que determina la app de host activa: gmailEventObject, calendarEventObject o driveEventObject.

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

Objeto de evento
eventObject.commonEventObject Common fields object
Un objeto que contiene información común a todos los objetos de evento, independientemente de la aplicación host.
eventObject.calendar Calendar event object
Solo está presente si el host que realiza la llamada es el Calendario de Google. Es un objeto que contiene información de calendarios y eventos.
eventObject.chat Chat event object
Solo está presente si el host que realiza la llamada es Google Chat. Es un objeto que contiene información de Chat.
eventObject.drive Drive event object
Solo está presente si el host que realiza la llamada es Google Drive. Es un objeto que contiene información de Drive.
eventObject.gmail Gmail event object
Solo está presente si el host que realiza la llamada es Gmail. Es 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. Es 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. Es un objeto que contiene información de Hojas de cálculo.
eventObject.slides Slides event object
Solo está presente si el host que realiza la llamada es Presentaciones de Google. Es 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 esto para activar el acceso a los datos del usuario con permisos temporales de complementos 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 del mensaje del subproceso que 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. Es un mapa de los valores actuales de todos los widgets de formulario de 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 del evento proporciona formInput como comodidad para cuando necesitas leer datos de varios widgets con valores singulares esperados, como entradas de texto y interruptores. En el caso de los widgets de 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. Un mapa de los valores actuales de los widgets en la tarjeta, presentados como listas de cadenas. Las claves son los IDs de cadena asociados con el widget. En el caso de los widgets de un solo valor, el valor se presenta en un array de un solo elemento. En el caso de los widgets de 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. Un mapa de los parámetros adicionales que proporciones a Action con Action.setParameters() Las claves y los valores del mapa son cadenas.

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

eventObject.userCountry string
Quedó obsoleto y está 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 M49 de la ONU.

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

eventObject.userLocale string
Quedó obsoleto y está inhabilitado de forma predeterminada. Es el 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
Quedó obsoleto y está inhabilitado de forma predeterminada. El identificador de zona horaria de la zona horaria del usuario. Entre los ejemplos, se incluyen America/New_York, Europe/Vienna y Asia/Seoul. 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.timeZone.id.

eventObject.userTimezone.offset string
Quedó obsoleto y está inhabilitado de forma predeterminada. El desplazamiento de la hora del horario universal coordinado (UTC) de la zona horaria del usuario, medido en milisegundos. 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.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 los activadores contextuales y de la página principal, los complementos construyen 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 comunes de objetos de eventos
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 del mapa son los IDs de cadena asignados con cada widget.

La estructura del objeto MapValue 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 ID, accede al valor de entrada de texto 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 ID, accede al array de valores con e.commonEventObject.formInputs.participants.stringInputs.value.

  • A date-time picker: Un DateTimeInput object.

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

  • A date-only picker: Un DateInput object.

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

  • A time-only picker: Un objeto TimeInput object.

    Ejemplo: Para un selector con un ID de myTimePicker, accede al objeto TimeInput con e.commonEventObject.formInputs.myTimePicker.timeInput.
commonEventObject.hostApp string
Indica la app host en la que el complemento está activo cuando se genera el objeto del 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 una acción con actionParameters o Action.setParameters()

Versión preliminar para desarrolladores: Para los complementos que extienden Google Chat, usa el valor de la clave "autocomplete_widget_query" (event.commonEventObject.parameters["autocomplete_widget_query"]) para sugerir elementos según lo que los usuarios escriben en los menús de selección múltiple. Puedes usar este valor para consultar una base de datos y sugerir elementos seleccionables a los usuarios a medida que escriben. Para obtener más información, consulta Cómo recopilar y procesar información de los usuarios de Google Chat.
commonEventObject.userLocale string
Está inhabilitado de forma predeterminada. El idioma del usuario y el identificador de país o región en el formato de código de idioma ISO 639-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 alcance de tu complemento también debe incluir https://www.googleapis.com/auth/script.locale. Consulta Acceso a la configuración regional y la zona horaria del usuario para obtener más información.

commonEventObject.timeZone string
Está inhabilitado de forma predeterminada. El ID y la compensación de la zona horaria Para activar este campo, debes establecer addOns.common.useLocaleFromApp en true en el manifiesto de tu complemento. La lista de alcance de tu complemento también debe incluir https://www.googleapis.com/auth/script.locale. Consulta Acceso a la configuración regional y la zona horaria del usuario para obtener más información.
commonEventObject.timeZone.id string
El identificador de zona horaria de la zona horaria del usuario. Entre los ejemplos, se incluyen America/New_York, Europe/Vienna y Asia/Seoul. Para activar este campo, debes establecer addOns.common.useLocaleFromApp en true en el manifiesto de tu complemento. La lista de alcance de tu complemento también debe incluir https://www.googleapis.com/auth/script.locale. Consulta Cómo acceder a la configuración regional y la zona horaria del usuario para obtener más información.
commonEventObject.timeZone.offset string
Es el desplazamiento de la hora del horario universal coordinado (UTC) de la zona horaria del usuario, medido en milisegundos. Consulta Cómo acceder a la configuración regional y la zona horaria del usuario para obtener más información.

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 hora seleccionados por el usuario en los widgets de selector de fecha o hora. Sin embargo, la estructura de la información difiere según si el widget se configuró como un selector de fecha y hora, un selector de solo fecha o un selector de solo hora. Las diferencias estructurales se describen en la siguiente tabla:

Objeto DateTimeInput
dateTimeInput.hasDate boolean
true si la hora y fecha de entrada incluye una fecha; si false, solo se incluye una hora.
dateTimeInput.hasTime boolean
true si la hora de la fecha de entrada incluye una hora; si false, solo se incluye una fecha.
dateTimeInput.msSinceEpoch string
Es la hora que seleccionó el usuario, expresada en milisegundos desde la época (00:00:00 UTC del 1 de enero de 1970).
Objeto DateInput
dateInput.msSinceEpoch string
Es la hora que seleccionó el usuario, expresada 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 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 contiene información sobre el calendario y los eventos de 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 muestran 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 del evento solo si los datos están presentes en el evento del Calendario y el complemento establece su campo addOns.calendar.currentEventAccess manifest en READ o READ_WRITE.

Objeto de evento de calendario
calendar.attendees[] list of attendee objects
Datos generados por usuarios. Es una lista de los asistentes al evento de calendario.
calendar.calendarId string
El ID del calendario.
calendar.capabilities object
Datos generados por usuarios. Es un objeto que describe las capacidades del complemento para ver o actualizar la información del evento.
calendar.capabilities.canAddAttendees boolean
Datos generados por usuarios. true si el complemento puede agregar asistentes nuevos a la lista de asistentes del evento; false de lo contrario.
calendar.capabilities.canSeeAttendees boolean
Datos generados por usuarios. true si el complemento puede leer la lista de asistentes del 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 archivos adjuntos nuevos al evento; false de lo contrario.
calendar.conferenceData Conference data object
Datos generados por usuarios. Es un objeto que representa los datos de 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 del evento.
calendar.organizer.email string
La dirección de correo electrónico del organizador del evento.
calendar.recurringEventId string
Es el ID de un evento recurrente.

Asistente

Los objetos de asistentes contienen información sobre asistentes individuales a eventos del Calendario de Google. Esta información está presente en el objeto del evento solo si los datos están presentes en el evento del Calendario y el complemento establece su campo addOns.calendar.currentEventAccess manifest en READ o READ_WRITE.

Objeto Attendee
attendee.additionalGuests number
Es la cantidad de invitados adicionales que el asistente indicó que llevará. El valor predeterminado es cero.
attendee.comment string
El comentario de respuesta del asistente, si corresponde.
attendee.displayName string
Es el nombre visible del asistente.
attendee.email string
La dirección de correo electrónico del asistente.
attendee.optional boolean
true si la asistencia de este asistente está marcada como opcional; false de lo contrario.
attendee.organizer boolean
true si el asistente es organizador de este evento.
attendee.resource boolean
true si el asistente representa un recurso, como una habitación 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 al evento.
  • tentative: El asistente aceptó de forma provisoria la invitación al evento.
attendee.self boolean
true si este asistente representa el calendario en el que aparece este evento; false de lo contrario.

Datos de la conferencia

Los objetos de datos de conferencias contienen información sobre las conferencias que se adjuntan 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 del Calendario y el complemento establece su campo manifest addOns.calendar.currentEventAccess en READ o READ_WRITE.

Objeto de datos de conferencia
conferenceData.conferenceId string
Es 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
Un objeto que representa la solución de conferencia, como Hangouts o Google Meet.
conferenceData.conferenceSolution.iconUri string
Es 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 única la solución de conferencias de este evento.
conferenceData.conferenceSolution.key.type string
Es el 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 para 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 conferencias (no localizado).
conferenceData.entryPoints[] list of entry point objects
Es la lista de puntos de entrada de la conferencia, como URLs o números de teléfono.
conferenceData.notes string
Son 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 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 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 del evento solo si los datos están presentes en el evento del Calendario y el complemento establece su campo addOns.calendar.currentEventAccess manifest en READ o READ_WRITE.

Objeto de punto de entrada
entryPoint.accessCode string
Es el código de acceso que se usa para acceder a la conferencia. La longitud máxima es de 128 caracteres. Por lo general, los proveedores de conferencias solo usan un subconjunto de {accessCode, meetingCode, passcode, password, pin} para proporcionar acceso a las conferencias. Haz coincidir y muestra solo los campos que usa el proveedor de conferencias.
entryPoint.entryPointFeatures list
Funciones del punto de entrada. Actualmente, estas funciones solo se aplican a los puntos de entrada phone:
  • toll: El punto de entrada es una llamada telefónica con cargo.
  • toll_free: El punto de entrada es una llamada telefónica sin cargo.
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 de teléfono después de aplicarles formato y ordenarlos 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 video.
entryPoint.label string
Es la etiqueta visible para el usuario del URI del punto de entrada (no localizado).
entryPoint.meetingCode string
Es el código de reunión que se usa para acceder a la conferencia. La longitud máxima es de 128 caracteres. Por lo general, los proveedores de conferencias solo usan un subconjunto de {accessCode, meetingCode, passcode, password, pin} para proporcionar acceso a las conferencias. Haz coincidir y muestra solo los campos que usa el proveedor de conferencias.
entryPoint.passcode string
La contraseña que se usa para acceder a la conferencia. La longitud máxima es de 128 caracteres. Por lo general, los proveedores de conferencias solo usan un subconjunto de {accessCode, meetingCode, passcode, password, pin} para proporcionar acceso a las conferencias. Haz coincidir y muestra solo los campos que usa el proveedor de conferencias.
entryPoint.password string
La contraseña que se usa para acceder a la conferencia. La longitud máxima es de 128 caracteres. Por lo general, los proveedores de conferencias solo usan un subconjunto de {accessCode, meetingCode, passcode, password, pin} para proporcionar acceso a las conferencias. Haz coincidir y muestra solo los campos que usa el proveedor de conferencias.
entryPoint.pin string
Es el PIN que se usa para acceder a la conferencia. La longitud máxima es de 128 caracteres. Por lo general, los proveedores de conferencias solo usan un subconjunto de {accessCode, meetingCode, passcode, password, pin} para proporcionar acceso a las conferencias. Haz coincidir y muestra solo los campos que usa el proveedor de conferencias.
entryPoint.regionCode string
Código de región del número de teléfono. Los usuarios lo necesitan 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 de CLDR.
entryPoint.uri string
Es 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 toda la secuencia de marcado (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 del evento de Drive es la parte del objeto del evento general que contiene información sobre 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
Es el elemento de Drive que está activo en este momento.
drive.selectedItems[] list of Drive item objects
Es 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ó la autorización de permiso https://www.googleapis.com/auth/drive.file para este elemento. De lo contrario, este campo es false.
item.id string
Es 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 MIME del elemento seleccionado.
item.title string
Es el título del elemento seleccionado.

Objeto de evento de Gmail

El objeto del evento de Gmail es la parte del objeto del evento general que contiene 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 otorgarle acceso temporal a tu complemento al mensaje de Gmail abierto actualmente de un usuario o permitir que el complemento redacte borradores nuevos.
gmail.bccRecipients[] list of strings
Está inhabilitado de forma predeterminada. La lista de direcciones de correo electrónico de los destinatarios de “Cco” que se incluye actualmente en un borrador que está escribiendo el complemento Para activar este campo, debes configurar el campo addOns.gmail.composeTrigger.draftAccess en tu manifiesto como METADATA.
gmail.ccRecipients[] list of strings
Está inhabilitado de forma predeterminada. La lista de direcciones de correo electrónico de los destinatarios de “Cc” que se incluye actualmente en un borrador que está escribiendo el complemento Para activar este campo, debes configurar el campo addOns.gmail.composeTrigger.draftAccess en tu manifiesto como METADATA.
gmail.messageId string
Es el ID del mensaje de Gmail que está abierto en este momento.
gmail.threadId string
El ID de la conversación de Gmail abierta actualmente.
gmail.toRecipients[] list of strings
Está inhabilitado de forma predeterminada. La lista de direcciones de correo electrónico de los destinatarios del campo “Para” que se incluye actualmente en un borrador que está escribiendo el complemento Para activar este campo, debes configurar el campo addOns.gmail.composeTrigger.draftAccess en tu manifiesto como METADATA.

Objeto de evento de Documentos

El objeto del evento de Documentos es la parte del objeto del evento general que contiene 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 https://www.googleapis.com/auth/drive.file.
Es el ID del documento abierto en la IU de Documentos.
docs.title string
Solo está presente si el usuario autorizó el permiso https://www.googleapis.com/auth/drive.file.
Es el título del documento abierto 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.

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 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 del evento de Hojas de cálculo es la parte del objeto del evento general que contiene 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. 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 permiso 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 Vínculos de vista previa 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 diapositivas

El objeto del evento de diapositivas es la parte del objeto del evento general que contiene 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 diapositivas
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. El título de la presentación se abre en la IU de Presentaciones.
slides.addonHasFileScopePermission boolean
Si es true, el complemento solicitó y recibió la autorización de alcance https://www.googleapis.com/auth/drive.file 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 Vínculos de vista previa 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"
  }
}