Event

Un evento de interacción con la app de Google Chat que representa y contiene datos sobre la interacción de un usuario con una app de Chat. Si quieres configurar tu app de Chat para que reciba eventos de interacción, consulta Recibe y responde interacciones del usuario.

Además de recibir eventos de las interacciones de los usuarios, las apps de Chat pueden recibir eventos sobre cambios en los espacios, como cuando se agrega un miembro nuevo a un espacio. Para obtener información sobre los eventos espaciales, consulta Trabaja con eventos de Google Chat.

Representación JSON 
{
  "type": enum (EventType),
  "eventTime": string,
  "token": string,
  "threadKey": string,
  "message": {
    object (Message)
  },
  "user": {
    object (User)
  },
  "space": {
    object (Space)
  },
  "action": {
    object (FormAction)
  },
  "configCompleteRedirectUrl": string,
  "isDialogEvent": boolean,
  "dialogEventType": enum (DialogEventType),
  "common": {
    object (CommonEventObject)
  }
}
Campos
type

enum (EventType)

Es el tipo de interacción del usuario con la app de Chat, como MESSAGE o ADDED_TO_SPACE.
eventTime

string (Timestamp format)

Es la marca de tiempo que indica cuándo ocurrió el evento de interacción.
token

string

Un valor secreto que las apps de Chat heredadas pueden usar para verificar si una solicitud es de Google. Google genera el token de forma aleatoria, y su valor permanece estático. Puede obtener, revocar o regenerar el token desde la página de configuración de la API de Chat en la consola de Google Cloud.

Las apps de Chat modernas no usan este campo. No aparece en las respuestas de la API ni en la página de configuración de la API de Chat.
threadKey

string

La clave definida por la app de Chat para la conversación relacionada con el evento de interacción. Consulta spaces.messages.thread.threadKey para obtener más información.
message

object (Message)

Es el mensaje que activó el evento de interacción, si corresponde.
user

object (User)

El usuario que interactuó con la app de Chat
space

object (Space)

El espacio en el que el usuario interactuó con la app de Chat.
action

object (FormAction)

Para los eventos de interacción CARD_CLICKED, son los datos de la acción del formulario asociados cuando un usuario hace clic en una tarjeta o un diálogo. Para obtener más información, consulta Cómo leer los datos del formulario que ingresan los usuarios en las tarjetas.
configCompleteRedirectUrl

string

La URL a la que la app de Chat debe redireccionar al usuario después de que haya completado un flujo de autorización o configuración fuera de Google Chat. Para obtener más información, consulta Conecta una app de Chat con otros servicios y herramientas.
isDialogEvent

boolean

En el caso de los eventos de interacción CARD_CLICKED y MESSAGE, indica si el usuario interactúa con un diálogo o está por interactuar con él.
dialogEventType

enum (DialogEventType)

Es el tipo de evento de interacción dialog recibido.
common

object (CommonEventObject)

Representa información sobre el cliente del usuario, como la configuración regional, la app host y la plataforma. En el caso de las apps de Chat, CommonEventObject incluye información que envían los usuarios que interactúan con diálogos, como los datos ingresados en una tarjeta.

CommonEventObject

Representa información sobre el cliente del usuario, como la configuración regional, la app host y la plataforma. En el caso de las apps de Chat, CommonEventObject incluye los datos enviados por los usuarios que interactúan con tarjetas, como los datos ingresados en los diálogos.

Representación JSON 
{
  "userLocale": string,
  "hostApp": enum (HostApp),
  "platform": enum (Platform),
  "timeZone": {
    object (TimeZone)
  },
  "formInputs": {
    string: {
      object (Inputs)
    },
    ...
  },
  "parameters": {
    string: string,
    ...
  },
  "invokedFunction": string
}
Campos
userLocale

string

El locale.displayName completo en el formato de [código de idioma ISO 639]-[código de país/región ISO 3166], como “en-US”.
hostApp

enum (HostApp)

La enumeración hostApp, que indica la aplicación desde la que se invoca el complemento. Siempre es CHAT para las apps de Chat.
platform

enum (Platform)

La enumeración de la plataforma que indica la plataforma en la que se origina el evento (WEB, IOS o ANDROID). No es compatible con las apps de Chat.
timeZone

