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

Si vous êtes administrateur Google Workspace, vous pouvez appeler le delete() permettant de supprimer tout espace nommé dans votre organisation Google Workspace.

La Ressource Space représente un endroit 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 de collaborer.

Prérequis

Node.js

<ph type="x-smartling-placeholder">

Supprimer un espace nommé en tant qu'utilisateur

Pour supprimer un espace existant dans Google Chat avec authentification utilisateur, transmettre les éléments suivants dans votre demande:

  • Spécifiez le champ d'application de l'autorisation chat.delete.
  • Appelez la méthode DeleteSpace().
  • Transmettez le 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. Pour obtenir cet identifiant, appelez 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 approbation de l'administrateur.

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 authentification de l'application, pass les éléments suivants dans votre demande:

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

Créer une clé API

Pour appeler une méthode d'API Preview développeur, vous devez utiliser une version Preview développeur 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 &gt; 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 peut aussi être figurant 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és 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. Incluez 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 Méthode spaces.list dans l'API Chat ou depuis 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és.

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

Si vous êtes administrateur Google Workspace, vous pouvez appeler le DeleteSpace() pour supprimer tout espace nommé dans 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 des espaces Google Chat en tant qu'administrateur Google Workspace