Package google.chat.v1

rpc CompleteImportSpace(CompleteImportSpaceRequest) returns (CompleteImportSpaceResponse)

Schließt den Importvorgang für den angegebenen Gruppenbereich ab und macht ihn für Nutzer sichtbar.

Erfordert Nutzerauthentifizierung und domainweite Delegierung mit dem Autorisierungsbereich:

• https://www.googleapis.com/auth/chat.import

Weitere Informationen finden Sie unter Google Chat-Apps zum Importieren von Daten autorisieren.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

• https://www.googleapis.com/auth/chat.import

Weitere Informationen finden Sie im Autorisierungsleitfaden.

rpc CreateCustomEmoji(CreateCustomEmojiRequest) returns (CustomEmoji)

Erstellt ein benutzerdefiniertes Emoji.

Benutzerdefinierte Emojis sind nur für Google Workspace-Konten verfügbar und der Administrator muss sie für die Organisation aktivieren. Weitere Informationen finden Sie unter Benutzerdefinierte Emojis in Google Chat und Berechtigungen für benutzerdefinierte Emojis verwalten.

Erfordert Nutzerauthentifizierung mit dem Autorisierungsbereich:

• https://www.googleapis.com/auth/chat.customemojis

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

• https://www.googleapis.com/auth/chat.customemojis

Weitere Informationen finden Sie im Autorisierungsleitfaden.

rpc CreateMembership(CreateMembershipRequest) returns (Membership)

Erstellt eine Mitgliedschaft für die aufrufende Chat-App, einen Nutzer oder eine Google-Gruppe. Das Erstellen von Mitgliedschaften für andere Chat-Apps wird nicht unterstützt. Wenn Sie eine Mitgliedschaft erstellen und die angegebene Person die Richtlinie zum automatischen Akzeptieren deaktiviert hat, wird sie eingeladen und muss die Einladung für den Bereich annehmen, bevor sie beitreten kann. Andernfalls wird das Mitglied durch das Erstellen einer Mitgliedschaft direkt dem angegebenen Gruppenbereich hinzugefügt.

Unterstützt die folgenden Arten der Authentifizierung:

• App-Authentifizierung mit Administratorgenehmigung und dem Autorisierungsbereich:

  • https://www.googleapis.com/auth/chat.app.memberships

• Nutzerauthentifizierung mit einem der folgenden Autorisierungsbereiche:

  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.app (um die Anruf-App dem Gruppenbereich hinzuzufügen)
  • https://www.googleapis.com/auth/chat.import (nur Gruppenbereiche im Importmodus)
  • Bei der Nutzerauthentifizierung werden Administratorrechte gewährt, wenn ein Administratorkonto authentifiziert wird, use_admin_access gleich true ist und der folgende Autorisierungsbereich verwendet wird:
    • https://www.googleapis.com/auth/chat.admin.memberships

Die App-Authentifizierung wird für die folgenden Anwendungsfälle nicht unterstützt:

• Nutzer einladen, die nicht zur Workspace-Organisation gehören, die Eigentümer des Gruppenbereichs ist.
• Google-Gruppen zu Gruppenbereichen hinzufügen
• Eine Chat-App zu einem Gruppenbereich hinzufügen

Beispiele zur Verwendung finden Sie unter:

• Nutzer in einen Gruppenbereich einladen oder hinzufügen
• Google-Gruppen in einen Gruppenbereich einladen oder hinzufügen
• Fügen Sie die Chat-App einem Gruppenbereich hinzu.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

• https://www.googleapis.com/auth/chat.app.memberships
• https://www.googleapis.com/auth/chat.admin.memberships
• https://www.googleapis.com/auth/chat.import
• https://www.googleapis.com/auth/chat.memberships
• https://www.googleapis.com/auth/chat.memberships.app

Weitere Informationen finden Sie im Autorisierungsleitfaden.

rpc CreateMessage(CreateMessageRequest) returns (Message)

Erstellt eine Nachricht in einem Google Chat-Bereich. Ein Beispiel finden Sie unter Nachricht senden.

Unterstützt die folgenden Arten der Authentifizierung:

• App-Authentifizierung mit dem Autorisierungsbereich:
  • https://www.googleapis.com/auth/chat.bot
• Nutzerauthentifizierung mit einem der folgenden Autorisierungsbereiche:
  • https://www.googleapis.com/auth/chat.messages.create
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.import (nur Gruppenbereiche im Importmodus)

Chat ordnet den Absender der Nachricht je nach Art der Authentifizierung in Ihrer Anfrage unterschiedlich zu.

