Gruppenbereiche löschen

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

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 Ressource Space ist ein Ort, an dem Nutzer und Chat-Apps Nachrichten senden, Dateien teilen und zusammenarbeiten können. Es gibt verschiedene Arten von Gruppenbereichen:

  • Direktnachrichten (DMs) sind Unterhaltungen zwischen zwei Nutzern oder einem Nutzer und einer Chat-App.
  • Gruppenchats sind Unterhaltungen zwischen drei oder mehr Nutzern und Chat-Apps.
  • Namensgruppenbereiche sind persistente Gruppenbereiche, in denen Nutzer Nachrichten senden, Dateien teilen und zusammenarbeiten können.

Vorbereitung

Node.js

  • Einen Google Chat-Bereich Informationen zum Erstellen mit der Google Chat API finden Sie unter Gruppenbereich erstellen. Eine Anleitung zum Erstellen in Google Chat finden Sie in der Hilfe.

Als Nutzer einen benannten Gruppenbereich löschen

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

  • Geben Sie den Autorisierungsbereich für chat.delete 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);

Wenn Sie dieses Beispiel ausführen möchten, ersetzen Sie SPACE_NAME durch die ID aus dem Feld name des Gruppenbereichs. Sie können die ID durch Aufrufen der Methode ListSpaces() oder aus der URL des Gruppenbereichs abrufen.

Einen 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 Gruppenbereich in Google Chat mit App-Authentifizierung löschen möchten, geben Sie in Ihrer Anfrage Folgendes an:

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

API-Schlüssel erstellen

Wenn Sie eine API-Methode der Entwicklervorschau aufrufen möchten, müssen Sie eine nicht öffentliche Entwicklervorschauversion des API-Discovery-Dokuments verwenden. Zur Authentifizierung der Anfrage müssen Sie einen API-Schlüssel übergeben.

Öffnen Sie zum Erstellen des API-Schlüssels das Google Cloud-Projekt Ihrer App und führen Sie die folgenden Schritte aus:

  1. Gehen Sie in der Google Cloud Console zu „Menü“  > APIs und Dienste > Anmeldedaten.

    Zu den Anmeldedaten

  2. Klicken Sie auf Anmeldedaten erstellen > API-Schlüssel.
  3. Ihr neuer API-Schlüssel wird angezeigt.
    • Klicken Sie auf „Kopieren“ , um den API-Schlüssel für die Verwendung im Code Ihrer App zu kopieren. Den API-Schlüssel finden Sie auch im Bereich „API-Schlüssel“ der Anmeldedaten Ihres Projekts.
    • Klicken Sie auf Schlüssel einschränken, um die erweiterten Einstellungen zu aktualisieren und die Verwendung Ihres API-Schlüssels einzuschränken. Weitere Informationen finden Sie unter Einschränkungen für API-Schlüssel anwenden.

Script zum Aufrufen der Chat API schreiben

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 in chat_space_delete_app.py den folgenden Code 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, 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. Ersetzen Sie im Code Folgendes:

    • API_KEY: Der API-Schlüssel, den Sie zum Erstellen des Dienstendpunkts für die Chat API erstellt haben.

    • SPACE mit dem Namen des Gruppenbereichs, den Sie über die Methode spaces.list in der Chat API oder über die URL eines Gruppenbereichs abrufen können.

  4. Erstellen und führen Sie das Beispiel in Ihrem Arbeitsverzeichnis aus:

    python3 chat_space_delete_app.py

Wenn der Vorgang erfolgreich ist, ist der Antworttext leer.

Als Google Workspace-Administrator einen benannten Gruppenbereich 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 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 auf true an.

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