Package google.chat.v1

Index

ChatService

Ermöglicht Entwicklern, Chat-Apps und Integrationen auf der Google Chat-Plattform zu erstellen.

CompleteImportSpace

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

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

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:

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

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.

Nachricht mit App-Authentifizierung gesendet

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.

Nachricht mit Nutzerauthentifizierung gesendet

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

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

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

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

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

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

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

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

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

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

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

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

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

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:

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

rpc GetSpaceEvent(GetSpaceEventRequest) returns (SpaceEvent)

Gibt ein Ereignis aus einem Google Chat-Gruppenbereich zurück. Die Ereignisnutzlast enthält die aktuelle Version der geänderten Ressource. Wenn Sie beispielsweise ein Ereignis zu einer neuen Nachricht anfordern, die Nachricht aber später aktualisiert wird, gibt der Server die aktualisierte Message-Ressource in der Ereignisnutzlast zurück.

Hinweis: Das Feld permissionSettings wird in den Space-Ereignisdaten für diese Anfrage nicht im Space-Objekt zurückgegeben.

Unterstützt die folgenden Arten der Authentifizierung mit einem Autorisierungsbereich, der zum Lesen der angeforderten Daten geeignet ist:

  • App-Authentifizierung mit Administratorgenehmigung in der Developer Preview mit einem der folgenden Autorisierungsbereiche:

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

  • Nutzerauthentifizierung mit einem der folgenden Autorisierungsbereiche:

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

Damit ein Ereignis empfangen werden kann, muss der authentifizierte Aufrufer Mitglied des Gruppenbereichs sein.

Ein Beispiel finden Sie unter Details zu einem Termin aus einem Google Chat-Gruppenbereich abrufen.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

  • https://www.googleapis.com/auth/chat.app.memberships
  • https://www.googleapis.com/auth/chat.app.messages.readonly
  • https://www.googleapis.com/auth/chat.app.spaces
  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.readonly
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.readonly
  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages.reactions.readonly

Weitere Informationen finden Sie im Autorisierungsleitfaden.
GetSpaceNotificationSetting

rpc GetSpaceNotificationSetting(GetSpaceNotificationSettingRequest) returns (SpaceNotificationSetting)

Ruft die Einstellung für Gruppenbereichsbenachrichtigungen ab. Ein Beispiel finden Sie unter Benachrichtigungseinstellung des Anrufers für den Bereich abrufen.

Erfordert Nutzerauthentifizierung mit dem Autorisierungsbereich:

  • https://www.googleapis.com/auth/chat.users.spacesettings
Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

  • https://www.googleapis.com/auth/chat.users.spacesettings

Weitere Informationen finden Sie im Autorisierungsleitfaden.
GetSpaceReadState

rpc GetSpaceReadState(GetSpaceReadStateRequest) returns (SpaceReadState)

Gibt Details zum Lesestatus eines Nutzers in einem Gruppenbereich zurück, mit denen gelesene und ungelesene Nachrichten identifiziert werden können. Ein Beispiel finden Sie unter Details zum Lesestatus eines Nutzers in einem Bereich abrufen.

Erfordert Nutzerauthentifizierung mit einem der folgenden Autorisierungsbereiche:

  • https://www.googleapis.com/auth/chat.users.readstate.readonly
  • https://www.googleapis.com/auth/chat.users.readstate
Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

  • https://www.googleapis.com/auth/chat.users.readstate
  • https://www.googleapis.com/auth/chat.users.readstate.readonly

Weitere Informationen finden Sie im Autorisierungsleitfaden.
GetThreadReadState

rpc GetThreadReadState(GetThreadReadStateRequest) returns (ThreadReadState)

Gibt Details zum Lesestatus eines Nutzers in einem Thread zurück, mit denen gelesene und ungelesene Nachrichten identifiziert werden. Ein Beispiel finden Sie unter Details zum Lesestatus eines Threads eines Nutzers abrufen.

Erfordert Nutzerauthentifizierung mit einem der folgenden Autorisierungsbereiche:

  • https://www.googleapis.com/auth/chat.users.readstate.readonly
  • https://www.googleapis.com/auth/chat.users.readstate
Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

  • https://www.googleapis.com/auth/chat.users.readstate
  • https://www.googleapis.com/auth/chat.users.readstate.readonly

Weitere Informationen finden Sie im Autorisierungsleitfaden.
ListCustomEmojis

rpc ListCustomEmojis(ListCustomEmojisRequest) returns (ListCustomEmojisResponse)

Listet benutzerdefinierte Emojis auf, die für den authentifizierten Nutzer sichtbar sind.

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

rpc ListMemberships(ListMembershipsRequest) returns (ListMembershipsResponse)

Listet Mitgliedschaften in einem Gruppenbereich auf. Ein Beispiel finden Sie unter Nutzer und Google Chat-Apps in einem Gruppenbereich auflisten. Wenn Sie Mitgliedschaften mit App-Authentifizierung auflisten, werden Mitgliedschaften in Gruppenbereichen aufgeführt, auf die die Chat-App Zugriff hat. Mitgliedschaften in Chat-Apps, einschließlich der eigenen, werden jedoch ausgeschlossen. Wenn Sie Mitgliedschaften mit Nutzerauthentifizierung auflisten, werden Mitgliedschaften in Bereichen aufgeführt, auf die der authentifizierte Nutzer Zugriff hat.

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
    • https://www.googleapis.com/auth/chat.import (nur Gruppenbereiche im Importmodus)
    • 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.import
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.readonly

Weitere Informationen finden Sie im Autorisierungsleitfaden.
ListMessages

rpc ListMessages(ListMessagesRequest) returns (ListMessagesResponse)

Listet Nachrichten in einem Gruppenbereich auf, in dem der Anrufer Mitglied ist, einschließlich Nachrichten von blockierten Mitgliedern und Gruppenbereichen. Systemnachrichten, z. B. Nachrichten, in denen neue Gruppenbereichsmitglieder angekündigt werden, sind nicht enthalten. Wenn Sie Nachrichten aus einem Gruppenbereich ohne Nachrichten auflisten, ist die Antwort ein leeres Objekt. Bei Verwendung einer REST-/HTTP-Schnittstelle enthält die Antwort ein leeres JSON-Objekt, {}. Ein Beispiel finden Sie unter Nachrichten auflisten.