Das folgende Bild zeigt, wie Chat eine Nachricht zuordnet, wenn Sie die App-Authentifizierung verwenden. In Google Chat wird die Chat-App als Absender der Nachricht angezeigt. Der Inhalt der Nachricht kann Text (text), Karten (cardsV2) und Zubehör-Widgets (accessoryWidgets) enthalten.

Das folgende Bild zeigt, wie Chat eine Nachricht zuordnet, wenn Sie die Nutzerauthentifizierung verwenden. Im Chat wird der Nutzer als Absender der Nachricht angezeigt und die Chat-App wird der Nachricht durch die Anzeige ihres Namens zugeordnet. Der Inhalt der Nachricht darf nur Text (text) enthalten.

Die maximale Nachrichtengröße, einschließlich des Nachrichteninhalts, beträgt 32.000 Byte.

Bei Webhook-Anfragen enthält die Antwort nicht die vollständige Nachricht. In der Antwort werden nur die Felder name und thread.name zusätzlich zu den Informationen in der Anfrage ausgefüllt.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

• https://www.googleapis.com/auth/chat.bot
• https://www.googleapis.com/auth/chat.import
• https://www.googleapis.com/auth/chat.messages
• https://www.googleapis.com/auth/chat.messages.create

Weitere Informationen finden Sie im Autorisierungsleitfaden.

rpc CreateReaction(CreateReactionRequest) returns (Reaction)

Erstellt eine Reaktion und fügt sie einer Nachricht hinzu. Ein Beispiel finden Sie unter Reaktion auf eine Nachricht hinzufügen.

Erfordert Nutzerauthentifizierung mit einem der folgenden Autorisierungsbereiche:

• https://www.googleapis.com/auth/chat.messages.reactions.create
• https://www.googleapis.com/auth/chat.messages.reactions
• https://www.googleapis.com/auth/chat.messages
• https://www.googleapis.com/auth/chat.import (nur Gruppenbereiche im Importmodus)

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

• https://www.googleapis.com/auth/chat.import
• https://www.googleapis.com/auth/chat.messages
• https://www.googleapis.com/auth/chat.messages.reactions
• https://www.googleapis.com/auth/chat.messages.reactions.create

Weitere Informationen finden Sie im Autorisierungsleitfaden.

rpc CreateSpace(CreateSpaceRequest) returns (Space)

Erstellt einen Gruppenbereich. Kann verwendet werden, um einen benannten Bereich oder einen Gruppenchat in Import mode zu erstellen. Ein Beispiel finden Sie unter Bereich erstellen.

Unterstützt die folgenden Arten der Authentifizierung:

• App-Authentifizierung mit Administratorgenehmigung und einem der folgenden Autorisierungsbereiche:

  • https://www.googleapis.com/auth/chat.app.spaces.create
  • https://www.googleapis.com/auth/chat.app.spaces

• Nutzerauthentifizierung mit einem der folgenden Autorisierungsbereiche:

  • https://www.googleapis.com/auth/chat.spaces.create
  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.import (nur Gruppenbereiche im Importmodus)

Bei der Authentifizierung als App muss das Feld space.customer in der Anfrage festgelegt werden.

Wenn die Authentifizierung als App erfolgt, wird die Chat-App als Mitglied des Gruppenbereichs hinzugefügt. Im Gegensatz zur menschlichen Authentifizierung wird die Chat-App jedoch nicht als Administrator des Gruppenbereichs hinzugefügt. Standardmäßig kann die Chat-App von allen Mitgliedern des Gruppenbereichs aus dem Gruppenbereich entfernt werden. Wenn nur Administratoren des Gruppenbereichs die App aus einem Gruppenbereich entfernen dürfen, legen Sie space.permission_settings.manage_apps auf managers_allowed fest.

Die Mitgliedschaft in einem Gruppenbereich hängt davon ab, ob der Gruppenbereich in Import mode erstellt wird:

• Importmodus:Es werden keine Mitglieder erstellt.
• Alle anderen Modi:Der anrufende Nutzer wird als Mitglied hinzugefügt. Das ist:
  • Die App selbst, wenn die App-Authentifizierung verwendet wird.
  • Der menschliche Nutzer bei der Nutzerauthentifizierung.

Wenn Sie beim Erstellen eines Bereichs die Fehlermeldung ALREADY_EXISTS erhalten, versuchen Sie es mit einem anderen displayName. Möglicherweise wird dieser Anzeigename bereits in einem vorhandenen Gruppenbereich in der Google Workspace-Organisation verwendet.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

• https://www.googleapis.com/auth/chat.app.spaces.create
• https://www.googleapis.com/auth/chat.app.spaces
• https://www.googleapis.com/auth/chat.import
• https://www.googleapis.com/auth/chat.spaces
• https://www.googleapis.com/auth/chat.spaces.create

