In diesem Abschnitt wird erläutert, wie eine Google Chat-App die Chat API aufrufen kann. Damit können Chat-Apps beispielsweise einen Gruppenbereich erstellen, Personen hinzufügen und eine Nachricht posten, ohne von einem Interaktionsereignis der Chat-App dazu aufgefordert zu werden.
Authentifizierung
Für den asynchronen Aufruf der Chat API ist eine Authentifizierung erforderlich. Für jede Chat API-Methode ist entweder die Nutzerauthentifizierung (um Aktionen oder den Zugriff auf Daten im Namen eines Nutzers auszuführen) oder eine Anwendungsauthentifizierung (um Aktionen oder den Zugriff auf Daten als Chat-App auszuführen) erforderlich. Einige Methoden unterstützen sowohl die Nutzer- als auch die Anwendungsauthentifizierung.
Weitere Informationen zur Authentifizierung in Chat finden Sie unter Authentifizierung.
API-Ressourcen und -Methoden
REST-Ressourcen und -Methoden gewähren asynchronen Zugriff auf Chatbereiche, Mitglieder von Gruppenbereichen, Nachrichten, Nachrichtenreaktionen und Nachrichtenanhänge.
- Gruppenbereiche
In Gruppenbereichen können sich Nutzer und Apps unterhalten und Dateien teilen. Es gibt verschiedene Arten von Gruppenbereichen. Direktnachrichten (DN) sind 1:1-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 Personen Nachrichten senden, Dateien teilen und zusammenarbeiten.
Die Ressource
spacesstellt einen Bereich dar.Gruppenbereiche unterstützen die folgenden Methoden:
- Erstellen Sie einen Gruppenbereich, in dem sich Nutzer und Apps unterhalten und Dateien teilen können.
- Richten Sie einen Gruppenbereich ein, um den Gruppenbereich zu erstellen, und fügen Sie ihm Personen und Chat-Apps hinzu.
- Erstellen Sie einen Gruppenbereich, um Details zu einem Gruppenbereich zu sehen.
- Listen Sie Gruppenbereiche auf, um eine paginierte, filterbare Liste von Gruppenbereichen aufzurufen.
- Einen Gruppenbereich aktualisieren, um Attribute zu einem Gruppenbereich zu ändern, z. B. den für den Nutzer sichtbaren Anzeigenamen, die Beschreibung und Richtlinien.
- Gruppenbereiche löschen, wenn sie nicht mehr benötigt werden.
- Suchen Sie eine Direktnachricht (DN), um eine DM zwischen zwei Nutzern zurückzugeben, oder eine Direktnachricht zwischen einem Nutzer und den aufrufenden Chat-Apps.
- Mitglieder
Mitglieder sind Nutzer und Chat-Apps, die einem Gruppenbereich beigetreten sind oder dazu eingeladen wurden.
Die Ressource
spaces.membersstellt ein Mitglied dar.Mitglieder unterstützen die folgenden Methoden:
- Erstellen Sie eine Mitgliedschaft, um einem Gruppenbereich einen Nutzer oder eine App hinzuzufügen.
- Schließe eine Mitgliedschaft ab, um Details dazu aufzurufen.
- Mitgliedschaften auflisten, um eine paginierte, filterbare Liste der Mitgliedschaften in einem Gruppenbereich aufzurufen.
- Eine Mitgliedschaft aktualisieren, um Attribute zu ändern, z. B. ein Mitglied des Gruppenbereichs zu einem Administrator des Gruppenbereichs zu ändern oder einen Administrator des Gruppenbereichs zu einem Mitglied zu ändern
- Löschen Sie eine Mitgliedschaft, um einen Nutzer oder eine App aus einem Gruppenbereich zu entfernen.
- Nachrichten
Nachrichten enthalten Textmitteilungen und Karten, die in Gruppenbereichen gepostet werden. An Nachrichten können Dateien angehängt werden. Personen können auf Nachrichten reagieren, indem sie ihnen Emojis hinzufügen.
Die Ressource
spaces.messagesstellt eine Nachricht dar.Messages unterstützt die folgenden Methoden:
- Erstelle eine Nachricht, um eine Textnachricht oder eine Infokarte zu veröffentlichen. Sie können auch einen Nachrichten-Thread starten oder darauf antworten.
- Nachricht abrufen, um Details zu einer Nachricht zu erhalten, z. B. wann sie gesendet wurde oder was sie sagt.
- Nachrichten auflisten, um eine paginierte, filterbare Liste von Nachrichten in einem Gruppenbereich aufzurufen.
- Eine Nachricht aktualisieren, um Nachrichtenattribute wie den Inhalt zu ändern. Du kannst Text auch an eine Kartennachricht oder eine Karte an eine Textnachricht anhängen.
- Nachrichten löschen, wenn sie nicht mehr benötigt werden
- Reaktionen
Reaktionen stehen für die Emojis, mit denen Nutzer auf eine Nachricht reagieren, z. B. 👍, 🚲 und Ю.
Die Ressource
spaces.messages.reactionsstellt eine Reaktion dar.Für Reaktionen werden die folgenden Methoden unterstützt:
- Erstellen Sie eine Reaktion, um ein Emoji an eine Nachricht anzuhängen.
- Reaktionen auflisten, um eine paginierte, filterbare Liste von Reaktionen auf eine Nachricht zu sehen
- Wenn Sie eine Reaktion löschen möchten, wird ein Emoji aus der Nachricht entfernt.
- Medien und Anhänge
Medien stellt eine in Google Chat hochgeladene Datei dar, z. B. Bilder, Videos und Dokumente.
Die Ressource
mediastellt Medien dar, die an Nachrichten angehängt sind.Anhänge sind Instanzen von Medien (Dateien), die an Nachrichten angehängt sind.
Die Ressource
spaces.messages.attachmentsstellt einen Anhang dar. Ein Anhang enthält die an eine Nachricht angehängten Medien und zugehörigen Metadaten.Bei Medien und Anhängen werden folgende Methoden unterstützt:
- Medien als Anhang hochladen, um Medien in Google Chat hochzuladen und dann an eine Nachricht anzuhängen
- Medien als Anhang herunterladen, um Medien aus Google Chat als Binärdatei herunterzuladen
- Rufen Sie einen Anhang ab, um Metadaten zu einem Nachrichtenanhang abzurufen.
- Space-Veranstaltungen
Ereignisse für Gruppenbereiche stellen Änderungen an einem Gruppenbereich oder seinen untergeordneten Ressourcen dar, einschließlich seiner Mitglieder, Nachrichten und Reaktionen.
Die Ressource
spaces.spaceEventstellt ein Raumereignis dar.Gruppenbereiche unterstützen die folgenden Methoden:
- Rufen Sie einen Gruppenbereich ab, um Details zu einem Termin in einem Gruppenbereich abzurufen.
- Sie können Ereignisse für Gruppenbereiche auflisten, um eine Liste der Ereignisse zu erhalten, die in einem Gruppenbereich aufgetreten sind.
- Lesestatus der Nutzer (Entwicklervorschau)
Lesestatus des Nutzers sind Singleton-Ressourcen, die Details zur zuletzt gelesenen Nachricht eines bestimmten Nutzers in einem Google Chat-Bereich oder einem Nachrichten-Thread darstellen.
Die Ressource
users.spacesstellt den Lesestatus eines Nutzers in einem Bereich dar.Die Ressource
users.spaces.threadsstellt den Lesestatus eines Nutzers in einem Nachrichten-Thread dar.Für den Nutzer-Lesestatus werden die folgenden Methoden unterstützt:
- Lesestatus des Gruppenbereichs abrufen, um Details zum Lesestatus eines Nutzers in einem Bereich zurückzugeben.
- Lesestatus für Gruppenbereich aktualisieren, um den Lesestatus eines Nutzers innerhalb eines Gruppenbereichs zu aktualisieren.
- Thread-Lesestatus abrufen, um Details zum Lesestatus eines Nutzers in einem Thread zurückzugeben.