Unterstützt die folgenden Arten der Authentifizierung:

  • App-Authentifizierung mit Administratorgenehmigung in der Developer Preview mit dem Autorisierungsbereich:

    • https://www.googleapis.com/auth/chat.app.messages.readonly. Wenn Sie diesen Authentifizierungsbereich verwenden, werden mit dieser Methode nur öffentliche Nachrichten in einem Bereich zurückgegeben. Private Nachrichten sind nicht enthalten.

  • Nutzerauthentifizierung mit einem der folgenden Autorisierungsbereiche:

    • https://www.googleapis.com/auth/chat.messages.readonly
    • 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.readonly
  • https://www.googleapis.com/auth/chat.app.messages.readonly

Weitere Informationen finden Sie im Autorisierungsleitfaden.
ListReactions

rpc ListReactions(ListReactionsRequest) returns (ListReactionsResponse)

Listet Reaktionen auf eine Nachricht auf. Ein Beispiel finden Sie unter Reaktionen für eine Nachricht auflisten.

Erfordert Nutzerauthentifizierung mit einem der folgenden Autorisierungsbereiche:

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

Erfordert einen der folgenden OAuth-Bereiche:

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

Weitere Informationen finden Sie im Autorisierungsleitfaden.
ListSpaceEvents

rpc ListSpaceEvents(ListSpaceEventsRequest) returns (ListSpaceEventsResponse)

Listet Ereignisse aus einem Google Chat-Bereich auf. Für jedes Ereignis enthält die Nutzlast die aktuelle Version der Chat-Ressource. Wenn Sie beispielsweise Ereignisse zu neuen Projektbereichsmitgliedern auflisten, gibt der Server Membership-Ressourcen mit den neuesten Mitgliedschaftsdetails zurück. Wenn im angeforderten Zeitraum neue Mitglieder entfernt wurden, enthält die Ereignis-Nutzlast eine leere Membership-Ressource.

Unterstützt die folgenden Arten der Authentifizierung mit einem Autorisierungsbereich, der zum Lesen der angeforderten Daten geeignet ist:

  • App-Authentifizierung mit Administratorgenehmigung in der Developer Preview mit einem der folgenden Autorisierungsbereiche:

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

  • Nutzerauthentifizierung mit einem der folgenden Autorisierungsbereiche:

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

Um Ereignisse aufzulisten, muss der authentifizierte Aufrufer Mitglied des Gruppenbereichs sein.

Ein Beispiel finden Sie unter Ereignisse aus einem Google Chat-Gruppenbereich auflisten.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

  • https://www.googleapis.com/auth/chat.app.memberships
  • https://www.googleapis.com/auth/chat.app.messages.readonly
  • https://www.googleapis.com/auth/chat.app.spaces
  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.readonly
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.readonly
  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages.reactions.readonly

Weitere Informationen finden Sie im Autorisierungsleitfaden.
ListSpaces

rpc ListSpaces(ListSpacesRequest) returns (ListSpacesResponse)

Listet Projektbereiche auf, in denen der Aufrufer Mitglied ist. Gruppenchats und Direktnachrichten werden erst angezeigt, wenn die erste Nachricht gesendet wurde. Ein Beispiel finden Sie unter Gruppenbereiche auflisten.

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

Wenn Sie alle benannten Spaces nach Google Workspace-Organisation auflisten möchten, verwenden Sie stattdessen die Methode spaces.search() mit Workspace-Administratorberechtigungen.

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

rpc SearchSpaces(SearchSpacesRequest) returns (SearchSpacesResponse)

Gibt eine Liste von Bereichen in einer Google Workspace-Organisation basierend auf der Suche eines Administrators zurück. Legen Sie in der Anfrage für use_admin_access true fest. Ein Beispiel finden Sie unter Projektbereiche suchen und verwalten.

Erfordert Nutzerauthentifizierung mit Administratorberechtigungen und einen der folgenden Autorisierungsbereiche:

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

Erfordert einen der folgenden OAuth-Bereiche:

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

Weitere Informationen finden Sie im Autorisierungsleitfaden.
SetUpSpace

rpc SetUpSpace(SetUpSpaceRequest) returns (Space)

Erstellt einen Bereich und fügt die angegebenen Nutzer hinzu. Der anrufende Nutzer wird dem Gruppenbereich automatisch hinzugefügt und sollte in der Anfrage nicht als Mitgliedschaft angegeben werden. Ein Beispiel finden Sie unter Gruppenbereich mit ersten Mitgliedern einrichten.

Um die hinzuzufügenden menschlichen Mitglieder anzugeben, fügen Sie Mitgliedschaften mit dem entsprechenden membership.member.name hinzu. Wenn Sie einen menschlichen Nutzer hinzufügen möchten, verwenden Sie users/{user}, wobei {user} die E-Mail-Adresse des Nutzers sein kann. Für Nutzer in derselben Workspace-Organisation kann {user} auch die id für die Person aus der People API oder die id für den Nutzer in der Directory API sein. Wenn die Personenprofil-ID der People API für [email protected] beispielsweise 123456789 ist, können Sie den Nutzer dem Bereich hinzufügen, indem Sie membership.member.name auf users/[email protected] oder users/123456789 festlegen.

Wenn Sie die hinzuzufügenden Google-Gruppen angeben möchten, fügen Sie Mitgliedschaften mit dem entsprechenden membership.group_member.name hinzu. Wenn Sie eine Google-Gruppe hinzufügen oder einladen möchten, verwenden Sie groups/{group}, wobei {group} die id für die Gruppe aus der Cloud Identity Groups API ist. Mit der Cloud Identity Groups Lookup API können Sie beispielsweise die ID 123456789 für die Gruppen-E-Mail-Adresse [email protected] abrufen und die Gruppe dann dem Bereich hinzufügen, indem Sie membership.group_member.name auf groups/123456789 festlegen. Gruppen-E-Mails werden nicht unterstützt und Google-Gruppen können nur als Mitglieder in benannten Gruppenbereichen hinzugefügt werden.

