Event

Un evento de interacción de la app de Google Chat

Para obtener información sobre los eventos de interacción, consulta Recibe y responde interacciones con la app de Google Chat. Para obtener información sobre los tipos de eventos y la carga útil de eventos, consulta Tipos de eventos de interacción de la app 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 evento de interacción. Para conocer los detalles, consulte Tipos de eventos de interacción con la aplicación de Google Chat.
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. Puedes obtener, revocar o volver a generar el token en la página de configuración de la API de Chat de Google Cloud Console.

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

string

Es 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)

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

object (User)

Indica el usuario que activó el evento de interacción.
space

object (Space)

El espacio en el que ocurrió el evento de interacción.
action

object (FormAction)

Para los eventos de interacción CARD_CLICKED, 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 Lee la entrada de datos del formulario de los usuarios en las tarjetas.
configCompleteRedirectUrl

string

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

boolean

Para los eventos de interacción CARD_CLICKED, indica si el usuario interactuó con un diálogo.
dialogEventType

enum (DialogEventType)

Es el tipo de evento de interacción de diálogo recibido.
common

object (CommonEventObject)

Representa información del 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.

ObjetoObjectEvent

Representa información del cliente del usuario, como la configuración regional, la app host y la plataforma. En el caso de las apps de chat, CommonEventObject incluye datos enviados por usuarios que interactúan con tarjetas, como los datos ingresados en 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

Corresponde a la locale.displayName completa 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 de hostApp, que indica la app desde la que se invoca el complemento Siempre CHAT para apps de chat.
platform

enum (Platform)

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

object (TimeZone)

Es el ID de la zona horaria y el desplazamiento desde la hora universal coordinada (UTC). Solo se admite para los tipos de eventos CARD_CLICKED y SUBMIT_DIALOG.
formInputs

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

Mapa que contiene los valores actuales de los widgets en una tarjeta. Las claves del mapa son los ID de string asignados a cada widget, y los valores representan entradas para el widget. Según el tipo de datos de entrada, un objeto diferente representa cada entrada: para widgets de valor único, StringInput. Para los widgets de varios valores, un array de objetos StringInput. Para un selector de fecha y hora, un DateTimeInput. Para un selector de solo fecha, un DateInput. Para un selector solo de tiempo, un TimeInput. Corresponde a los datos ingresados por un usuario en una tarjeta en un diálogo.
parameters

map (key: string, value: string)

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

string

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

TimeZone

Es el ID de la zona horaria y el desplazamiento desde la hora universal coordinada (UTC). Solo se admite para los tipos de eventos 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 “América/Toronto”.
offset

integer

La compensación horaria del usuario, en milisegundos, a partir del tiempo universal coordinado (UTC).

Entradas

Tipos de datos que los usuarios pueden ingresar en tarjetas o diálogos. Para obtener información sobre cómo procesar la información de los usuarios, consulta Cómo leer la entrada de datos de formularios de los usuarios en tarjetas.

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)

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

object (DateTimeInput)

Valores de entrada de fecha y hora.
dateInput

object (DateInput)

Valores de entrada de la fecha.
timeInput

object (TimeInput)

Valores de entrada de tiempo.

StringInputs

Parámetro de entrada para widgets normales. Para los widgets de valor único, es una lista de valores únicos. 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

Es un array de strings que ingresó el usuario.

Entrada de fecha y hora

Valores de entrada de fecha y hora.

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

string (int64 format)

Tiempo transcurrido desde el epoch, en milisegundos
hasDate

boolean

Si la entrada datetime incluye una fecha del calendario
hasTime

boolean

Indica si la entrada datetime incluye una marca de tiempo.

Entrada de fecha

Valores de entrada de la fecha.

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

string (int64 format)

Tiempo transcurrido desde el epoch, en milisegundos

Entrada de tiempo

Valores de entrada de tiempo.

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

integer

La hora en un reloj de 24 horas
minutes

integer

La cantidad de minutos después de la hora. Los valores válidos van de 0 a 59.