Objetos de eventos

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

Los objetos de evento son estructuras JSON que se crean automáticamente y se pasan como parámetros para activar o devolver funciones 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 evento en los siguientes lugares:

  • Activadores de la página principal. A cada función de homepageTrigger que definas, se le pasa 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 de activación de la página principal para identificar la app host activa, la plataforma del cliente, la configuración regional del usuario y otra información.

    Los objetos de evento creados cuando se activan los activadores de la página principal no contienen todos los campos incluidos en los otros 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:

    Cuando se activa un activador contextual, la aplicación alojada llama a la 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 se activan los activadores contextuales contienen todos los campos incluidos en los objetos de evento de activador de página principal, además de los campos que contienen información contextual.

  • Acciones de widgets. Los objetos de evento proporcionan interactividad de 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. En los complementos de Google Workspace, los objetos de eventos de acción incluyen más información sobre la que puede actuar una función de devolución de llamada.

    Los objetos de evento creados a partir de acciones de widgets contienen todos los campos incluidos en los objetos de evento de activador contextual, además de los campos que contienen información del widget.

  • Obtén una vista previa de los activadores de vínculos. En Documentos de Google, Hojas de cálculo y Presentaciones, puedes configurar vistas previas de vínculos para servicios de terceros según patrones de URL específicos. Cuando los usuarios interactúan con un vínculo que cumple con el patrón, se activa el activador 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 construir un chip inteligente y una tarjeta que muestren información sobre el vínculo dentro de la aplicación alojada. También puedes crear acciones de widget para que los usuarios puedan interactuar con la tarjeta de vista previa y su contenido.

  • Activadores de la app de Google Chat. En Google Chat, tu complemento aparece para los usuarios como una app de Chat, y los usuarios pueden interactuar con él agregándolo a espacios, enviando mensajes, usando comandos de barra y mucho más. Para compilar funciones interactivas, configura y usa varios activadores de la app de Chat. Cada activador envía una carga útil de objeto de evento diferente que te ayuda a procesar cada tipo de interacción o responder a ella.

Estructura del objeto de evento

En la siguiente tabla, se describe la estructura de nivel superior de los objetos de evento de los complementos de Google Workspace. La estructura incluye un campo commonEventObject de nivel superior 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 mantener la retrocompatibilidad, los objetos de evento de los complementos de Google Workspace incluyen los campos originales que se usan en los objetos de evento de acción de los complementos de Gmail. Estos campos se encuentran en "Campos originales del complemento de Gmail" y no forman parte de commonEventObject.

Los campos originales del complemento de Gmail dejaron de estar disponibles. Cuando desarrolles o migres un complemento de Google Workspace, usa la estructura de objetos de evento más reciente. Es posible que estos campos se quiten en una actualización futura.

Objeto de evento
eventObject.commonEventObject Common fields object
Es 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 llama es el Calendario de Google. Es un objeto que contiene información sobre el calendario y los 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 esta opción para activar el acceso a los datos del usuario con 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. Es el 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. 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 de evento proporciona formInput para facilitar la lectura de datos de varios widgets con valores singulares esperados, como entradas de texto y selectores. En el caso de los widgets con varios valores, como las casillas de verificación, lee 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. Es un mapa de los valores actuales de los widgets de la tarjeta, presentados como listas de cadenas. Las claves son los IDs de cadena asociados con el widget. Para los widgets de valor único, el valor se presenta en un array de un solo elemento. En el caso de los widgets con varios valores, como los grupos de casillas de verificación, todos los valores se presentan en una lista.

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

eventObject.parameters object
Obsoleto. Es un mapa de cualquier parámetro adicional que proporciones 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. Es 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. 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 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 zona horaria de la zona horaria del usuario. Por ejemplo, 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 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 compensación de tiempo de la hora universal coordinada (UTC) de la zona horaria del usuario, medida en milisegundos. Consulta Cómo acceder a la configuración regional y 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 del usuario, la app host y la plataforma.

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