Weitere Informationen finden Sie im Autorisierungsleitfaden.

rpc DeleteCustomEmoji(DeleteCustomEmojiRequest) returns (Empty)

Löscht ein benutzerdefiniertes Emoji. Standardmäßig können Nutzer nur benutzerdefinierte Emojis löschen, die sie selbst erstellt haben. Emoji-Manager, die vom Administrator zugewiesen wurden, können alle benutzerdefinierten Emojis in der Organisation löschen. Weitere Informationen zu benutzerdefinierten Emojis in Google Chat

Benutzerdefinierte Emojis sind nur für Google Workspace-Konten verfügbar und der Administrator muss sie für die Organisation aktivieren. Weitere Informationen finden Sie unter Benutzerdefinierte Emojis in Google Chat und Berechtigungen für benutzerdefinierte Emojis verwalten.

Erfordert Nutzerauthentifizierung mit dem Autorisierungsbereich:

• https://www.googleapis.com/auth/chat.customemojis

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

• https://www.googleapis.com/auth/chat.customemojis

Weitere Informationen finden Sie im Autorisierungsleitfaden.

rpc DeleteMembership(DeleteMembershipRequest) returns (Membership)

Löscht eine Mitgliedschaft. Ein Beispiel finden Sie unter Nutzer oder Google Chat-App aus einem Gruppenbereich entfernen.

Unterstützt die folgenden Arten der Authentifizierung:

• App-Authentifizierung mit Administratorgenehmigung und dem Autorisierungsbereich:

  • https://www.googleapis.com/auth/chat.app.memberships

• Nutzerauthentifizierung mit einem der folgenden Autorisierungsbereiche:

  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.app (um die Anruf-App aus dem Gruppenbereich zu entfernen)
  • https://www.googleapis.com/auth/chat.import (nur Gruppenbereiche im Importmodus)
  • Bei der Nutzerauthentifizierung werden Administratorrechte gewährt, wenn ein Administratorkonto authentifiziert wird, use_admin_access gleich true ist und der folgende Autorisierungsbereich verwendet wird:
    • https://www.googleapis.com/auth/chat.admin.memberships

Die App-Authentifizierung wird für die folgenden Anwendungsfälle nicht unterstützt:

• Entfernen einer Google-Gruppe aus einem Gruppenbereich
• Eine Chat-App aus einem Gruppenbereich entfernen

Zum Löschen von Mitgliedschaften für Administratoren des Gruppenbereichs muss der Antragsteller Administrator des Gruppenbereichs sein. Wenn Sie die App-Authentifizierung verwenden, muss die Chat App der Ersteller des Gruppenbereichs sein.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

• https://www.googleapis.com/auth/chat.app.memberships
• https://www.googleapis.com/auth/chat.admin.memberships
• https://www.googleapis.com/auth/chat.import
• https://www.googleapis.com/auth/chat.memberships
• https://www.googleapis.com/auth/chat.memberships.app

Weitere Informationen finden Sie im Autorisierungsleitfaden.

rpc DeleteMessage(DeleteMessageRequest) returns (Empty)

Löscht eine Nachricht. Ein Beispiel finden Sie unter Nachricht löschen.

Unterstützt die folgenden Arten der Authentifizierung:

• App-Authentifizierung mit dem Autorisierungsbereich:

  • https://www.googleapis.com/auth/chat.bot

• Nutzerauthentifizierung mit einem der folgenden Autorisierungsbereiche:

  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.import (nur Gruppenbereiche im Importmodus)

Bei der App-Authentifizierung können mit Anfragen nur Nachrichten gelöscht werden, die von der aufrufenden Chat-App erstellt wurden.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

• https://www.googleapis.com/auth/chat.bot
• https://www.googleapis.com/auth/chat.import
• https://www.googleapis.com/auth/chat.messages

Weitere Informationen finden Sie im Autorisierungsleitfaden.

rpc DeleteReaction(DeleteReactionRequest) returns (Empty)

Löscht eine Reaktion auf eine Nachricht. Ein Beispiel finden Sie unter Reaktion löschen.

Erfordert Nutzerauthentifizierung mit einem der folgenden Autorisierungsbereiche:

• https://www.googleapis.com/auth/chat.messages.reactions
• https://www.googleapis.com/auth/chat.messages
• https://www.googleapis.com/auth/chat.import (nur Gruppenbereiche im Importmodus)

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

• https://www.googleapis.com/auth/chat.import
• https://www.googleapis.com/auth/chat.messages
• https://www.googleapis.com/auth/chat.messages.reactions