Wenn der Anrufer in einem benannten Gruppenbereich oder Gruppenchat einige Mitglieder blockiert oder von einigen Mitgliedern blockiert wird oder nicht die Berechtigung hat, einige Mitglieder hinzuzufügen, werden diese Mitglieder dem erstellten Gruppenbereich nicht hinzugefügt.

Wenn Sie eine Direktnachricht zwischen dem anrufenden Nutzer und einem anderen menschlichen Nutzer erstellen möchten, geben Sie genau eine Mitgliedschaft an, die den menschlichen Nutzer repräsentiert. Wenn ein Nutzer den anderen blockiert, schlägt die Anfrage fehl und die Direktnachricht wird nicht erstellt.

Wenn Sie eine DM zwischen dem anrufenden Nutzer und der anrufenden App erstellen möchten, legen Sie Space.singleUserBotDm auf true fest und geben Sie keine Mitgliedschaften an. Mit dieser Methode können Sie nur eine DM mit der Anruf-App einrichten. Wenn Sie die Anruf-App als Mitglied eines Gruppenbereichs oder einer vorhandenen DM zwischen zwei menschlichen Nutzern hinzufügen möchten, lesen Sie den Hilfeartikel Nutzer oder App in einen Gruppenbereich einladen oder hinzufügen.

Wenn zwischen zwei Nutzern bereits eine DM vorhanden ist, wird die vorhandene DM zurückgegeben, auch wenn einer der Nutzer den anderen zum Zeitpunkt der Anfrage blockiert.

Spaces mit verschachtelten Antworten werden nicht unterstützt. Wenn Sie beim Einrichten eines Gruppenbereichs die Fehlermeldung ALREADY_EXISTS erhalten, versuchen Sie es mit einem anderen displayName. Möglicherweise wird dieser Anzeigename bereits für einen vorhandenen Gruppenbereich in der Google Workspace-Organisation verwendet.

Erfordert Nutzerauthentifizierung mit einem der folgenden Autorisierungsbereiche:

  • https://www.googleapis.com/auth/chat.spaces.create
  • 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.create

Weitere Informationen finden Sie im Autorisierungsleitfaden.
UpdateMembership

rpc UpdateMembership(UpdateMembershipRequest) returns (Membership)

Aktualisiert eine Mitgliedschaft. Ein Beispiel finden Sie unter Mitgliedschaft eines Nutzers in einem Gruppenbereich aktualisieren.

Unterstützt die folgenden Arten der Authentifizierung:

  • App-Authentifizierung mit Administratorgenehmigung und dem Autorisierungsbereich:

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

  • Nutzerauthentifizierung mit einem der folgenden Autorisierungsbereiche:

    • https://www.googleapis.com/auth/chat.memberships
    • 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
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

Weitere Informationen finden Sie im Autorisierungsleitfaden.
UpdateMessage

rpc UpdateMessage(UpdateMessageRequest) returns (Message)

Aktualisiert eine Nachricht. Es gibt einen Unterschied zwischen den Methoden patch und update. Bei der Methode patch wird eine patch-Anfrage verwendet, bei der Methode update eine put-Anfrage. Wir empfehlen die Verwendung der Methode patch. Ein Beispiel finden Sie unter Nachricht aktualisieren.

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 aktualisiert 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.
UpdateSpace

rpc UpdateSpace(UpdateSpaceRequest) returns (Space)

Aktualisiert einen Gruppenbereich. Ein Beispiel finden Sie unter Bereich aktualisieren.

Wenn Sie das Feld displayName aktualisieren und die Fehlermeldung ALREADY_EXISTS erhalten, versuchen Sie es mit einem anderen Anzeigenamen. Möglicherweise wird dieser Anzeigename bereits für einen vorhandenen Gruppenbereich in der Google Workspace-Organisation verwendet.

Unterstützt die folgenden Arten der Authentifizierung:

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

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

  • Nutzerauthentifizierung mit einem der folgenden Autorisierungsbereiche:

    • https://www.googleapis.com/auth/chat.spaces
    • https://www.googleapis.com/auth/chat.import (nur Gruppenbereiche im Importmodus)
    • Bei der Nutzerauthentifizierung werden Administratorberechtigungen erteilt, wenn ein Administratorkonto authentifiziert wird, use_admin_access = true und die folgenden Autorisierungsbereiche verwendet werden:
      • https://www.googleapis.com/auth/chat.admin.spaces

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

  • Um space.predefined_permission_settings oder space.permission_settings zu aktualisieren, muss die App der Ersteller des Gruppenbereichs sein.
  • Das Aktualisieren der space.access_settings.audience wird für die App-Authentifizierung nicht unterstützt.
Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

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

Weitere Informationen finden Sie im Autorisierungsleitfaden.
UpdateSpaceNotificationSetting

rpc UpdateSpaceNotificationSetting(UpdateSpaceNotificationSettingRequest) returns (SpaceNotificationSetting)

Aktualisiert die Benachrichtigungseinstellung für den Gruppenbereich. Ein Beispiel finden Sie unter Benachrichtigungseinstellung des Anrufers für den Gruppenbereich aktualisieren.

Erfordert Nutzerauthentifizierung mit dem Autorisierungsbereich:

  • https://www.googleapis.com/auth/chat.users.spacesettings
Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

  • https://www.googleapis.com/auth/chat.users.spacesettings

Weitere Informationen finden Sie im Autorisierungsleitfaden.
UpdateSpaceReadState

rpc UpdateSpaceReadState(UpdateSpaceReadStateRequest) returns (SpaceReadState)

Aktualisiert den Lesestatus eines Nutzers in einem Gruppenbereich, um gelesene und ungelesene Nachrichten zu identifizieren. Ein Beispiel finden Sie unter Lesestatus eines Nutzers für einen Bereich aktualisieren.

Erfordert Nutzerauthentifizierung mit dem Autorisierungsbereich:

  • https://www.googleapis.com/auth/chat.users.readstate
Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

  • https://www.googleapis.com/auth/chat.users.readstate

