Google Chat API

Mit der Google Chat API können Sie Chat-Apps erstellen, um Ihre Dienste in Google Chat einzubinden und Chat-Ressourcen wie Gruppenbereiche, Mitglieder und Nachrichten zu verwalten.

Dienst: chat.googleapis.com

Wir empfehlen, diesen Dienst mit den von Google bereitgestellten Clientbibliotheken aufzurufen. Wenn Ihre Anwendung Ihre eigenen Bibliotheken zum Aufrufen dieses Dienstes verwenden muss, verwenden Sie bei den API-Anfragen die folgenden Informationen.

Discovery-Dokument

Ein Discovery-Dokument ist eine maschinenlesbare Spezifikation zum Beschreiben und Nutzen von REST APIs. Sie wird verwendet, um Clientbibliotheken, IDE-Plug-ins und andere Tools zu erstellen, die mit Google APIs interagieren. Ein Dienst kann mehrere Discovery-Dokumente haben. Der Dienst bietet das folgende Discovery-Dokument:

Dienstendpunkt

Ein Dienstendpunkt ist eine Basis-URL, die die Netzwerkadresse eines API-Dienstes angibt. Ein Dienst kann mehrere Dienstendpunkte haben. Dieser Dienst hat den folgenden Dienstendpunkt und alle nachstehenden URIs beziehen sich auf ihn:

  • https://chat.googleapis.com

REST-Ressource: v1.customEmojis

Methoden
create POST /v1/customEmojis
Erstellt ein benutzerdefiniertes Emoji.
delete DELETE /v1/{name=customEmojis/*}
Löscht ein benutzerdefiniertes Emoji.
get GET /v1/{name=customEmojis/*}
Gibt Details zu einem benutzerdefinierten Emoji zurück.
list GET /v1/customEmojis
Listet benutzerdefinierte Emojis auf, die für den authentifizierten Nutzer sichtbar sind.

REST-Ressource: v1.media

Methoden
download GET /v1/media/{resourceName=**}
Medien werden heruntergeladen.
upload POST /upload/v1/{parent=spaces/*}/attachments:upload
Lädt einen Anhang hoch.

REST-Ressource: v1.spaces

Methoden
completeImport POST /v1/{name=spaces/*}:completeImport
Führt den Importvorgang für den angegebenen Gruppenbereich durch und macht ihn für Nutzer sichtbar.
create POST /v1/spaces
Erstellt einen Gruppenbereich ohne Mitglieder.
delete DELETE /v1/{name=spaces/*}
Löscht einen benannten Gruppenbereich.
findDirectMessage GET /v1/spaces:findDirectMessage
Gibt die vorhandene Direktnachricht mit dem angegebenen Nutzer zurück.
get GET /v1/{name=spaces/*}
Gibt Details zu einem Gruppenbereich zurück.
list GET /v1/spaces
Listet Gruppenbereiche auf, in denen der Anrufer Mitglied ist.
patch PATCH /v1/{space.name=spaces/*}
Aktualisiert einen Gruppenbereich.
search GET /v1/spaces:search
Gibt basierend auf der Suche eines Administrators eine Liste von Gruppenbereichen in einer Google Workspace-Organisation zurück.
setup POST /v1/spaces:setup
Erstellt einen Gruppenbereich und fügt ihm angegebene Nutzer hinzu.

REST-Ressource: v1.spaces.members

Methoden
create POST /v1/{parent=spaces/*}/members
Damit wird eine Mitgliedschaft für die anrufende Chat-App, einen Nutzer oder eine Google-Gruppe erstellt.
delete DELETE /v1/{name=spaces/*/members/*}
Löscht eine Mitgliedschaft.
get GET /v1/{name=spaces/*/members/*}
Gibt Details zu einer Mitgliedschaft zurück.
list GET /v1/{parent=spaces/*}/members
Listet Mitgliedschaften in einem Gruppenbereich auf.
patch PATCH /v1/{membership.name=spaces/*/members/*}
Aktualisiert eine Mitgliedschaft.

REST-Ressource: v1.spaces.messages

Methoden
create POST /v1/{parent=spaces/*}/messages
Erstellt eine Nachricht in einem Google Chat-Bereich.
delete DELETE /v1/{name=spaces/*/messages/*}
Löscht eine Nachricht.
get GET /v1/{name=spaces/*/messages/*}
Gibt Details zu einer Nachricht zurück.
list GET /v1/{parent=spaces/*}/messages
Zeigt Nachrichten in einem Gruppenbereich an, in dem der Anrufer Mitglied ist, einschließlich Nachrichten von blockierten Mitgliedern und Gruppenbereichen.
patch PATCH /v1/{message.name=spaces/*/messages/*}
Aktualisiert eine Nachricht.
update PUT /v1/{message.name=spaces/*/messages/*}
Aktualisiert eine Nachricht.

REST-Ressource: v1.spaces.messages.attachments

Methoden
get GET /v1/{name=spaces/*/messages/*/attachments/*}
Ruft die Metadaten eines Nachrichtenanhangs ab.

REST-Ressource: v1.spaces.messages.reactions

Methoden
create POST /v1/{parent=spaces/*/messages/*}/reactions
Erstellt eine Reaktion und fügt sie einer Nachricht hinzu.
delete DELETE /v1/{name=spaces/*/messages/*/reactions/*}
Löscht eine Reaktion auf eine Nachricht.
list GET /v1/{parent=spaces/*/messages/*}/reactions
Listet Reaktionen auf eine Nachricht auf.

REST-Ressource: v1.spaces.spaceEvents

Methoden
get GET /v1/{name=spaces/*/spaceEvents/*}
Gibt ein Ereignis aus einem Google Chat-Gruppenbereich zurück.
list GET /v1/{parent=spaces/*}/spaceEvents
Listet Ereignisse aus einem Google Chat-Gruppenbereich auf.

REST-Ressource: v1.users.spaces

Methoden
getSpaceReadState GET /v1/{name=users/*/spaces/*/spaceReadState}
Gibt Details zum Lesestatus eines Nutzers in einem Gruppenbereich zurück, um gelesene und ungelesene Nachrichten zu identifizieren.
updateSpaceReadState PATCH /v1/{spaceReadState.name=users/*/spaces/*/spaceReadState}
Aktualisiert den Lesestatus eines Nutzers in einem Gruppenbereich, um gelesene und ungelesene Nachrichten zu identifizieren.

REST-Ressource: v1.users.spaces.spaceNotificationSetting

Methoden
get GET /v1/{name=users/*/spaces/*/spaceNotificationSetting}
Ruft die Einstellungen für den Benachrichtigungsstatus des Gruppenbereichs ab.
patch PATCH /v1/{spaceNotificationSetting.name=users/*/spaces/*/spaceNotificationSetting}
Aktualisiert die Einstellungen für den Benachrichtigungsstatus des Gruppenbereichs.

REST-Ressource: v1.users.spaces.threads

Methoden
getThreadReadState GET /v1/{name=users/*/spaces/*/threads/*/threadReadState}
Gibt Details zum Lesestatus eines Nutzers in einem Thread zurück, um gelesene und ungelesene Nachrichten zu identifizieren.