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 la suppression de tout ce qu'il contient, y compris les messages et les pièces jointes.

Si vous êtes administrateur Google Workspace, vous pouvez appeler la méthode delete() pour supprimer n'importe quel espace nommé de votre organisation Google Workspace.

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 au moins trois utilisateurs et des applications Chat.
  • Les espaces nommés sont des espaces persistants où les utilisateurs peuvent envoyer des messages, partager des fichiers et collaborer.

Prérequis

Node.js

Supprimer un espace nommé en tant qu'utilisateur

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

  • Spécifiez le champ d'application de l'autorisation chat.delete.
  • Appelez la méthode DeleteSpace().
  • Transmettez l'name de l'espace à supprimer.

Pour supprimer un espace:

Node.js

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

const USER_AUTH_OAUTH_SCOPES = ['https://www.googleapis.com/auth/chat.delete'];

// This sample shows how to delete a space 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
    name: 'spaces/SPACE_NAME'
  };

  // Make the request
  const response = await chatClient.deleteSpace(request);

  // Handle the response
  console.log(response);
}

main().catch(console.error);

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

Supprimer un espace nommé en tant qu'application Chat

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

Avec l'authentification par application, vous ne pouvez supprimer que les espaces créés par les applications Chat.

Pour supprimer un espace existant dans Google Chat avec l'authentification des applications, transmettez la commande suivante dans votre requête:

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

Créer une clé API

Pour appeler une méthode d'API en version Preview développeur, vous devez utiliser une version non publique de la version Preview développeur 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. La clé API se trouve également dans la section "Clés API" des identifiants de votre projet.
    • Cliquez sur Restreindre la clé pour mettre à jour les paramètres avancés et limiter l'utilisation de votre clé API. Pour en savoir plus, consultez Appliquer des restrictions de clé API.

Écrire un script qui appelle l'API Chat

Pour supprimer un espace:

Python

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

  2. Ajoutez le code suivant dans chat_space_delete_app.py:

    from google.oauth2 import service_account
from apiclient.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.app.delete"]

def main():
    '''
    Authenticates with Chat API using app authentication,
    then deletes the 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().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 les éléments suivants:

    • API_KEY: clé API que vous avez créée pour créer le point de terminaison de service de l'API Chat.

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

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

    python3 chat_space_delete_app.py

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

Supprimer un espace nommé en tant qu'administrateur Google Workspace

Si vous êtes administrateur Google Workspace, vous pouvez appeler la méthode DeleteSpace() pour supprimer n'importe quel espace nommé de votre organisation Google Workspace.

Pour appeler cette méthode en tant qu'administrateur Google Workspace, procédez comme suit:

Pour en savoir plus et obtenir des exemples, consultez Gérer les espaces Google Chat en tant qu'administrateur Google Workspace.