Event

Um evento de interação do app Google Chat que representa e contém dados sobre a interação de um usuário com um app Chat. Para configurar o app Chat para receber eventos de interação, consulte Receber e responder a interações do usuário.

Além de receber eventos de interações do usuário, os apps do Chat podem receber eventos sobre mudanças nos espaços, como quando um novo participante é adicionado a um espaço. Para saber mais sobre os eventos do espaço, consulte Trabalhar com eventos do Google Chat.

Representação 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)
  },
  "appCommandMetadata": {
    object (AppCommandMetadata)
  }
}
Campos
type

enum (EventType)

O tipo de interação do usuário com o app do Chat, como MESSAGE ou ADDED_TO_SPACE.
eventTime

string (Timestamp format)

O carimbo de data/hora que indica quando o evento de interação ocorreu.
token

string

Um valor secreto que os apps de chat legados podem usar para verificar se uma solicitação é do Google. O Google gera o token aleatoriamente, e o valor dele permanece estático. É possível receber, revogar ou regenerar o token na página de configuração da API Chat no console do Google Cloud.

Os apps do Chat moderno não usam esse campo. Ele não aparece nas respostas da API nem na página de configuração da API Chat.
threadKey

string

A chave definida pelo app Chat para a linha de execução relacionada ao evento de interação. Consulte spaces.messages.thread.threadKey para mais informações.
message

object (Message)

Para eventos de interação ADDED_TO_SPACE, CARD_CLICKED e MESSAGE, a mensagem que acionou o evento de interação, se aplicável.
user

object (User)

O usuário que interagiu com o app Chat.
space

object (Space)

O espaço em que o usuário interagiu com o app Chat.
action

object (FormAction)

Para eventos de interação CARD_CLICKED, os dados de ação do formulário associados quando um usuário clica em um card ou diálogo. Para saber mais, consulte Ler dados de formulário inseridos pelos usuários em cards.
configCompleteRedirectUrl

string

Para eventos de interação MESSAGE, o URL para o qual os usuários precisam ser redirecionados depois de concluir um fluxo de autorização ou configuração fora do Google Chat. Para mais informações, consulte Conectar um app de chat a outros serviços e ferramentas.
isDialogEvent

boolean

Para eventos de interação CARD_CLICKED e MESSAGE, se o usuário está interagindo ou prestes a interagir com uma caixa de diálogo.
dialogEventType

enum (DialogEventType)

O tipo de evento de interação com a caixa de diálogo recebido.
common

object (CommonEventObject)

Representa informações sobre o cliente do usuário, como localidade, app host e plataforma. Para apps de chat, CommonEventObject inclui informações enviadas por usuários que interagem com caixas de diálogo, como dados inseridos em um card.
appCommandMetadata

object (AppCommandMetadata)

Preenchido para comandos de app, incluindo comandos de barra e comandos rápidos.

CommonEventObject

Representa informações sobre o cliente do usuário, como localidade, app host e plataforma. Para apps de chat, CommonEventObject inclui dados enviados por usuários que interagem com cards, como dados inseridos em caixas de diálogo.

Representação JSON 
{
  "userLocale": string,
  "hostApp": enum (HostApp),
  "platform": enum (Platform),
  "timeZone": {
    object (TimeZone)
  },
  "formInputs": {
    string: {
      object (Inputs)
    },
    ...
  },
  "parameters": {
    string: string,
    ...
  },
  "invokedFunction": string
}
Campos
userLocale

string

O locale.displayName completo no formato [código de idioma ISO 639]-[código de país/região ISO 3166], como "pt-BR".
hostApp

enum (HostApp)

O tipo enumerado hostApp que indica o app em que o complemento é invocado. Sempre CHAT para apps de chat.
platform

enum (Platform)

O tipo enumerado de plataforma que indica a plataforma de origem do evento (WEB, IOS ou ANDROID). Não tem suporte para apps de chat.
timeZone

object (TimeZone)

