Google Chat API – Übersicht

In diesem Abschnitt wird erläutert, wie eine Google Chat-App die Chat API aufrufen kann. Chat-Apps können damit beispielsweise einen Gruppenbereich erstellen, Personen hinzufügen und eine Nachricht posten, ohne von einem Chat-App-Interaktionsereignis dazu aufgefordert zu werden.

Authentifizierung

Für den asynchronen Aufruf der Chat API ist eine Authentifizierung erforderlich. Jede Chat API-Methode erfordert entweder die Nutzerauthentifizierung, um im Namen eines Nutzers Aktionen durchzuführen oder auf Daten zuzugreifen, oder die App-Authentifizierung, um als Chat-App Aktionen auszuführen oder auf Daten zuzugreifen. Einige Methoden unterstützen sowohl die Nutzer- als auch die Anwendungsauthentifizierung.

Weitere Informationen zur Authentifizierung in Google Chat finden Sie unter Authentifizierung.

API-Ressourcen und -Methoden

REST-Ressourcen und -Methoden gewähren asynchronen Zugriff auf Chatbereiche, Mitglieder des Gruppenbereichs, Nachrichten, Nachrichtenreaktionen und Nachrichtenanhänge.

Gruppenbereiche

Gruppenbereiche sind Orte, an denen sich Personen und Apps miteinander austauschen und Dateien teilen können. Es gibt verschiedene Arten von Leerzeichen. 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 zusammenarbeiten.

Die Ressource spaces stellt einen Bereich dar.

Gruppenbereiche unterstützen die folgenden Methoden:

• Erstellen Sie einen Gruppenbereich, in dem Nutzer und Apps sich unterhalten und Dateien teilen können.
• Richten Sie einen Bereich ein, um den Bereich zu erstellen, und fügen Sie ihm Personen und Chat-Apps hinzu.
• Wenn Sie sich Details zu einem Gruppenbereich ansehen möchten, rufen Sie einen Gruppenbereich ab.
• Listen Sie Gruppenbereiche auf, um eine paginierte, filterbare Liste von Gruppenbereichen aufzurufen.
• Aktualisieren Sie einen Bereich, um Attribute eines Gruppenbereichs zu ändern, z. B. den für den Nutzer sichtbaren Anzeigenamen, die Beschreibung und Richtlinien.
• Einen Gruppenbereich löschen, wenn er nicht mehr benötigt wird.
• Suchen Sie nach einer Direktnachricht (DN), um eine DN zwischen zwei Nutzern oder eine DM zwischen einem Nutzer und der aufrufenden Chat-App zurückzugeben.

Mitglieder

Mitglieder sind Nutzer und Chat-Apps, die einem Gruppenbereich beigetreten sind oder in diesen eingeladen wurden.

Die Ressource spaces.members stellt ein Mitglied dar.

Mitglieder unterstützen die folgenden Methoden:

• Erstellen Sie eine Mitgliedschaft, um einem Bereich einen Nutzer oder eine App hinzuzufügen.
• Mitglied werden, um Details zu einer Mitgliedschaft anzusehen.
• Listen Sie Mitgliedschaften auf, um eine paginierte, filterbare Liste der Mitgliedschaften in einem Bereich aufzurufen.
• Sie können eine Mitgliedschaft aktualisieren, um Attribute einer Mitgliedschaft zu ändern, z. B. ein Mitglied zu einem Administrator eines Gruppenbereichs oder einen Administrator zu einem Mitglied des Gruppenbereichs.
• Mitgliedschaft löschen, um einen Nutzer oder eine App aus einem Gruppenbereich zu entfernen

Nachrichten

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

Die Ressource spaces.messages stellt eine Nachricht dar.

In Messages werden die folgenden Methoden unterstützt:

• Erstellen Sie eine Nachricht, um eine Textnachricht oder Kartennachricht zu posten. Sie können auch eine Konversation starten oder beantworten.
• Nachricht abrufen: Mit diesem Befehl können Sie Details zu einer Nachricht abrufen, z. B. wann sie gesendet wurde oder was sie enthält.
• Nachrichten auflisten, um eine paginierte, filterbare Liste von Nachrichten in einem Gruppenbereich anzusehen.
• Aktualisieren Sie eine Nachricht, um Nachrichtenattribute wie den Text zu ändern. Sie können auch Text 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.reactions 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 zu sehen.
• Wenn Sie ein Emoji aus der Nachricht entfernen möchten, löschen Sie eine Reaktion.

Medien und Anhänge

Medien stehen 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 spaces.messages.attachments stellt einen Anhang dar. Ein Anhang enthält die an eine Nachricht angehängten Medien und zugehörigen Metadaten.

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.

Veranstaltungen im Weltraum

Space-Ereignisse stellen Änderungen an einem Gruppenbereich oder dessen untergeordneten Ressourcen dar, einschließlich seiner Mitglieder, Nachrichten und Reaktionen.

Die Ressource spaces.spaceEvent stellt ein Weltraumereignis dar.

Ereignisse in Gruppenbereichen unterstützen die folgenden Methoden:

• Rufen Sie ein Weltraumereignis ab, um Details zu einem Ereignis abzurufen, das in einem Gruppenbereich stattgefunden hat.
• Sie können Space-Ereignisse auflisten, um eine Liste der Ereignisse abzurufen, die in einem Gruppenbereich aufgetreten sind.

Lesestatus des Nutzers

Lesestatus von Nutzern sind Singleton-Ressourcen, die Details zur letzten gelesenen Nachricht eines angegebenen Nutzers in einem Google Chat-Bereich oder einem Nachrichtenthread darstellen.

Die Ressource users.spaces stellt den Lesestatus eines Nutzers in einem Bereich dar.

Die Ressource users.spaces.threads stellt den Lesestatus eines Nutzers in einem Nachrichtenthread dar.

Lesestatus von Nutzern unterstützen die folgenden Methoden:

• Rufen Sie den Lesestatus des Gruppenbereichs ab, um Details zum Lesestatus eines Nutzers innerhalb eines Bereichs zurückzugeben.
• Aktualisieren Sie den Lesestatus eines Gruppenbereichs, um den Lesestatus eines Nutzers innerhalb eines Gruppenbereichs zu aktualisieren.
• Rufen Sie den Lesestatus eines Threads ab, um Details zum Lesestatus eines Nutzers innerhalb eines Threads zurückzugeben.

Weitere Informationen

• Referenzdokumentation zur Google Chat API