object (TimeZone)

Indica el ID de la zona horaria y el desplazamiento de la hora universal coordinada (UTC). Solo es compatible con los tipos de evento CARD_CLICKED y SUBMIT_DIALOG.
formInputs

map (key: string, value: object (Inputs))

Un mapa que contiene los valores que un usuario ingresa en un widget desde una tarjeta o un diálogo. Las claves del mapa son los IDs de cadena asignados a cada widget, y los valores representan entradas para el widget.

Para obtener más detalles, consulta Cómo procesar la información que ingresan los usuarios.
parameters

map (key: string, value: string)

Son los parámetros personalizados que se pasan a la función invocada. Tanto las claves como los valores deben ser cadenas.
invokedFunction

string

Nombre de la función invocada asociada con el widget. Solo se configuró para las apps de Chat.

TimeZone

Indica el ID de la zona horaria y el desplazamiento de la hora universal coordinada (UTC). Solo es compatible con los tipos de evento CARD_CLICKED y SUBMIT_DIALOG.

Representación JSON 
{
  "id": string,
  "offset": integer
}
Campos
id

string

El código de la base de datos de la zona horaria IANA TZ, como “America/Toronto”.
offset

integer

Desplazamiento de la zona horaria del usuario, en milisegundos, con respecto a la hora universal coordinada (UTC)

Entradas

Son los tipos de datos que los usuarios pueden ingresar en las tarjetas o los diálogos. El tipo de entrada depende del tipo de valores que acepta el widget.

Representación JSON 
{

  // Union field inputs can be only one of the following:
  "stringInputs": {
    object (StringInputs)
  },
  "dateTimeInput": {
    object (DateTimeInput)
  },
  "dateInput": {
    object (DateInput)
  },
  "timeInput": {
    object (TimeInput)
  }
  // End of list of possible types for union field inputs.
}
Campos

Campo de unión inputs.

inputs puede ser una de las siguientes opciones:
stringInputs

object (StringInputs)

Una lista de cadenas que representan los valores que el usuario ingresa en un widget.

Si el widget solo acepta un valor, como un widget TextInput, la lista contiene un objeto de cadena. Si el widget acepta varios valores, como un widget SelectionInput con casillas de verificación, la lista contiene un objeto de cadena para cada valor que el usuario ingresa o selecciona.
dateTimeInput

object (DateTimeInput)

Valores de entrada de fecha y hora de un widget DateTimePicker que acepta tanto una fecha como una hora.
dateInput

object (DateInput)

Valores de entrada de fecha de un widget DateTimePicker que solo acepta valores de fecha.
timeInput

object (TimeInput)

Valores de entrada de hora de un widget DateTimePicker que solo acepta valores de hora.

StringInputs

Parámetro de entrada para widgets normales. Para los widgets con un solo valor, es una lista de un solo valor. En el caso de los widgets con valores múltiples, como la casilla de verificación, se presentan todos los valores.

Representación JSON 
{
  "value": [
    string
  ]
}
Campos
value[]

string

Una lista de cadenas ingresadas por el usuario.

DateTimeInput

Valores de entrada de fecha y hora.

Representación JSON 
{
  "msSinceEpoch": string,
  "hasDate": boolean,
  "hasTime": boolean
}
Campos
msSinceEpoch

string (int64 format)

Indica el tiempo transcurrido desde el tiempo de ciclo de entrenamiento, en milisegundos.
hasDate

boolean

Indica si la entrada datetime incluye una fecha de calendario.
hasTime

boolean

Indica si la entrada datetime incluye una marca de tiempo.

DateInput

Valores de entrada de fecha.

Representación JSON 
{
  "msSinceEpoch": string
}
Campos
msSinceEpoch

string (int64 format)

Indica el tiempo transcurrido desde el tiempo de ciclo de entrenamiento, en milisegundos.

TimeInput

Valores de entrada de hora.

Representación JSON 
{
  "hours": integer,
  "minutes": integer
}
Campos
hours

integer

La hora en un reloj de 24 horas.
minutes

integer

Indica la cantidad de minutos transcurridos la hora. Los valores válidos van del 0 al 59.