O ID e a diferença do fuso horário em relação ao Tempo Universal Coordenado (UTC). Somente compatível com os tipos de evento CARD_CLICKED e SUBMIT_DIALOG.
formInputs

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

Um mapa que contém os valores que um usuário insere em um widget de um card ou diálogo. As chaves do mapa são os IDs de string atribuídos a cada widget, e os valores representam as entradas do widget.

Para mais detalhes, consulte Processar informações inseridas pelos usuários.
parameters

map (key: string, value: string)

Parâmetros personalizados transmitidos para a função invocada. As chaves e os valores precisam ser strings.
invokedFunction

string

Nome da função invocada associada ao widget. Definido apenas para apps de chat.

TimeZone

O ID e a diferença do fuso horário em relação ao Tempo Universal Coordenado (UTC). Somente compatível com os tipos de evento CARD_CLICKED e SUBMIT_DIALOG.

Representação JSON 
{
  "id": string,
  "offset": integer
}
Campos
id

string

O código do banco de dados de fuso horário IANA TZ, como "America/Toronto".
offset

integer

A diferença do fuso horário do usuário, em milissegundos, em relação ao Tempo Universal Coordenado (UTC).

Entradas

Tipos de dados que os usuários podem inserir em cards ou caixas de diálogo. O tipo de entrada depende do tipo de valores aceitos pelo widget.

Representação 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ão inputs.

inputs pode ser apenas de um dos tipos a seguir:
stringInputs

object (StringInputs)

Uma lista de strings que representam os valores inseridos pelo usuário em um widget.

Se o widget aceitar apenas um valor, como um widget TextInput, a lista vai conter um objeto de string. Se o widget aceitar vários valores, como um widget de caixas de seleção SelectionInput, a lista vai conter um objeto de string para cada valor que o usuário inserir ou selecionar.
dateTimeInput

object (DateTimeInput)

Valores de entrada de data e hora de um widget DateTimePicker que aceita data e hora.
dateInput

object (DateInput)

Valores de entrada de data de um widget DateTimePicker que aceita apenas valores de data.
timeInput

object (TimeInput)

Valores de entrada de tempo de um widget DateTimePicker que aceita apenas valores de tempo.

StringInputs

Parâmetro de entrada para widgets comuns. Para widgets de valor único, é uma lista de valores únicos. Para widgets com vários valores, como caixas de seleção, todos os valores são apresentados.

Representação JSON 
{
  "value": [
    string
  ]
}
Campos
value[]

string

Uma lista de strings inseridas pelo usuário.

DateTimeInput

Valores de entrada de data e hora.

Representação JSON 
{
  "msSinceEpoch": string,
  "hasDate": boolean,
  "hasTime": boolean
}
Campos
msSinceEpoch

string (int64 format)

Tempo desde a época, em milissegundos.
hasDate

boolean

Se a entrada datetime inclui uma data do calendário.
hasTime

boolean

Se a entrada datetime inclui um carimbo de data/hora.

DateInput

Valores de entrada de data.

Representação JSON 
{
  "msSinceEpoch": string
}
Campos
msSinceEpoch

string (int64 format)

Tempo desde a época, em milissegundos.

TimeInput

Valores de entrada de tempo.

Representação JSON 
{
  "hours": integer,
  "minutes": integer
}
Campos
hours

integer

A hora em um relógio de 24 horas.
minutes

integer

O número de minutos após a hora. Os valores válidos são de 0 a 59.

AppCommandMetadata

Metadados associados aos comandos do app. Os comandos de app são uma forma de os usuários invocarem e interagirem com um app de chat. Eles podem ser comandos de barra digitados na caixa de composição ou itens selecionados diretamente no menu de integração.

Representação JSON 
{
  "appCommandId": integer,
  "appCommandType": enum (AppCommandType)
}
Campos
appCommandId

integer

O ID do comando para a interação do app.
appCommandType

enum (AppCommandType)

O tipo de comando do app.