Gruppenbereich erstellen

In dieser Anleitung wird erläutert, wie Sie mit der Methode create für die Ressource Space der Google Chat API einen benannten Bereich erstellen.

Die Ressource Space stellt einen Ort dar, an dem Nutzer und Chat-Apps Nachrichten senden, Dateien freigeben 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.
  • Benannte Gruppenbereiche sind persistente Orte, an denen Nutzer Nachrichten senden, Dateien freigeben und zusammenarbeiten.

Ein benannter Gruppenbereich ist ein Ort, an dem Personen Nachrichten senden, Dateien teilen und zusammenarbeiten. Benannte Gruppenbereiche können Chat-Apps enthalten. Benannte Gruppenbereiche enthalten zusätzliche Funktionen, die es bei unbenannten Gruppenunterhaltungen und Direktnachrichten nicht gibt, z. B. Administratoren von Gruppenbereichen, die administrative Einstellungen und Beschreibungen anwenden sowie Personen und Apps hinzufügen oder entfernen können. Nach dem Erstellen eines benannten Gruppenbereichs ist das einzige Mitglied des Gruppenbereichs der authentifizierte Nutzer. Der Gruppenbereich enthält keine anderen Personen oder Apps, auch nicht die Chat-App, von der er erstellt wird. Wenn Sie Personen hinzufügen möchten, erstellen Sie Mitgliedschaften im Gruppenbereich. Rufen Sie dazu die Methode create für die Ressource Member auf. Wie das geht, erfährst du unter „Mitgliedschaft erstellen“.

Wenn Sie einen benannten Gruppenbereich mit mehreren Mitgliedern erstellen möchten – einen unbenannten Gruppenchat mit drei oder mehr Personen, eine Direktnachrichtenunterhaltung zwischen zwei Personen oder eine Person und die Chat-App, die die Chat API aufruft, – richten Sie stattdessen einen Gruppenbereich ein.

Voraussetzungen

Python

  • Python 3.6 oder höher
  • Das Paketverwaltungstool pip

  • Die aktuellen Google-Clientbibliotheken für Python. Führen Sie den folgenden Befehl in der Befehlszeile aus, um sie zu installieren oder zu aktualisieren:

    pip3 install --upgrade google-api-python-client google-auth-oauthlib
  • Ein Google Cloud-Projekt, in dem die Google Chat API aktiviert und konfiguriert ist. Eine entsprechende Anleitung finden Sie unter Google Chat-App erstellen.

  • Für die Chat-Anwendung konfigurierte Autorisierung. Zum Erstellen eines Gruppenbereichs ist eine Nutzerauthentifizierung mit dem Autorisierungsbereich chat.spaces.create oder chat.spaces erforderlich.

Node.js

  • Node.js und npm

  • Aktuelle Google-Clientbibliotheken für Node.js Führen Sie den folgenden Befehl über die Befehlszeile aus, um sie zu installieren:

    npm install @google-cloud/local-auth @googleapis/chat
  • Ein Google Cloud-Projekt, in dem die Google Chat API aktiviert und konfiguriert ist. Eine entsprechende Anleitung finden Sie unter Google Chat-App erstellen.

  • Für die Chat-Anwendung konfigurierte Autorisierung. Zum Erstellen eines Gruppenbereichs ist eine Nutzerauthentifizierung mit dem Autorisierungsbereich chat.spaces.create oder chat.spaces erforderlich.

Benannten Gruppenbereich erstellen

Übergeben Sie in Ihrer Anfrage Folgendes, um einen benannten Gruppenbereich zu erstellen:

  • Geben Sie den Autorisierungsbereich chat.spaces.create oder chat.spaces an.
  • Rufen Sie die Methode create für die Ressource Space auf.
  • Legen Sie spaceType auf SPACE fest.
  • Legen Sie für displayName den für den Nutzer sichtbaren Namen des Gruppenbereichs fest. Im folgenden Beispiel ist displayName auf API-made festgelegt.
  • Optional können Sie weitere Attribute für den Gruppenbereich festlegen, z. B. spaceDetails (eine für den Nutzer sichtbare Beschreibung und Richtlinien für den Gruppenbereich).

So erstellen Sie einen benannten Gruppenbereich:

Python

  1. Erstellen Sie in Ihrem Arbeitsverzeichnis eine Datei mit dem Namen chat_space_create_named.py.

  2. Fügen Sie den folgenden Code in chat_space_create_named.py ein:

    from google_auth_oauthlib.flow import InstalledAppFlow
from googleapiclient.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.spaces.create"]

def main():
    '''
    Authenticates with Chat API via user credentials,
    then creates a Chat space.
    '''

    # Authenticate with Google Workspace
    # and get user authorization.
    flow = InstalledAppFlow.from_client_secrets_file(
                      'client_secrets.json', SCOPES)
    creds = flow.run_local_server()

    # Build a service endpoint for Chat API.
    chat = build('chat', 'v1', credentials=creds)

    # Use the service endpoint to call Chat API.
    result = chat.spaces().create(

      # Details about the space to create.
      body = {

        # To create a named space, set spaceType to SPACE.
        'spaceType': 'SPACE',

        # The user-visible name of the space.
        'displayName': 'API-made'
      }

      ).execute()

    # Prints details about the created membership.
    print(result)

if __name__ == '__main__':
    main()

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

    python3 chat_space_create_named.py

Node.js

  1. Erstellen Sie in Ihrem Arbeitsverzeichnis eine Datei mit dem Namen create-space.js.

  2. Fügen Sie den folgenden Code in create-space.js ein:

    const chat = require('@googleapis/chat');
const {authenticate} = require('@google-cloud/local-auth');

/**
* Creates a new chat space.
* @return {!Promise<!Object>}
*/
async function createSpace() {
  const scopes = [
    'https://www.googleapis.com/auth/chat.spaces.create',
  ];

  const authClient =
      await authenticate({scopes, keyfilePath: 'client_secrets.json'});

  const chatClient = await chat.chat({version: 'v1', auth: authClient});

  return await chatClient.spaces.create(
      {requestBody: {spaceType: 'SPACE', displayName: 'API-made'}});
}

createSpace().then(console.log);

  3. Führen Sie das Beispiel in Ihrem Arbeitsverzeichnis aus:

    node create-space.js

Ein benannter Gruppenbereich wird erstellt. Verwenden Sie die Ressourcen-ID des Gruppenbereichs, um die URL des Gruppenbereichs zu erstellen. Sie finden die Ressourcen-ID aus dem Gruppenbereich name im Antworttext von Google Chat. Wenn die name Ihres Gruppenbereichs beispielsweise spaces/1234567 lautet, können Sie den Gruppenbereich über die folgende URL aufrufen: https://mail.google.com/chat/u/0/#chat/space/1234567.