Event

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)
  }
}
Campos
type

enum (EventType)

O tipo do evento.

eventTime

string (Timestamp format)

É o carimbo de data/hora que indica quando o evento 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 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 do Chat não usam esse campo. Não há respostas da API e a página de configuração da API Chat.

threadKey

string

Chave definida pelo app de chat para a conversa relacionada ao evento. Consulte spaces.messages.thread.threadKey para mais informações.

message

object (Message)

A mensagem que acionou o evento, se aplicável.

user

object (User)

O usuário que acionou o evento.

space

object (Space)

O espaço em que o evento ocorreu.

action

object (FormAction)

Os dados da ação de formulário associados a um cartão interativo que foi clicado. Preenchido apenas para eventos CARD_CLICKED. Consulte o guia sobre cards interativos para mais informações.

configCompleteRedirectUrl

string

O URL para o qual o app de chat precisa 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

Verdadeiro quando o evento está relacionado a caixas de diálogo.

dialogEventType

enum (DialogEventType)

O tipo de evento 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 por 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 do país/região ISO 3166], como "en-US".

hostApp

enum (HostApp)

A enumeração hostApp que indica o app a partir do qual o complemento é invocado. Sempre CHAT para apps de chat.

platform

enum (Platform)

A enumeração da plataforma que indica a 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 strings atribuídos a cada widget, e os valores representam as entradas deles. 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 uma data, um DateInput. Para um seletor de horário, um TimeInput. Corresponde aos dados inseridos por um usuário em um card em uma caixa de diálogo.

parameters

map (key: string, value: string)

Parâmetros personalizados transmitidos para a função invocada. Tanto as chaves quanto os valores precisam ser strings.

invokedFunction

string

Nome da função invocada associada ao widget. Definido apenas para apps de 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 "EUA/Toronto".

offset

integer

O deslocamento do fuso horário do usuário, em milissegundos, do Tempo Universal Coordenado (UTC).

Entradas

Tipos de entradas de dados para widgets. Os usuários inserem dados com essas entradas.

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 valores únicos. 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 de data.

timeInput

object (TimeInput)

Valores de entrada de tempo.

StringInputs

Parâmetro de entrada para widgets regulares. Para widgets de valor único, é uma lista de valores únicos. 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 de 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 no calendário.

hasTime

boolean

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

DataEntrada

Valores de entrada de data.

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

string (int64 format)

Tempo desde a época, em milissegundos.

Entrada de tempo

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.