In diesem Leitfaden wird die Verwendung des
setUp()
für die Ressource Space
der Google Chat API, um ein Google Chat-Konto einzurichten
Leerzeichen. Wenn Sie einen Gruppenbereich einrichten, wird ein Gruppenbereich erstellt und bestimmte Nutzer werden diesem hinzugefügt.
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 (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.
Beachten Sie beim Einrichten eines Gruppenbereichs Folgendes:
- Der anrufende (authentifizierte) Nutzer wird dem Gruppenbereich automatisch hinzugefügt. Sie müssen also die Mitgliedschaft des Nutzers in der Anfrage nicht angeben.
- Wenn beim Erstellen einer Direktnachricht (DN) eine DN zwischen zwei Nutzern vorhanden ist, wird die DM zurückgegeben. Andernfalls wird eine Direktnachricht erstellt.
- Wenn beim Erstellen eines Gruppenchats keine der in der Anfrage angegebenen Mitgliedschaften angegeben wird zum Gruppenchat hinzugefügt werden (z. B. Berechtigungsproblem), dann wird möglicherweise ein leerer Gruppenchat erstellt (einschließlich nur des anrufenden Nutzers).
- Sie können keine Gruppenbereiche mit Antworten in Form von Threads einrichten und keine Personen außerhalb Ihrer Google Workspace-Organisation hinzufügen.
- Doppelte Mitgliedschaften (einschließlich des anrufenden Nutzers), die in der Anfrage angegeben sind, werden herausgefiltert, anstatt zu einem Fehler zu führen.
Vorbereitung
Node.js
- Ein Google Workspace-Konto für Unternehmen oder Organisationen mit Zugriff auf Google Chat.
- Richten Sie Ihre Umgebung ein:
- Google Cloud-Projekt erstellen
- Konfigurieren Sie den OAuth-Zustimmungsbildschirm.
- Aktivieren und konfigurieren Sie die Google Chat API mit einem Namen, Symbol und einer Beschreibung für Ihre Chat-App.
- Installieren Sie die Node.js Cloud-Clientbibliothek
-
OAuth-Client-ID-Anmeldedaten für eine Desktopanwendung erstellen Um das Beispiel in diesem
sollten Sie die Anmeldedaten als JSON-Datei mit dem Namen
client_secrets.json
in Ihrem lokales Verzeichnis.
- Wählen Sie einen Autorisierungsbereich aus, der die Nutzerauthentifizierung unterstützt.
Python
- Unternehmen Google Workspace-Konto mit Zugriff auf Google Chat:
- Richten Sie Ihre Umgebung ein:
- Google Cloud-Projekt erstellen
- Konfigurieren Sie den OAuth-Zustimmungsbildschirm.
- Aktivieren und konfigurieren Sie die Google Chat API mit einem Namen, Symbol und einer Beschreibung für Ihre Chat-App.
- Installieren Sie die Cloud-Clientbibliothek für Python.
-
OAuth-Client-ID-Anmeldedaten für eine Desktopanwendung erstellen Um das Beispiel in diesem
sollten Sie die Anmeldedaten als JSON-Datei mit dem Namen
client_secrets.json
in Ihrem lokales Verzeichnis.
- Wählen Sie einen Autorisierungsbereich aus, der die Nutzerauthentifizierung unterstützt.
Java
- Unternehmen Google Workspace-Konto mit Zugriff auf Google Chat:
- Richten Sie Ihre Umgebung ein:
- Google Cloud-Projekt erstellen
- Konfigurieren Sie den OAuth-Zustimmungsbildschirm.
- Aktivieren und konfigurieren Sie die Google Chat API mit einem Namen, Symbol und einer Beschreibung für Ihre Chat-App.
- Installieren Sie die Java-Cloud-Clientbibliothek.
-
OAuth-Client-ID-Anmeldedaten für eine Desktopanwendung erstellen Wenn Sie das Beispiel in dieser Anleitung ausführen möchten, speichern Sie die Anmeldedaten als JSON-Datei mit dem Namen
client_secrets.json
in Ihrem lokalen Verzeichnis.
- Wählen Sie einen Autorisierungsbereich aus, der die Nutzerauthentifizierung unterstützt.
Apps Script
- Ein Google Workspace-Konto für Unternehmen oder Organisationen mit Zugriff auf Google Chat.
- Richten Sie Ihre Umgebung ein:
- Google Cloud-Projekt erstellen
- Konfigurieren Sie den OAuth-Zustimmungsbildschirm.
- Aktivieren und konfigurieren Sie die Google Chat API mit einem Namen, und eine Beschreibung der Chat App.
- Erstellen Sie ein eigenständiges Apps Script-Projekt und aktivieren Sie den erweiterten Chatdienst.
- Wählen Sie einen Autorisierungsbereich aus, der die Nutzerauthentifizierung unterstützt.
Gruppenbereich einrichten
Wenn Sie einen Gruppenbereich einrichten möchten, geben Sie Folgendes in Ihrer Anfrage an:
- Geben Sie den Autorisierungsbereich
chat.spaces.create
oderchat.spaces
an. - Rufen Sie die Methode
SetUpSpace()
auf. - Gib
space
als Instanz vonSpace
mit allen erforderlichen Feldern wiedisplayName
oderspaceType
an. - Übergeben Sie
memberships
als Array vonMembership
Instanzen. Für jede Instanz:- Geben Sie
users/{user}
an, um einen menschlichen Nutzer als Mitglied des Gruppenbereichs hinzuzufügen, wobei{user}
ist entweder der{person_id}
für denperson
aus der People API oder die ID einesuser
in der Directory API. Wenn beispielsweise die People API-PersonresourceName
gleichpeople/123456789
ist, können Sie den Nutzer dem Gruppenbereich hinzufügen, indem Sie einschließlich einer Mitgliedschaft beiusers/123456789
alsmember.name
. - Geben Sie
groups/{group}
an, um eine Gruppe als Mitglied eines Gruppenbereichs hinzuzufügen.{group}
ist die Gruppen-ID, für die Sie die Mitgliedschaft erstellen möchten. Die ID der Gruppe kann mit der Cloud Identity API abgerufen werden. Wenn die Cloud Identity API beispielsweise eine Gruppe mit dem Namengroups/123456789
zurückgibt, setzen Siemembership.groupMember.name
aufgroups/123456789
. Google Groups-Gruppen können nicht wurden einem Gruppenchat oder einer Direktnachricht hinzugefügt, aber nur einem benannten Gruppenbereich.
- Geben Sie
Wenn Sie eine DM zwischen dem anrufenden Nutzer und einem anderen menschlichen Nutzer erstellen möchten, geben Sie in Ihrer Anfrage eine Mitgliedschaft des menschlichen Nutzers an.
Wenn Sie eine DM zwischen dem anrufenden Nutzer und der anrufenden App erstellen möchten, legen Sie space.singleUserBotDm
auf true
fest und geben Sie keine Mitgliedschaften an. Sie können
Verwenden Sie diese Methode nur, um eine DN mit der aufrufenden App einzurichten. So fügen Sie die Anruffunktion hinzu:
als Mitglied eines Gruppenbereichs oder als bestehende DN zwischen zwei menschlichen Nutzern, siehe
Erstellen Sie eine Mitgliedschaft.
Im folgenden Beispiel wird ein benannter Gruppenbereich erstellt und eine Mitgliedschaft für den Gruppenbereich für zwei natürliche Personen (den authentifizierten Nutzer und einen anderen Nutzer) erstellt.
Node.js
Python
Java
Apps Script
Ersetzen Sie zum Ausführen des Beispiels Folgendes:
DISPLAY_NAME
: Der Anzeigename des neuen Gruppenbereichs.USER_NAME
: die ID des anderen Nutzers, der hinzugefügt werden soll Mitgliedschaft.
Um den Gruppenbereich aufzurufen, verwenden Sie die Ressourcen-ID des Gruppenbereichs, um die URL des Gruppenbereichs zu erstellen.
Sie finden die Ressourcen-ID im Gruppenbereich name
im Textkörper der Google Chat-Antwort. 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
.
Weitere Informationen
- Erstellen Sie einen Gruppenbereich.
- Details zu einem Gruppenbereich abrufen
- Gruppenbereiche auflisten:
- Gruppenbereiche aktualisieren
- Gruppenbereiche löschen
- Suchen Sie einen Gruppenbereich für Direktnachrichten.
- Sie können einen Gruppenbereich für bestimmte Nutzer sichtbar machen.