Weitere Informationen finden Sie im Autorisierungsleitfaden.

AccessoryWidget

Ein oder mehrere interaktive Widgets, die unten in einer Nachricht angezeigt werden. Weitere Informationen finden Sie unter Interaktive Widgets am Ende einer Nachricht hinzufügen.

Felder
Union-Feld action. Der Aktionstyp. Für action ist nur einer der folgenden Werte zulässig:
button_list

ButtonList

Eine Liste mit Schaltflächen.

ActionResponse

Parameter, die eine Chat-App verwenden kann, um zu konfigurieren, wie ihre Antwort gepostet wird.

Felder
type

ResponseType

Nur Eingabe. Der Typ der Chat-App-Antwort.
url

string

Nur Eingabe. URL, über die sich Nutzer authentifizieren oder die Konfiguration vornehmen können. (Nur für Antworttypen vom Typ REQUEST_CONFIG)
dialog_action

DialogAction

Nur Eingabe. Eine Antwort auf ein Interaktionsereignis im Zusammenhang mit einem Dialog. Muss von ResponseType.Dialog begleitet werden.
updated_widget

UpdatedWidget

Nur Eingabe. Die Antwort des aktualisierten Widgets.

ResponseType

Der Typ der Chat-App-Antwort.

Enums
TYPE_UNSPECIFIED Standardtyp, der als NEW_MESSAGE behandelt wird.
NEW_MESSAGE Als neue Nachricht im Thema posten
UPDATE_MESSAGE Aktualisieren Sie die Nachricht der Chat App. Dies ist nur bei einem CARD_CLICKED-Ereignis zulässig, bei dem der Absendertyp der Nachricht BOT ist.
UPDATE_USER_MESSAGE_CARDS Karten in einer Nachricht eines Nutzers aktualisieren Dies ist nur als Reaktion auf ein MESSAGE-Ereignis mit einer übereinstimmenden URL oder ein CARD_CLICKED-Ereignis zulässig, bei dem der Absendertyp der Nachricht HUMAN ist. Text wird ignoriert.
REQUEST_CONFIG Nutzer privat nach zusätzlicher Authentifizierung oder Konfiguration fragen
DIALOG Es wird ein Dialogfeld angezeigt.
UPDATE_WIDGET Abfrage für Optionen zur automatischen Vervollständigung von Widget-Text.

SelectionItems

Liste der Ergebnisse der automatischen Vervollständigung für das Widget.

Felder
items[]

SelectionItem

Ein Array der SelectionItem-Objekte.

UpdatedWidget

Gibt für selectionInput-Widgets Vorschläge zur automatischen Vervollständigung für ein Menü mit Mehrfachauswahl zurück.

Felder
widget

string

Die ID des aktualisierten Widgets. Die ID muss mit der ID des Widgets übereinstimmen, das die Aktualisierungsanfrage ausgelöst hat.
Union-Feld updated_widget. Das Widget wurde als Reaktion auf eine Nutzeraktion aktualisiert. Für updated_widget ist nur einer der folgenden Werte zulässig:
suggestions

SelectionItems

Liste der Ergebnisse der automatischen Vervollständigung für Widgets

ActionStatus

Repräsentiert den Status einer Anfrage zum Aufrufen oder Einreichen eines Dialogfelds.

Felder
status_code

Code

Der Statuscode.
user_facing_message

string

Die Nachricht, die an Nutzer gesendet wird, um sie über den Status ihrer Anfrage zu informieren. Wenn nichts angegeben ist, wird eine allgemeine Nachricht basierend auf status_code gesendet.

Vermerk

Nur Ausgabe. Anmerkungen können dem Nur-Text-Teil der Nachricht oder Chips zugeordnet werden, die mit start_index und length von 0 auf Google Workspace-Ressourcen wie Google Docs oder Google Sheets verweisen. Informationen zum Hinzufügen einer einfachen Formatierung zu einer SMS finden Sie unter SMS formatieren.

Beispiel für einen Nur-Text-Nachrichtentext:

Hello @FooBot how are you!"

Die entsprechenden Metadaten für Anmerkungen:

"annotations":[{
  "type":"USER_MENTION",
  "startIndex":6,
  "length":7,
  "userMention": {
    "user": {
      "name":"users/{user}",
      "displayName":"FooBot",
      "avatarUrl":"https://goo.gl/aeDtrS",
      "type":"BOT"
    },
    "type":"MENTION"
   }
}]
Felder
type

AnnotationType

Der Typ dieser Annotation.
length

int32

Länge des Teilstrings im Nur-Text-Nachrichtentext, dem diese Anmerkung entspricht. Wenn nicht vorhanden, wird eine Länge von 0 angegeben.
start_index

int32

0-basierter Startindex (einschließlich) im Nur-Text-Nachrichtentext, dem diese Anmerkung entspricht.
Union-Feld metadata. Zusätzliche Metadaten zur Anmerkung. Für metadata ist nur einer der folgenden Werte zulässig:
user_mention

UserMentionMetadata

Die Metadaten der Erwähnung des Nutzers.
slash_command

SlashCommandMetadata

Die Metadaten für einen Slash-Befehl.
custom_emoji_metadata

CustomEmojiMetadata

Die Metadaten für ein benutzerdefiniertes Emoji.

AnnotationType

Typ der Annotation.

Enums
ANNOTATION_TYPE_UNSPECIFIED Standardwert für die Enumeration. Nicht verwenden.
USER_MENTION Ein Nutzer wird erwähnt.
SLASH_COMMAND Ein Slash-Befehl wird aufgerufen.
CUSTOM_EMOJI Eine Anmerkung mit einem benutzerdefinierten Emoji.

AppCommandMetadata

Metadaten zu einem Chat-App-Befehl.

Felder
app_command_id

int32

Die ID für den in der Chat API-Konfiguration angegebenen Befehl.
app_command_type

AppCommandType

Der Typ des Chat-App-Befehls.

AppCommandType

Der Typ des Chat-App-Befehls. Weitere Informationen finden Sie unter Arten von Chat-App-Befehlen.

