Lister les espaces

Ce guide explique comment utiliser la ressource list sur la ressource Space de l'API Google Chat pour répertorier les espaces. La liste des espaces renvoie une liste paginée et filtrable d'espaces.

La ressource Space représente un emplacement où les utilisateurs et les applications Chat peuvent envoyer des messages, partager des fichiers et collaborer. Il existe plusieurs types d'espaces:

  • Les messages privés (MP) sont des conversations entre deux utilisateurs (ou un utilisateur) et une application Chat.
  • Les chats de groupe sont des conversations entre trois utilisateurs ou plus et des applications Chat.
  • Les espaces nommés sont des espaces permanents où les utilisateurs envoient des messages, partagent des fichiers et collaborent.

La liste des espaces avec authentification de l'application répertorie les espaces auxquels l'application Chat a accès. La liste des espaces avec le paramètre Authentification de l'utilisateur répertorie les espaces auxquels l'utilisateur authentifié a accès.

Conditions préalables

Python

  • Python 3.6 ou version ultérieure
  • L'outil de gestion de packages pip

  • Les dernières bibliothèques clientes Google pour Python. Pour les installer ou les mettre à jour, exécutez la commande suivante dans votre interface de ligne de commande:

    pip3 install --upgrade google-api-python-client google-auth-httplib2 google-auth-oauthlib oauth2client

  • Une application Chat publiée. Pour créer et publier une application Chat, consultez la section Créer une application Google Chat.

  • Autorisation configurée pour l'application Chat. La liste des espaces est compatible avec les deux méthodes d'authentification suivantes:

Répertorier les espaces avec authentification de l'utilisateur

Pour répertorier les espaces dans Google Chat, transmettez les éléments suivants dans votre requête:

L'exemple suivant répertorie les espaces nommés et les chats de groupe (mais pas les messages privés filtrés) visibles par l'utilisateur authentifié:

Python

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

  2. Incluez le code suivant dans chat_space_list.py:

    import os.path

from google.auth.transport.requests import Request
from google.oauth2.credentials import Credentials
from google_auth_oauthlib.flow import InstalledAppFlow
from googleapiclient.discovery import build
from googleapiclient.errors import HttpError

# Define your app's authorization scopes.
# When modifying these scopes, delete the file token.json, if it exists.
SCOPES = ["https://www.googleapis.com/auth/chat.spaces.readonly"]

def main():
    '''
    Authenticates with Chat API via user credentials,
    then lists named spaces and group chats (but not direct messages)
    visible to the authenticated user.
    '''

    # Authenticate with Google Workspace
    # and get user authorization.
    flow = InstalledAppFlow.from_client_secrets_file(
                      'client_secrets.json', SCOPES)
    creds = flow.run_local_server()

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

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

          # An optional filter that returns named spaces or unnamed group chats,
          # but not direct messages (DMs).
          filter='spaceType = "SPACE" OR spaceType = "GROUP_CHAT"'

      ).execute()

    # Prints the returned list of spaces.
    print(result)

if __name__ == '__main__':
    main()

  3. Dans votre répertoire de travail, créez et exécutez l'exemple:

    python3 chat_space_list.py

L'API Chat renvoie un tableau paginé d'espaces nommés et de chats de groupe.

Répertorier les espaces avec authentification de l'application

Pour répertorier les espaces dans Google Chat, transmettez les éléments suivants dans votre requête:

L'exemple suivant répertorie les espaces nommés et les chats de groupe (mais pas les messages privés) visibles par l'application Chat:

Python

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

  2. Incluez le code suivant dans chat_space_list_app.py:

    from httplib2 import Http
from oauth2client.service_account import ServiceAccountCredentials
from apiclient.discovery import build

# Specify required scopes.
SCOPES = ['https://www.googleapis.com/auth/chat.bot']

# Specify service account details.
CREDENTIALS = ServiceAccountCredentials.from_json_keyfile_name(
    'credentials.json', SCOPES)

# Build the URI and authenticate with the service account.
chat = build('chat', 'v1', http=CREDENTIALS.authorize(Http()))

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

        # An optional filter that returns named spaces or unnamed
        # group chats, but not direct messages (DMs).
        filter='spaceType = "SPACE" OR spaceType = "GROUP_CHAT"'

    ).execute()

print(result)

  3. Dans votre répertoire de travail, créez et exécutez l'exemple:

    python3 chat_space_list_app.py

L'API Chat renvoie un tableau paginé d'espaces.

Personnaliser la pagination ou filtrer la liste

Pour répertorier des espaces dans Google Chat, transmettez les paramètres de requête facultatifs suivants afin de personnaliser la pagination ou de filtrer les espaces répertoriés:

  • pageSize: nombre maximal d'espaces à renvoyer. Le service peut renvoyer une valeur inférieure à cette valeur. Si aucune valeur n'est spécifiée, la recherche renvoie 100 espaces au maximum. La valeur maximale est 1 000. Les valeurs supérieures à 1 000 sont automatiquement remplacées par 1 000.
  • pageToken: jeton de page, reçu d'un appel précédent des espaces de liste. Fournissez ce jeton pour récupérer la page suivante. Lors de la pagination, la valeur du filtre doit correspondre à l'appel qui a fourni le jeton de page. La transmission d'une valeur différente peut entraîner des résultats inattendus.
  • filter: filtre de requête. Requiert une authentification de l'utilisateur. Pour en savoir plus sur les requêtes acceptées, consultez la méthode spaces.list.