- Representación JSON
- CommonEventObject
- TimeZone
- Entradas
- StringInputs
- DateTimeInput
- DateInput
- TimeInput
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 de los usuarios.
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 ( |
Campos | |
---|---|
type |
Es el tipo de interacción del usuario con la app de Chat, como |
eventTime |
Es la marca de tiempo que indica cuándo ocurrió el evento de interacción. |
token |
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 |
La clave definida por la app de Chat para la conversación relacionada con el evento de interacción. Consulta |
message |
Es el mensaje que activó el evento de interacción, si corresponde. |
user |
El usuario que interactuó con la app de Chat |
space |
El espacio en el que el usuario interactuó con la app de Chat. |
action |
Para los eventos de interacción |
configCompleteRedirectUrl |
Para los eventos de interacción |
isDialogEvent |
En el caso de los eventos de interacción |
dialogEventType |
Es el tipo de evento de interacción dialog recibido. |
common |
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
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 ( |
Campos | |
---|---|
userLocale |
El |
hostApp |
La enumeración hostApp, que indica la aplicación desde la que se invoca el complemento. Siempre es |
platform |
La enumeración de la plataforma que indica la plataforma en la que se origina el evento ( |
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 |
formInputs |
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 |
Son los parámetros personalizados que se pasan a la función invocada. Tanto las claves como los valores deben ser cadenas. |
invokedFunction |
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 |
El código de la base de datos de la zona horaria IANA TZ, como “America/Toronto”. |
offset |
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 |
Campos | |
---|---|
Campo de unión
|
|
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 |
dateTimeInput |
Valores de entrada de fecha y hora de un widget |
dateInput |
Valores de entrada de fecha de un widget |
timeInput |
Valores de entrada de hora de un widget |
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[] |
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 |
Indica el tiempo transcurrido desde el tiempo de ciclo de entrenamiento, en milisegundos. |
hasDate |
Indica si la entrada |
hasTime |
Indica si la entrada |
DateInput
Valores de entrada de fecha.
Representación JSON |
---|
{ "msSinceEpoch": string } |
Campos | |
---|---|
msSinceEpoch |
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 |
La hora en un reloj de 24 horas. |
minutes |
Indica la cantidad de minutos transcurridos la hora. Los valores válidos van del 0 al 59. |