Enums
APP_COMMAND_TYPE_UNSPECIFIED Standardwert. Nicht angegeben
SLASH_COMMAND Ein Slash-Befehl. Der Nutzer sendet den Befehl in einer Chatnachricht.
QUICK_COMMAND Ein Schnellbefehl Der Nutzer wählt den Befehl im Chatmenü im Antwortbereich der Nachricht aus.

AttachedGif

Ein GIF-Bild, das durch eine URL angegeben wird.

Felder
uri

string

Nur Ausgabe. Die URL, unter der das GIF-Bild gehostet wird.

Anhang

Ein Anhang in Google Chat.

Felder
name

string

Optional. Ressourcenname des Anhangs im Format spaces/{space}/messages/{message}/attachments/{attachment}.
content_name

string

Nur Ausgabe. Der ursprüngliche Dateiname des Inhalts, nicht der vollständige Pfad.
content_type

string

Nur Ausgabe. Der Inhaltstyp (MIME-Typ) der Datei.
thumbnail_uri

string

Nur Ausgabe. Die Thumbnail-URL, die für die Vorschau des Anhangs für einen menschlichen Nutzer verwendet werden soll. Chat-Apps sollten diese URL nicht zum Herunterladen von Anhängen verwenden.
download_uri

string

Nur Ausgabe. Die Download-URL, die verwendet werden sollte, damit ein menschlicher Nutzer den Anhang herunterladen kann. Chat-Apps sollten diese URL nicht zum Herunterladen von Anhängen verwenden.
source

Source

Nur Ausgabe. Die Quelle des Anhangs.
Union-Feld data_ref. Der Datenverweis auf den Anhang. Für data_ref ist nur einer der folgenden Werte zulässig:
attachment_data_ref

AttachmentDataRef

Optional. Ein Verweis auf die Attachment-Daten. Dieses Feld wird verwendet, um Nachrichten mit Anhängen zu erstellen oder zu aktualisieren oder um mit der Media API die Anhangsdaten herunterzuladen.
drive_data_ref

DriveDataRef

Nur Ausgabe. Ein Verweis auf den Google Drive-Anhang. Dieses Feld wird mit der Google Drive API verwendet.

Quelle

Die Quelle des Anhangs.

Enums
SOURCE_UNSPECIFIED Reserviert.
DRIVE_FILE Die Datei ist eine Google Drive-Datei.
UPLOADED_CONTENT Die Datei wird in Chat hochgeladen.

AttachmentDataRef

Ein Verweis auf die Attachment-Daten.

Felder
resource_name

string

Optional. Der Ressourcenname der Anhangsdaten. Dieses Feld wird mit der Media API verwendet, um die Anhänge herunterzuladen.
attachment_upload_token

string

Optional. Opakes Token mit einem Verweis auf einen hochgeladenen Anhang. Wird von Clients als undurchsichtiger String behandelt und zum Erstellen oder Aktualisieren von Chatnachrichten mit Anhängen verwendet.

CalendarEventLinkData

Daten für Links zu Kalenderterminen.

Felder
calendar_id

string

Die Kalender-ID des verknüpften Kalenders.
event_id

string

Die Ereignis-ID des verknüpften Kalendertermins.

CardWithId

Eine Karte in einer Google Chat-Nachricht.

Nur Chat-Apps können Karten erstellen. Wenn Ihre Chat-App als Nutzer authentifiziert wird, darf die Nachricht keine Karten enthalten.

Mit dem Card Builder können Sie Karten entwerfen und in der Vorschau ansehen.

Card Builder öffnen

Felder
card_id

string

Erforderlich, wenn die Nachricht mehrere Karten enthält. Eine eindeutige Kennung für eine Karte in einer Nachricht.
card

Card

Eine Infokarte Die maximale Größe beträgt 32 KB.

ChatSpaceLinkData

Daten für Links zu Chatbereichen.

Felder
space

string

Der Bereich der verknüpften Chatbereich-Ressource.

Format: spaces/{space}
thread

string

Der Thread der verknüpften Chatbereich-Ressource.

Format: spaces/{space}/threads/{thread}
message

string

Die Nachricht der verknüpften Chatbereich-Ressource.

Format: spaces/{space}/messages/{message}

CompleteImportSpaceRequest

Anfragenachricht zum Abschließen des Importvorgangs für einen Gruppenbereich

Felder
name

string

Erforderlich. Ressourcenname des Gruppenbereichs im Importmodus.

Format: spaces/{space}

CompleteImportSpaceResponse

Antwortnachricht zum Abschließen des Importvorgangs für einen Gruppenbereich.

Felder
space

Space

Der Gruppenbereich im Importmodus.

ContextualAddOnMarkup

Dieser Typ hat keine Felder.

Das Markup, mit dem Entwickler den Inhalt eines kontextbezogenen Add-ons angeben können.

Infokarte

Eine Karte ist ein UI-Element, das UI-Widgets wie Text und Bilder enthalten kann.

Felder
header

CardHeader

Die Kopfzeile der Karte. Eine Kopfzeile enthält in der Regel einen Titel und ein Bild.
sections[]

Section

Abschnitte sind durch eine Trennlinie getrennt.
card_actions[]

CardAction

Die Aktionen dieser Karte.
name

string

Name der Karte.

CardAction

Eine Kartenaktion ist die Aktion, die mit der Karte verknüpft ist. Bei einer Rechnungskarte wäre eine typische Aktion: Rechnung löschen, Rechnung per E-Mail senden oder Rechnung im Browser öffnen.

Wird von Google Chat-Apps nicht unterstützt.

Felder
action_label

string

Das Label wurde früher im Aktionsmenüpunkt angezeigt.
on_click

OnClick

Die „onclick“-Aktion für diese Aufgabe.

CardHeader

Felder
title

string

Der Titel muss angegeben werden. Der Header hat eine feste Höhe. Wenn sowohl ein Titel als auch ein Untertitel angegeben sind, nimmt jeder eine Zeile ein. Wenn nur der Titel angegeben ist, belegt er beide Zeilen.
subtitle

