Event

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

Saiba mais sobre os eventos de interação em Receber e responder a interações com seu app do Google Chat. Para saber mais sobre os tipos de eventos e, por exemplo, os payloads de eventos, consulte Tipos de eventos de interação no app do Google Chat.

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 a adição de um novo participante. Saiba mais sobre os eventos no espaço em 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)
  }
}
Campos
type

enum (EventType)

O tipo de evento de interação. Saiba mais em Tipos de eventos de interação no 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 do 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. Você pode conseguir, revogar ou gerar o token novamente na página de configuração da API Chat no console do Google Cloud.

Apps modernos do Chat não usam esse campo. Ele não aparece nas respostas da API e na página de configuração da API Chat.
threadKey

string

A chave definida pelo app do 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 CARD_CLICKED, os dados de ação do formulário associados quando um usuário clica em um card ou caixa de diálogo. Para saber mais, consulte Ler dados de entrada dos usuários nos cartões.
configCompleteRedirectUrl

string

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

boolean

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

enum (DialogEventType)

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

object (CommonEventObject)

Representa informações sobre o cliente do usuário, como localidade, app host e plataforma. Em 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. No caso de apps de chat, o CommonEventObject inclui dados enviados por usuários que interagem com cards, como os 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 "en-US".
hostApp

enum (HostApp)

O enum hostApp que indica o app em que o complemento é invocado. Sempre CHAT para apps do Chat.
platform

enum (Platform)

É o tipo enumerado da plataforma que indica a plataforma de origem do evento (WEB, IOS ou ANDROID). Não é compatível com apps do Chat.
timeZone

object (TimeZone)

O ID do fuso horário e o deslocamento do Horário 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 contendo os valores que um usuário insere em um widget usando um card ou uma caixa de 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 as informações inseridas pelos usuários.
parameters

map (key: string, value: string)

Parâmetros personalizados transmitidos à 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 Horário 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).

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 que o widget aceita.

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 que o usuário insere em um widget.

Se o widget aceitar apenas um valor, como um widget TextInput, a lista conterá um objeto de string. Se o widget aceitar diversos valores, como um widget SelectionInput de caixas de seleção, a lista vai conter um objeto de string para cada valor inserido ou selecionado pelo usuário.
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 caixa 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 o tempo de época, em milissegundos.
hasDate

boolean

Indica 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 o tempo de é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.