La estructura del objeto de valor de mapa 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 valor de entrada de texto con lo siguiente: e.commonEventObject.formInputs.employeeName.stringInputs.value[0]

  • Widgets con 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 array de valores con: e.commonEventObject.formInputs.participants.stringInputs.value.

  • A date-time picker: Es un objeto 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: Es un objeto 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: Es 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 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 una acción con actionParameters o Action.setParameters.

Versión preliminar para desarrolladores: En el caso de las apps de Google Chat, para sugerir elementos según lo que escriben los usuarios en los menús de selección múltiple, usa el valor de la clave "autocomplete_widget_query" (event.commonEventObject.parameters["autocomplete_widget_query"]). 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 Recopila y procesa información de los usuarios de Google Chat.
commonEventObject.userLocale string
Inhabilitado de forma predeterminada. Es el identificador de idioma y país o región del usuario 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 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 la zona horaria del usuario para obtener más detalles.

commonEventObject.timeZone string
Inhabilitado de forma predeterminada. El ID de la zona horaria y la diferencia. 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 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. Por ejemplo: 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 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 la zona horaria del usuario para obtener más detalles.
commonEventObject.timeZone.offset string
Es la compensación de tiempo de la hora universal coordinada (UTC) de la zona horaria del usuario, medida en milisegundos. Consulta Cómo acceder a la configuración regional y la zona horaria del usuario para obtener más detalles.

Entradas de formulario del selector de fecha y hora

Las funciones de devolución de llamada de acción pueden recibir valores de widgets actuales en el campo commonEventObject.formInputs. Esto incluye los valores de fecha o de hora que el usuario selecciona en los widgets de selector de fecha o de hora. La estructura de la información varía 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 fecha y hora de entrada incluye una fecha; si es false, solo se incluye una hora.
dateTimeInput.hasTime boolean
true si la fecha y hora de entrada incluye una hora; si es false, solo se incluye una fecha.
dateTimeInput.msSinceEpoch string
Es 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
Es 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 el número de minuto que seleccionó el usuario.

Objeto de evento de chat

El objeto de evento de Chat es la parte del objeto de evento general que contiene información sobre las interacciones de un usuario con una app de Chat. Solo está presente en un objeto de evento si el complemento extiende Google Chat.

Chat
chat.user object (User)
Es el usuario de Chat que interactuó con la app de Chat.
chat.space object (Space)
Es el espacio de Chat en el que un usuario interactuó con la app de Chat.
chat.eventTime

string (Timestamp format)

Es la hora en que se produjo la interacción.

Campo de unión payload. Para un activador de página principal de la app (cuando un usuario abre la pestaña Página principal), no se establece payload y chat contiene chat.user y chat.eventTime.

payload puede ser una de las siguientes opciones:
chat.messagePayload

object (MessagePayload)

Es la carga útil que reciben las apps de Chat de un activador de mensaje.
chat.addedToSpacePayload

object (AddedToSpacePayload)

Es la carga útil que reciben las apps de Chat de un activador Se agregó al espacio.
chat.removedFromSpacePayload

object (RemovedFromSpacePayload)

Es la carga útil que reciben las apps de Chat de un activador Se quitó del espacio.
chat.buttonClickedPayload

object (ButtonClickedPayload)

Es la carga útil que reciben las apps de Chat cuando los usuarios hacen clic en un botón de un mensaje o una tarjeta. Si un usuario hace clic en un botón para enviar información, el objeto commonEventObject.formInputs contiene los valores recopilados del usuario. Para obtener más información, consulta Recopila información de los usuarios de Google Chat.
chat.widgetUpdatedPayload

object (WidgetUpdatedPayload)

Es la carga útil que reciben las apps de Chat cuando los usuarios escriben texto en el menú de selección múltiple de un widget selectionInput. Las apps de Chat pueden usar este objeto de evento para propagar elementos sugeridos de una fuente de datos dinámica. Por ejemplo, para propagar casos de asistencia desde una fuente de datos externa, una app de Chat puede consultar la fuente de datos según lo que el usuario escriba en el menú y, luego, devolver los casos de asistencia coincidentes como elementos seleccionables.

El objeto CommonEventObject.parameters['autocomplete_widget_query'] contiene el valor de cadena que el usuario escribe en el menú.

chat.appCommandPayload

object (AppCommandPayload)