string

Der Untertitel der Kartenüberschrift.
image_style

ImageStyle

Der Typ des Bildes, z. B. quadratischer oder kreisförmiger Rahmen.
image_url

string

Die URL des Bildes in der Kopfzeile der Karte.

ImageStyle

Enums
IMAGE_STYLE_UNSPECIFIED
IMAGE Quadratischer Rahmen
AVATAR Kreisförmiger Rahmen

Bereich

Ein Abschnitt enthält eine Sammlung von Widgets, die in der angegebenen Reihenfolge (vertikal) gerendert werden. Karten haben auf allen Plattformen eine schmale, feste Breite. Daher sind derzeit keine Layout-Properties (z. B. „float“) erforderlich.

Felder
header

string

Die Überschrift des Abschnitts. Formatierter Text wird unterstützt. Weitere Informationen zum Formatieren von Text finden Sie unter Text in Google Chat-Apps formatieren und Text in Google Workspace-Add-ons formatieren.
widgets[]

WidgetMarkup

Ein Bereich muss mindestens ein Widget enthalten.

CreateCustomEmojiRequest

Eine Anfrage zum Erstellen eines benutzerdefinierten Emojis.

Felder
custom_emoji

CustomEmoji

Erforderlich. Das benutzerdefinierte Emoji, das erstellt werden soll.

CreateMembershipRequest

Anfragenachricht zum Erstellen einer Mitgliedschaft.

Felder
parent

string

Erforderlich. Der Ressourcenname des Spaces, für den die Mitgliedschaft erstellt werden soll.

Format: spaces/{space}
membership

Membership

Erforderlich. Die zu erstellende Mitgliedschaftsbeziehung.

Das Feld memberType muss einen Nutzer mit den Feldern user.name und user.type enthalten. Der Server weist einen Ressourcennamen zu und überschreibt alle angegebenen Werte.

Wenn eine Chat-App eine Mitgliedschaftsbeziehung für einen menschlichen Nutzer erstellt, muss sie bestimmte Autorisierungsbereiche verwenden und bestimmte Werte für bestimmte Felder festlegen:

  • Bei der Authentifizierung als Nutzer ist der Autorisierungsbereich chat.memberships erforderlich.

  • Bei der Authentifizierung als App ist der Autorisierungsbereich chat.app.memberships erforderlich.

  • Legen Sie user.type auf HUMAN und user.name im Format users/{user} fest. {user} kann die E‑Mail-Adresse des Nutzers sein. Für Nutzer in derselben Workspace-Organisation kann {user} auch die id der Person aus der People API oder die id für den Nutzer in der Directory API sein. Wenn die Personenprofil-ID der People API für [email protected] beispielsweise 123456789 ist, können Sie den Nutzer dem Bereich hinzufügen, indem Sie membership.member.name auf users/[email protected] oder users/123456789 festlegen.

Wenn Sie Nutzer einladen, die nicht zur Workspace-Organisation gehören, der der Gruppenbereich gehört, ist eine Nutzerauthentifizierung erforderlich.

Wenn eine Chat-App eine Mitgliedschaftsbeziehung für sich selbst erstellt, muss sie sich als Nutzer authentifizieren, den Bereich chat.memberships.app verwenden, user.type auf BOT und user.name auf users/app festlegen.
use_admin_access

bool

Optional. Wenn true, wird die Methode mit den Administratorberechtigungen des Google Workspace-Nutzers ausgeführt.

Der anrufende Nutzer muss ein Google Workspace-Administrator mit der Berechtigung Unterhaltungen in Chats und Gruppenbereichen verwalten sein.

Erfordert den chat.admin.memberships OAuth 2.0-Bereich.

Das Erstellen von App-Mitgliedschaften oder Mitgliedschaften für Nutzer außerhalb der Google Workspace-Organisation des Administrators wird mit Administratorzugriff nicht unterstützt.

CreateMessageRequest

Erstellt eine Nachricht.

Felder
parent

string

Erforderlich. Der Ressourcenname des Gruppenbereichs, in dem eine Nachricht erstellt werden soll.

Format: spaces/{space}
message

Message

Erforderlich. Nachrichtentext.
thread_key
(deprecated)

string

Optional. Verworfen: Verwenden Sie stattdessen thread.thread_key. ID für den Thread. Es können bis zu 4.000 Zeichen eingegeben werden. Wenn Sie einen Thread starten oder ihm etwas hinzufügen möchten, erstellen Sie eine Nachricht und geben Sie ein threadKey oder das thread.name an. Beispiele für die Verwendung finden Sie unter Nachrichtenthread starten oder darauf antworten.
request_id

string

Optional. Eine eindeutige Anfrage-ID für diese Nachricht. Wenn Sie eine vorhandene Anforderungs-ID angeben, wird die mit dieser ID erstellte Nachricht zurückgegeben, anstatt eine neue Nachricht zu erstellen.
message_reply_option

MessageReplyOption

Optional. Gibt an, ob mit einer Nachricht ein Thread gestartet oder auf einen Thread geantwortet wird. Wird nur in benannten Bereichen unterstützt.

Beim Reagieren auf Nutzerinteraktionen wird dieses Feld ignoriert. Bei Interaktionen in einem Thread wird die Antwort im selben Thread erstellt. Andernfalls wird die Antwort als neuer Thread erstellt.
message_id

string

Optional. Eine benutzerdefinierte ID für eine Nachricht. Mit dieser Methode können Chat-Apps eine Nachricht abrufen, aktualisieren oder löschen, ohne die vom System zugewiesene ID im Ressourcennamen der Nachricht (im Feld name der Nachricht dargestellt) speichern zu müssen.

Der Wert für dieses Feld muss die folgenden Anforderungen erfüllen:

  • Beginnt mit client-. Beispiel: client-custom-name ist eine gültige benutzerdefinierte ID, custom-name jedoch nicht.
  • Enthält bis zu 63 Zeichen und nur Kleinbuchstaben, Ziffern und Bindestriche.
  • Sie ist innerhalb eines Bereichs eindeutig. Eine Chat-App kann nicht dieselbe benutzerdefinierte ID für verschiedene Nachrichten verwenden.

