Method: spaces.spaceEvents.list

Répertorie les événements d'un espace Google Chat. Pour chaque événement, la charge utile contient la version la plus récente de la ressource Chat. Par exemple, si vous répertoriez les événements concernant les nouveaux membres d'un espace, le serveur renvoie des ressources Membership contenant les dernières informations sur l'adhésion. 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.

Prend en charge les types d'authentification suivants avec un niveau d'accès des autorisations approprié pour lire les données demandées :

  • Authentification de l'application avec approbation de l'administrateur avec l'un des niveaux d'accès des autorisations suivants :

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

  • Authentification de l'utilisateur avec l'un des niveaux d'accès des autorisations suivants :

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

Pour répertorier les événements, l'appelant 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 la 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.

Les valeurs négatives renvoient une erreur INVALID_ARGUMENT.
pageToken

string

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

Lors de la pagination, tous les autres paramètres fournis à la liste des événements d'espace doivent correspondre à l'appel ayant 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. Filtre de requête.

Vous devez spécifier au moins un type d'événement (eventType) à l'aide de l'opérateur has :. Pour filtrer les données par plusieurs types d'événements, utilisez l'opérateur OR. Omettez les types d'événements par lot dans votre filtre. La requête renvoie automatiquement tous les événements par lot associés. Par exemple, si vous filtrez les données par nouvelles réactions (google.workspace.chat.reaction.v1.created), le serveur renvoie également les événements par lot de nouvelles réactions (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 les données par heure de début (startTime) et heure de fin (endTime) :

  • startTime : horodatage exclusif à partir duquel commencer à répertorier les événements d'espace. Vous pouvez répertorier les événements qui se sont produits il y a jusqu'à 28 jours. Si aucune valeur n'est spécifiée, les événements d'espace des 28 derniers jours sont répertoriés.
  • endTime : horodatage inclusif jusqu'auquel les événements d'espace sont répertoriés. Si aucune valeur n'est spécifiée, les événements sont répertoriés jusqu'à l'heure de la requête.

Pour spécifier une heure de début ou de fin, utilisez l'opérateur equals = et le format RFC-3339. Pour filtrer les données à 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 d'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 par ordre chronologique (l'événement le plus ancien en premier). Remarque : Le champ permissionSettings n'est pas renvoyé dans l'objet Space pour les requêtes de liste.
nextPageToken

string

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

Niveaux d'accès des autorisations

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

  • https://www.googleapis.com/auth/chat.app.memberships
  • https://www.googleapis.com/auth/chat.app.memberships.readonly
  • https://www.googleapis.com/auth/chat.app.messages.readonly
  • https://www.googleapis.com/auth/chat.app.spaces
  • https://www.googleapis.com/auth/chat.app.spaces.readonly
  • 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 sur l'autorisation.