Es la carga útil que reciben las apps de Chat cuando un usuario usa un comando de la app de Chat.

Carga útil

Según el tipo de interacción de la app de Chat, el evento contiene una carga útil con uno o más recursos de la API de Chat.

Carga útil del mensaje
MessagePayload
chat.messagePayload.message object (Message)
Es el mensaje de Chat que activó el evento.
chat.messagePayload.space object (Space)
Es el espacio de Chat en el que un usuario envió el mensaje que invocó la app de Chat.
chat.messagePayload.configCompleteRedirectUri string
Es la URL a la que la app de Chat debe redireccionar al usuario después de que complete un flujo de autorización o configuración fuera de Google Chat. Para obtener más información, consulta Conecta tu complemento de Google Workspace a un servicio de terceros.
Carga útil de agregado al espacio
AddedToSpacePayload
chat.addedToSpacePayload.space object (Space)
Es el espacio de Chat al que el usuario agregó o instaló la app de Chat.

Cuando los administradores instalan apps de Chat, el campo space.adminInstalled se establece en true.

chat.addedToSpacePayload.interactionAdd boolean
Indica si un usuario agrega la app de Chat a un espacio con un mensaje. Por ejemplo, menciona con @ a la app de Chat o usa un comando. Si es true, Chat envía otro objeto de evento con un messagePayload que contiene información sobre el mensaje.
chat.addedToSpacePayload.configCompleteRedirectUri string
Es la URL a la que la app de Chat debe redireccionar al usuario después de que complete un flujo de autorización o configuración fuera de Google Chat. Para obtener más información, consulta Conecta tu complemento de Google Workspace a un servicio de terceros.
Carga útil de eliminación del espacio
RemovedFromSpacePayload
chat.removedFromSpacePayload.space object (Space)
Es el espacio de Chat del que el usuario quitó o desinstaló la app de Chat.

Cuando los administradores desinstalan apps de Chat, el campo space.adminInstalled se establece en false.

Carga útil del clic en el botón
ButtonClickedPayload
chat.buttonClickedPayload.message object (Message)
Es el mensaje de Chat que contiene el botón en el que hizo clic un usuario.
chat.buttonClickedPayload.space object (Space)
Es el espacio de Chat en el que el usuario hizo clic en un botón de un mensaje de la app de Chat.
chat.buttonClickedPayload.isDialogEvent boolean
Indica si el usuario hizo clic en el botón para interactuar con un diálogo.
chat.buttonClickedPayload.dialogEventType enum (DialogEventType)
Si isDialogEvent es true, es el tipo de interacción en un diálogo.

Enum DialogEventType.

El valor de dialogEventType puede ser solo uno de los siguientes:
TYPE_UNSPECIFIED Valor predeterminado Sin especificar.
REQUEST_DIALOG Un usuario solicita un diálogo. Por ejemplo, usan un comando o hacen clic en un botón de un mensaje.
SUBMIT_DIALOG Un usuario hace clic en un elemento interactivo dentro de un diálogo. Por ejemplo, un usuario completa información en un diálogo y hace clic en un botón para enviarla.
Carga útil actualizada del widget
WidgetUpdatedPayload
chat.widgetUpdatedPayload.space object (Space)
Es el espacio de Chat en el que se produjo la interacción.
Carga útil del comando de la app
AppCommandPayload
chat.appCommandPayload.appCommandMetadata object (AppCommandMetadata)
Metadatos sobre el comando que usó el usuario y cómo lo activó.
chat.appCommandPayload.space object (Space)
Es el espacio de Chat en el que un usuario usó el comando.
chat.appCommandPayload.thread object (Thread)
Si la interacción se produjo en una conversación, es la conversación de Chat en la que el usuario usó el comando.
chat.appCommandPayload.message object (Message)
En el caso de los comandos de barra, el mensaje con el comando de barra.
chat.appCommandPayload.configCompleteRedirectUri string
Si se requiere autorización o configuración para el comando, una URL a la que se redireccionará al usuario después de que complete el proceso fuera de Google Chat.
chat.appCommandPayload.isDialogEvent boolean
Indica si el comando abre un diálogo.
chat.appCommandPayload.dialogEventType enum (DialogEventType)
Es el tipo de interacción con un diálogo.