Weitere Informationen

MessageReplyOption

Gibt an, wie auf eine Nachricht geantwortet werden soll. Möglicherweise werden in Zukunft weitere Bundesstaaten hinzugefügt.

Enums
MESSAGE_REPLY_OPTION_UNSPECIFIED Standard. Startet einen neuen Thread. Wenn Sie diese Option verwenden, werden alle enthaltenen thread ID- oder thread_key-Elemente ignoriert.
REPLY_MESSAGE_FALLBACK_TO_NEW_THREAD Erstellt die Nachricht als Antwort auf den Thread, der durch thread ID oder thread_key angegeben wird. Wenn das nicht möglich ist, wird mit der Nachricht stattdessen ein neuer Thread gestartet.
REPLY_MESSAGE_OR_FAIL Erstellt die Nachricht als Antwort auf den Thread, der durch thread ID oder thread_key angegeben wird. Wenn ein neuer thread_key verwendet wird, wird ein neuer Thread erstellt. Wenn die Nachrichtenerstellung fehlschlägt, wird stattdessen ein NOT_FOUND-Fehler zurückgegeben.

CreateReactionRequest

Erstellt eine Reaktion auf eine Nachricht.

Felder
parent

string

Erforderlich. Die Nachricht, in der die Reaktion erstellt wird.

Format: spaces/{space}/messages/{message}
reaction

Reaction

Erforderlich. Die zu erstellende Reaktion.

CreateSpaceRequest

Eine Anfrage zum Erstellen eines benannten Gruppenbereichs ohne Mitglieder.

Felder
space

Space

Erforderlich. Die Felder displayName und spaceType müssen ausgefüllt werden. Es werden nur SpaceType.SPACE und SpaceType.GROUP_CHAT unterstützt. SpaceType.GROUP_CHAT kann nur verwendet werden, wenn importMode auf „true“ gesetzt ist.

Wenn Sie die Fehlermeldung ALREADY_EXISTS erhalten, versuchen Sie es mit einem anderen displayName. Möglicherweise wird dieser Anzeigename bereits für einen vorhandenen Gruppenbereich in der Google Workspace-Organisation verwendet.

Der Bereich name wird auf dem Server zugewiesen. Alle Angaben in diesem Feld werden ignoriert.
request_id

string

Optional. Eine eindeutige Kennung für diese Anfrage. Eine zufällige UUID wird empfohlen. Wenn Sie eine vorhandene Anfrage-ID angeben, wird der mit dieser ID erstellte Gruppenbereich zurückgegeben, anstatt einen neuen Gruppenbereich zu erstellen. Wenn Sie eine vorhandene Anfrage-ID aus derselben Chat-App mit einem anderen authentifizierten Nutzer angeben, wird ein Fehler zurückgegeben.

CustomEmoji

Stellt ein benutzerdefiniertes Emoji dar.

Felder
name

string

ID. Der vom Server zugewiesene Ressourcenname des benutzerdefinierten Emojis.

Format: customEmojis/{customEmoji}
uid

string

Nur Ausgabe. Eindeutiger Schlüssel für die benutzerdefinierte Emoji-Ressource.
emoji_name

string

Optional. Nicht veränderbar. Der vom Nutzer angegebene Name für das benutzerdefinierte Emoji, der innerhalb der Organisation eindeutig ist.

Erforderlich, wenn das benutzerdefinierte Emoji erstellt wird, ansonsten nur Ausgabe.

Emoji-Namen müssen mit einem Doppelpunkt beginnen und enden, in Kleinbuchstaben geschrieben werden und dürfen nur alphanumerische Zeichen, Bindestriche und Unterstriche enthalten. Wörter werden durch Binde- und Unterstriche getrennt. Diese Zeichen dürfen nicht mehrmals hintereinander stehen.

Beispiel: :valid-emoji-name:
temporary_image_uri

string

Nur Ausgabe. Eine temporäre Bild-URL für das benutzerdefinierte Emoji, die mindestens 10 Minuten lang gültig ist. Hinweis: Dieses Feld wird in der Antwort nicht ausgefüllt, wenn das benutzerdefinierte Emoji erstellt wird.
payload

CustomEmojiPayload

Optional. Nur Eingabe. Nutzlastdaten. Erforderlich beim Erstellen des benutzerdefinierten Emojis.

CustomEmojiPayload

Nutzlastdaten für das benutzerdefinierte Emoji.

Felder
file_content

bytes

Erforderlich. Nur Eingabe. Das für das benutzerdefinierte Emoji verwendete Bild.

Die Nutzlast darf nicht größer als 256 KB sein und das Bild muss quadratisch und zwischen 64 und 500 Pixel groß sein. Die Einschränkungen können sich ändern.
filename

string

Erforderlich. Nur Eingabe. Der Name der Bilddatei.

Unterstützte Dateiendungen: .png, .jpg, .gif.

CustomEmojiMetadata

Anmerkungsmetadaten für benutzerdefinierte Emojis.

Felder
custom_emoji

CustomEmoji

Das benutzerdefinierte Emoji.

DeleteCustomEmojiRequest

Anfrage zum Löschen eines benutzerdefinierten Emojis.

Felder
name

string

Erforderlich. Ressourcenname des zu löschenden benutzerdefinierten Emojis.

Format: customEmojis/{customEmoji}

Sie können den Emoji-Namen als Alias für {customEmoji} verwenden. Beispiel: customEmojis/:example-emoji:, wobei :example-emoji: der Emoji-Name für ein benutzerdefiniertes Emoji ist.

DeleteMembershipRequest

Anfrage zum Löschen einer Mitgliedschaft in einem Gruppenbereich.

Felder
name

string

Erforderlich. Ressourcenname der zu löschenden Mitgliedschaft. Chat-Apps können die Mitgliedschaften von menschlichen Nutzern oder ihre eigenen Mitgliedschaften löschen. Chat-Apps können keine Mitgliedschaften anderer Apps löschen.

