Gruppenbereiche löschen

In diesem Leitfaden wird beschrieben, wie Sie die Methode delete() für die Ressource Space der Google Chat API verwenden, um einen benannten Bereich zu löschen, wenn er nicht mehr benötigt wird. Wenn Sie einen Gruppenbereich löschen, werden auch alle darin enthaltenen Elemente gelöscht, einschließlich Nachrichten und Anhänge.

Wenn Sie Google Workspace-Administrator sind, können Sie die Methode delete() aufrufen, um einen benannten Gruppenbereich in Ihrer Google Workspace-Organisation zu löschen.

Die Space-Ressource stellt einen Ort dar, an dem Personen und Chat-Apps Nachrichten senden, Dateien teilen und zusammenarbeiten können. Es gibt verschiedene Arten von Bereichen:

  • Direktnachrichten (DNs) sind Unterhaltungen zwischen zwei Nutzern oder zwischen einem Nutzer und einer Chat-App.
  • Gruppenchats sind Unterhaltungen zwischen drei oder mehr Nutzern und Chat-Apps.
  • Benannte Gruppenbereiche sind dauerhafte Orte, an denen Nutzer Nachrichten senden, Dateien teilen und zusammenarbeiten können.

Vorbereitung

Node.js

Benannte Bereiche als Nutzer löschen

Wenn Sie einen vorhandenen Gruppenbereich in Google Chat mit Nutzerauthentifizierung löschen möchten, übergeben Sie Folgendes in Ihrer Anfrage:

  • Geben Sie den chat.delete-Autorisierungsbereich an.
  • Rufen Sie die Methode DeleteSpace() auf.
  • Übergeben Sie die name des zu löschenden Gruppenbereichs.

So löschen Sie einen Gruppenbereich:

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

Ersetzen Sie SPACE_NAME durch die ID aus dem Feld name des Arbeitsbereichs, um dieses Beispiel auszuführen. Sie können die ID abrufen, indem Sie die Methode ListSpaces() aufrufen oder die URL des Bereichs verwenden.

Benannten Gruppenbereich als Chat-App löschen

Für die App-Authentifizierung ist eine einmalige Administratorgenehmigung erforderlich.

Bei der App-Authentifizierung können Sie nur Gruppenbereiche löschen, die von Chat-Apps erstellt wurden.

Wenn Sie einen vorhandenen Bereich in Google Chat mit App-Authentifizierung löschen möchten, übergeben Sie Folgendes in Ihrer Anfrage:

  • Geben Sie den chat.app.delete-Autorisierungsbereich an.
  • Rufen Sie die Methode delete für die Ressource Space auf.
  • Übergeben Sie die name des zu löschenden Gruppenbereichs.

Skript schreiben, das die Chat API aufruft

So löschen Sie einen Gruppenbereich:

Python

  1. Erstellen Sie in Ihrem Arbeitsverzeichnis eine Datei mit dem Namen chat_space_delete_app.py.
  2. Fügen Sie den folgenden Code in chat_space_delete_app.py ein:

    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)
    
        # 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. Ersetzen Sie im Code Folgendes:

    • SPACE mit dem Namen des Bereichs. Sie können ihn mit der spaces.list-Methode in der Chat API oder aus der URL eines Bereichs abrufen.
  4. Erstellen Sie das Beispiel in Ihrem Arbeitsverzeichnis und führen Sie es aus:

    python3 chat_space_delete_app.py

Wenn der Vorgang erfolgreich ist, ist der Antworttext leer. Das bedeutet, dass der Bereich gelöscht wurde.

Benannten Gruppenbereich als Google Workspace-Administrator löschen

Wenn Sie Google Workspace-Administrator sind, können Sie die Methode DeleteSpace() aufrufen, um einen benannten Gruppenbereich in Ihrer Google Workspace-Organisation zu löschen.

So rufen Sie diese Methode als Google Workspace-Administrator auf:

  • Rufen Sie die Methode mit der Nutzerauthentifizierung auf und geben Sie einen Autorisierungsbereich an, der den Aufruf der Methode mit Administratorberechtigungen unterstützt.
  • Geben Sie in Ihrer Anfrage den Abfrageparameter useAdminAccess als true an.

Weitere Informationen und Beispiele finden Sie unter Gruppenbereiche in Google Chat als Google Workspace-Administrator verwalten.