Eliminare uno spazio

Questa guida spiega come utilizzare il metodo delete() nella risorsa Space dell'API Google Chat per eliminare uno spazio denominato quando non è più necessario. L'eliminazione di uno spazio comporta anche l'eliminazione di tutto ciò che contiene, inclusi messaggi e allegati.

Se sei un amministratore di Google Workspace, puoi chiamare il metodo delete() per eliminare qualsiasi spazio con nome nella tua organizzazione Google Workspace.

La risorsa Space rappresenta un luogo in cui persone e app di chat possono inviare messaggi, condividere file e collaborare. Esistono diversi tipi di spazi:

  • I messaggi diretti sono conversazioni tra due utenti o tra un utente e un'app di chat.
  • Le chat di gruppo sono conversazioni tra tre o più utenti e app di chat.
  • Gli spazi denominati sono luoghi permanenti in cui le persone inviano messaggi, condividono file e collaborano.

Prerequisiti

Node.js

Eliminare uno spazio con nome come utente

Per eliminare uno spazio esistente in Google Chat con autenticazione utente, trasmetti quanto segue nella richiesta:

  • Specifica l'ambito di autorizzazione chat.delete.
  • Chiama il metodo DeleteSpace().
  • Passa l'name dello spazio da eliminare.

Ecco come eliminare uno spazio:

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);

Per eseguire questo esempio, sostituisci SPACE_NAME con l'ID del campo name dello spazio. Puoi ottenere l'ID chiamando il metodo ListSpaces() o dall'URL dello spazio.

Eliminare uno spazio denominato come app di chat

L'autenticazione dell'app richiede l'approvazione dell'amministratore una sola volta.

Con l'autenticazione delle app, puoi eliminare solo gli spazi creati dalle app di chat.

Per eliminare uno spazio esistente in Google Chat con autenticazione dell'app, passa quanto segue nella richiesta:

  • Specifica l'ambito di autorizzazione chat.app.delete.
  • Chiama il metodo delete sulla risorsa Space.
  • Passa l'name dello spazio da eliminare.

Crea una chiave API

Per chiamare un metodo API di anteprima per gli sviluppatori, devi utilizzare una versione di anteprima per gli sviluppatori non pubblica del documento di rilevamento API. Per autenticare la richiesta, devi passare una chiave API.

Per creare la chiave API, apri il progetto Google Cloud della tua app e svolgi i seguenti passaggi:

  1. Nella console Google Cloud, vai a Menu > API e servizi > Credenziali.

    Vai a credenziali

  2. Fai clic su Crea credenziali > Chiave API.
  3. Viene visualizzata la nuova chiave API.
    • Fai clic su Copia per copiare la chiave API da utilizzare nel codice dell'app. La chiave API può essere trovata anche nella sezione "Chiavi API" delle credenziali del progetto.
    • Fai clic su Limita chiave per aggiornare le impostazioni avanzate e limitare l'utilizzo della chiave API. Per maggiori dettagli, consulta Applicare le limitazioni relative alle chiavi API.

Scrivere uno script che chiama l'API Chat

Ecco come eliminare uno spazio:

Python

  1. Nella directory di lavoro, crea un file denominato chat_space_delete_app.py.

  2. Includi il seguente codice in 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. Nel codice, sostituisci quanto segue:

    • API_KEY: la chiave API che hai creato per creare l'endpoint del servizio per l'API Chat.

    • SPACE con il nome dello spazio, che puoi ottenere dal metodo spaces.list nell'API Chat o dall'URL di uno spazio.

  4. Nella directory di lavoro, compila ed esegui l'esempio:

    python3 chat_space_delete_app.py

In caso di esito positivo, il corpo della risposta è vuoto, il che indica che lo spazio è stato eliminato.

Eliminare uno spazio con nome in qualità di amministratore di Google Workspace

Se sei un amministratore di Google Workspace, puoi chiamare il metodo DeleteSpace() per eliminare qualsiasi spazio denominato nella tua organizzazione Google Workspace.

Per chiamare questo metodo in qualità di amministratore di Google Workspace, procedi nel seguente modo:

  • Chiama il metodo utilizzando l'autenticazione utente e specifica un ambito di autorizzazione che supporti la chiamata del metodo utilizzando privilegi amministrativi.
  • Nella richiesta, specifica il parametro di query useAdminAccess su true.

Per ulteriori informazioni ed esempi, vedi Gestire gli spazi di Google Chat come amministratore di Google Workspace.