Event

Événement d'interaction avec l'application Google Chat.

Pour en savoir plus sur les événements d'interaction, consultez Recevoir des interactions avec votre application Google Chat et y répondre. Pour en savoir plus sur les types d'événements et par exemple les charges utiles d'événement, consultez Types d'événements d'interaction dans l'application Google Chat.

En plus de recevoir les événements liés aux interactions utilisateur, les applications Chat peuvent recevoir des événements concernant les modifications apportées aux espaces, par exemple lorsqu'un nouveau membre est ajouté à un espace. Pour en savoir plus sur les événements d'un espace, consultez Gérer les événements Google Chat.

Représentation 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)
  }
}
Champs
type

enum (EventType)

Type d'événement d'interaction. Pour en savoir plus, consultez Types d'événements d'interaction avec les applications Google Chat.
eventTime

string (Timestamp format)

Horodatage indiquant le moment où l'événement d'interaction s'est produit.
token

string

Valeur secrète que les anciennes applications Chat peuvent utiliser pour vérifier si une requête provient de Google. Google génère le jeton de manière aléatoire, et sa valeur reste statique. Vous pouvez obtenir, révoquer ou générer à nouveau le jeton depuis la page de configuration de l'API Chat dans la console Google Cloud.

Les applications Chat modernes n'utilisent pas ce champ. Il n'apparaît pas dans les réponses de l'API ni sur la page de configuration de l'API Chat.
threadKey

string

Clé définie par l'application Chat pour le fil de discussion associé à l'événement d'interaction. Pour en savoir plus, consultez spaces.messages.thread.threadKey.
message

object (Message)

Message ayant déclenché l'événement d'interaction, le cas échéant.
user

object (User)

Utilisateur ayant déclenché l'événement d'interaction.
space

object (Space)

Espace dans lequel l'événement d'interaction s'est produit.
action

object (FormAction)

Pour les événements d'interaction CARD_CLICKED, il s'agit des données d'action du formulaire associées lorsqu'un utilisateur clique sur une fiche ou une boîte de dialogue. Pour en savoir plus, consultez Lire les données saisies par les utilisateurs sur des fiches.
configCompleteRedirectUrl

string

URL vers laquelle l'application Chat doit rediriger l'utilisateur une fois qu'il a terminé un flux d'autorisation ou de configuration en dehors de Google Chat. Pour en savoir plus, consultez Connecter une application Chat à d'autres services et outils.
isDialogEvent

boolean

Pour les événements d'interaction CARD_CLICKED, indique si l'utilisateur a interagi avec une boîte de dialogue.
dialogEventType

enum (DialogEventType)

Type d'événement d'interaction de boîte de dialogue reçu.
common

object (CommonEventObject)

Représente les informations sur le client de l'utilisateur, telles que les paramètres régionaux, l'application hôte et la plate-forme. Pour les applications Chat, CommonEventObject inclut les informations envoyées par les utilisateurs qui interagissent avec des boîtes de dialogue, telles que les données saisies sur une fiche.

CommonEventObject

Représente les informations sur le client de l'utilisateur, telles que les paramètres régionaux, l'application hôte et la plate-forme. Pour les applications Chat, CommonEventObject inclut les données envoyées par les utilisateurs interagissant avec les fiches, telles que les données saisies dans les boîtes de dialogue.

Représentation JSON 
{
  "userLocale": string,
  "hostApp": enum (HostApp),
  "platform": enum (Platform),
  "timeZone": {
    object (TimeZone)
  },
  "formInputs": {
    string: {
      object (Inputs)
    },
    ...
  },
  "parameters": {
    string: string,
    ...
  },
  "invokedFunction": string
}
Champs
userLocale

string

La valeur locale.displayName complète au format [code de langue ISO 639]-[code pays/région ISO 3166], par exemple "en-US".
hostApp

enum (HostApp)

Énumération hostApp qui indique l'application à partir de laquelle le module complémentaire est appelé. Toujours CHAT pour les applications Chat.
platform

enum (Platform)

