Method: spaces.spaceEvents.list

Répertorie les événements d'un espace Google Chat. Pour chaque événement, la payload contient la version la plus récente de la ressource Chat. Par exemple, si vous répertoriez des événements concernant les nouveaux membres d'un espace, le serveur renvoie les ressources Membership contenant les derniers détails d'appartenance. Si de nouveaux membres ont été supprimés au cours de la période demandée, la charge utile de l'événement contient une ressource Membership vide.

Nécessite une authentification utilisateur. Pour répertorier les événements, l'utilisateur authentifié doit être membre de l'espace.

Pour obtenir un exemple, consultez Répertorier les événements d'un espace Google Chat.

Requête HTTP

GET https://chat.googleapis.com/v1/{parent=spaces/*}/spaceEvents

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
parent

string

Obligatoire. Nom de ressource de l'espace Google Chat dans lequel les événements se sont produits.

Format : spaces/{space}.

Paramètres de requête

Paramètres
pageSize

integer

Facultatif. Nombre maximal d'événements d'espace renvoyés. Le service peut renvoyer une valeur inférieure à cette valeur.

Les valeurs négatives renvoient une erreur INVALID_ARGUMENT.
pageToken

string

Jeton de page, reçu lors d'un précédent appel d'événements d'espace de liste. Fournissez-le pour récupérer la page suivante.

Lors de la pagination, tous les autres paramètres fournis pour répertorier les événements d'espace doivent correspondre à l'appel qui a fourni le jeton de page. La transmission de valeurs différentes aux autres paramètres peut entraîner des résultats inattendus.
filter

string

Obligatoire. Un filtre de requête.

Vous devez spécifier au moins un type d'événement (eventType) à l'aide de l'opérateur :. Pour filtrer selon plusieurs types d'événements, utilisez l'opérateur OR. Omettez les types d'événements de lots dans votre filtre. La requête renvoie automatiquement tous les événements de lot associés. Par exemple, si vous filtrez par nouvelles réactions (google.workspace.chat.reaction.v1.created), le serveur renvoie également les nouveaux événements de réaction par lot (google.workspace.chat.reaction.v1.batchCreated). Pour obtenir la liste des types d'événements compatibles, consultez la documentation de référence SpaceEvents.

Vous pouvez également filtrer par heure de début (startTime) et heure de fin (endTime):

  • startTime: code temporel exclusif à partir duquel commencer à lister les événements de l'espace. Vous pouvez répertorier les événements datant de 28 jours maximum. Si aucune valeur n'est spécifiée, répertorie les événements d'espace des 28 derniers jours.
  • endTime: code temporel inclusif jusqu'à ce que les événements d'espace soient répertoriés. Si aucune valeur n'est spécifiée, répertorie les événements jusqu'au moment de la requête.

Pour spécifier une heure de début ou de fin, utilisez l'opérateur "est égal(e) à =" et respectez le format indiqué dans le document RFC-3339. Pour filtrer à la fois par startTime et endTime, utilisez l'opérateur AND.

Par exemple, les requêtes suivantes sont valides:

startTime="2023-08-23T19:20:33+00:00" AND
endTime="2023-08-23T19:21:54+00:00"

startTime="2023-08-23T19:20:33+00:00" AND
(eventTypes:"google.workspace.chat.space.v1.updated" OR
eventTypes:"google.workspace.chat.message.v1.created")

Les requêtes suivantes ne sont pas valides:

startTime="2023-08-23T19:20:33+00:00" OR
endTime="2023-08-23T19:21:54+00:00"

eventTypes:"google.workspace.chat.space.v1.updated" AND
eventTypes:"google.workspace.chat.message.v1.created"

Les requêtes non valides sont rejetées par le serveur avec une erreur INVALID_ARGUMENT.

Corps de la requête

Le corps de la requête doit être vide.

Corps de la réponse

Message de réponse pour la liste des événements de l'espace.

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

Représentation JSON 
{
  "spaceEvents": [
    {
      object (SpaceEvent)
    }
  ],
  "nextPageToken": string
}
Champs
spaceEvents[]

object (SpaceEvent)

Les résultats sont renvoyés dans l'ordre chronologique (l'événement le plus ancien en premier).
nextPageToken

string

Jeton de continuité utilisé pour récupérer d'autres événements. Si ce champ est omis, il n'y a pas d'autres pages.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.readonly
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.readonly
  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages.reactions.readonly

Pour en savoir plus, consultez le guide relatif aux autorisations.