- Representação JSON
- CommonEventObject
- TimeZone
- Entradas
- StringInputs
- DateTimeInput
- DateInput
- TimeInput
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 ( |
Campos | |
---|---|
type |
O tipo de evento de interação. Saiba mais em Tipos de eventos de interação no app Google Chat. |
eventTime |
O carimbo de data/hora que indica quando o evento de interação ocorreu. |
token |
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 |
A chave definida pelo app do Chat para a conversa relacionada ao evento de interação. Consulte |
message |
A mensagem que acionou o evento de interação, se aplicável. |
user |
O usuário que acionou o evento de interação. |
space |
O espaço em que o evento de interação ocorreu. |
action |
Para eventos de interação |
configCompleteRedirectUrl |
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 |
Para eventos de interação |
dialogEventType |
O tipo de evento de interação dialog recebido. |
common |
Representa informações sobre o cliente do usuário, como localidade, app host e plataforma. Em apps de chat, o |
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 ( |
Campos | |
---|---|
userLocale |
O |
hostApp |
O enum hostApp que indica o app em que o complemento é invocado. Sempre |
platform |
É o tipo enumerado da plataforma que indica a plataforma de origem do evento ( |
timeZone |
O ID do fuso horário e o deslocamento do Horário Universal Coordenado (UTC). Compatível apenas com os tipos de evento |
formInputs |
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 |
Parâmetros personalizados transmitidos à função invocada. Tanto as chaves quanto os valores precisam ser strings. |
invokedFunction |
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 |
O código do banco de dados de fuso horário IANA TZ, como "America/Toronto". |
offset |
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 |
Campos | |
---|---|
Campo de união
|
|
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 |
dateTimeInput |
Valores de entrada de data e hora de um widget |
dateInput |
Valores de entrada de data de um widget |
timeInput |
Valores de entrada de tempo de um widget |
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[] |
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 |
Tempo desde o tempo de época, em milissegundos. |
hasDate |
Indica se a entrada |
hasTime |
Se a entrada |
DateInput
Valores de entrada de data.
Representação JSON |
---|
{ "msSinceEpoch": string } |
Campos | |
---|---|
msSinceEpoch |
Tempo desde o tempo de época, em milissegundos. |
TimeInput
Valores de entrada de horário.
Representação JSON |
---|
{ "hours": integer, "minutes": integer } |
Campos | |
---|---|
hours |
É a hora em um relógio de 24 horas. |
minutes |
O número de minutos após a hora. Os valores válidos são de 0 a 59. |