Google Chat API – Übersicht

In den Anleitungen 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 einer Chat-App dazu aufgefordert zu werden.

Authentifizierung

Für den asynchronen Aufruf der Chat API ist eine Authentifizierung erforderlich. Jede Chat API-Methode erfordert entweder eine Nutzerauthentifizierung (für Aktionen oder den Zugriff auf Daten im Namen eines Nutzers) oder eine App-Authentifizierung (für Aktionen oder den Zugriff auf Daten im Rahmen einer Chat-Anwendung). 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 Nutzer und Apps sich 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-Anwendungen. Benannte Gruppenbereiche sind persistente Orte, an denen Personen Nachrichten senden, Dateien freigeben und zusammenarbeiten.

Die Ressource Space steht für einen Bereich.

Gruppenbereiche unterstützen die folgenden Methoden:

• Erstellen Sie einen Gruppenbereich – einen Ort, an 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.
• Bereiche auflisten, um eine paginierte, filterbare Liste von Gruppenbereichen aufzurufen.
• Gruppenbereiche aktualisieren, um Attribute eines Gruppenbereichs zu ändern, z. B. den für den Nutzer sichtbaren Anzeigenamen, die Beschreibung und Richtlinien
• Sie können Leerzeichen löschen, wenn sie nicht mehr benötigt werden.
• Suchen Sie eine Direktnachricht (DN), um eine DN 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 in einen Gruppenbereich eingeladen wurden.

Die Ressource Member steht für ein Mitglied.

Mitglieder unterstützen die folgenden Methoden:

• Erstellen Sie eine Mitgliedschaft, um einem Gruppenbereich einen Nutzer oder eine App hinzuzufügen.
• Abo abschließen
• Mitgliedschaften auflisten, um eine paginierte, filterbare Liste von Mitgliedschaften in einem Gruppenbereich aufzurufen.
• Löschen Sie eine Mitgliedschaft, um einen Nutzer oder eine App aus einem Gruppenbereich zu entfernen.

Nachrichten

Nachrichten enthalten Text und Kartennachrichten, die in Gruppenbereichen gepostet werden. Nachrichten können Dateien angehängt haben. Nutzer können auf Nachrichten reagieren, indem sie Emojis anhängen.

Die Ressource Message stellt eine Nachricht dar.

Messages unterstützt die folgenden Methoden:

• Erstelle eine Nachricht, um eine Textnachricht oder eine Infokarte zu posten. Sie können auch einen Nachrichtenthread starten oder darauf antworten.
• Nachricht abrufen, um Details zu einer Nachricht abzurufen, z. B. wann sie gesendet wurde oder was sie sagt.
• Nachrichten auflisten, um eine paginierte, filterbare Liste von Nachrichten in einem Gruppenbereich aufzurufen.
• Aktualisieren Sie eine Nachricht, um Nachrichtenattribute wie den Inhalt zu ändern. Du kannst Text auch an eine Kartennachricht oder eine Karte an eine Textnachricht anhängen.
• Nachricht löschen, wenn sie nicht mehr benötigt wird

Reaktionen

Reaktionen stellen die Emojis dar, mit denen Nutzer auf eine Nachricht reagieren, z. B. 👍, 🚲 und Ю.

Die Ressource Reaction stellt 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 aufzurufen.
• Reaktion löschen, um ein Emoji aus der Nachricht zu entfernen

Medien und Anhänge

Medien steht für eine in Google Chat hochgeladene Datei, z. B. Bilder, Videos und Dokumente.

Die Ressource Media stellt Medien dar, die an Nachrichten angehängt sind.

Anhänge sind Instanzen von Medien (Dateien), die an Nachrichten angehängt wurden.

Die Ressource Attachment stellt einen Anhang dar. Ein Anhang enthält die Medien und die zugehörigen Metadaten, die an eine Nachricht angehängt sind.

Medien und Anhänge unterstützen die folgenden Methoden:

• 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.

Discovery-Dokument suchen

Das Discovery-Dokument für diese API befindet sich unter der folgenden URL:

• https://chat.googleapis.com/$discovery/rest?version=v1.