Répertorier les événements d'un espace Google Chat

Ce guide explique comment utiliser la list() méthode sur la ressource SpaceEvent de l'API Google Chat pour lister les modifications apportées aux ressources d'un espace.

La ressource SpaceEvent représente une modification apportée à l'espace cible, y compris les ressources enfants de l'espace telles que les messages, les réactions et les appartenances. Pour en savoir plus sur la liste des types d'événements et des charges utiles d'événements compatibles, consultez les eventType et payload champs de la documentation de référence sur la ressource SpaceEvent.

Vous pouvez lister les événements jusqu'à 28 jours avant l'heure de la requête. Le serveur renvoie les événements qui contiennent la version la plus récente de la ressource concernée. Par exemple, si vous listez les événements concernant les nouveaux membres d'un espace, le serveur renvoie des ressources Membership contenant les dernières informations sur l'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.

Pour lister les événements d'un espace, l'utilisateur authentifié ou l'application Chat doit être membre de l'espace.

Prérequis

Node.js

Python

Lister les événements d'espace (authentification de l'utilisateur)

Pour lister les événements d'espace à partir d'un espace Chat, transmettez les éléments suivants dans votre requête :

  • Spécifiez une ou plusieurs autorisations pour prendre en charge chaque type d'événement dans votre requête. Nous vous recommandons de choisir l'autorisation la plus restrictive qui permet à votre application de fonctionner. Pour choisir une autorisation, consultez la présentation de l'authentification et de l'autorisation.

  • Appelez la ListSpaceEvents() méthode, en transmettant le filter des types d'événements à lister. Vous devez spécifier au moins un type d'événement. Vous pouvez également filtrer par date. Pour obtenir la liste des types d'événements compatibles, consultez le eventType champ de la SpaceEvent ressource documentation de référence.

L'exemple suivant liste les événements concernant les nouvelles appartenances et les nouveaux messages dans un espace :

Node.js

chat/client-libraries/cloud/list-space-events-user-cred.js
import {createClientWithUserCredentials} from './authentication-utils.js';

// Authorization scopes based on the event types
const USER_AUTH_OAUTH_SCOPES = [
  'https://www.googleapis.com/auth/chat.memberships.readonly',
  'https://www.googleapis.com/auth/chat.messages.readonly',
];

// This sample shows how to list space events with user credential
async function main() {
  // Create a client
  const chatClient = await createClientWithUserCredentials(
    USER_AUTH_OAUTH_SCOPES,
  );

  // Initialize request argument(s)
  const request = {
    // Replace SPACE_NAME here
    parent: 'spaces/SPACE_NAME',
    // A required filter. Filters events about new memberships and messages.
    filter:
      'eventTypes:"google.workspace.chat.membership.v1.created" OR eventTypes:"google.workspace.chat.message.v1.created"',
  };

  // Make the request
  const pageResult = chatClient.listSpaceEventsAsync(request);

  // Handle the response. Iterating over pageResult will yield results and
  // resolve additional pages automatically.
  for await (const response of pageResult) {
    console.log(response);
  }
}

await main();

Pour exécuter cet exemple, remplacez SPACE_NAME par l'ID de l'espace's name. Vous pouvez obtenir l'ID en appelant la ListSpaces() méthode ou à partir de l'URL de l'espace.

L'API Chat renvoie une liste de liste paginée d'événements d'espace concernant les nouvelles appartenances et les nouveaux messages.

Lister les événements d'espace (authentification de l'application Chat)

L'authentification de l'application nécessite une approbation unique de l'administrateur.

Pour lister les événements d'espace à partir d'un espace avec l'authentification de l'application et l' API REST Chat, transmettez les éléments suivants dans votre requête :

  • Spécifiez une ou plusieurs autorisations pour prendre en charge chaque type d'événement dans votre requête. Nous vous recommandons de choisir l'autorisation la plus restrictive qui permet à votre application de fonctionner. Pour en savoir plus sur le choix d'une autorisation, consultez la présentation de l'authentification et de l'autorisation.
    • 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
  • Appelez la list méthode sur la spaceEvents ressource.
  • Transmettez le name de l'espace à partir duquel lister les messages.
  • Transmettez un filter pour interroger des types d'événements spécifiques.

Écrire un script qui appelle l'API Chat

Voici comment lister les événements d'espace avec l'authentification de l'application et l' API REST Chat :

Python

  1. Dans votre répertoire de travail, créez un fichier nommé chat_spaceevents_list_app.py.

  2. Incluez le code suivant dans chat_spaceevents_list_app.py :

    from google.oauth2 import service_account
from apiclient.discovery import build

# Define your app's authorization scopes.
# Set authorization scopes based on the
# event type. For example, if you are getting a space event
# about a new membership, use the `chat.app.memberships` scope.
#
# When modifying these scopes, delete the file token.json, if it exists.
SCOPES = ["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"]

def main():
    '''
    Authenticates with Chat API using app authentication,
    then lists space events from a specified space.
    '''

    # Specify service account details.
    creds = (
        service_account.Credentials.from_service_account_file('credentials.json')
        .with_scopes(SCOPES)
    )

    # Build a service endpoint for Chat API.
    chat = build('chat', 'v1', credentials=creds)

    # Use the service endpoint to call Chat API.
    result = chat.spaces().spaceEvents().list(

        # The space to list events from.
        #
        # Replace SPACE_NAME with a space name.
        # Obtain the space name from the spaces resource of Chat API,
        # or from a space's URL.
        parent='spaces/SPACE_NAME',

        # A required filter. Filters events by event type.
        #
        # Update this filter to match your requirements.
        filter='eventTypes:"google.workspace.chat.message.v1.created"'

    ).execute()

    # Print Chat API's response in your command line interface.
    print(result)

if __name__ == '__main__':
    main()

  3. Dans le code, remplacez les éléments suivants :

    • SPACE_NAME : nom d'espace que vous pouvez obtenir à partir de la méthode spaces.list de l'API Chat ou à partir de l'URL d'un espace.

  4. Dans votre répertoire de travail, compilez et exécutez l'exemple :

    python3 chat_spaceevents_list_app.py

L'API Chat renvoie une liste de liste paginée d'événements d'espace concernant les nouvelles appartenances et les nouveaux messages.