Gruppenbereiche löschen

In diesem Leitfaden wird erläutert, 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. Beim Löschen eines Gruppenbereichs werden auch alle zugehörigen Inhalte gelöscht enthält, einschließlich Nachrichten und Anhängen.

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

Die Space-Ressource ist ein Ort, an dem Personen und Chat-Apps Nachrichten senden können, Dateien freigeben und gemeinsam bearbeiten. Es gibt verschiedene Arten von Gruppenbereichen:

  • Direktnachrichten sind Unterhaltungen zwischen zwei Nutzern oder 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 zusammenzuarbeiten.

Vorbereitung

Node.js

Als Nutzer einen benannten Gruppenbereich löschen

So löschen Sie einen vorhandenen Gruppenbereich in Google Chat mit Nutzerauthentifizierung, übergeben Folgendes in Ihrer Anfrage angeben:

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

Ersetzen Sie zum Ausführen dieses Beispiels SPACE_NAME durch die ID von des Gruppenbereichs name ein. Sie können die ID durch Aufrufen der Methode ListSpaces() oder aus der URL des Gruppenbereichs abrufen.

Benannte Gruppenbereiche als Chat-App löschen

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

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

So löschen Sie einen vorhandenen Gruppenbereich in Google Chat mit app authentication, pass (App-Authentifizierung), Pass Folgendes in Ihrer Anfrage angeben:

  • Geben Sie den Autorisierungsbereich chat.app.delete an.
  • Rufen Sie die Methode delete-Methode für die Ressource Space
  • Ü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. Zum Authentifizieren der Anfrage müssen Sie einen API-Schlüssel übergeben.

Öffnen Sie zum Erstellen des API-Schlüssels das Google Cloud-Projekt Ihrer Anwendung und gehen Sie so vor:

  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 Ihren API-Schlüssel zur 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.

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 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 durch den Namen des Gruppenbereichs, Diese finden Sie im Methode spaces.list in der Chat API oder über die URL eines Gruppenbereichs.

  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.

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 mithilfe der Nutzerauthentifizierung auf und geben Sie einen Autorisierungsbereich das das Aufrufen der Methode mit Administratorberechtigungen.
  • Geben Sie in der Anfrage den Abfrageparameter useAdminAccess in true an.

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