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

Ce guide explique comment utiliser la méthode list() 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 aux ressources enfants de l'espace, telles que les messages, les réactions et les membres. Pour en savoir plus sur la liste des types d'événements et des charges utiles d'événements compatibles, consultez les champs eventType et payload de la documentation de référence sur les ressources SpaceEvent.

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

Prérequis

Node.js

Python

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

Pour lister les événements d'un espace Chat, transmettez les informations suivantes dans votre requête :

L'exemple suivant liste les événements concernant les nouveaux membres et les 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'name de l'espace. Vous pouvez obtenir l'ID en appelant la méthode ListSpaces() ou à partir de l'URL de l'espace.

L'API Chat renvoie une liste paginée des événements d'un espace concernant les nouveaux membres et les nouveaux messages.

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

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

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

  • Spécifiez un ou plusieurs champs d'application d'autorisation pour prendre en charge chaque type d'événement dans votre requête. Il est recommandé de choisir le champ d'application le plus restrictif qui permet à votre application de fonctionner. Pour en savoir plus sur le choix d'un champ d'application, 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.messages.readonly
    • https://www.googleapis.com/auth/chat.app.spaces
  • Appelez la méthode list sur la ressource spaceEvents.
  • Transmettez l'name de l'espace à partir duquel lister les messages.
  • Transmettez un filter pour interroger des types d'événements spécifiques.

Créer une clé API

Pour appeler une méthode de l'API Developer Preview, vous devez utiliser une version Developer Preview non publique du document de découverte de l'API. Pour authentifier la requête, vous devez transmettre une clé API.

Pour créer la clé API, ouvrez le projet Google Cloud de votre application et procédez comme suit :

  1. Dans la console Google Cloud, accédez à Menu  > API et services > Identifiants.

    Accéder à "Identifiants"

  2. Cliquez sur Créer des identifiants > Clé API.
  3. Votre nouvelle clé API s'affiche.
    • Cliquez sur Copier  pour copier votre clé API et l'utiliser dans le code de votre application. Vous trouverez également la clé API dans la section "Clés API" des identifiants de votre projet.
    • Pour éviter toute utilisation abusive, nous recommandons d'ajouter des restrictions pour limiter les emplacements et les API pour lesquels la clé API peut être utilisée. Pour en savoir plus, consultez Ajouter des restrictions d'API.

Écrire un script qui appelle l'API Chat

Voici comment lister les événements d'un espace avec l'authentification d'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.readonly` 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.messages.readonly",
          "https://www.googleapis.com/auth/chat.app.spaces"]

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, discoveryServiceUrl='https://chat.googleapis.com/$discovery/rest?version=v1&labels=DEVELOPER_PREVIEW&key=API_KEY')

    # 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 :

    • API_KEY : clé API que vous avez créée pour générer le point de terminaison de service pour l'API Chat.
    • SPACE_NAME : nom d'un 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 paginée des événements d'un espace concernant les nouveaux membres et les nouveaux messages.