Google Chat API

Mit der Google Chat API können Sie Chat-Apps entwickeln, 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 diesen Dienst mit Ihren eigenen Bibliotheken aufrufen muss, sollten Sie die folgenden Informationen verwenden, wenn Sie die API-Anfragen senden.

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. Dieser Dienst stellt folgendes Discovery-Dokument bereit:

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=**}
Lädt Medien herunter.
upload POST /upload/v1/{parent=spaces/*}/attachments:upload
Lädt einen Anhang hoch.

REST-Ressource: v1.spaces

Methoden
completeImport POST /v1/{name=spaces/*}:completeImport
Schließt den Importvorgang für den angegebenen Gruppenbereich ab und macht ihn für Nutzer sichtbar.
create POST /v1/spaces
Erstellt einen Gruppenbereich.
delete DELETE /v1/{name=spaces/*}
Löscht einen benannten Bereich.
findDirectMessage GET /v1/spaces:findDirectMessage
Gibt die vorhandene Direktnachricht mit dem angegebenen Nutzer zurück.
findGroupChats GET /v1/spaces:findGroupChats
Gibt alle Bereiche mit spaceType == GROUP_CHAT zurück, deren Mitgliedschaften genau den aufrufenden Nutzer und die in FindGroupChatsRequest.memberships angegebenen Nutzer enthalten.
get GET /v1/{name=spaces/*}
Gibt Details zu einem Gruppenbereich zurück.
list GET /v1/spaces
Listet die Gruppenbereiche auf, in denen der Aufrufer Mitglied ist.
patch PATCH /v1/{space.name=spaces/*}
Aktualisiert einen Space.
search GET /v1/spaces:search
Gibt eine Liste von Bereichen in einer Google Workspace-Organisation basierend auf der Suche eines Administrators zurück.
setup POST /v1/spaces:setup
Erstellt einen Bereich und fügt die angegebenen Nutzer hinzu.

REST-Ressource: v1.spaces.members

Methoden
create POST /v1/{parent=spaces/*}/members
Erstellt eine Mitgliedschaft für die Anruf-Chat-App, einen Nutzer oder eine Google-Gruppe.
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-Gruppenbereich.
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
Listet Nachrichten in einem Gruppenbereich auf, in dem der Aufrufer 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-Bereich zurück.
list GET /v1/{parent=spaces/*}/spaceEvents
Listet Ereignisse aus einem Google Chat-Gruppenbereich auf.

REST-Ressource: v1.users.sections

Methoden
create POST /v1/{parent=users/*}/sections
Erstellt einen Bereich in Google Chat.
delete DELETE /v1/{name=users/*/sections/*}
Löscht einen Abschnitt vom Typ CUSTOM_SECTION.
list GET /v1/{parent=users/*}/sections
Listet die Abschnitte auf, die für den Chat-Nutzer verfügbar sind.
patch PATCH /v1/{section.name=users/*/sections/*}
Aktualisiert einen Abschnitt.
position POST /v1/{name=users/*/sections/*}:position
Ändert die Sortierreihenfolge eines Abschnitts.

REST-Ressource: v1.users.sections.items

Methoden
list GET /v1/{parent=users/*/sections/*}/items
Listet Elemente in einem Abschnitt auf.
move POST /v1/{name=users/*/sections/*/items/*}:move
Verschiebt ein Element von einem Abschnitt in einen anderen.

REST-Ressource: v1.users.spaces

Methoden
getSpaceReadState GET /v1/{name=users/*/spaces/*/spaceReadState}
Gibt Details zum Lesestatus eines Nutzers in einem Gruppenbereich zurück, mit denen gelesene und ungelesene Nachrichten identifiziert werden können.
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 Benachrichtigungseinstellung für den Gruppenbereich ab.
patch PATCH /v1/{spaceNotificationSetting.name=users/*/spaces/*/spaceNotificationSetting}
Aktualisiert die Benachrichtigungseinstellung für den Gruppenbereich.

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, mit denen gelesene und ungelesene Nachrichten identifiziert werden können.