Weitere Informationen finden Sie im Autorisierungsleitfaden.

rpc DeleteSpace(DeleteSpaceRequest) returns (Empty)

Löscht einen benannten Bereich. Führt immer ein kaskadierendes Löschen durch. Das bedeutet, dass auch die untergeordneten Ressourcen des Gruppenbereichs gelöscht werden, z. B. Nachrichten, die im Gruppenbereich gepostet wurden, und Mitgliedschaften im Gruppenbereich. Ein Beispiel finden Sie unter Chatbereich löschen.

Unterstützt die folgenden Arten der Authentifizierung:

• App-Authentifizierung mit Administratorgenehmigung und dem Autorisierungsbereich:

  • https://www.googleapis.com/auth/chat.app.delete (nur in Gruppenbereichen, die von der App erstellt wurden)

• Nutzerauthentifizierung mit einem der folgenden Autorisierungsbereiche:

  • https://www.googleapis.com/auth/chat.delete
  • https://www.googleapis.com/auth/chat.import (nur Gruppenbereiche im Importmodus)
  • Bei der Nutzerauthentifizierung werden Administratorrechte gewährt, wenn ein Administratorkonto authentifiziert wird, use_admin_access gleich true ist und der folgende Autorisierungsbereich verwendet wird:
    • https://www.googleapis.com/auth/chat.admin.delete

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

• https://www.googleapis.com/auth/chat.app.delete
• https://www.googleapis.com/auth/chat.admin.delete
• https://www.googleapis.com/auth/chat.import
• https://www.googleapis.com/auth/chat.delete

Weitere Informationen finden Sie im Autorisierungsleitfaden.

rpc FindDirectMessage(FindDirectMessageRequest) returns (Space)

Gibt die vorhandene Direktnachricht mit dem angegebenen Nutzer zurück. Wenn kein Direktnachrichtenbereich gefunden wird, wird ein 404 NOT_FOUND-Fehler zurückgegeben. Ein Beispiel finden Sie unter Direktnachricht suchen.

Mit der App-Authentifizierung wird der Direktnachrichtenbereich zwischen dem angegebenen Nutzer und der aufrufenden Chat-App zurückgegeben.

Mit der Nutzerauthentifizierung wird der Direktnachrichtenbereich zwischen dem angegebenen Nutzer und dem authentifizierten Nutzer zurückgegeben.

Unterstützt die folgenden Arten der Authentifizierung:

• App-Authentifizierung mit dem Autorisierungsbereich:

  • https://www.googleapis.com/auth/chat.bot

• Nutzerauthentifizierung mit einem der folgenden Autorisierungsbereiche:

  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.spaces

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

• https://www.googleapis.com/auth/chat.spaces
• https://www.googleapis.com/auth/chat.spaces.readonly
• https://www.googleapis.com/auth/chat.bot

Weitere Informationen finden Sie im Autorisierungsleitfaden.

rpc GetAttachment(GetAttachmentRequest) returns (Attachment)

Ruft die Metadaten eines Nachrichtenanhangs ab. Die Anhänge werden über die Media API abgerufen. Ein Beispiel finden Sie unter Metadaten zu einem Nachrichtenanhang abrufen.

Erfordert App-Authentifizierung mit dem Autorisierungsbereich:

• https://www.googleapis.com/auth/chat.bot

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

• https://www.googleapis.com/auth/chat.bot

Weitere Informationen finden Sie im Autorisierungsleitfaden.

rpc GetCustomEmoji(GetCustomEmojiRequest) returns (CustomEmoji)

Gibt Details zu einem benutzerdefinierten Emoji zurück.

Benutzerdefinierte Emojis sind nur für Google Workspace-Konten verfügbar und der Administrator muss sie für die Organisation aktivieren. Weitere Informationen finden Sie unter Benutzerdefinierte Emojis in Google Chat und Berechtigungen für benutzerdefinierte Emojis verwalten.

Erfordert Nutzerauthentifizierung mit einem der folgenden Autorisierungsbereiche:

• https://www.googleapis.com/auth/chat.customemojis.readonly
• https://www.googleapis.com/auth/chat.customemojis

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

• https://www.googleapis.com/auth/chat.customemojis
• https://www.googleapis.com/auth/chat.customemojis.readonly

Weitere Informationen finden Sie im Autorisierungsleitfaden.

rpc GetMembership(GetMembershipRequest) returns (Membership)

Gibt Details zu einer Mitgliedschaft zurück. Ein Beispiel finden Sie unter Details zur Mitgliedschaft eines Nutzers oder einer Google Chat-App abrufen.