Énumération de la plate-forme indiquant la plate-forme d'où provient l'événement (WEB, IOS ou ANDROID). Non compatible avec les applications Chat.
timeZone

object (TimeZone)

ID et décalage du fuseau horaire par rapport au temps universel coordonné (UTC). Uniquement compatible avec les types d'événements CARD_CLICKED et SUBMIT_DIALOG.
formInputs

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

Carte contenant les valeurs qu'un utilisateur saisit dans un widget à partir d'une carte ou d'une boîte de dialogue. Les clés de mappage sont les ID de chaîne attribués à chaque widget. Les valeurs représentent les entrées du widget.

Pour en savoir plus, consultez Traiter les informations saisies par les utilisateurs.
parameters

map (key: string, value: string)

Paramètres personnalisés transmis à la fonction appelée. Les clés et les valeurs doivent être des chaînes.
invokedFunction

string

Nom de la fonction appelée associée au widget. Défini uniquement pour les applications Chat.

TimeZone

ID et décalage du fuseau horaire par rapport au temps universel coordonné (UTC). Uniquement compatible avec les types d'événements CARD_CLICKED et SUBMIT_DIALOG.

Représentation JSON 
{
  "id": string,
  "offset": integer
}
Champs
id

string

Code de la base de données de fuseau horaire de l'IANA TZ, tel que "America/Toronto".
offset

integer

Décalage horaire de l'utilisateur, en millisecondes, par rapport au temps universel coordonné (UTC).

Entrées

Types de données que les utilisateurs peuvent saisir sur des fiches ou des boîtes de dialogue. Le type d'entrée dépend du type de valeurs acceptées par le widget.

Représentation 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.
}
Champs

Champ d'union inputs.

inputs ne peut être qu'un des éléments suivants :
stringInputs

object (StringInputs)

Liste de chaînes représentant les valeurs saisies par l'utilisateur dans un widget.

Si le widget n'accepte qu'une seule valeur, par exemple un widget TextInput, la liste contient un objet de chaîne. Si le widget accepte plusieurs valeurs, par exemple un widget SelectionInput de cases à cocher, la liste contient un objet de chaîne pour chaque valeur saisie ou sélectionnée par l'utilisateur.
dateTimeInput

object (DateTimeInput)

Valeurs d'entrée de date et d'heure provenant d'un widget DateTimePicker qui accepte à la fois une date et une heure.
dateInput

object (DateInput)

Valeurs de saisie de date provenant d'un widget DateTimePicker qui n'accepte que des valeurs de date.
timeInput

object (TimeInput)

Valeurs temporelles saisies à partir d'un widget DateTimePicker qui n'accepte que des valeurs temporelles.

StringInputs

Paramètre d'entrée pour les widgets standards. Pour les widgets à valeur unique, il s'agit d'une liste à valeur unique. Pour les widgets à valeurs multiples, comme par exemple une case à cocher, toutes les valeurs sont présentées.

Représentation JSON 
{
  "value": [
    string
  ]
}
Champs
value[]

string

Liste de chaînes saisies par l'utilisateur.

DateTimeInput

Valeurs d'entrée de date et d'heure.

Représentation JSON 
{
  "msSinceEpoch": string,
  "hasDate": boolean,
  "hasTime": boolean
}
Champs
msSinceEpoch

string (int64 format)

Temps écoulé depuis l'epoch, en millisecondes.
hasDate

boolean

Indique si l'entrée datetime inclut une date du calendrier.
hasTime

boolean

Indique si l'entrée datetime inclut un horodatage.

DateInput

Valeurs de saisie de date

Représentation JSON 
{
  "msSinceEpoch": string
}
Champs
msSinceEpoch

string (int64 format)

Temps écoulé depuis l'epoch, en millisecondes.

TimeInput

Valeurs de saisie de l'heure.

Représentation JSON 
{
  "hours": integer,
  "minutes": integer
}
Champs
hours

integer

Heure au format 24 heures.
minutes

integer

Nombre de minutes après l'heure écoulée. Les valeurs valides sont comprises entre 0 et 59.