Enum DialogEventType.

El valor de dialogEventType puede ser solo uno de los siguientes:
TYPE_UNSPECIFIED Valor predeterminado Sin especificar.
REQUEST_DIALOG Un usuario solicita un diálogo. Por ejemplo, usan un comando o hacen clic en un botón de un mensaje.
SUBMIT_DIALOG Un usuario hace clic en un elemento interactivo dentro de un diálogo. Por ejemplo, un usuario completa información en un diálogo y hace clic en un botón para enviarla.
Metadatos de comandos de la app
AppCommandMetadata
chat.appCommandPayload.appCommandMetadata.appCommandId

string (int64 format)

Es el ID del comando.
chat.appCommandPayload.appCommandMetadata.appCommandType enum (AppCommandType)
Es el tipo de comando.

Enum AppCommandType.

El valor de AppCommandType puede ser solo uno de los siguientes:
APP_COMMAND_TYPE_UNSPECIFIED Valor predeterminado Sin especificar.
SLASH_COMMAND Para usar el comando, el usuario envía un mensaje que comienza con una barra /.
QUICK_COMMAND El usuario selecciona el comando en el menú de Chat, en el área de respuesta de mensajes.

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 el complemento extiende 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 de manifiesto addOns.calendar.currentEventAccess en READ o READ_WRITE.

Muchos de los campos de este objeto y sus subestructuras se asignan directamente a los campos del recurso Event de la API de Calendar que tienen el mismo nombre. Si las descripciones de los campos difieren, la información de la siguiente tabla es correcta.

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
Es el ID del calendario.
calendar.capabilities object
Datos generados por el usuario. 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 el usuario. 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 el usuario. true si el complemento puede leer la lista de asistentes al evento; false de lo contrario.
calendar.capabilities.canSeeConferenceData boolean
Datos generados por el usuario. true si el complemento puede leer los datos de la conferencia del evento; false de lo contrario.
calendar.capabilities.canSetConferenceData boolean
Datos generados por el usuario. true si el complemento puede actualizar los datos de la conferencia del evento; de lo contrario, false.
calendar.capabilities.canAddAttachments boolean
Datos generados por el usuario. 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 la conferencia asociados con este evento, como los detalles de la conferencia de Google Meet.
calendar.id string
Es el ID del evento.
calendar.organizer object
Es un objeto que representa al organizador del evento.
calendar.organizer.email string
Es 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 los 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 del manifiesto 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
Es el comentario de respuesta del asistente, si lo hay.
attendee.displayName string
Es el nombre visible del asistente.
attendee.email string
Es la dirección de correo electrónico del asistente.
attendee.optional boolean
true si la asistencia de este invitado se marca como opcional; de lo contrario, false.
attendee.organizer boolean
true si el asistente es un organizador de este evento.
attendee.resource boolean
true si el asistente representa un recurso, como una sala o un equipo; de lo contrario, false.
attendee.responseStatus string
Es 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; de lo contrario, false.

Datos de conferencias

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

Objeto de datos de conferencia
conferenceData.conferenceId string
Es el ID de la conferencia. Este ID está diseñado para permitir que las aplicaciones realicen un seguimiento de las conferencias. No debes mostrar este ID a los usuarios.
conferenceData.conferenceSolution object
Es un objeto que representa la solución para videoconferencias, como Hangouts o Google Meet.
conferenceData.conferenceSolution.iconUri string
Es el URI del ícono visible para el usuario que representa esta solución para conferencias.
conferenceData.conferenceSolution.key object
Es la clave que identifica de forma única la solución para reuniones de este evento.
conferenceData.conferenceSolution.key.type string
Es el tipo de solución para conferencias. 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 para 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
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
Es un objeto que contiene un mapa de datos de parámetros definidos para que los use el complemento.
conferenceData.parameters.addOnParameters object
Es 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 de evento solo si los datos están presentes en el evento de calendario y el complemento establece su campo de manifiesto addOns.calendar.currentEventAccess 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
Son las funciones del punto de entrada. Actualmente, estas funciones solo se aplican a los puntos de entrada de phone:
  • 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
