Event

Um evento de interação do app Google Chat.

Para saber mais sobre os eventos de interação, consulte Receber e responder às interações com seu app Google Chat. Para saber mais sobre os tipos de evento e os payloads de evento, consulte Tipos de evento de interação com o app 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)
  }
}
Campos
type

enum (EventType)

O tipo de evento de interação. Veja mais detalhes em Tipos de eventos de interação com o app Google Chat.
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 legados de chat podem usar para verificar se uma solicitação veio do Google. O Google gera aleatoriamente o token, e o valor dele permanece estático. Você pode acessar, revogar ou gerar novamente o token na página de configuração da API Chat no Console do Google Cloud.

Os apps modernos de chat não usam esse campo. Ela não aparece nas respostas da API e na página de configuração da API Chat.
threadKey

string

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

object (Message)

A mensagem que acionou o evento de interação, se aplicável.
user

object (User)

O usuário que acionou o evento de interação.
space

object (Space)

O espaço em que o evento de interação ocorreu.
action

object (FormAction)

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

string

O URL para o qual o app Chat deve redirecionar o usuário depois de concluir um fluxo de autorização ou configuração fora do Google Chat. Veja mais informações em Conectar um app de chat a outros serviços e ferramentas.
isDialogEvent

boolean

Para eventos de interação do CARD_CLICKED, se o usuário interagiu com uma caixa de diálogo.
dialogEventType

enum (DialogEventType)

O tipo de evento de interação de dialog recebido.
common

object (CommonEventObject)

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

CommonEventObject

Representa informações sobre o cliente do usuário, como localidade, app host e plataforma. Nos apps de chat, o 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 de [código de idioma ISO 639]-[código de país/região ISO 3166], como "pt-BR".
hostApp

enum (HostApp)

O enum hostApp que indica o aplicativo do qual o complemento é invocado. Sempre CHAT para apps de chat.
platform

enum (Platform)

O enum da plataforma que indica a plataforma de origem do evento (WEB, IOS ou ANDROID). Não é compatível com apps de chat.
timeZone

object (TimeZone)

O ID do fuso horário e o deslocamento do Tempo Universal Coordenado (UTC). Compatível apenas com os tipos de evento CARD_CLICKED e SUBMIT_DIALOG.
formInputs

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

Um mapa com os valores atuais dos widgets em um card. As chaves do mapa são os IDs de string atribuídos a cada widget, e os valores representam entradas para o widget. Dependendo do tipo de dados de entrada, um objeto diferente representa cada entrada: para widgets de valor único, StringInput. Para widgets de vários valores, uma matriz de objetos StringInput. Para um seletor de data e hora, um DateTimeInput. Para um seletor de apenas data, um DateInput. Para um seletor de somente tempo, um TimeInput. Corresponde aos dados inseridos por um usuário em um cartão em uma caixa de diálogo.
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 Chat.

TimeZone

O ID do fuso horário e o deslocamento do Tempo Universal Coordenado (UTC). Compatível apenas 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

O deslocamento do fuso horário do usuário, em milissegundos, em relação ao Tempo Universal Coordenado (UTC, na sigla em inglês).

Entradas

Tipos de dados que os usuários podem inserir em cards ou caixas de diálogo. Para saber como processar informações dos usuários, consulte Ler entradas de dados do formulário feitas pelos usuários em cards.

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)

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

object (DateTimeInput)

Valores de entrada de data e hora.
dateInput

object (DateInput)

Valores de entrada da data.
timeInput

object (TimeInput)

Valores de entrada de horário.

StringInput

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

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

string

Uma matriz de strings inseridas pelo usuário.

Entrada DateTime

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.

DataInput

Valores de entrada da data.

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

string (int64 format)

Tempo desde a época, em milissegundos.

TimeInput

Valores de entrada de horário.

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.