Event

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)

El tipo de evento.

eventTime

string (Timestamp format)

La marca de tiempo que indica cuándo ocurrió el evento.

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 en Google Cloud Console.

Las apps de Chat modernas no usan este campo. Está ausente en las respuestas de la API y 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. Consulta spaces.messages.thread.threadKey para obtener más información.

message

object (Message)

El mensaje que activó el evento, si corresponde.

user

object (User)

Indica el usuario que activó el evento.

space

object (Space)

Espacio en el que ocurrió el evento.

action

object (FormAction)

Los datos de acción del formulario asociados con una tarjeta interactiva en la que se hizo clic Solo se propaga para eventos de CARD_CLICKED. Consulta la guía de tarjetas interactivas para obtener más información.

configCompleteRedirectUrl

string

Es 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, consulte Cómo conectar una aplicación de Chat con otros servicios y herramientas.

isDialogEvent

boolean

Verdadero cuando el evento está relacionado con diálogos.

dialogEventType

enum (DialogEventType)

El tipo de evento 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 que se ingresan 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 datos que envían los usuarios que interactúan con tarjetas, como los datos que se ingresan 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

El locale.displayName completo con el formato del [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 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 en la que se originó el evento (WEB, IOS o ANDROID) no es compatible con las apps de Chat.

timeZone

object (TimeZone)

El ID de zona horaria y la diferencia respecto de la hora universal coordinada (UTC). Solo se admite para los tipos de evento 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 de mapa son los ID de string asignados a cada widget, y los valores representan entradas en 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 arreglo 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 que un usuario ingresó en una tarjeta en un diálogo.

parameters

map (key: string, value: string)

Los parámetros personalizados pasados 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 establecido para las apps de chat.

TimeZone

El ID de zona horaria y la diferencia respecto de la hora universal coordinada (UTC). Solo se admite para 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

El desplazamiento de zona horaria del usuario, en milisegundos, a partir de la hora universal coordinada (UTC)

Entradas

Tipos de entradas de datos para widgets. Los usuarios ingresan datos con estas entradas.

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. Para los widgets de 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 fecha.

timeInput

object (TimeInput)

Valores de entrada de tiempo.

StringInput

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

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

string

Un arreglo de strings ingresadas por 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

Indica si la entrada datetime incluye una fecha calendario.

hasTime

boolean

Indica si la entrada datetime incluye una marca de tiempo.

Entrada de fecha

Valores de entrada de 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

Cantidad de minutos transcurridos por hora. Los valores válidos van del 0 al 59.