Es el tipo de punto de entrada. Los valores posibles son los siguientes:
  • more: Son 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 primeros dos puntos de entrada telefónicos, después de darles formato y ordenarlos alfabéticamente.
  • sip: Únete a la conferencia por 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 localizada).
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
Es 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
Es 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
Es el 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@myprovider.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 contiene información sobre la unidad de Google Drive de un usuario y su contenido. Solo está presente en un objeto de evento si el complemento extiende Google Drive.

Objeto de evento de Drive
drive.activeCursorItem Drive item object
El elemento de Drive que está activo actualmente.
drive.selectedItems[] list of Drive item objects
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 del 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 elemento seleccionado.
item.iconUrl string
Es la URL del ícono que representa el elemento seleccionado.
item.mimeType string
Es el tipo de MIME del elemento seleccionado.
item.title string
Es el título del elemento seleccionado.

Objeto de evento de Gmail

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

Objeto de evento de Gmail
gmail.accessToken string
Es el token de acceso específico de Gmail. Usa este token con el método GmailApp.setCurrentMessageAccessToken para otorgar a tu complemento acceso temporal al mensaje de Gmail que el usuario tiene abierto o permitir que tu complemento redacte borradores nuevos.
gmail.bccRecipients[] list of strings
Inhabilitado de forma predeterminada. Es la lista de direcciones de correo electrónico de los destinatarios de "Cco:" que se incluyen actualmente en un borrador que está redactando el complemento. Para activar este campo, establece el campo addOns.gmail.composeTrigger.draftAccess en tu manifiesto como METADATA.
gmail.ccRecipients[] list of strings
Inhabilitado de forma predeterminada. Es la lista de direcciones de correo electrónico de los destinatarios de "CC:" que se incluyen actualmente en un borrador que está redactando el complemento. Para activar este campo, establece el campo addOns.gmail.composeTrigger.draftAccess en tu manifiesto como METADATA.
gmail.messageId string
Es el ID del mensaje de Gmail que está abierto actualmente.
gmail.threadId string
Es el ID de la conversación de Gmail que está abierta actualmente.
gmail.toRecipients[] list of strings
Inhabilitado de forma predeterminada. Es la lista de direcciones de correo electrónico de los destinatarios "Para:" que se incluyen actualmente en un borrador que está redactando el complemento. Para activar este campo, establece 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 contiene información sobre el documento de un usuario y su contenido. Solo está presente en un objeto de evento si el complemento extiende Documentos de Google.

Objeto de evento de Documentos
docs.id string
Solo se muestra 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 del permiso 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 se presenta si se cumplen las siguientes condiciones:
  • El usuario autorizó a https://www.googleapis.com/auth/workspace.linkpreview.
  • La URL coincide con el patrón de host especificado en el activador LinkPreviewTriggers.

Es la URL del vínculo que genera una vista previa en Documentos de Google. Para usar este campo, debes configurar LinkPreviewTriggers en el manifiesto de tu complemento. Consulta Vínculos de vista previa 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 contiene información sobre el documento de un usuario y su contenido. Solo está presente en un objeto de evento si el complemento extiende 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. Es 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 del 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 se presenta si se cumplen las siguientes condiciones:
  • El usuario autorizó a 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, configura LinkPreviewTriggers en el manifiesto de tu complemento. Consulta Obtén una vista previa de los 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 contiene información sobre el documento de un usuario y su contenido. Solo está presente en un objeto de evento si el complemento extiende Presentaciones de Google.

Objeto de evento de Presentaciones
slides.id string
Solo está presente si el usuario autorizó el permiso https://www.googleapis.com/auth/drive.file. 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 https://www.googleapis.com/auth/drive.file. Es el título de la presentación abierta en la IU de Presentaciones.
slides.addonHasFileScopePermission boolean
Si es true, el complemento solicitó y recibió la autorización del permiso 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 se presenta si se cumplen las siguientes condiciones:
  • El usuario autorizó a 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, configura el LinkPreviewTriggers en el manifiesto de tu complemento. Consulta Obtén una vista previa de los 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"
  }
}