Gruppenbereich erstellen

In diesem Leitfaden wird erläutert, wie Sie die Methode create für die Ressource Space von die Google Chat API verwenden, um einen benannten Gruppenbereich zu erstellen.

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 (DNs) sind Unterhaltungen zwischen zwei Nutzern oder einem Nutzer und eine 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.

Ein benannter Bereich ist ein Ort, an dem Personen Nachrichten senden, Dateien teilen und zusammenzuarbeiten. Benannte Gruppenbereiche können Chat-Apps enthalten. Benannte Gruppenbereiche enthalten zusätzliche Funktionen wie unbenannte Gruppenunterhaltungen z. B. Administratoren von Gruppenbereichen, die administrative Einstellungen anwenden können, sowie Personen und Apps hinzufügen oder entfernen. Nachdem Sie einen benannten Gruppenbereich erstellt haben, ist der authentifizierte Nutzer das einzige Mitglied des Gruppenbereichs. Der Gruppenbereich andere Personen oder Apps einschließen; nicht einmal die Chat-App, der sie erstellt. Wenn Sie Personen hinzufügen möchten, erstellen Sie Mitgliedschaften im Gruppenbereich, indem Sie die create-Methode am Member-Ressource. Weitere Informationen

So erstellen Sie einen benannten Gruppenbereich mit mehreren Mitgliedern, also einen unbenannten Gruppenchat zwischen mit drei oder mehr Personen bzw. einer Unterhaltung in Direktnachrichten zwischen zwei Personen oder einer und die Chat-App, die die Chat API: Gruppenbereich einrichten .

Vorbereitung

Python

Node.js

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-Methode am Space-Ressource.
  • Legen Sie spaceType auf SPACE fest.
  • Festlegen displayName an den für Nutzer sichtbaren Namen des Gruppenbereichs an. Im folgenden Beispiel ist displayName ist auf API-made festgelegt.
  • Optional können Sie weitere Attribute für den Gruppenbereich festlegen, z. B. spaceDetails Das sind 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, um den Gruppenbereich aufzurufen um die URL des Gruppenbereichs zu erstellen. Die Ressourcen-ID finden Sie im Gruppenbereich name im Google Chat-Antworttext. Wenn beispielsweise name ist spaces/1234567. Sie können den Gruppenbereich so aufrufen: URL: https://mail.google.com/chat/u/0/#chat/space/1234567.