Supprimer un espace

Ce guide explique comment utiliser la méthode delete sur la ressource Space de l'API Google Chat pour supprimer un espace nommé lorsqu'il n'est plus nécessaire. La suppression d'un espace entraîne également celle de tous ses éléments, y compris les messages et les pièces jointes.

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 persistants où les utilisateurs envoient des messages, partagent des fichiers et collaborent.

Prérequis

Python

  • Python 3.6 ou version ultérieure
  • L'outil de gestion des 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-oauthlib
  • Un projet Google Cloud avec l'API Google Chat activée et configurée Pour connaître la procédure à suivre, consultez Créer une application Google Chat.

  • Autorisation configurée pour l'application Chat. La suppression d'un espace nécessite l'authentification d'un utilisateur avec le niveau d'autorisation chat.delete de la part d'un utilisateur autorisé à supprimer l'espace spécifié.

Node.js

  • Node.js et npm

  • Les dernières bibliothèques clientes Google pour Node.js. Pour les installer, exécutez la commande suivante dans votre interface de ligne de commande:

    npm install @google-cloud/local-auth @googleapis/chat
  • Un projet Google Cloud avec l'API Google Chat activée et configurée Pour connaître la procédure à suivre, consultez Créer une application Google Chat.

  • Autorisation configurée pour l'application Chat. La suppression d'un espace nécessite l'authentification d'un utilisateur avec le niveau d'autorisation chat.delete de la part d'un utilisateur autorisé à supprimer l'espace spécifié.

Supprimer un espace nommé

Pour supprimer un espace existant dans Google Chat, transmettez les éléments suivants dans votre requête:

  • Spécifiez le champ d'application des autorisations chat.delete.
  • Appelez la méthode delete sur la ressource Space.
  • Transmettez le name de l'espace à supprimer.

Pour supprimer un espace, procédez comme suit:

Python

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

  2. Incluez le code suivant dans chat_space_delete.py:

    from google_auth_oauthlib.flow import InstalledAppFlow
from googleapiclient.discovery import build

# 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.delete"]

def main():
    '''
    Authenticates with Chat API via user credentials,
    then deletes the specified 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().delete(

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

      ).execute()

    # Print Chat API's response in your command line interface.
    # When deleting a space, the response body is empty.
    print(result)

if __name__ == '__main__':
    main()

  3. Dans le code, remplacez SPACE par le nom de l'espace, que vous pouvez obtenir à partir de la méthode spaces.list dans l'API Chat ou de l'URL d'un espace.

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

    python3 chat_space_delete.py

Node.js

  1. Dans votre répertoire de travail, créez un fichier nommé delete-space.js.

  2. Incluez le code suivant dans delete-space.js:

    const chat = require('@googleapis/chat');
const {authenticate} = require('@google-cloud/local-auth');

/**
* Deletes a Chat space.
* @return {!Promise<!Object>}
*/
async function deleteSpace() {
  const scopes = [
    'https://www.googleapis.com/auth/chat.delete',
  ];

  const authClient =
      await authenticate({scopes, keyfilePath: 'client_secrets.json'});

  const chatClient = await chat.chat({version: 'v1', auth: authClient});

  return await chatClient.spaces.delete({name: 'spaces/SPACE'});
}

deleteSpace().then(console.log);

  3. Dans le code, remplacez SPACE par le nom d'un espace, que vous pouvez obtenir à partir de la méthode spaces.list de l'API Chat ou de l'URL d'un espace.

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

    node delete-space.js

    Si la requête aboutit, le corps de la réponse est vide, ce qui indique que l'espace est supprimé.