Créer un espace

Ce guide explique comment utiliser la méthode create sur la ressource Space de l'API Google Chat pour créer un espace nommé.

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.

Un espace nommé est un endroit où les utilisateurs envoient des messages, partagent des fichiers et collaborent. Les espaces nommés peuvent inclure des applications Chat. Les espaces nommés incluent des fonctionnalités supplémentaires auxquelles les conversations de groupe et les messages privés sans nom ne disposent pas. Par exemple, les gestionnaires d'espaces peuvent appliquer des paramètres d'administration et des descriptions, et ajouter ou supprimer des personnes et des applications. Après avoir créé un espace nommé, le seul membre de cet espace est l'utilisateur authentifié. L'espace n'inclut pas d'autres personnes ni applications, pas même l'application Chat qui le crée. Pour ajouter des membres, créez des abonnements dans l'espace en appelant la méthode create sur la ressource Member. Pour savoir comment procéder, consultez Créer un abonnement.

Pour créer un espace nommé comportant plusieurs membres (un chat de groupe sans nom entre trois personnes ou plus, une conversation par message privé entre deux personnes, ou une personne et l'application Chat appelant l'API Chat), configurez un espace.

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 création d'un espace nécessite une authentification de l'utilisateur avec le champ d'application d'autorisation chat.spaces.create ou chat.spaces.

Créer un espace nommé

Pour créer un espace nommé, transmettez les éléments suivants dans votre requête:

  • Spécifiez le champ d'application des autorisations chat.spaces.create ou chat.spaces.
  • Appelez la méthode create sur la ressource Space.
  • Définissez spaceType sur SPACE.
  • Définissez displayName sur le nom de l'espace visible par l'utilisateur. Dans l'exemple suivant, displayName est défini sur API-made.
  • Vous pouvez également définir d'autres attributs d'espace, tels que spaceDetails (une description visible par l'utilisateur et un ensemble de consignes pour l'espace).

Pour créer un espace nommé:

Python

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

  2. Incluez le code suivant dans chat_space_create_named.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.create"]

def main():
    '''
    Authenticates with Chat API via user credentials,
    then creates a Chat space.
    '''

    # 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().create(

      # Details about the space to create.
      body = {

        # To create a named space, set spaceType to SPACE.
        'spaceType': 'SPACE',

        # The user-visible name of the space.
        'displayName': 'API-made'
      }

      ).execute()

    # Prints details about the created membership.
    print(result)

if __name__ == '__main__':
    main()

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

    python3 chat_space_create_named.py

Un espace nommé est créé. Pour accéder à l'espace, utilisez son ID de ressource afin de créer son URL. Vous trouverez l'ID de ressource de l'espace name dans le corps de la réponse Google Chat. Par exemple, si l'élément name de votre espace est spaces/1234567, vous pouvez y accéder à l'aide de l'URL suivante: https://mail.google.com/chat/u/0/#chat/space/1234567.