Gruppenbereich erstellen

In diesem Leitfaden 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 Personen und Chat-Apps Nachrichten senden, Dateien freigeben und zusammenarbeiten können. Es gibt verschiedene Arten von Gruppenbereichen:

  • Direktnachrichten (DNs) 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 freigeben und mit anderen zusammenarbeiten.

Ein benannter Bereich ist ein Ort, an dem Personen Nachrichten senden, Dateien freigeben und zusammenarbeiten. Benannte Gruppenbereiche können Chat-Apps enthalten. Benannte Gruppenbereiche enthalten zusätzliche Funktionen, die unbenannte Gruppenunterhaltungen und Direktnachrichten nicht haben, z. B. Administratoren des Gruppenbereichs, die administrative Einstellungen und Beschreibungen anwenden sowie Personen und Apps hinzufügen oder entfernen können. Nach dem Erstellen eines benannten Bereichs ist das einzige Mitglied des Bereichs der authentifizierte Nutzer. Der Bereich umfasst keine anderen Personen oder Apps, nicht einmal die Chat-App, von der er erstellt wurde. Wenn Sie Personen hinzufügen möchten, erstellen Sie Mitgliedschaften im Gruppenbereich. Rufen Sie dazu die Methode create für die Ressource Member auf. Weitere Informationen

Wenn Sie einen benannten Gruppenbereich mit mehreren Mitgliedern erstellen möchten, z. B. einen unbenannten Gruppenchat mit drei oder mehr Personen, eine Unterhaltung in Direktnachrichten 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 neuesten 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 mit aktivierter und konfigurierter Google Chat API. Eine Anleitung dazu finden Sie unter Google Chat-App erstellen.

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

Node.js

  • Node.js und npm

  • Die neuesten Google-Clientbibliotheken für Node.js. Führen Sie den folgenden Befehl in der Befehlszeile aus, um sie zu installieren:

    npm install @google-cloud/local-auth @googleapis/chat
  • Ein Google Cloud-Projekt mit aktivierter und konfigurierter Google Chat API. Eine Anleitung dazu finden Sie unter Google Chat-App erstellen.

  • Für die Chat-App konfigurierte Autorisierung. Zum Erstellen eines Bereichs 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 displayName auf den für den Nutzer sichtbaren Namen des Gruppenbereichs fest. Im folgenden Beispiel ist displayName auf API-made gesetzt.
  • Optional können Sie weitere Attribute für den Gruppenbereich festlegen, z. B. spaceDetails (eine für 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 space.
    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 Bereich name im Google Chat-Antworttext. Wenn die name Ihres Gruppenbereichs beispielsweise spaces/1234567 ist, können Sie den Gruppenbereich über die folgende URL aufrufen: https://mail.google.com/chat/u/0/#chat/space/1234567.