Event

Événement d'interaction avec une application Google Chat qui représente et contient des données sur l'interaction d'un utilisateur avec une application Chat. Pour configurer votre application Chat afin qu'elle reçoive des événements d'interaction, consultez Recevoir et répondre aux interactions des utilisateurs.

En plus de recevoir des événements liés aux interactions des utilisateurs, 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'espace, consultez Utiliser des événements depuis 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)
  },
  "appCommandMetadata": {
    object (AppCommandMetadata)
  }
}
Champs
type

enum (EventType)

Type d'interaction de l'utilisateur avec l'application Chat, par exemple MESSAGE ou ADDED_TO_SPACE.
eventTime

string (Timestamp format)

Code temporel indiquant le moment auquel 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 sur 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)

Pour les événements d'interaction ADDED_TO_SPACE, CARD_CLICKED et MESSAGE, le message ayant déclenché l'événement d'interaction, le cas échéant.
user

object (User)

Utilisateur ayant interagi avec l'application Chat.
space

object (Space)

Espace dans lequel l'utilisateur a interagi avec l'application Chat.
action

object (FormAction)

Pour les événements d'interaction CARD_CLICKED, les 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 de formulaire saisies par les utilisateurs sur les fiches.
configCompleteRedirectUrl

string

Pour les événements d'interaction MESSAGE, URL vers laquelle les utilisateurs doivent être redirigés après avoir terminé un flux d'autorisation ou de configuration en dehors de Google Chat. Pour en savoir plus, consultez Associer une application Chat à d'autres services et outils.
isDialogEvent

boolean

Pour les événements d'interaction CARD_CLICKED et MESSAGE, indique si l'utilisateur interagit avec une boîte de dialogue ou s'il est sur le point de le faire.
dialogEventType

enum (DialogEventType)

Type d'événement d'interaction dialog reçu.
common

object (CommonEventObject)

Représente des 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 les boîtes de dialogue, comme les données saisies sur une fiche.
appCommandMetadata

object (AppCommandMetadata)

Inséré pour les commandes d'application, y compris les commandes à barre oblique et les commandes rapides.

CommonEventObject

Représente des 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 qui interagissent avec les fiches, comme 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

locale.displayName complet au format [code de langue ISO 639]-[code de 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)

Enumération de la plate-forme qui indique la plate-forme à l'origine de l'événement (WEB, IOS ou ANDROID). Non compatible avec les applications Chat.
timeZone

object (TimeZone)

ID du fuseau horaire et décalage par rapport au temps universel coordonné (UTC) Compatible uniquement 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 fiche ou d'une boîte de dialogue. Les clés de mappage sont les ID de chaîne attribués à chaque widget, et 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 du fuseau horaire et décalage par rapport au temps universel coordonné (UTC) Compatible uniquement 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 des fuseaux horaires IANA TZ, par exemple "America/Toronto".
offset

integer

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

Entrées

Types de données que les utilisateurs peuvent saisir dans 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, comme un widget TextInput, la liste contient un objet de chaîne. Si le widget accepte plusieurs valeurs, comme un widget de cases à cocher SelectionInput, la liste contient un objet de chaîne pour chaque valeur saisie ou sélectionnée par l'utilisateur.
dateTimeInput

object (DateTimeInput)

Valeurs de saisie de date et d'heure à partir d'un widget DateTimePicker qui accepte à la fois une date et une heure.
dateInput

object (DateInput)

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

object (TimeInput)

Valeurs d'entrée temporelles provenant 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 de valeurs uniques. Pour les widgets à valeurs multiples, tels que les cases à 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)

Heure 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 code temporel.

DateInput

Valeurs d'entrée de date.

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

string (int64 format)

Heure depuis l'epoch, en millisecondes.

TimeInput

Valeurs d'entrée temporelles.

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

integer

Heure sur une horloge 24 heures.
minutes

integer

Nombre de minutes après l'heure. Les valeurs autorisées sont comprises entre 0 et 59.

AppCommandMetadata

Métadonnées associées aux commandes d'application. Les commandes d'application permettent aux utilisateurs d'appeler et d'interagir avec une application Chat. Il peut s'agir de commandes à barre oblique saisies dans la zone de rédaction ou d'éléments sélectionnés directement dans le menu d'intégration.

Représentation JSON 
{
  "appCommandId": integer,
  "appCommandType": enum (AppCommandType)
}
Champs
appCommandId

integer

ID de commande pour l'interaction d'application donnée.
appCommandType

enum (AppCommandType)

Type de la commande de l'application.