Beim Löschen einer Mitgliedschaft eines Nutzers ist der Bereich chat.memberships mit Nutzerauthentifizierung oder der Bereich chat.memberships.app mit App-Authentifizierung und dem Format spaces/{space}/members/{member} erforderlich. Sie können die E-Mail-Adresse als Alias für {member} verwenden. Beispiel: spaces/{space}/members/[email protected], wobei [email protected] die E‑Mail-Adresse des Google Chat-Nutzers ist.

Zum Löschen einer App-Mitgliedschaft sind der Bereich chat.memberships.app und das Format spaces/{space}/members/app erforderlich.

Format: spaces/{space}/members/{member} oder spaces/{space}/members/app.
use_admin_access

bool

Optional. Wenn true, wird die Methode mit den Administratorberechtigungen des Google Workspace-Nutzers ausgeführt.

Der anrufende Nutzer muss ein Google Workspace-Administrator mit der Berechtigung Unterhaltungen in Chats und Gruppenbereichen verwalten sein.

Erfordert den chat.admin.memberships OAuth 2.0-Bereich.

Das Löschen von App-Mitgliedschaften in einem Gruppenbereich wird mit Administratorzugriff nicht unterstützt.

DeleteMessageRequest

Anfrage zum Löschen einer Nachricht.

Felder
name

string

Erforderlich. Ressourcenname der Nachricht.

Format: spaces/{space}/messages/{message}

Wenn Sie eine benutzerdefinierte ID für Ihre Mitteilung festgelegt haben, können Sie den Wert aus dem Feld clientAssignedMessageId für {message} verwenden. Weitere Informationen
force

bool

Optional. Wenn true, werden beim Löschen einer Nachricht auch die zugehörigen Antworten im Thread gelöscht. Wenn false, schlägt das Löschen fehl, wenn eine Nachricht Antworten in einem Thread enthält.

Gilt nur, wenn Sie sich als Nutzer authentifizieren. Hat keine Auswirkungen, wenn die Authentifizierung als Chat-App erfolgt.

DeleteReactionRequest

Löscht eine Reaktion auf eine Nachricht.

Felder
name

string

Erforderlich. Name der zu löschenden Reaktion.

Format: spaces/{space}/messages/{message}/reactions/{reaction}

DeleteSpaceRequest

Anfrage zum Löschen eines Gruppenbereichs.

Felder
name

string

Erforderlich. Ressourcenname des zu löschenden Bereichs.

Format: spaces/{space}
use_admin_access

bool

Optional. Wenn true, wird die Methode mit den Administratorberechtigungen des Google Workspace-Nutzers ausgeführt.

Der anrufende Nutzer muss ein Google Workspace-Administrator mit der Berechtigung Unterhaltungen in Chats und Gruppenbereichen verwalten sein.

Erfordert den chat.admin.delete OAuth 2.0-Bereich.

DeletionMetadata

Informationen zu einer gelöschten Nachricht. Eine Nachricht wird gelöscht, wenn delete_time festgelegt ist.

Felder
deletion_type

DeletionType

Gibt an, wer die Nachricht gelöscht hat.

DeletionType

Wer die Nachricht gelöscht hat und wie sie gelöscht wurde. In Zukunft werden möglicherweise weitere Werte hinzugefügt. Weitere Informationen dazu, wann Nachrichten gelöscht werden können, finden Sie hier.

Enums
DELETION_TYPE_UNSPECIFIED Dieser Wert wird nicht verwendet.
CREATOR Der Nutzer hat seine eigene Nachricht gelöscht.
SPACE_OWNER Ein Administrator des Gruppenbereichs hat die Nachricht gelöscht.
ADMIN Ein Google Workspace-Administrator hat die Nachricht gelöscht. Administratoren können jede Nachricht im Gruppenbereich löschen, auch Nachrichten, die von Mitgliedern des Gruppenbereichs oder von Chat-Apps gesendet wurden.
APP_MESSAGE_EXPIRY Eine Chat-App hat ihre eigene Nachricht gelöscht, als sie abgelaufen ist.
CREATOR_VIA_APP Eine Chat-App hat die Nachricht im Namen des Erstellers gelöscht (mit Nutzerauthentifizierung).
SPACE_OWNER_VIA_APP Eine Chat-App hat die Nachricht im Namen eines Administrators des Gruppenbereichs gelöscht (mit Nutzerauthentifizierung).
SPACE_MEMBER Ein Mitglied des Gruppenbereichs hat die Nachricht gelöscht. Nutzer können von Apps gesendete Nachrichten löschen.

Dialog

Wrapper um den Kartenkörper des Dialogfelds.

Felder
body

Card

Nur Eingabe. Textkörper des Dialogfelds, der in einem Modal gerendert wird. Google Chat-Apps unterstützen die folgenden Kartenentitäten nicht: DateTimePicker, OnChangeAction.

DialogAction

Enthält einen Dialog und einen Statuscode für die Anfrage.

Felder
action_status

ActionStatus

Nur Eingabe. Status einer Anfrage zum Aufrufen oder Einreichen eines Dialogs. Zeigt bei Bedarf einen Status und eine Nachricht für Nutzer an. z. B. im Fall eines Fehlers oder Erfolgs.
Union-Feld action. Auszuführende Aktion. Für action ist nur einer der folgenden Werte zulässig:
dialog

Dialog

Nur Eingabe. Dialog für die Anfrage.

DriveDataRef

Ein Verweis auf die Daten eines Drive-Anhangs.

Felder
drive_file_id

string

Die ID für die Drive-Datei. Mit der Drive API verwenden

DriveLinkData

Daten für Google Drive-Links.

Felder
drive_data_ref

DriveDataRef

Eine DriveDataRef, die auf eine Google Drive-Datei verweist.
mime_type

string

Der MIME-Typ der verknüpften Google Drive-Ressource.

Emoji

Ein Emoji, das als Reaktion auf eine Nachricht verwendet wird.

Felder
Union-Feld content Erforderlich. Der Inhalt des Emojis. Für content ist nur einer der folgenden Werte zulässig:
unicode

string

Optional. Ein einfaches Emoji, das durch einen Unicode-String dargestellt wird.
custom_emoji