Unterstützt die folgenden Arten der Authentifizierung:

• App-Authentifizierung mit einem der folgenden Autorisierungsbereiche:

  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.app.memberships (erfordert Administratorgenehmigung)

• Nutzerauthentifizierung mit einem der folgenden Autorisierungsbereiche:

  • https://www.googleapis.com/auth/chat.memberships.readonly
  • https://www.googleapis.com/auth/chat.memberships
  • Bei der Nutzerauthentifizierung werden Administratorberechtigungen gewährt, wenn ein Administratorkonto authentifiziert wird, use_admin_access gleich true ist und einer der folgenden Autorisierungsbereiche verwendet wird:
    • https://www.googleapis.com/auth/chat.admin.memberships.readonly
    • https://www.googleapis.com/auth/chat.admin.memberships

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

• https://www.googleapis.com/auth/chat.admin.memberships
• https://www.googleapis.com/auth/chat.admin.memberships.readonly
• https://www.googleapis.com/auth/chat.app.memberships
• https://www.googleapis.com/auth/chat.bot
• https://www.googleapis.com/auth/chat.memberships
• https://www.googleapis.com/auth/chat.memberships.readonly

Weitere Informationen finden Sie im Autorisierungsleitfaden.

rpc GetMessage(GetMessageRequest) returns (Message)

Gibt Details zu einer Nachricht zurück. Ein Beispiel finden Sie unter Details zu einer Nachricht abrufen.

Unterstützt die folgenden Arten der Authentifizierung:

• App-Authentifizierung mit einem der folgenden Autorisierungsbereiche:

  • https://www.googleapis.com/auth/chat.bot: Wenn Sie diesen Autorisierungsbereich verwenden, gibt diese Methode Details zu einer Nachricht zurück, auf die die Chat App zugreifen kann, z. B. Direktnachrichten und Slash-Befehle, mit denen die Chat App aufgerufen wird.
  • https://www.googleapis.com/auth/chat.app.messages.readonly mit Administratorgenehmigung (verfügbar in der Entwicklervorschau). Wenn Sie diesen Authentifizierungsbereich verwenden, gibt diese Methode Details zu einer öffentlichen Nachricht in einem Bereich zurück.

• Nutzerauthentifizierung mit einem der folgenden Autorisierungsbereiche:

  • https://www.googleapis.com/auth/chat.messages.readonly
  • https://www.googleapis.com/auth/chat.messages

Hinweis: Möglicherweise wird eine Nachricht von einem blockierten Mitglied oder Gruppenbereich zurückgegeben.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

• https://www.googleapis.com/auth/chat.bot
• https://www.googleapis.com/auth/chat.messages
• https://www.googleapis.com/auth/chat.messages.readonly
• https://www.googleapis.com/auth/chat.app.messages.readonly

Weitere Informationen finden Sie im Autorisierungsleitfaden.

rpc GetSpace(GetSpaceRequest) returns (Space)

Gibt Details zu einem Gruppenbereich zurück. Ein Beispiel finden Sie unter Details zu einem Gruppenbereich abrufen.

Unterstützt die folgenden Arten der Authentifizierung:

• App-Authentifizierung mit einem der folgenden Autorisierungsbereiche:

  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.app.spaces mit Administratorgenehmigung

• Nutzerauthentifizierung mit einem der folgenden Autorisierungsbereiche:

  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.spaces
  • Bei der Nutzerauthentifizierung werden Administratorberechtigungen gewährt, wenn ein Administratorkonto authentifiziert wird, use_admin_access gleich true ist und einer der folgenden Autorisierungsbereiche verwendet wird:
    • https://www.googleapis.com/auth/chat.admin.spaces.readonly
    • https://www.googleapis.com/auth/chat.admin.spaces

Für die App-Authentifizierung gelten die folgenden Einschränkungen:

• space.access_settings wird nur ausgefüllt, wenn der Bereich chat.app.spaces verwendet wird.
• space.predefind_permission_settings und space.permission_settings werden nur bei Verwendung des Bereichs chat.app.spaces und nur für von der App erstellte Gruppenbereiche ausgefüllt.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

• https://www.googleapis.com/auth/chat.admin.spaces
• https://www.googleapis.com/auth/chat.admin.spaces.readonly
• https://www.googleapis.com/auth/chat.spaces
• https://www.googleapis.com/auth/chat.spaces.readonly
• https://www.googleapis.com/auth/chat.bot
• https://www.googleapis.com/auth/chat.app.spaces

Weitere Informationen finden Sie im Autorisierungsleitfaden.

rpc GetSpaceEvent(GetSpaceEventRequest) returns (