Package google.chat.v1

Index

• ChatService (Benutzeroberfläche)
• AccessoryWidget (Meldung)
• ActionResponse (Meldung)
• ActionResponse.ResponseType (Aufzählung)
• ActionResponse.SelectionItems (Meldung)
• ActionResponse.UpdatedWidget (Meldung)
• ActionStatus (Meldung)
• Annotation (Meldung)
• AnnotationType (Aufzählung)
• AppCommandMetadata (Meldung)
• AppCommandMetadata.AppCommandType (Aufzählung)
• AttachedGif (Meldung)
• Attachment (Meldung)
• Attachment.Source (Aufzählung)
• AttachmentDataRef (Meldung)
• CardWithId (Meldung)
• ChatSpaceLinkData (Meldung)
• CompleteImportSpaceRequest (Meldung)
• CompleteImportSpaceResponse (Meldung)
• ContextualAddOnMarkup (Meldung)
• ContextualAddOnMarkup.Card (Meldung)
• ContextualAddOnMarkup.Card.CardAction (Meldung)
• ContextualAddOnMarkup.Card.CardHeader (Meldung)
• ContextualAddOnMarkup.Card.CardHeader.ImageStyle (Aufzählung)
• ContextualAddOnMarkup.Card.Section (Meldung)
• CreateCustomEmojiRequest (Meldung)
• CreateMembershipRequest (Meldung)
• CreateMessageRequest (Meldung)
• CreateMessageRequest.MessageReplyOption (Aufzählung)
• CreateReactionRequest (Meldung)
• CreateSpaceRequest (Meldung)
• CustomEmoji (Meldung)
• CustomEmoji.CustomEmojiPayload (Meldung)
• CustomEmojiMetadata (Meldung)
• DeleteCustomEmojiRequest (Meldung)
• DeleteMembershipRequest (Meldung)
• DeleteMessageRequest (Meldung)
• DeleteReactionRequest (Meldung)
• DeleteSpaceRequest (Meldung)
• DeletionMetadata (Meldung)
• DeletionMetadata.DeletionType (Aufzählung)
• Dialog (Meldung)
• DialogAction (Meldung)
• DriveDataRef (Meldung)
• DriveLinkData (Meldung)
• Emoji (Meldung)
• EmojiReactionSummary (Meldung)
• FindDirectMessageRequest (Meldung)
• GetAttachmentRequest (Meldung)
• GetCustomEmojiRequest (Meldung)
• GetMembershipRequest (Meldung)
• GetMessageRequest (Meldung)
• GetSpaceEventRequest (Meldung)
• GetSpaceNotificationSettingRequest (Meldung)
• GetSpaceReadStateRequest (Meldung)
• GetSpaceRequest (Meldung)
• GetThreadReadStateRequest (Meldung)
• Group (Meldung)
• HistoryState (Aufzählung)
• ListCustomEmojisRequest (Meldung)
• ListCustomEmojisResponse (Meldung)
• ListMembershipsRequest (Meldung)
• ListMembershipsResponse (Meldung)
• ListMessagesRequest (Meldung)
• ListMessagesResponse (Meldung)
• ListReactionsRequest (Meldung)
• ListReactionsResponse (Meldung)
• ListSpaceEventsRequest (Meldung)
• ListSpaceEventsResponse (Meldung)
• ListSpacesRequest (Meldung)
• ListSpacesResponse (Meldung)
• MatchedUrl (Meldung)
• Membership (Meldung)
• Membership.MembershipRole (Option)
• Membership.MembershipState (Option)
• MembershipBatchCreatedEventData (Meldung)
• MembershipBatchDeletedEventData (Meldung)
• MembershipBatchUpdatedEventData (Meldung)
• MembershipCreatedEventData (Meldung)
• MembershipDeletedEventData (Meldung)
• MembershipUpdatedEventData (Meldung)
• Message (Meldung)
• MessageBatchCreatedEventData (Meldung)
• MessageBatchDeletedEventData (Meldung)
• MessageBatchUpdatedEventData (Meldung)
• MessageCreatedEventData (Meldung)
• MessageDeletedEventData (Meldung)
• MessageUpdatedEventData (Meldung)
• QuotedMessageMetadata (Meldung)
• Reaction (Meldung)
• ReactionBatchCreatedEventData (Meldung)
• ReactionBatchDeletedEventData (Meldung)
• ReactionCreatedEventData (Meldung)
• ReactionDeletedEventData (Meldung)
• RichLinkMetadata (Meldung)
• RichLinkMetadata.RichLinkType (Aufzählung)
• SearchSpacesRequest (Meldung)
• SearchSpacesResponse (Meldung)
• SetUpSpaceRequest (Meldung)
• SlashCommand (Meldung)
• SlashCommandMetadata (Meldung)
• SlashCommandMetadata.Type (Aufzählung)
• Space (Meldung)
• Space.AccessSettings (Meldung)
• Space.AccessSettings.AccessState (Aufzählung)
• Space.MembershipCount (Meldung)
• Space.PermissionSetting (Meldung)
• Space.PermissionSettings (Meldung)
• Space.PredefinedPermissionSettings (Aufzählung)
• Space.SpaceDetails (Meldung)
• Space.SpaceThreadingState (Option)
• Space.SpaceType (Option)
• Space.Type (Option)
• SpaceBatchUpdatedEventData (Meldung)
• SpaceEvent (Meldung)
• SpaceNotificationSetting (Meldung)
• SpaceNotificationSetting.MuteSetting (Option)
• SpaceNotificationSetting.NotificationSetting (Option)
• SpaceReadState (Meldung)
• SpaceUpdatedEventData (Meldung)
• Thread (Meldung)
• ThreadReadState (Meldung)
• UpdateMembershipRequest (Meldung)
• UpdateMessageRequest (Meldung)
• UpdateSpaceNotificationSettingRequest (Meldung)
• UpdateSpaceReadStateRequest (Meldung)
• UpdateSpaceRequest (Meldung)
• User (Meldung)
• User.Type (Aufzählung)
• UserMentionMetadata (Meldung)
• UserMentionMetadata.Type (Aufzählung)
• WidgetMarkup (Meldung)
• WidgetMarkup.Button (Meldung)
• WidgetMarkup.FormAction (Meldung)
• WidgetMarkup.FormAction.ActionParameter (Meldung)
• WidgetMarkup.Icon (Aufzählung)
• WidgetMarkup.Image (Meldung)
• WidgetMarkup.ImageButton (Meldung)
• WidgetMarkup.KeyValue (Meldung)
• WidgetMarkup.OnClick (Meldung)
• WidgetMarkup.OpenLink (Meldung)
• WidgetMarkup.TextButton (Meldung)
• WidgetMarkup.TextParagraph (Meldung)

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 in der Developer Preview und der 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 Chat-App zu einem Gruppenbereich hinzufügen 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. 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.

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 in der Developer Preview 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 im 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. Dieser Anzeigename wird möglicherweise bereits für einen 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 in der Developer Preview und der 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 in der Developer Preview und der 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 dem Autorisierungsbereich: https://www.googleapis.com/auth/chat.bot 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.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 dem Autorisierungsbereich: https://www.googleapis.com/auth/chat.bot 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 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: 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.

GetSpaceEvent

rpc GetSpaceEvent(GetSpaceEventRequest) returns (SpaceEvent) Gibt ein Ereignis aus einem Google Chat-Gruppenbereich zurück. Die Ereignis-Nutzlast 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. Erfordert Nutzerauthentifizierung mit einem Autorisierungsbereich, der für das Lesen der angeforderten Daten geeignet ist: 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 abgerufen werden kann, muss der authentifizierte Nutzer Mitglied des Bereichs 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.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 für einen Nutzer 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 der Chat-App selbst 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 dem Autorisierungsbereich: https://www.googleapis.com/auth/chat.bot 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.import 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.

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. 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. Erfordert 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 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 neue Mitglieder während des angeforderten Zeitraums entfernt wurden, enthält die Ereignisnutzlast eine leere Membership-Ressource. Erfordert Nutzerauthentifizierung mit einem Autorisierungsbereich, der für das Lesen der angeforderten Daten geeignet ist: 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 Nutzer Mitglied des Bereichs 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.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. 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 Legen Sie in der Anfrage für use_admin_access true fest. 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 [e-mail] beispielsweise 123456789 ist, können Sie den Nutzer dem Bereich hinzufügen, indem Sie membership.member.name auf users/[e-mail] 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 [e-mail] 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 in der Developer Preview und der 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 in der Developer Preview 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 gleich true ist 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	Zeigt ein Dialogfeld an.
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 für die automatische 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, die dem Nur-Text-Textkörper der Nachricht zugeordnet sind. 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.
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.
rich_link_metadata	RichLinkMetadata Die Metadaten für einen Rich-Link.
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.
RICH_LINK	Eine umfassende Link-Annotation.
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. Die Datenreferenz zum 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.

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üelement angezeigt.
on_click	OnClick Die „onclick“-Aktion für dieses Aktionselement.

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, belegt jeder eine Zeile. Wenn nur der Titel angegeben ist, nimmt er beide Zeilen ein.
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

Abschnitt

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 enthalten, für den die Felder user.name und user.type ausgefüllt sind. 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. Die Authentifizierung als App ist in folgenden Fällen verfügbar: Entwicklervorschau:Im Rahmen des Google Workspace-Entwicklervorschauprogramms verfügbar, das Vorabzugriff auf bestimmte Funktionen bietet. 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 [e-mail] beispielsweise 123456789 ist, können Sie den Nutzer dem Bereich hinzufügen, indem Sie membership.member.name auf users/[e-mail] 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 Dieses Element ist veraltet. 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 eine Nachricht einen Thread startet oder auf einen Thread antwortet. Wird nur in benannten Bereichen unterstützt. Beim Reagieren auf Nutzerinteraktionen wird dieses Feld ignoriert. Bei Interaktionen innerhalb eines Threads 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 Funktion können Lets Chat-Apps Nachrichten abrufen, aktualisieren oder löschen, ohne die vom System zugewiesene ID im Ressourcennamen der Nachricht (im Feld name der Nachricht) 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 Bereichs 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 Kennung. 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 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/[e-mail], wobei [e-mail] 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 Antworten im Thread gelöscht. Wenn false, schlägt das Löschen fehl, wenn eine Nachricht Thread-Antworten hat. 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 (mithilfe der 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	CustomEmoji Ein benutzerdefiniertes Emoji.

EmojiReactionSummary

Die Anzahl der Personen, die mit einem bestimmten Emoji auf eine Nachricht reagiert haben.

Felder
emoji	Emoji Nur Ausgabe. Emoji, die mit den Reaktionen verknüpft sind.
reaction_count	int32 Nur Ausgabe. Die Gesamtzahl der Reaktionen mit dem zugehörigen Emoji.

FindDirectMessageRequest

Ein Request zum Abrufen eines Direktnachrichten-Gruppenbereichs basierend auf der Nutzerressource.

Felder

name

string Erforderlich. Der Ressourcenname des Nutzers, mit dem Direktnachrichten gesucht werden sollen. Format: users/{user}, wobei {user} entweder die id für die Person aus der People API oder die id für den Nutzer in der Directory API ist. Wenn die Profil-ID der People API beispielsweise 123456789 ist, können Sie eine Direktnachricht mit dieser Person finden, indem Sie users/123456789 als name verwenden. Wenn Sie als Nutzer authentifiziert sind, können Sie die E-Mail-Adresse als Alias für {user} verwenden. Beispiel: users/[e-mail], wobei [e-mail] die E‑Mail-Adresse des Google Chat-Nutzers ist.

GetAttachmentRequest

Anfrage zum Abrufen eines Anhangs

Felder
name	string Erforderlich. Ressourcenname des Anhangs im Format spaces/{space}/messages/{message}/attachments/{attachment}.

GetCustomEmojiRequest

Eine Anfrage zum Zurückgeben eines einzelnen benutzerdefinierten Emojis.

Felder
name	string Erforderlich. Ressourcenname des 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.

GetMembershipRequest

Anfrage zum Abrufen einer Mitgliedschaft in einem Gruppenbereich.

Felder
name	string Erforderlich. Ressourcenname der abzurufenden Mitgliedschaft. Wenn Sie die eigene Mitgliedschaft der App mithilfe der Nutzerauthentifizierung abrufen möchten, können Sie optional spaces/{space}/members/app verwenden. Format: spaces/{space}/members/{member} oder spaces/{space}/members/app Sie können die E-Mail-Adresse des Nutzers als Alias für {member} verwenden. Beispiel: spaces/{space}/members/[e-mail], wobei [e-mail] die E‑Mail-Adresse des Google Chat-Nutzers ist.
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 die OAuth 2.0-Bereiche chat.admin.memberships oder chat.admin.memberships.readonly. Die Nutzung von Administratorzugriff wird nicht unterstützt, wenn Sie App-Mitgliedschaften in einem Bereich erwerben möchten.

GetMessageRequest

Anfrage zum Abrufen 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

GetSpaceEventRequest

Anfragenachricht zum Abrufen eines Gruppenbereich-Ereignisses

Felder
name	string Erforderlich. Der Ressourcenname des Gruppenbereich-Ereignisses. Format: spaces/{space}/spaceEvents/{spaceEvent}

GetSpaceNotificationSettingRequest

Anfragenachricht zum Abrufen der Benachrichtigungseinstellung für Gruppenbereiche Unterstützt nur das Abrufen von Benachrichtigungseinstellungen für den anrufenden Nutzer.

Felder
name	string Erforderlich. Format: users/{user}/spaces/{space}/spaceNotificationSetting users/me/spaces/{space}/spaceNotificationSetting ODER users/[e-mail]/spaces/{space}/spaceNotificationSetting ODER users/123456789/spaces/{space}/spaceNotificationSetting. Hinweis: Im Pfad sind nur die Nutzer-ID oder E‑Mail-Adresse des Anrufers zulässig.

GetSpaceReadStateRequest

Anfragenachricht für die GetSpaceReadState API.

Felder

name

string Erforderlich. Ressourcenname des abzurufenden Lesestatus des Bereichs. Unterstützt nur das Abrufen des Lesestatus für den aufrufenden Nutzer. Um auf den aufrufenden Nutzer zu verweisen, legen Sie einen der folgenden Werte fest: Der Alias me. Beispiel: users/me/spaces/{space}/spaceReadState. Ihre Workspace-E-Mail-Adresse. Beispiel: users/[e-mail]/spaces/{space}/spaceReadState. Ihre Nutzer-ID. Beispiel: users/123456789/spaces/{space}/spaceReadState. Format: users/{user}/spaces/{space}/spaceReadState

GetSpaceRequest

Eine Anfrage zum Zurückgeben eines einzelnen Gruppenbereichs.

Felder
name	string Erforderlich. Ressourcenname des Bereichs im Format spaces/{space}. 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 die OAuth 2.0-Bereiche chat.admin.spaces oder chat.admin.spaces.readonly.

GetThreadReadStateRequest

Anfragenachricht für die GetThreadReadStateRequest API.

Felder

name

string Erforderlich. Ressourcenname des abzurufenden Lesestatus des Threads. Unterstützt nur das Abrufen des Lesestatus für den aufrufenden Nutzer. Um auf den aufrufenden Nutzer zu verweisen, legen Sie einen der folgenden Werte fest: Der Alias me. Beispiel: users/me/spaces/{space}/threads/{thread}/threadReadState. Ihre Workspace-E-Mail-Adresse. Beispiel: users/[e-mail]/spaces/{space}/threads/{thread}/threadReadState. Ihre Nutzer-ID. Beispiel: users/123456789/spaces/{space}/threads/{thread}/threadReadState. Format: users/{user}/spaces/{space}/threads/{thread}/threadReadState

Gruppe

Eine Google-Gruppe in Google Chat.

Felder
name	string Der Ressourcenname einer Google-Gruppe. Stellt eine Gruppe in der Cloud Identity Groups API dar. Format: groups/{group}

HistoryState

Der Status des Verlaufs für Nachrichten und Gruppenbereiche. Gibt an, wie lange Nachrichten und Unterhaltungs-Threads nach der Erstellung aufbewahrt werden.

Enums
HISTORY_STATE_UNSPECIFIED	Standardwert. Nicht verwenden.
HISTORY_OFF	Verlauf deaktiviert. Nachrichten und Unterhaltungen werden 24 Stunden lang aufbewahrt.
HISTORY_ON	Der Verlauf ist aktiviert. In den Vault-Aufbewahrungsregeln der Organisation ist festgelegt, wie lange Nachrichten und Unterhaltungen aufbewahrt werden.

ListCustomEmojisRequest

Eine Anfrage zum Zurückgeben einer Liste benutzerdefinierter Emojis.

Felder
page_size	int32 Optional. Die maximale Anzahl der zurückgegebenen benutzerdefinierten Emojis. Der Dienst gibt möglicherweise weniger benutzerdefinierte Emojis als diesen Wert zurück. Wenn nicht angegeben, beträgt der Standardwert 25. Der Höchstwert beträgt 200. Werte über 200 werden in 200 geändert.
page_token	string Optional. (Wenn Sie die Arbeit an einer vorherigen Abfrage fortsetzen.) Ein Seitentoken, das von einem vorherigen Aufruf zum Auflisten benutzerdefinierter Emojis empfangen wurde. Geben Sie diese an, um die nachfolgende Seite abzurufen. Beim Paginieren muss der Filterwert mit dem Aufruf übereinstimmen, der das Seitentoken bereitgestellt hat. Die Übergabe eines anderen Werts kann zu unerwarteten Ergebnissen führen.
filter	string Optional. Ein Abfragefilter. Unterstützt das Filtern nach Creator. Wenn Sie nach Ersteller filtern möchten, müssen Sie einen gültigen Wert angeben. Derzeit werden nur creator("users/me") und NOT creator("users/me") akzeptiert, um benutzerdefinierte Emojis danach zu filtern, ob sie vom anrufenden Nutzer erstellt wurden. Die folgende Abfrage gibt beispielsweise benutzerdefinierte Emojis zurück, die vom Aufrufer erstellt wurden: creator("users/me") Ungültige Anfragen werden mit dem Fehler INVALID_ARGUMENT abgelehnt.

ListCustomEmojisResponse

Eine Antwort zum Auflisten benutzerdefinierter Emojis.

Felder
custom_emojis[]	CustomEmoji Unsortierte Liste. Liste der benutzerdefinierten Emojis.
next_page_token	string Ein Token, das als pageToken gesendet werden kann, um die nächste Ergebnisseite abzurufen. Wenn das Feld leer ist, gibt es keine nachfolgenden Seiten.

ListMembershipsRequest

Anfragenachricht zum Auflisten von Mitgliedschaften.

Felder
parent	string Erforderlich. Der Ressourcenname des Bereichs, für den eine Mitgliederliste abgerufen werden soll. Format: spaces/{space}
page_size	int32 Optional. Die maximale Anzahl der zurückzugebenden Mitgliedschaften. Der Dienst gibt möglicherweise weniger als diesen Wert zurück. Wenn nicht angegeben, werden maximal 100 Mitgliedschaften zurückgegeben. Der Höchstwert ist 1.000. Wenn Sie einen Wert über 1.000 verwenden, wird er automatisch in 1.000 geändert. Bei negativen Werten wird ein INVALID_ARGUMENT-Fehler zurückgegeben.
page_token	string Optional. Ein Seitentoken, das von einem vorherigen Aufruf zum Auflisten von Mitgliedschaften empfangen wurde. Geben Sie diesen Parameter an, um die nächste Seite abzurufen. Beim Paginieren müssen alle anderen bereitgestellten Parameter mit dem Aufruf übereinstimmen, der das Seitentoken bereitgestellt hat. Wenn Sie für die anderen Parameter unterschiedliche Werte übergeben, kann das zu unerwarteten Ergebnissen führen.
filter	string Optional. Ein Abfragefilter. Sie können Mitgliedschaften nach der Rolle (role) und dem Typ (member.type) eines Mitglieds filtern. Wenn Sie nach Rolle filtern möchten, legen Sie role auf ROLE_MEMBER oder ROLE_MANAGER fest. Wenn Sie nach Typ filtern möchten, legen Sie member.type auf HUMAN oder BOT fest. Sie können auch mit dem Operator != nach member.type filtern. Wenn Sie nach Rolle und Typ filtern möchten, verwenden Sie den Operator AND. Wenn Sie nach Rolle oder Typ filtern möchten, verwenden Sie den Operator OR. Entweder member.type = "HUMAN" oder member.type != "BOT" ist erforderlich, wenn use_admin_access auf „true“ gesetzt ist. Andere Filter für Mitgliedertypen werden abgelehnt. Die folgenden Abfragen sind beispielsweise gültig: role = "ROLE_MANAGER" OR role = "ROLE_MEMBER" member.type = "HUMAN" AND role = "ROLE_MANAGER" member.type != "BOT" Die folgenden Abfragen sind ungültig: member.type = "HUMAN" AND member.type = "BOT" role = "ROLE_MANAGER" AND role = "ROLE_MEMBER" Ungültige Abfragen werden vom Server mit dem Fehler INVALID_ARGUMENT abgelehnt.
show_groups	bool Optional. Wenn true, werden zusätzlich zu anderen Arten von Mitgliedschaften auch Mitgliedschaften zurückgegeben, die mit einem Google Group verknüpft sind. Wenn ein filter festgelegt ist, werden Google Group-Mitgliedschaften, die nicht den Filterkriterien entsprechen, nicht zurückgegeben.
show_invited	bool Optional. Wenn true, werden zusätzlich zu anderen Arten von Mitgliedschaften auch Mitgliedschaften zurückgegeben, die mit invited-Mitgliedern verknüpft sind. Wenn ein Filter festgelegt ist, werden invited-Mitgliedschaften, die nicht den Filterkriterien entsprechen, nicht zurückgegeben. Derzeit ist eine Nutzerauthentifizierung erforderlich.
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 OAuth 2.0-Bereich chat.admin.memberships.readonly oder chat.admin.memberships. Das Auflisten von App-Mitgliedschaften in einem Gruppenbereich wird bei Verwendung des Administratorzugriffs nicht unterstützt.

ListMembershipsResponse

Antwort auf die Anfrage zum Auflisten der Mitgliedschaften des Gruppenbereichs.

Felder
memberships[]	Membership Unsortierte Liste. Liste der Mitgliedschaften auf der angeforderten (oder ersten) Seite.
next_page_token	string Ein Token, das als pageToken gesendet werden kann, um die nächste Ergebnisseite abzurufen. Wenn das Feld leer ist, gibt es keine nachfolgenden Seiten.

ListMessagesRequest

Listet Nachrichten im angegebenen Bereich auf, in dem der Nutzer Mitglied ist.

Felder
parent	string Erforderlich. Der Ressourcenname des Bereichs, aus dem Nachrichten aufgelistet werden sollen. Format: spaces/{space}
page_size	int32 Optional. Die maximale Anzahl der zurückgegebenen Nachrichten. Der Dienst gibt möglicherweise weniger Nachrichten als diesen Wert zurück. Wenn nicht angegeben, werden maximal 25 zurückgegeben. Der Höchstwert ist 1.000. Wenn Sie einen Wert über 1.000 verwenden, wird er automatisch in 1.000 geändert. Bei negativen Werten wird ein INVALID_ARGUMENT-Fehler zurückgegeben.
page_token	string Optional. Ein Seitentoken, das von einem vorherigen Aufruf zum Auflisten von Nachrichten empfangen wurde. Geben Sie diesen Parameter an, um die nächste Seite abzurufen. Beim Paginieren müssen alle anderen bereitgestellten Parameter mit dem Aufruf übereinstimmen, der das Seitentoken bereitgestellt hat. Wenn Sie für die anderen Parameter unterschiedliche Werte übergeben, kann das zu unerwarteten Ergebnissen führen.
filter	string Optional. Ein Abfragefilter. Sie können Nachrichten nach Datum (create_time) und Thread (thread.name) filtern. Wenn Sie Nachrichten nach dem Erstellungsdatum filtern möchten, geben Sie create_time mit einem Zeitstempel im RFC-3339-Format und doppelten Anführungszeichen an. Beispiel: "2023-04-21T11:30:00-04:00" Mit dem Operator „größer als“ > können Sie Nachrichten auflisten, die nach einem Zeitstempel erstellt wurden, und mit dem Operator „kleiner als“ < Nachrichten, die vor einem Zeitstempel erstellt wurden. Wenn Sie Nachrichten innerhalb eines Zeitintervalls filtern möchten, verwenden Sie den Operator AND zwischen zwei Zeitstempeln. Wenn Sie nach Thread filtern möchten, geben Sie die thread.name im Format spaces/{space}/threads/{thread} an. Pro Abfrage kann nur ein thread.name angegeben werden. Wenn Sie sowohl nach Thread als auch nach Datum filtern möchten, verwenden Sie den Operator AND in Ihrer Anfrage. Die folgenden Abfragen sind beispielsweise gültig: create_time > "2012-04-21T11:30:00-04:00" create_time > "2012-04-21T11:30:00-04:00" AND thread.name = spaces/AAAAAAAAAAA/threads/123 create_time > "2012-04-21T11:30:00+00:00" AND create_time < "2013-01-01T00:00:00+00:00" AND thread.name = spaces/AAAAAAAAAAA/threads/123 thread.name = spaces/AAAAAAAAAAA/threads/123 Ungültige Abfragen werden vom Server mit dem Fehler INVALID_ARGUMENT abgelehnt.
order_by	string Optional. Wie die Liste der Nachrichten sortiert wird. Geben Sie einen Wert an, nach dem sortiert werden soll. Gültige Werte für den Sortiervorgang: ASC für aufsteigend. DESC für absteigend. Die Standardreihenfolge ist create_time ASC.
show_deleted	bool Optional. Ob gelöschte Nachrichten berücksichtigt werden sollen. Gelöschte Nachrichten enthalten die Uhrzeit und Metadaten zum Löschen, aber keine Inhalte.

ListMessagesResponse

Antwortnachricht zum Auflisten von Nachrichten.

Felder
messages[]	Message Liste der Nachrichten.
next_page_token	string Sie können ein Token als pageToken senden, um die nächste Ergebnisseite abzurufen. Wenn das Feld leer ist, gibt es keine nachfolgenden Seiten.

ListReactionsRequest

Listet Reaktionen auf eine Nachricht auf.

Felder
parent	string Erforderlich. Die Nachricht, auf die Nutzer reagiert haben. Format: spaces/{space}/messages/{message}
page_size	int32 Optional. Die maximale Anzahl der zurückgegebenen Reaktionen. Der Dienst gibt möglicherweise weniger Reaktionen als diesen Wert zurück. Wenn nicht angegeben, beträgt der Standardwert 25. Der Höchstwert beträgt 200. Werte über 200 werden in 200 geändert.
page_token	string Optional. (Wenn Sie die Arbeit an einer vorherigen Abfrage fortsetzen.) Ein Seitentoken, das von einem vorherigen Aufruf zum Auflisten von Reaktionen empfangen wurde. Geben Sie diese an, um die nachfolgende Seite abzurufen. Beim Paginieren muss der Filterwert mit dem Aufruf übereinstimmen, der das Seitentoken bereitgestellt hat. Die Übergabe eines anderen Werts kann zu unerwarteten Ergebnissen führen.
filter	string Optional. Ein Abfragefilter. Sie können Reaktionen nach Emoji (entweder emoji.unicode oder emoji.custom_emoji.uid) und Nutzer (user.name) filtern. Wenn Sie Reaktionen nach mehreren Emojis oder Nutzern filtern möchten, verknüpfen Sie ähnliche Felder mit dem Operator OR, z. B. emoji.unicode = "🙂" OR emoji.unicode = "👍" und user.name = "users/AAAAAA" OR user.name = "users/BBBBBB". Wenn Sie Reaktionen nach Emoji und Nutzer filtern möchten, verwenden Sie den Operator AND, z. B. emoji.unicode = "🙂" AND user.name = "users/AAAAAA". Wenn in Ihrer Abfrage sowohl AND als auch OR verwendet werden, müssen Sie sie mit Klammern gruppieren. Die folgenden Abfragen sind beispielsweise gültig: user.name = "users/{user}" emoji.unicode = "🙂" emoji.custom_emoji.uid = "{uid}" emoji.unicode = "🙂" OR emoji.unicode = "👍" emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}" emoji.unicode = "🙂" AND user.name = "users/{user}" (emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}") AND user.name = "users/{user}" Die folgenden Abfragen sind ungültig: emoji.unicode = "🙂" AND emoji.unicode = "👍" emoji.unicode = "🙂" AND emoji.custom_emoji.uid = "{uid}" emoji.unicode = "🙂" OR user.name = "users/{user}" emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}" OR user.name = "users/{user}" emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}" AND user.name = "users/{user}" Ungültige Anfragen werden mit dem Fehler INVALID_ARGUMENT abgelehnt.

ListReactionsResponse

Antwort auf eine Anfrage zum Auflisten von Reaktionen.

Felder
reactions[]	Reaction Liste der Reaktionen auf der angeforderten (oder ersten) Seite.
next_page_token	string Fortsetzungstoken zum Abrufen der nächsten Ergebnisseite. Für die letzte Ergebnisseite ist es leer.

ListSpaceEventsRequest

Anfragenachricht zum Auflisten von Ereignissen für einen Ort

Felder
parent	string Erforderlich. Der Ressourcenname des Google Chat-Bereichs, in dem die Ereignisse aufgetreten sind. Format: spaces/{space}.
page_size	int32 Optional. Die maximale Anzahl der zurückgegebenen Space-Ereignisse. Der Dienst gibt möglicherweise weniger als diesen Wert zurück. Bei negativen Werten wird ein INVALID_ARGUMENT-Fehler zurückgegeben.
page_token	string Optional. Ein Seitentoken, das von einem vorherigen Aufruf von „list space events“ empfangen wurde. Geben Sie diese an, um die nachfolgende Seite abzurufen. Beim Paginieren müssen alle anderen für die Auflistung von Space-Ereignissen bereitgestellten Parameter mit dem Aufruf übereinstimmen, der das Seitentoken bereitgestellt hat. Wenn Sie für die anderen Parameter unterschiedliche Werte übergeben, kann das zu unerwarteten Ergebnissen führen.
filter	string Erforderlich. Ein Abfragefilter. Sie müssen mindestens einen Ereignistyp (event_type) mit dem Operator „has“ (:) angeben. Wenn Sie nach mehreren Ereignistypen filtern möchten, verwenden Sie den Operator OR. Lassen Sie Batch-Ereignistypen in Ihrem Filter weg. Die Anfrage gibt automatisch alle zugehörigen Batch-Ereignisse zurück. Wenn Sie beispielsweise nach neuen Reaktionen (google.workspace.chat.reaction.v1.created) filtern, gibt der Server auch Batch-Ereignisse für neue Reaktionen (google.workspace.chat.reaction.v1.batchCreated) zurück. Eine Liste der unterstützten Ereignistypen finden Sie in der SpaceEvents-Referenzdokumentation. Optional können Sie auch nach Startzeit (start_time) und Endzeit (end_time) filtern: start_time: Exklusiver Zeitstempel, ab dem Space-Ereignisse aufgeführt werden sollen. Sie können Ereignisse auflisten, die bis zu 28 Tage zurückliegen. Wenn nicht angegeben, werden Ereignisse aus den letzten 28 Tagen aufgeführt. end_time: Inklusiver Zeitstempel, bis zu dem Space-Ereignisse aufgeführt werden. Wenn nichts angegeben ist, werden Ereignisse bis zum Zeitpunkt der Anfrage aufgeführt. Wenn Sie eine Start- oder Endzeit angeben möchten, verwenden Sie den Operator „Gleich“ = und das RFC-3339-Format. Wenn Sie nach start_time und end_time filtern möchten, verwenden Sie den Operator AND. Die folgenden Abfragen sind beispielsweise gültig: start_time="2023-08-23T19:20:33+00:00" AND end_time="2023-08-23T19:21:54+00:00" start_time="2023-08-23T19:20:33+00:00" AND (event_types:"google.workspace.chat.space.v1.updated" OR event_types:"google.workspace.chat.message.v1.created") Die folgenden Abfragen sind ungültig: start_time="2023-08-23T19:20:33+00:00" OR end_time="2023-08-23T19:21:54+00:00" event_types:"google.workspace.chat.space.v1.updated" AND event_types:"google.workspace.chat.message.v1.created" Ungültige Abfragen werden vom Server mit dem Fehler INVALID_ARGUMENT abgelehnt.

ListSpaceEventsResponse

Antwortnachricht zum Auflisten von Gruppenbereichsereignissen.

Felder
space_events[]	SpaceEvent Die Ergebnisse werden in chronologischer Reihenfolge zurückgegeben (ältestes Ereignis zuerst). Hinweis: Das Feld permissionSettings wird im Space-Objekt für Listenanfragen nicht zurückgegeben.
next_page_token	string Fortsetzungstoken zum Abrufen weiterer Ereignisse. Wenn dieses Feld weggelassen wird, gibt es keine nachfolgenden Seiten.

ListSpacesRequest

Eine Anfrage zum Auflisten der Gruppenbereiche, in denen der Anrufer Mitglied ist.

Felder
page_size	int32 Optional. Die maximale Anzahl der zurückzugebenden Arbeitsbereiche. Der Dienst gibt möglicherweise weniger als diesen Wert zurück. Wenn nicht angegeben, werden maximal 100 Bereiche zurückgegeben. Der Höchstwert ist 1.000. Wenn Sie einen Wert über 1.000 verwenden, wird er automatisch in 1.000 geändert. Bei negativen Werten wird ein INVALID_ARGUMENT-Fehler zurückgegeben.
page_token	string Optional. Ein Seitentoken, das von einem vorherigen Aufruf zum Auflisten von Bereichen empfangen wurde. Geben Sie diesen Parameter an, um die nächste Seite abzurufen. Beim Paginieren muss der Filterwert mit dem Aufruf übereinstimmen, der das Seitentoken bereitgestellt hat. Die Übergabe eines anderen Werts kann zu unerwarteten Ergebnissen führen.
filter	string Optional. Ein Abfragefilter. Sie können Gruppenbereiche nach Typ filtern (space_type). Wenn Sie nach dem Typ des Bereichs filtern möchten, müssen Sie einen gültigen Enumerationswert angeben, z. B. SPACE oder GROUP_CHAT (space_type darf nicht SPACE_TYPE_UNSPECIFIED sein). Wenn Sie mehrere Bereichstypen abfragen möchten, verwenden Sie den Operator OR. Die folgenden Abfragen sind beispielsweise gültig: space_type = "SPACE" spaceType = "GROUP_CHAT" OR spaceType = "DIRECT_MESSAGE" Ungültige Abfragen werden vom Server mit dem Fehler INVALID_ARGUMENT abgelehnt.

ListSpacesResponse

Die Antwort auf eine Anfrage zum Auflisten von Bereichen.

Felder
spaces[]	Space Liste der Gruppenbereiche auf der angeforderten (oder ersten) Seite. Hinweis: Das Feld permissionSettings wird im Space-Objekt für Listenanfragen nicht zurückgegeben.
next_page_token	string Sie können ein Token als pageToken senden, um die nächste Ergebnisseite abzurufen. Wenn das Feld leer ist, gibt es keine nachfolgenden Seiten.

MatchedUrl

Eine übereinstimmende URL in einer Chatnachricht. Chat-Apps können eine Vorschau von übereinstimmenden URLs anzeigen. Weitere Informationen finden Sie unter Vorschau von Links.

Felder
url	string Nur Ausgabe. Die URL, die abgeglichen wurde.

Mitgliedschaft

Stellt eine Mitgliedschaftsbeziehung in Google Chat dar, z. B. ob ein Nutzer oder eine Chat-App zu einem Gruppenbereich eingeladen wurde, Teil eines Gruppenbereichs ist oder nicht.

Felder
name	string Kennung. Vom Server zugewiesener Ressourcenname der Mitgliedschaft. Format: spaces/{space}/members/{member}
state	MembershipState Nur Ausgabe. Status der Mitgliedschaft.
role	MembershipRole Optional. Die Rolle des Nutzers in einem Chatbereich bestimmt, welche Aktionen er im Bereich ausführen darf. Dieses Feld kann nur als Eingabe in UpdateMembership verwendet werden.
create_time	Timestamp Optional. Nicht veränderbar. Der Erstellungszeitpunkt der Mitgliedschaft, z. B. wann ein Mitglied einem Gruppenbereich beigetreten ist oder dazu eingeladen wurde. Dieses Feld dient nur der Ausgabe, außer wenn es zum Importieren von Mitgliedschaften aus der Vergangenheit in Gruppenbereiche im Importmodus verwendet wird.
delete_time	Timestamp Optional. Nicht veränderbar. Der Zeitpunkt, zu dem die Mitgliedschaft gelöscht wurde, z. B. wenn ein Mitglied einen Gruppenbereich verlassen oder aus einem Gruppenbereich entfernt wurde. Dieses Feld dient nur der Ausgabe, außer wenn es zum Importieren von Mitgliedschaften aus der Vergangenheit in Gruppenbereiche im Importmodus verwendet wird.
Union-Feld memberType. Mitglied, das mit dieser Mitgliedschaft verknüpft ist. Andere Mitgliedertypen werden möglicherweise in Zukunft unterstützt. Für memberType ist nur einer der folgenden Werte zulässig:
member	User Optional. Der Google Chat-Nutzer oder die Google Chat-App, der bzw. der die Mitgliedschaft entspricht. Wenn sich Ihre Chat-App als Nutzer authentifiziert, werden die user-Felder name und type mit der Ausgabe gefüllt.
group_member	Group Optional. Die Google-Gruppe, der die Mitgliedschaft entspricht. Zum Lesen oder Ändern von Mitgliedschaften für Google Groups ist eine Nutzerauthentifizierung erforderlich.

MembershipRole

Stellt die zulässigen Aktionen eines Nutzers in einem Chatbereich dar. In Zukunft werden möglicherweise weitere Aufzählungswerte hinzugefügt.

Enums
MEMBERSHIP_ROLE_UNSPECIFIED	Standardwert. Für users: Der Nutzer ist kein Mitglied des Gruppenbereichs, kann aber eingeladen werden. Für Google Groups: Diese Rolle wird immer zugewiesen (in Zukunft können andere Enumerationswerte verwendet werden).
ROLE_MEMBER	Ein Mitglied des Gruppenbereichs. Der Nutzer hat grundlegende Berechtigungen, z. B. zum Senden von Nachrichten an den Bereich. In Einzel- und unbenannten Gruppenunterhaltungen hat jeder diese Rolle.
ROLE_MANAGER	Sie müssen Administrator des Gruppenbereichs sein. Der Nutzer hat alle grundlegenden Berechtigungen sowie Administratorberechtigungen, mit denen er den Gruppenbereich verwalten kann, z. B. Mitglieder hinzufügen oder entfernen. Wird nur in SpaceType.SPACE unterstützt.

MembershipState

Gibt die Beziehung des Mitglieds zu einem Space an. Möglicherweise werden in Zukunft weitere Mitgliedschaftsstatus unterstützt.

Enums
MEMBERSHIP_STATE_UNSPECIFIED	Standardwert. Nicht verwenden.
JOINED	Der Nutzer wird dem Gruppenbereich hinzugefügt und kann daran teilnehmen.
INVITED	Der Nutzer wurde eingeladen, dem Gruppenbereich beizutreten, ist ihm aber noch nicht beigetreten.
NOT_A_MEMBER	Der Nutzer gehört nicht zum Gruppenbereich und hat keine ausstehende Einladung, dem Gruppenbereich beizutreten.

MembershipBatchCreatedEventData

Ereignis-Payload für mehrere neue Mitgliedschaften.

Ereignistyp: google.workspace.chat.membership.v1.batchCreated

Felder
memberships[]	MembershipCreatedEventData Eine Liste der neuen Mitgliedschaften.

MembershipBatchDeletedEventData

Ereignis-Nutzlast für mehrere gelöschte Mitgliedschaften.

Ereignistyp: google.workspace.chat.membership.v1.batchDeleted

Felder
memberships[]	MembershipDeletedEventData Eine Liste der gelöschten Mitgliedschaften.

MembershipBatchUpdatedEventData

Ereignis-Nutzlast für mehrere aktualisierte Mitgliedschaften.

Ereignistyp: google.workspace.chat.membership.v1.batchUpdated

Felder
memberships[]	MembershipUpdatedEventData Eine Liste der aktualisierten Mitgliedschaften.

MembershipCreatedEventData

Ereignis-Payload für eine neue Mitgliedschaft.

Ereignistyp: google.workspace.chat.membership.v1.created.

Felder
membership	Membership Die neue Mitgliedschaft.

MembershipDeletedEventData

Ereignis-Nutzlast für eine gelöschte Mitgliedschaft.

Ereignistyp: google.workspace.chat.membership.v1.deleted

Felder
membership	Membership Die gelöschte Mitgliedschaft. Nur die Felder name und state werden ausgefüllt.

MembershipUpdatedEventData

Ereignis-Nutzlast für eine aktualisierte Mitgliedschaft.

Ereignistyp: google.workspace.chat.membership.v1.updated

Felder
membership	Membership Die aktualisierte Mitgliedschaft.

Nachricht

Eine Nachricht in einem Google Chat-Bereich.

Felder
name	string Kennung. Ressourcenname der Nachricht. Format: spaces/{space}/messages/{message} Dabei ist {space} die ID des Bereichs, in dem die Nachricht gepostet wird, und {message} eine vom System zugewiesene ID für die Nachricht. Beispiel: spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB Wenn Sie beim Erstellen einer Nachricht eine benutzerdefinierte ID festlegen, können Sie diese ID verwenden, um die Nachricht in einer Anfrage anzugeben. Ersetzen Sie dazu {message} durch den Wert aus dem Feld clientAssignedMessageId. Beispiel: spaces/AAAAAAAAAAA/messages/client-custom-name Weitere Informationen
sender	User Nur Ausgabe. Der Nutzer, der die Nachricht erstellt hat. Wenn sich Ihre Chat-App als Nutzer authentifiziert, werden die user-Felder name und type mit der Ausgabe gefüllt.
create_time	Timestamp Optional. Nicht veränderbar. Für in Google Chat erstellte Gruppenbereiche die Uhrzeit, zu der die Nachricht erstellt wurde. Dieses Feld dient nur der Ausgabe, außer wenn es in Gruppenbereichen im Importmodus verwendet wird. Legen Sie dieses Feld für Importmodusbereiche auf den historischen Zeitstempel fest, zu dem die Nachricht in der Quelle erstellt wurde, um die ursprüngliche Erstellungszeit beizubehalten.
last_update_time	Timestamp Nur Ausgabe. Der Zeitpunkt, zu dem die Nachricht zuletzt von einem Nutzer bearbeitet wurde. Wenn die Nachricht noch nie bearbeitet wurde, ist dieses Feld leer.
delete_time	Timestamp Nur Ausgabe. Der Zeitpunkt, zu dem die Nachricht in Google Chat gelöscht wurde. Wenn die Nachricht nie gelöscht wird, ist dieses Feld leer.
text	string Optional. Nur-Text-Textkörper der Nachricht. Der erste Link zu einem Bild, Video oder einer Webseite generiert einen Vorschaubild-Chip. Sie können auch einen Google Chat-Nutzer oder alle Nutzer im Gruppenbereich@erwähnen. Informationen zum Erstellen von SMS finden Sie unter Nachricht senden.
formatted_text	string Nur Ausgabe. Enthält die Nachricht text mit Markierungen zur Formatierung. In diesem Feld wird möglicherweise nicht die gesamte in der Benutzeroberfläche sichtbare Formatierung erfasst, aber es enthält Folgendes: Markupsyntax für fett, kursiv, durchgestrichen, Monospace, Monospace-Block und Aufzählungsliste. Nutzererwähnungen im Format <users/{user}>. Benutzerdefinierte Hyperlinks im Format <{url}|{rendered_text}>, wobei der erste String die URL und der zweite der gerenderte Text ist, z. B. <http://example.com|custom text>. Benutzerdefinierte Emojis im Format :{emoji_name}:, z. B. :smile:. Das gilt nicht für Unicode-Emojis wie U+1F600 für ein grinsendes Gesicht. Weitere Informationen finden Sie unter In einer Nachricht gesendete Textformatierung ansehen.
cards[] (deprecated)	Card Dieses Element ist veraltet. Verworfen: Verwenden Sie stattdessen cards_v2. Formatierte und interaktive Karten, mit denen Sie UI-Elemente wie formatierten Text, Schaltflächen und anklickbare Bilder anzeigen können. Karten werden normalerweise unter dem Nur-Text-Teil der Nachricht angezeigt. cards und cards_v2 dürfen maximal 32 KB groß sein.
cards_v2[]	CardWithId Optional. Ein Array von Karten. Nur Chat-Apps können Karten erstellen. Wenn sich Ihre Chat-App als Nutzer authentifiziert, dürfen die Nachrichten keine Karten enthalten. Informationen zum Erstellen einer Nachricht mit Karten finden Sie unter Nachricht senden. Mit dem Card Builder können Sie Karten entwerfen und in der Vorschau ansehen. Card Builder öffnen
annotations[]	Annotation Nur Ausgabe. Annotationen, die mit der text in dieser Nachricht verknüpft sind.
thread	Thread Der Thread, zu dem die Nachricht gehört. Beispiele für die Verwendung finden Sie unter Nachrichtenthread starten oder darauf antworten.
space	Space Nur Ausgabe. Wenn sich Ihre Chat-App als Nutzer authentifiziert, wird in der Ausgabe nur der Gruppenbereich name ausgefüllt.
fallback_text	string Optional. Eine Nur-Text-Beschreibung der Karten der Nachricht, die verwendet wird, wenn die tatsächlichen Karten nicht angezeigt werden können, z. B. bei mobilen Benachrichtigungen.
action_response	ActionResponse Nur Eingabe. Parameter, die eine Chat-App verwenden kann, um zu konfigurieren, wie ihre Antwort gepostet wird.
argument_text	string Nur Ausgabe. Nur-Text-Textkörper der Nachricht, in dem alle Erwähnungen der Chat App entfernt wurden.
slash_command	SlashCommand Nur Ausgabe. Informationen zu Slash-Befehlen, falls zutreffend.
attachment[]	Attachment Optional. Von einem Nutzer hochgeladener Anhang.
matched_url	MatchedUrl Nur Ausgabe. Eine URL in spaces.messages.text, die einem Linkvorschau-Muster entspricht. Weitere Informationen finden Sie unter Vorschaulinks.
thread_reply	bool Nur Ausgabe. Wenn true, ist die Nachricht eine Antwort in einem Antwortthread. Wenn false, ist die Nachricht in der Unterhaltung auf höchster Ebene des Gruppenbereichs als erste Nachricht eines Threads oder als Nachricht ohne Antworten im Thread sichtbar. Wenn der Bereich keine Antworten in Threads unterstützt, ist dieses Feld immer false.
client_assigned_message_id	string Optional. Eine benutzerdefinierte ID für die Nachricht. Sie können ein Feld verwenden, um eine Nachricht zu identifizieren oder abzurufen, zu löschen oder zu aktualisieren. Wenn Sie eine benutzerdefinierte ID festlegen möchten, geben Sie beim Erstellen der Nachricht das Feld messageId an. Weitere Informationen
emoji_reaction_summaries[]	EmojiReactionSummary Nur Ausgabe. Die Liste der Zusammenfassungen von Emoji-Reaktionen auf die Nachricht.
private_message_viewer	User Optional. Nicht veränderbar. Eingabe zum Erstellen einer Nachricht, ansonsten nur Ausgabe. Der Nutzer, der die Nachricht sehen kann. Wenn dieses Feld festgelegt ist, ist die Nachricht privat und nur für den angegebenen Nutzer und die Chat-App sichtbar. Wenn Sie dieses Feld in Ihre Anfrage aufnehmen möchten, müssen Sie die Chat API mit App-Authentifizierung aufrufen und Folgendes weglassen: Anhänge Zubehör-Widgets Weitere Informationen finden Sie unter Private Nachrichten senden.
deletion_metadata	DeletionMetadata Nur Ausgabe. Informationen zu einer gelöschten Nachricht. Eine Nachricht wird gelöscht, wenn delete_time festgelegt ist.
quoted_message_metadata	QuotedMessageMetadata Nur Ausgabe. Informationen zu einer Nachricht, die von einem Google Chat-Nutzer in einem Gruppenbereich zitiert wird. Google Chat-Nutzer können eine Nachricht zitieren, um darauf zu antworten.
attached_gifs[]	AttachedGif Nur Ausgabe. GIF-Bilder, die an die Nachricht angehängt sind.
accessory_widgets[]	AccessoryWidget Optional. Ein oder mehrere interaktive Widgets, die unten in einer Nachricht angezeigt werden. Sie können Nachrichten, die Text, Karten oder beides enthalten, Zubehör-Widgets hinzufügen. Nicht unterstützt für Nachrichten, die Dialogfelder enthalten. Weitere Informationen finden Sie unter Interaktive Widgets am Ende einer Nachricht hinzufügen. Zum Erstellen einer Nachricht mit Zubehör-Widgets ist eine App-Authentifizierung erforderlich.

MessageBatchCreatedEventData

Ereignisnutzlast für mehrere neue Nachrichten.

Ereignistyp: google.workspace.chat.message.v1.batchCreated

Felder
messages[]	MessageCreatedEventData Eine Liste der neuen Nachrichten.

MessageBatchDeletedEventData

Ereignis-Payload für mehrere gelöschte Nachrichten.

Ereignistyp: google.workspace.chat.message.v1.batchDeleted

Felder
messages[]	MessageDeletedEventData Eine Liste der gelöschten Nachrichten.

MessageBatchUpdatedEventData

Ereignis-Nutzlast für mehrere aktualisierte Nachrichten.

Ereignistyp: google.workspace.chat.message.v1.batchUpdated

Felder
messages[]	MessageUpdatedEventData Eine Liste der aktualisierten Nachrichten.

MessageCreatedEventData

Ereignis-Nutzlast für eine neue Nachricht.

Ereignistyp: google.workspace.chat.message.v1.created

Felder
message	Message Die neue Nachricht.

MessageDeletedEventData

Ereignis-Nutzlast für eine gelöschte Nachricht.

Ereignistyp: google.workspace.chat.message.v1.deleted

Felder
message	Message Die gelöschte Nachricht. Nur die Felder name, createTime, deleteTime und deletionMetadata werden ausgefüllt.

MessageUpdatedEventData

Ereignisnutzlast für eine aktualisierte Nachricht.

Ereignistyp: google.workspace.chat.message.v1.updated

Felder
message	Message Die aktualisierte Nachricht.

QuotedMessageMetadata

Informationen zu einer zitierten Nachricht.

Felder
name	string Nur Ausgabe. Ressourcenname der zitierten Nachricht. Format: spaces/{space}/messages/{message}
last_update_time	Timestamp Nur Ausgabe. Der Zeitstempel für die Erstellung oder letzte Aktualisierung der zitierten Nachricht.

Reaktion

Eine Reaktion auf eine Nachricht.

Felder
name	string Kennung. Der Ressourcenname der Reaktion. Format: spaces/{space}/messages/{message}/reactions/{reaction}
user	User Nur Ausgabe. Der Nutzer, der die Reaktion erstellt hat.
emoji	Emoji Erforderlich. Das in der Reaktion verwendete Emoji.

ReactionBatchCreatedEventData

Ereignisnutzlast für mehrere neue Reaktionen.

Ereignistyp: google.workspace.chat.reaction.v1.batchCreated

Felder
reactions[]	ReactionCreatedEventData Eine Liste mit neuen Reaktionen.

ReactionBatchDeletedEventData

Ereignis-Payload für mehrere gelöschte Reaktionen.

Ereignistyp: google.workspace.chat.reaction.v1.batchDeleted

Felder
reactions[]	ReactionDeletedEventData Eine Liste der gelöschten Reaktionen.

ReactionCreatedEventData

Ereignis-Nutzlast für eine neue Reaktion.

Ereignistyp: google.workspace.chat.reaction.v1.created

Felder
reaction	Reaction Die neue Reaktion.

ReactionDeletedEventData

Ereignis-Nutzlast für eine gelöschte Reaktion.

Typ: google.workspace.chat.reaction.v1.deleted

Felder
reaction	Reaction Die gelöschte Reaktion.

RichLinkMetadata

Ein Rich-Link zu einer Ressource.

Felder
uri	string Der URI dieses Links.
rich_link_type	RichLinkType Der Rich-Link-Typ.
Union-Feld data. Daten für die verknüpfte Ressource. Für data ist nur einer der folgenden Werte zulässig:
drive_link_data	DriveLinkData Daten für einen Drive-Link.
chat_space_link_data	ChatSpaceLinkData Daten für einen Link zu einem Chatbereich.

RichLinkType

Der Rich-Link-Typ. In Zukunft werden möglicherweise weitere Typen hinzugefügt.

Enums
RICH_LINK_TYPE_UNSPECIFIED	Standardwert für die Enumeration. Nicht verwenden.
DRIVE_FILE	Ein Google Drive-Rich-Link-Typ.
CHAT_SPACE	Ein Rich-Link-Typ für Google Chat-Bereiche. Zum Beispiel ein Smartchip für Projektbereiche.

SearchSpacesRequest

Anfrage zum Suchen nach einer Liste von Gruppenbereichen basierend auf einer Anfrage.

Felder
use_admin_access	bool 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 OAuth 2.0-Bereich chat.admin.spaces.readonly oder chat.admin.spaces. Diese Methode unterstützt derzeit nur Administratorzugriff. Daher wird für dieses Feld nur true akzeptiert.
page_size	int32 Die maximale Anzahl der zurückzugebenden Arbeitsbereiche. Der Dienst gibt möglicherweise weniger als diesen Wert zurück. Wenn nicht angegeben, werden maximal 100 Bereiche zurückgegeben. Der Höchstwert ist 1.000. Wenn Sie einen Wert über 1.000 verwenden, wird er automatisch in 1.000 geändert.
page_token	string Ein Token, das vom vorherigen Aufruf von Suchbereichen empfangen wurde. Geben Sie diesen Parameter an, um die nächste Seite abzurufen. Beim Paginieren müssen alle anderen bereitgestellten Parameter mit dem Aufruf übereinstimmen, der das Seitentoken bereitgestellt hat. Wenn Sie für die anderen Parameter unterschiedliche Werte übergeben, kann das zu unerwarteten Ergebnissen führen.
query	string Erforderlich. Eine Suchanfrage. Sie können mit den folgenden Parametern suchen: create_time customer display_name external_user_allowed last_active_time space_history_state space_type create_time und last_active_time akzeptieren einen Zeitstempel im RFC-3339. Die unterstützten Vergleichsoperatoren sind: =, <, >, <=, >=. customer ist erforderlich und wird verwendet, um anzugeben, von welchem Kunden Gruppenbereiche abgerufen werden sollen. customers/my_customer ist der einzige unterstützte Wert. Für display_name ist nur der Operator HAS (:) zulässig. Der abzugleichende Text wird zuerst in Tokens zerlegt. Jedes Token wird dann unabhängig und ohne Berücksichtigung der Groß- und Kleinschreibung als Teilstring an einer beliebigen Stelle in der display_name des Bereichs mit einem Präfix abgeglichen. Beispiel: Fun Eve entspricht Fun event oder The evening was fun, aber nicht notFun event oder even. external_user_allowed akzeptiert entweder true oder false. space_history_state akzeptiert nur Werte aus dem Feld historyState einer space-Ressource. space_type ist erforderlich und der einzige gültige Wert ist SPACE. Für verschiedene Felder werden nur AND-Operatoren unterstützt. Ein gültiges Beispiel ist space_type = "SPACE" AND display_name:"Hello" und ein ungültiges Beispiel ist space_type = "SPACE" OR display_name:"Hello". Im selben Feld werden die Operatoren AND oder OR nicht unterstützt.space_type display_name, „space_history_state“ und „external_user_allowed“ unterstützen nur OR-Operatoren. last_active_time und create_time unterstützen sowohl AND- als auch OR-Operatoren. AND kann nur verwendet werden, um ein Intervall darzustellen, z. B. last_active_time < "2022-01-01T00:00:00+00:00" AND last_active_time > "2023-01-01T00:00:00+00:00". Die folgenden Beispielabfragen sind gültig: customer = "customers/my_customer" AND space_type = "SPACE" customer = "customers/my_customer" AND space_type = "SPACE" AND display_name:"Hello World" customer = "customers/my_customer" AND space_type = "SPACE" AND (last_active_time < "2020-01-01T00:00:00+00:00" OR last_active_time > "2022-01-01T00:00:00+00:00") customer = "customers/my_customer" AND space_type = "SPACE" AND (display_name:"Hello World" OR display_name:"Fun event") AND (last_active_time > "2020-01-01T00:00:00+00:00" AND last_active_time < "2022-01-01T00:00:00+00:00") customer = "customers/my_customer" AND space_type = "SPACE" AND (create_time > "2019-01-01T00:00:00+00:00" AND create_time < "2020-01-01T00:00:00+00:00") AND (external_user_allowed = "true") AND (space_history_state = "HISTORY_ON" OR space_history_state = "HISTORY_OFF")
order_by	string Optional. So wird die Liste der Gruppenbereiche sortiert. Folgende Attribute können für die Sortierung verwendet werden: membership_count.joined_direct_human_user_count: Anzahl der Nutzer, die einem Gruppenbereich direkt beigetreten sind. last_active_time: Gibt den Zeitpunkt an, zu dem dem Thema des Gruppenbereichs das letzte zulässige Element hinzugefügt wurde. create_time: Gibt die Uhrzeit an, zu der der Bereich erstellt wurde. Gültige Werte für den Sortiervorgang sind: ASC für aufsteigend. Standardwert. DESC für absteigend. Folgende Syntax wird unterstützt: membership_count.joined_direct_human_user_count DESC membership_count.joined_direct_human_user_count ASC last_active_time DESC last_active_time ASC create_time DESC create_time ASC

SearchSpacesResponse

Antwort mit einer Liste von Gruppenbereichen, die dem Request für Suchbereiche entsprechen.

Felder
spaces[]	Space Eine Seite der angeforderten Gruppenbereiche.
next_page_token	string Ein Token, mit dem die nächste Seite abgerufen werden kann. Wenn dieses Feld leer ist, gibt es keine nachfolgenden Seiten.
total_size	int32 Die Gesamtzahl der Bereiche, die der Abfrage entsprechen, über alle Seiten hinweg. Wenn das Ergebnis mehr als 10.000 Leerzeichen umfasst, ist dieser Wert eine Schätzung.

SetUpSpaceRequest

Anfrage zum Erstellen eines Gruppenbereichs und Hinzufügen bestimmter Nutzer

Felder
space	Space Erforderlich. Space.spaceType ist ein Pflichtfeld. Um einen Gruppenbereich zu erstellen, legen Sie Space.spaceType auf SPACE und Space.displayName fest. 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. Um einen Gruppenchat zu erstellen, setzen Sie Space.spaceType auf GROUP_CHAT. Legen Sie Space.displayName nicht fest. Wenn Sie eine 1:1-Unterhaltung zwischen Menschen erstellen möchten, setzen Sie Space.spaceType auf DIRECT_MESSAGE und Space.singleUserBotDm auf false. Legen Sie Space.displayName oder Space.spaceDetails nicht fest. Wenn Sie eine 1:1-Unterhaltung zwischen einem Menschen und der aufrufenden Chat-App erstellen möchten, legen Sie Space.spaceType auf DIRECT_MESSAGE und Space.singleUserBotDm auf true fest. Legen Sie Space.displayName oder Space.spaceDetails nicht fest. Wenn ein DIRECT_MESSAGE-Bereich bereits vorhanden ist, wird dieser zurückgegeben, anstatt einen neuen zu erstellen.
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.
memberships[]	Membership Optional. Die Google Chat-Nutzer oder -Gruppen, die Sie einladen möchten, dem Gruppenbereich beizutreten. Lassen Sie den anrufenden Nutzer weg, da er automatisch hinzugefügt wird. Das Set ermöglicht derzeit bis zu 49 Mitgliedschaften (zusätzlich zum Anrufer). Für die Mitgliedschaft von Personen muss das Feld Membership.member ein user mit dem ausgefüllten Feld name (Format: users/{user}) enthalten und type muss auf User.Type.HUMAN festgelegt sein. Sie können nur menschliche Nutzer hinzufügen, wenn Sie einen Gruppenbereich einrichten. Das Hinzufügen von Chat-Apps wird nur bei der Einrichtung von Direktnachrichten mit der Anruf-App unterstützt. Sie können auch Mitglieder hinzufügen, indem Sie die E-Mail-Adresse des Nutzers als Alias für {user} verwenden. user.name kann beispielsweise users/[e-mail] sein. Wenn Sie Gmail-Nutzer oder Nutzer aus externen Google Workspace-Domains einladen möchten, muss die E-Mail-Adresse des Nutzers für {user} verwendet werden. Für die Mitgliedschaft in einer Google-Gruppe muss das Feld Membership.group_member eine group mit dem Wert name enthalten (Format groups/{group}). Sie können Google-Gruppen nur hinzufügen, wenn Sie Space.spaceType auf SPACE festlegen. Optional, wenn Space.spaceType auf SPACE gesetzt ist. Erforderlich, wenn Space.spaceType auf GROUP_CHAT gesetzt ist und mindestens zwei Mitgliedschaften vorhanden sind. Erforderlich, wenn Space.spaceType für einen menschlichen Nutzer auf DIRECT_MESSAGE gesetzt wird und genau eine Mitgliedschaft vorhanden ist. Muss leer sein, wenn eine 1:1-Unterhaltung zwischen einem Menschen und der aufrufenden Chat-App erstellt wird (wenn Space.spaceType auf DIRECT_MESSAGE und Space.singleUserBotDm auf true festgelegt ist).

SlashCommand

Metadaten zu einem Slash-Befehl in Google Chat.

Felder
command_id	int64 Die ID des Slash-Befehls.

SlashCommandMetadata

Metadaten für Annotationen für Slash-Befehle (/).

Felder
bot	User Die Chat-App, deren Befehl aufgerufen wurde.
type	Type Der Typ des Slash-Befehls.
command_name	string Der Name des aufgerufenen Slash-Befehls.
command_id	int64 Die Befehls-ID des aufgerufenen Slash-Befehls.
triggers_dialog	bool Gibt an, ob der Slash-Befehl für ein Dialogfeld ist.

Typ

Enums
TYPE_UNSPECIFIED	Standardwert für die Enumeration. Nicht verwenden.
ADD	Fügen Sie die Chat-App dem Gruppenbereich hinzu.
INVOKE	Slash-Befehl in einem Gruppenbereich aufrufen

Leerzeichen

Ein Gruppenbereich in Google Chat. Gruppenbereiche sind Unterhaltungen zwischen zwei oder mehr Nutzern oder 1:1-Nachrichten zwischen einem Nutzer und einer Chat-App.

Felder
name	string Kennung. Ressourcenname des Bereichs. Format: spaces/{space} Dabei steht {space} für die vom System zugewiesene ID für den Bereich. Sie können die Gruppenbereichs-ID abrufen, indem Sie die Methode spaces.list() aufrufen oder die Gruppenbereichs-URL verwenden. Wenn die URL des Bereichs beispielsweise https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA lautet, ist die Bereichs-ID AAAAAAAAA.
type (deprecated)	Type Dieses Element ist veraltet. Nur Ausgabe. Verworfen: Verwenden Sie stattdessen space_type. Der Typ eines Gruppenbereichs.
space_type	SpaceType Optional. Der Typ des Gruppenbereichs. Erforderlich beim Erstellen eines Gruppenbereichs oder beim Aktualisieren des Typs eines Gruppenbereichs. Nur Ausgabe für andere Verwendungszwecke.
single_user_bot_dm	bool Optional. Gibt an, ob es sich bei dem Gruppenbereich um eine Direktnachricht zwischen einer Chat-App und einem einzelnen Nutzer handelt.
threaded (deprecated)	bool Dieses Element ist veraltet. Nur Ausgabe. Verworfen: Verwenden Sie stattdessen spaceThreadingState. Ob Nachrichten in diesem Gruppenbereich in Threads organisiert sind.
display_name	string Optional. Der Anzeigename des Bereichs. Erforderlich, wenn Sie einen Gruppenbereich erstellen und spaceType auf SPACE gesetzt ist. Wenn Sie beim Erstellen eines Gruppenbereichs oder beim Aktualisieren der displayName die Fehlermeldung ALREADY_EXISTS erhalten, versuchen Sie es mit einer anderen displayName. Möglicherweise wird dieser Anzeigename bereits für einen vorhandenen Gruppenbereich in der Google Workspace-Organisation verwendet. Bei Direktnachrichten ist dieses Feld möglicherweise leer. Unterstützt bis zu 128 Zeichen.
external_user_allowed	bool Optional. Nicht veränderbar. Gibt an, ob jeder Google Chat-Nutzer Mitglied dieses Bereichs sein darf. Eingabe beim Erstellen eines Gruppenbereichs in einer Google Workspace-Organisation. Lassen Sie dieses Feld beim Erstellen von Bereichen unter den folgenden Bedingungen weg: Der authentifizierte Nutzer verwendet ein privates Konto (nicht verwaltetes Nutzerkonto). Standardmäßig ist in einem von einem privaten Konto erstellten Gruppenbereich jeder Google Chat-Nutzer zugelassen. Bei vorhandenen Bereichen dient dieses Feld nur der Ausgabe.
space_threading_state	SpaceThreadingState Nur Ausgabe. Der Status von Unterhaltungsthreads im Chatbereich.
space_details	SpaceDetails Optional. Details zum Gruppenbereich, einschließlich Beschreibung und Regeln.
space_history_state	HistoryState Optional. Der Status des Nachrichtenverlaufs für Nachrichten und Threads in diesem Gruppenbereich.
import_mode	bool Optional. Gibt an, ob dieser Gruppenbereich in Import Mode im Rahmen einer Datenmigration in Google Workspace erstellt wurde. Während Gruppenbereiche importiert werden, sind sie für Nutzer erst sichtbar, wenn der Import abgeschlossen ist. Zum Erstellen eines Gruppenbereichs in Import Mode ist eine Nutzerauthentifizierung erforderlich.
create_time	Timestamp Optional. Nicht veränderbar. Bei in Chat erstellten Gruppenbereichen ist das der Zeitpunkt, zu dem der Gruppenbereich erstellt wurde. Dieses Feld dient nur der Ausgabe, außer wenn es in Gruppenbereichen im Importmodus verwendet wird. Legen Sie dieses Feld für Gruppenbereiche im Importmodus auf den historischen Zeitstempel fest, zu dem der Gruppenbereich in der Quelle erstellt wurde, um den ursprünglichen Erstellungszeitpunkt beizubehalten. Wird in der Ausgabe nur ausgefüllt, wenn spaceType GROUP_CHAT oder SPACE ist.
last_active_time	Timestamp Nur Ausgabe. Zeitstempel der letzten Nachricht im Gruppenbereich.
admin_installed	bool Nur Ausgabe. Bei Direktnachrichtenbereichen (DMs) mit einer Chat-App wird angegeben, ob der Bereich von einem Google Workspace-Administrator erstellt wurde. Administratoren können im Namen von Nutzern in ihrer Organisation eine Direktnachricht mit einer Chat-App installieren und einrichten. Damit die Installation durch Administratoren unterstützt wird, muss Ihre Chat-App Direktnachrichten unterstützen.
membership_count	MembershipCount Nur Ausgabe. Die Anzahl der Mitgliedschaften, die nach Mitgliedstyp gruppiert sind. Wird ausgefüllt, wenn space_type SPACE, DIRECT_MESSAGE oder GROUP_CHAT ist.
access_settings	AccessSettings Optional. Gibt die Zugriffseinstellung des Gruppenbereichs an. Wird nur ausgefüllt, wenn der space_type SPACE ist.
space_uri	string Nur Ausgabe. Der URI, über den ein Nutzer auf den Bereich zugreifen kann.
import_mode_expire_time	Timestamp Nur Ausgabe. Die Zeit, zu der der Bereich automatisch vom System gelöscht wird, wenn er im Importmodus verbleibt. Jeder im Importmodus erstellte Bereich muss diesen Modus vor Ablauf der Frist mit spaces.completeImport verlassen. Dieses Feld wird nur für Gruppenbereiche ausgefüllt, die im Importmodus erstellt wurden.
customer	string Optional. Nicht veränderbar. Die Kunden-ID der Domain des Gruppenbereichs. Nur erforderlich, wenn Sie einen Projektbereich mit App-Authentifizierung erstellen und SpaceType SPACE ist. Andernfalls sollte dieser Parameter nicht festgelegt werden. Im Format customers/{customer}, wobei customer die id aus der [Admin SDK-Kundenressource]( https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers) ist. Bei privaten Apps kann auch der Alias customers/my_customer verwendet werden, um den Bereich in derselben Google Workspace-Organisation wie die App zu erstellen. Bei DMs wird dieses Feld nicht ausgefüllt. Entwicklervorschau:Im Rahmen des Google Workspace-Entwicklervorschauprogramms verfügbar, das Vorabzugriff auf bestimmte Funktionen bietet.
Union-Feld space_permission_settings. Stellt die Berechtigungseinstellungen eines Gruppenbereichs dar. Wird nur ausgefüllt, wenn der space_type SPACE ist. Für space_permission_settings ist nur einer der folgenden Werte zulässig:
predefined_permission_settings	PredefinedPermissionSettings Optional. Nur Eingabe. Vordefinierte Berechtigungseinstellungen für Gruppenbereiche, die nur beim Erstellen eines Gruppenbereichs eingegeben werden können. Wenn das Feld nicht festgelegt ist, wird ein Arbeitsbereich für die Zusammenarbeit erstellt. Nachdem Sie den Gruppenbereich erstellt haben, werden die Einstellungen im Feld PermissionSettings eingetragen. Das Festlegen vordefinierter Berechtigungseinstellungen bietet folgende Vorteile: In der Entwicklervorschau ist die App-Authentifizierung mit Administratorgenehmigung mit den Bereichen chat.app.spaces oder chat.app.spaces.create verfügbar. Nutzerauthentifizierung
permission_settings	PermissionSettings Optional. Berechtigungseinstellungen für vorhandene Gruppenbereiche Eingabe zum Aktualisieren der genauen Berechtigungseinstellungen für Gruppenbereiche, wobei vorhandene Berechtigungseinstellungen ersetzt werden. Die Ausgabe enthält die aktuellen Berechtigungseinstellungen. Das Lesen und Aktualisieren von Berechtigungseinstellungen wird unterstützt für: In der Entwicklervorschau ist die App-Authentifizierung mit Administratorgenehmigung mit dem Bereich chat.app.spaces verfügbar. Wird nur ausgefüllt und kann nur festgelegt werden, wenn die Chat-App den Gruppenbereich erstellt hat. Nutzerauthentifizierung

AccessSettings

Stellt die Zugriffseinstellung des Bereichs dar.

Felder
access_state	AccessState Nur Ausgabe. Gibt den Zugriffsstatus des Bereichs an.
audience	string Optional. Der Ressourcenname der Zielgruppe, die den Gruppenbereich finden, ihm beitreten und die Nachrichten im Gruppenbereich als Vorschau ansehen kann. Wenn diese Option nicht festgelegt ist, können nur Nutzer oder Google-Gruppen, die einzeln eingeladen oder dem Gruppenbereich hinzugefügt wurden, darauf zugreifen. Weitere Informationen finden Sie im Hilfeartikel Gruppenbereich für eine Zielgruppe sichtbar machen. Format: audiences/{audience} Wenn Sie die Standardzielgruppe für die Google Workspace-Organisation verwenden möchten, legen Sie audiences/default fest. Die Zielgruppe lesen: Nutzerauthentifizierung App-Authentifizierung mit Administratorgenehmigung mit dem Bereich chat.app.spaces in Entwicklervorschau:Im Rahmen des Google Workspace-Entwicklervorschauprogramms verfügbar, das Vorabzugriff auf bestimmte Funktionen bietet. Dieses Feld wird nicht ausgefüllt, wenn der chat.bot-Bereich mit der App-Authentifizierung verwendet wird. Zum Festlegen der Zielgruppe ist eine Nutzerauthentifizierung erforderlich.

AccessState

Gibt den Zugriffsstatus des Gruppenbereichs an.

Enums
ACCESS_STATE_UNSPECIFIED	Der Zugriffsstatus ist unbekannt oder wird in dieser API nicht unterstützt.
PRIVATE	Nur Nutzer oder Google-Gruppen, die von anderen Nutzern oder Google Workspace-Administratoren einzeln hinzugefügt oder eingeladen wurden, können den Gruppenbereich finden und darauf zugreifen.
DISCOVERABLE	Der Administrator des Gruppenbereichs hat einer Zielgruppe Zugriff auf den Gruppenbereich gewährt. Nutzer oder Google-Gruppen, die dem Gruppenbereich einzeln hinzugefügt oder in den Gruppenbereich eingeladen wurden, können den Gruppenbereich auch finden und darauf zugreifen. Weitere Informationen finden Sie unter Projektbereich für bestimmte Nutzer auffindbar machen. Zum Erstellen von Gruppenbereichen mit offenem Zugang ist eine Nutzerauthentifizierung erforderlich.

MembershipCount

Stellt die Anzahl der Mitgliedschaften eines Bereichs dar, gruppiert nach Kategorien.

Felder
joined_direct_human_user_count	int32 Nur Ausgabe. Anzahl der Nutzer, die dem Gruppenbereich direkt beigetreten sind. Nutzer, die über die Mitgliedschaft in einer Gruppe beigetreten sind, werden nicht gezählt.
joined_group_count	int32 Nur Ausgabe. Anzahl aller Gruppen, die dem Gruppenbereich direkt beigetreten sind.

PermissionSetting

Stellt eine Berechtigungseinstellung für einen Gruppenbereich dar.

Felder
managers_allowed	bool Optional. Ob Administratoren von Gruppenbereichen diese Berechtigung haben.
members_allowed	bool Optional. Gibt an, ob Mitglieder ohne Administratorrolle diese Berechtigung haben.

PermissionSettings

Berechtigungseinstellungen, die Sie beim Aktualisieren eines vorhandenen benannten Bereichs angeben können.

Wenn Sie beim Erstellen eines Bereichs Berechtigungseinstellungen festlegen möchten, geben Sie das Feld PredefinedPermissionSettings in Ihrer Anfrage an.

Felder
manage_members_and_groups	PermissionSetting Optional. Einstellung zum Verwalten von Mitgliedern und Gruppen in einem Space.
modify_space_details	PermissionSetting Optional. Einstellung zum Aktualisieren von Name, Avatar, Beschreibung und Richtlinien des Gruppenbereichs.
toggle_history	PermissionSetting Optional. Einstellung zum Aktivieren und Deaktivieren des Gruppenbereichsverlaufs.
use_at_mention_all	PermissionSetting Optional. Einstellung für die Verwendung von @alle in einem Gruppenbereich.
manage_apps	PermissionSetting Optional. Einstellung zum Verwalten von Apps in einem Bereich.
manage_webhooks	PermissionSetting Optional. Einstellung zum Verwalten von Webhooks in einem Bereich.
post_messages	PermissionSetting Nur Ausgabe. Einstellung zum Posten von Nachrichten in einem Gruppenbereich.
reply_messages	PermissionSetting Optional. Einstellung zum Antworten auf Nachrichten in einem Gruppenbereich.

PredefinedPermissionSettings

Vordefinierte Berechtigungseinstellungen, die Sie nur beim Erstellen eines benannten Gruppenbereichs angeben können. In Zukunft werden möglicherweise weitere Einstellungen hinzugefügt. Weitere Informationen zu den Berechtigungseinstellungen für benannte Bereiche finden Sie unter Bereiche.

Enums
PREDEFINED_PERMISSION_SETTINGS_UNSPECIFIED	Nicht angegeben Nicht verwenden.
COLLABORATION_SPACE	Einstellung, um den Gruppenbereich zu einem Gruppenbereich für die Zusammenarbeit zu machen, in dem alle Mitglieder Nachrichten posten können.
ANNOUNCEMENT_SPACE	Einstellung, um den Gruppenbereich in einen Gruppenbereich für Ankündigungen umzuwandeln, in dem nur Administratoren des Gruppenbereichs Nachrichten posten können.

SpaceDetails

Details zum Gruppenbereich, einschließlich Beschreibung und Regeln.

Felder
description	string Optional. Eine Beschreibung des Gruppenbereichs. Beschreiben Sie beispielsweise das Diskussionsthema, den funktionalen Zweck oder die Teilnehmer des Bereichs. Unterstützt bis zu 150 Zeichen.
guidelines	string Optional. Regeln, Erwartungen und Verhaltensregeln für den Gruppenbereich. Es können bis zu 5.000 Zeichen eingegeben werden.

SpaceThreadingState

Gibt den Typ des Threading-Zustands im Chatbereich an.

Enums
SPACE_THREADING_STATE_UNSPECIFIED	Reserviert.
THREADED_MESSAGES	Benannte Bereiche, die Nachrichten-Threads unterstützen. Wenn Nutzer auf eine Nachricht antworten, können sie dies im Thread tun. So bleibt ihre Antwort im Kontext der ursprünglichen Nachricht.
GROUPED_MESSAGES	Benannte Gruppenbereiche, in denen Unterhaltungen nach Thema sortiert sind. Themen und ihre Antworten werden gruppiert.
UNTHREADED_MESSAGES	Direktnachrichten zwischen zwei Personen und Gruppenunterhaltungen zwischen mindestens drei Personen.

SpaceType

Der Typ des Gruppenbereichs. Erforderlich beim Erstellen oder Aktualisieren eines Projektbereichs. Nur Ausgabe für andere Verwendungszwecke.

Enums
SPACE_TYPE_UNSPECIFIED	Reserviert.
SPACE	Ein Ort, an dem Nutzer Nachrichten senden, Dateien teilen und zusammenarbeiten können. Eine SPACE kann Chat-Apps enthalten.
GROUP_CHAT	Gruppenunterhaltungen mit mindestens drei Personen. Eine GROUP_CHAT kann Chat-Apps enthalten.
DIRECT_MESSAGE	1:1-Nachrichten zwischen zwei Personen oder zwischen einer Person und einer Chat-App.

Typ

Verworfen: Verwenden Sie stattdessen SpaceType.

Enums
TYPE_UNSPECIFIED	Reserviert.
ROOM	Unterhaltungen zwischen zwei oder mehr Menschen.
DM	1:1-Direktnachricht zwischen einem Menschen und einer Chat-App, in der alle Nachrichten flach sind. Direktnachrichten zwischen zwei Personen sind davon nicht betroffen.

SpaceBatchUpdatedEventData

Ereignisnutzlast für mehrere Aktualisierungen eines Bereichs.

Ereignistyp: google.workspace.chat.space.v1.batchUpdated

Felder
spaces[]	SpaceUpdatedEventData Eine Liste der aktualisierten Gruppenbereiche.

SpaceEvent

Ein Ereignis, das eine Änderung oder Aktivität in einem Google Chat-Gruppenbereich darstellt. Weitere Informationen

Felder
name	string Ressourcenname des Gruppenbereich-Ereignisses. Format: spaces/{space}/spaceEvents/{spaceEvent}
event_time	Timestamp Zeitpunkt des Ereignisses.
event_type	string Art des Gruppenbereich-Ereignisses. Für jeden Ereignistyp gibt es eine Batch-Version, die mehrere Instanzen des Ereignistyps darstellt, die in einem kurzen Zeitraum auftreten. Lassen Sie bei spaceEvents.list()-Anfragen Batch-Ereignistypen in Ihrem Abfragefilter weg. Standardmäßig gibt der Server sowohl den Ereignistyp als auch die Batch-Version zurück. Unterstützte Ereignistypen für Mitteilungen: Neue Nachricht: google.workspace.chat.message.v1.created Aktualisierte Nachricht: google.workspace.chat.message.v1.updated Gelöschte Nachricht: google.workspace.chat.message.v1.deleted Mehrere neue Nachrichten: google.workspace.chat.message.v1.batchCreated Mehrere aktualisierte Nachrichten: google.workspace.chat.message.v1.batchUpdated Mehrere gelöschte Nachrichten: google.workspace.chat.message.v1.batchDeleted Unterstützte Ereignistypen für Mitgliedschaften: Neue Mitgliedschaft: google.workspace.chat.membership.v1.created Aktualisierte Mitgliedschaft: google.workspace.chat.membership.v1.updated Gelöschte Mitgliedschaft: google.workspace.chat.membership.v1.deleted Mehrere neue Mitgliedschaften: google.workspace.chat.membership.v1.batchCreated Mehrere aktualisierte Mitgliedschaften: google.workspace.chat.membership.v1.batchUpdated Mehrere gelöschte Mitgliedschaften: google.workspace.chat.membership.v1.batchDeleted Unterstützte Ereignistypen für Reaktionen: Neue Reaktion: google.workspace.chat.reaction.v1.created Gelöschte Reaktion: google.workspace.chat.reaction.v1.deleted Mehrere neue Reaktionen: google.workspace.chat.reaction.v1.batchCreated Mehrere gelöschte Reaktionen: google.workspace.chat.reaction.v1.batchDeleted Unterstützte Ereignistypen für den Arbeitsbereich: Aktualisierter Speicherplatz: google.workspace.chat.space.v1.updated Mehrere Updates zum Gruppenbereich: google.workspace.chat.space.v1.batchUpdated
Union-Feld payload. Für payload ist nur einer der folgenden Werte zulässig:
message_created_event_data	MessageCreatedEventData Ereignis-Nutzlast für eine neue Nachricht. Ereignistyp: google.workspace.chat.message.v1.created
message_updated_event_data	MessageUpdatedEventData Ereignisnutzlast für eine aktualisierte Nachricht. Ereignistyp: google.workspace.chat.message.v1.updated
message_deleted_event_data	MessageDeletedEventData Ereignis-Nutzlast für eine gelöschte Nachricht. Ereignistyp: google.workspace.chat.message.v1.deleted
message_batch_created_event_data	MessageBatchCreatedEventData Ereignisnutzlast für mehrere neue Nachrichten. Ereignistyp: google.workspace.chat.message.v1.batchCreated
message_batch_updated_event_data	MessageBatchUpdatedEventData Ereignis-Nutzlast für mehrere aktualisierte Nachrichten. Ereignistyp: google.workspace.chat.message.v1.batchUpdated
message_batch_deleted_event_data	MessageBatchDeletedEventData Ereignis-Payload für mehrere gelöschte Nachrichten. Ereignistyp: google.workspace.chat.message.v1.batchDeleted
space_updated_event_data	SpaceUpdatedEventData Ereignisnutzlast für eine Bereichsaktualisierung. Ereignistyp: google.workspace.chat.space.v1.updated
space_batch_updated_event_data	SpaceBatchUpdatedEventData Ereignisnutzlast für mehrere Aktualisierungen eines Bereichs. Ereignistyp: google.workspace.chat.space.v1.batchUpdated
membership_created_event_data	MembershipCreatedEventData Ereignis-Payload für eine neue Mitgliedschaft. Ereignistyp: google.workspace.chat.membership.v1.created
membership_updated_event_data	MembershipUpdatedEventData Ereignis-Nutzlast für eine aktualisierte Mitgliedschaft. Ereignistyp: google.workspace.chat.membership.v1.updated
membership_deleted_event_data	MembershipDeletedEventData Ereignis-Nutzlast für eine gelöschte Mitgliedschaft. Ereignistyp: google.workspace.chat.membership.v1.deleted
membership_batch_created_event_data	MembershipBatchCreatedEventData Ereignis-Payload für mehrere neue Mitgliedschaften. Ereignistyp: google.workspace.chat.membership.v1.batchCreated
membership_batch_updated_event_data	MembershipBatchUpdatedEventData Ereignis-Nutzlast für mehrere aktualisierte Mitgliedschaften. Ereignistyp: google.workspace.chat.membership.v1.batchUpdated
membership_batch_deleted_event_data	MembershipBatchDeletedEventData Ereignis-Nutzlast für mehrere gelöschte Mitgliedschaften. Ereignistyp: google.workspace.chat.membership.v1.batchDeleted
reaction_created_event_data	ReactionCreatedEventData Ereignis-Nutzlast für eine neue Reaktion. Ereignistyp: google.workspace.chat.reaction.v1.created
reaction_deleted_event_data	ReactionDeletedEventData Ereignis-Nutzlast für eine gelöschte Reaktion. Ereignistyp: google.workspace.chat.reaction.v1.deleted
reaction_batch_created_event_data	ReactionBatchCreatedEventData Ereignisnutzlast für mehrere neue Reaktionen. Ereignistyp: google.workspace.chat.reaction.v1.batchCreated
reaction_batch_deleted_event_data	ReactionBatchDeletedEventData Ereignis-Payload für mehrere gelöschte Reaktionen. Ereignistyp: google.workspace.chat.reaction.v1.batchDeleted

SpaceNotificationSetting

Die Benachrichtigungseinstellung eines Nutzers in einem Bereich.

Felder
name	string Kennung. Der Ressourcenname der Space-Benachrichtigungseinstellung. Format: users/{user}/spaces/{space}/spaceNotificationSetting.
notification_setting	NotificationSetting Die Benachrichtigungseinstellung
mute_setting	MuteSetting Die Einstellung zum Stummschalten von Benachrichtigungen für den Gruppenbereich.

MuteSetting

Die Typen der Einstellungen zum Ausblenden von Benachrichtigungen für Gruppenbereiche.

Enums
MUTE_SETTING_UNSPECIFIED	Reserviert.
UNMUTED	Der Nutzer erhält Benachrichtigungen für den Bereich entsprechend der Benachrichtigungseinstellung.
MUTED	Der Nutzer erhält keine Benachrichtigungen für den Gruppenbereich, unabhängig von der Benachrichtigungseinstellung.

NotificationSetting

Die Benachrichtigungseinstellungstypen. Möglicherweise werden in Zukunft weitere Typen unterstützt.

Enums
NOTIFICATION_SETTING_UNSPECIFIED	Reserviert.
ALL	Benachrichtigungen werden durch @Erwähnungen, Unterhaltungen, denen Sie folgen, und die erste Nachricht in neuen Unterhaltungen ausgelöst. Alle neuen Threads werden automatisch abonniert, sofern der Nutzer das Abonnement nicht manuell beendet.
MAIN_CONVERSATIONS	Die Benachrichtigung wird durch @Erwähnungen, Unterhaltungen, denen Sie folgen, und die erste Nachricht in neuen Unterhaltungen ausgelöst. Nicht für 1:1-Direktnachrichten verfügbar.
FOR_YOU	Die Benachrichtigung wird durch @Erwähnungen und Unterhaltungen, denen Sie folgen, ausgelöst. Nicht für 1:1-Direktnachrichten verfügbar.
OFF	Benachrichtigungen sind deaktiviert.

SpaceReadState

Der Lesestatus eines Nutzers in einem Gruppenbereich, mit dem gelesene und ungelesene Nachrichten identifiziert werden.

Felder
name	string Ressourcenname des Lesestatus des Bereichs. Format: users/{user}/spaces/{space}/spaceReadState
last_read_time	Timestamp Optional. Der Zeitpunkt, zu dem der Lesestatus des Nutzers für den Bereich aktualisiert wurde. Normalerweise entspricht dies entweder dem Zeitstempel der letzten gelesenen Nachricht oder einem vom Nutzer angegebenen Zeitstempel, um die letzte gelesene Position in einem Bereich zu markieren.

SpaceUpdatedEventData

Ereignisnutzlast für einen aktualisierten Bereich.

Ereignistyp: google.workspace.chat.space.v1.updated

Felder
space	Space Der aktualisierte Gruppenbereich.

Thread

Ein Thread in einem Google Chat-Bereich. Beispiele für die Verwendung finden Sie unter Nachrichtenthread starten oder darauf antworten.

Wenn Sie beim Erstellen einer Nachricht einen Thread angeben, können Sie das Feld messageReplyOption festlegen, um zu bestimmen, was passiert, wenn kein passender Thread gefunden wird.

Felder
name	string Kennung. Ressourcenname des Threads. Beispiel: spaces/{space}/threads/{thread}
thread_key	string Optional. Eingabe zum Erstellen oder Aktualisieren eines Threads. Andernfalls nur Ausgabe. ID für den Thread. Es können bis zu 4.000 Zeichen eingegeben werden. Diese ID ist eindeutig für die Chat-App, die sie festlegt. Wenn beispielsweise mehrere Chat-Apps eine Nachricht mit demselben Thread-Schlüssel erstellen, werden die Nachrichten in verschiedenen Threads gepostet. Wenn Sie in einem Thread antworten möchten, der von einer Person oder einer anderen Chat-App erstellt wurde, geben Sie stattdessen das Feld name an.

ThreadReadState

Der Lesestatus eines Nutzers in einem Thread, mit dem gelesene und ungelesene Nachrichten identifiziert werden.

Felder
name	string Ressourcenname des Lesestatus des Threads. Format: users/{user}/spaces/{space}/threads/{thread}/threadReadState
last_read_time	Timestamp Der Zeitpunkt, zu dem der Lesestatus des Threads des Nutzers aktualisiert wurde. Dies entspricht in der Regel dem Zeitstempel der letzten gelesenen Nachricht in einem Thread.

UpdateMembershipRequest

Anfragenachricht zum Aktualisieren einer Mitgliedschaft

Felder
membership	Membership Erforderlich. Die zu aktualisierende Mitgliedschaft. Nur die von update_mask angegebenen Felder werden aktualisiert.
update_mask	FieldMask Erforderlich. Die zu aktualisierenden Feldpfade. Trennen Sie mehrere Werte durch Kommas oder verwenden Sie *, um alle Feldpfade zu aktualisieren. Derzeit unterstützte Feldpfade: role
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.

UpdateMessageRequest

Anfrage zum Aktualisieren einer Nachricht

Felder
message	Message Erforderlich. Nachricht mit aktualisierten Feldern.
update_mask	FieldMask Erforderlich. Die zu aktualisierenden Feldpfade. Trennen Sie mehrere Werte durch Kommas oder verwenden Sie *, um alle Feldpfade zu aktualisieren. Derzeit unterstützte Feldpfade: text attachment cards (App-Authentifizierung erforderlich) cards_v2 (App-Authentifizierung erforderlich) accessory_widgets (App-Authentifizierung erforderlich)
allow_missing	bool Optional. Wenn true und die Nachricht nicht gefunden werden, wird eine neue Nachricht erstellt und updateMask wird ignoriert. Die angegebene Nachrichten-ID muss clientseitig zugewiesen sein. Andernfalls schlägt die Anfrage fehl.

UpdateSpaceNotificationSettingRequest

Anfrage zum Aktualisieren der Benachrichtigungseinstellungen für Gruppenbereiche Unterstützt nur das Aktualisieren der Benachrichtigungseinstellung für den anrufenden Nutzer.

Felder
space_notification_setting	SpaceNotificationSetting Erforderlich. Der Ressourcenname für die Einstellungen für Benachrichtigungen für den Bereich muss im Format users/{user}/spaces/{space}/spaceNotificationSetting angegeben werden. Nur die von update_mask angegebenen Felder werden aktualisiert.
update_mask	FieldMask Erforderlich. Unterstützte Feldpfade: notification_setting mute_setting

UpdateSpaceReadStateRequest

Anfragenachricht für die UpdateSpaceReadState API.

Felder
space_read_state	SpaceReadState Erforderlich. Der Lesestatus des Gruppenbereichs und die zu aktualisierenden Felder. Unterstützt nur das Aktualisieren des Lesestatus für den aufrufenden Nutzer. Um auf den aufrufenden Nutzer zu verweisen, legen Sie einen der folgenden Werte fest: Der Alias me. Beispiel: users/me/spaces/{space}/spaceReadState. Ihre Workspace-E-Mail-Adresse. Beispiel: users/[e-mail]/spaces/{space}/spaceReadState. Ihre Nutzer-ID. Beispiel: users/123456789/spaces/{space}/spaceReadState. Format: users/{user}/spaces/{space}/spaceReadState
update_mask	FieldMask Erforderlich. Die zu aktualisierenden Feldpfade. Derzeit unterstützte Feldpfade: last_read_time Wenn last_read_time vor dem Erstellungszeitpunkt der letzten Nachricht liegt, wird der Gruppenbereich in der Benutzeroberfläche als ungelesen angezeigt. Wenn Sie den Bereich als gelesen markieren möchten, legen Sie last_read_time auf einen beliebigen Wert fest, der später (größer) als die Erstellungszeit der letzten Nachricht ist. Der Wert für last_read_time wird so angepasst, dass er mit der Erstellungszeit der letzten Nachricht übereinstimmt. Der Lesestatus des Gruppenbereichs wirkt sich nur auf den Lesestatus von Nachrichten aus, die in der Unterhaltung der obersten Ebene des Gruppenbereichs sichtbar sind. Antworten in Threads sind von diesem Zeitstempel nicht betroffen. Stattdessen wird der Lesestatus des Threads berücksichtigt.

UpdateSpaceRequest

Eine Anfrage zum Aktualisieren eines einzelnen Gruppenbereichs.

Felder
space	Space Erforderlich. Gruppenbereich mit den zu aktualisierenden Feldern. Space.name muss im Format spaces/{space} ausgefüllt werden. Nur die von update_mask angegebenen Felder werden aktualisiert.
update_mask	FieldMask Erforderlich. Die aktualisierten Feldpfade, durch Kommas getrennt, falls es mehrere gibt. Sie können die folgenden Felder für einen Bereich aktualisieren: space_details: Aktualisiert die Beschreibung des Gruppenbereichs. Unterstützt bis zu 150 Zeichen. display_name: Nur das Aktualisieren des Anzeigenamens für Bereiche wird unterstützt, in denen das Feld spaceType SPACE ist. Wenn Sie die Fehlermeldung ALREADY_EXISTS erhalten, versuchen Sie es mit einem anderen Wert. Möglicherweise wird dieser Anzeigename bereits für einen vorhandenen Gruppenbereich in der Google Workspace-Organisation verwendet. space_type: Es wird nur das Ändern eines GROUP_CHAT-Bereichstyps in SPACE unterstützt. Nehmen Sie display_name zusammen mit space_type in die Aktualisierungsmaske auf und achten Sie darauf, dass der angegebene Space einen nicht leeren Anzeigenamen und den Space-Typ SPACE hat. Das Einbeziehen der space_type-Maske und des SPACE-Typs im angegebenen Bereich beim Aktualisieren des Anzeigenamens ist optional, wenn der vorhandene Bereich bereits den SPACE-Typ hat. Wenn Sie versuchen, den Bereichstyp auf andere Weise zu aktualisieren, wird ein Fehler wegen eines ungültigen Arguments ausgegeben. space_type wird mit useAdminAccess nicht unterstützt. space_history_state: Aktualisiert die Einstellungen für den Gruppenbereichsverlauf, indem der Verlauf für den Gruppenbereich aktiviert oder deaktiviert wird. Wird nur unterstützt, wenn die Verlaufseinstellungen für die Google Workspace-Organisation aktiviert sind. Wenn Sie den Status des Gruppenbereichs aktualisieren möchten, müssen Sie alle anderen Feldmasken in Ihrer Anfrage weglassen. space_history_state wird mit useAdminAccess nicht unterstützt. access_settings.audience: Aktualisiert die Zugriffseinstellung für die Nutzer, die den benannten Gruppenbereich finden, ihm beitreten und die Nachrichten darin ansehen können, wenn das Feld spaceType SPACE ist. Wenn der vorhandene Gruppenbereich eine Zielgruppe hat, können Sie sie entfernen und den Zugriff auf den Gruppenbereich einschränken, indem Sie keinen Wert für diese Feldmaske angeben. Wenn Sie die Zugriffseinstellungen für einen Bereich aktualisieren möchten, muss der authentifizierende Nutzer ein Bereichsmanager sein und alle anderen Feldmasken in Ihrer Anfrage weglassen. Sie können dieses Feld nicht aktualisieren, wenn sich der Bereich im Importmodus befindet. Weitere Informationen finden Sie unter Projektbereich für bestimmte Nutzer auffindbar machen. access_settings.audience wird mit useAdminAccess nicht unterstützt. permission_settings: Unterstützt das Ändern der Berechtigungseinstellungen eines Bereichs. Beim Aktualisieren von Berechtigungseinstellungen können Sie nur permissionSettings-Feldmasken angeben. Andere Feldmasken können nicht gleichzeitig aktualisiert werden. permissionSettings wird mit useAdminAccess nicht unterstützt. Die unterstützten Feldmasken sind: permission_settings.manageMembersAndGroups permission_settings.modifySpaceDetails permission_settings.toggleHistory permission_settings.useAtMentionAll permission_settings.manageApps permission_settings.manageWebhooks permission_settings.replyMessages
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.spaces OAuth 2.0-Bereich. Einige FieldMask-Werte werden mit Administratorzugriff nicht unterstützt. Weitere Informationen finden Sie in der Beschreibung von update_mask.

Nutzer

Ein Nutzer in Google Chat. Wenn Ihre Chat-App als Nutzer authentifiziert wird und die Antwort einer Anfrage eine User-Ressource enthält, werden nur die name und type des Nutzers ausgegeben.

Felder
name	string Ressourcenname für eine Google Chat-user. Format: users/{user}. users/app kann als Alias für den Nutzer der Anruf-App bot verwendet werden. Für human users ist {user} dieselbe Nutzer-ID wie: die id für die Person in der People API. Beispiel: users/123456789 in der Chat API steht für dieselbe Person wie die Personenprofil-ID 123456789 in der People API. die id für einen Nutzer in der Admin SDK Directory API. Die E-Mail-Adresse des Nutzers kann als Alias für {user} in API-Anfragen verwendet werden. Wenn die Personenprofil-ID der People API für [e-mail] beispielsweise 123456789 ist, können Sie users/[e-mail] als Alias verwenden, um auf users/123456789 zu verweisen. Von der API wird nur der kanonische Ressourcenname (z. B. users/123456789) zurückgegeben.
display_name	string Nur Ausgabe. Der Anzeigename des Nutzers.
domain_id	string Eindeutige Kennung der Google Workspace-Domain des Nutzers.
type	Type Nutzertyp
is_anonymous	bool Nur Ausgabe. Wenn true, wird der Nutzer gelöscht oder sein Profil ist nicht sichtbar.

Typ

Enums
TYPE_UNSPECIFIED	Standardwert für die Enumeration. NICHT VERWENDEN.
HUMAN	Ein menschlicher Nutzer.
BOT	Nutzer der Chat-App.

UserMentionMetadata

Metadaten für Anmerkungen für Erwähnungen (@).

Felder
user	User Der erwähnte Nutzer.
type	Type Der Typ der Erwähnung.

Typ

Enums
TYPE_UNSPECIFIED	Standardwert für die Enumeration. Nicht verwenden.
ADD	Nutzer einem Gruppenbereich hinzufügen
MENTION	Nutzer im Gruppenbereich erwähnen.

WidgetMarkup

Ein Widget ist ein UI-Element, in dem Text und Bilder präsentiert werden.

Felder
buttons[]	Button Eine Liste mit Schaltflächen. „Buttons“ ist ebenfalls oneof data. Es sollte nur eines dieser Felder festgelegt sein.
Union-Feld data. Ein WidgetMarkup kann nur eines der folgenden Elemente enthalten. Sie können mehrere WidgetMarkup-Felder verwenden, um mehr Elemente anzuzeigen. Für data ist nur einer der folgenden Werte zulässig:
text_paragraph	TextParagraph Einen Textabsatz in diesem Widget anzeigen
image	Image Ein Bild in diesem Widget anzeigen
key_value	KeyValue Ein Schlüssel/Wert-Element in diesem Widget anzeigen

Schaltfläche

Eine Schaltfläche. Kann eine Text- oder Bildschaltfläche sein.

Felder
Union-Feld type. Für type ist nur einer der folgenden Werte zulässig:
text_button	TextButton Eine Schaltfläche mit Text und der Aktion onclick.
image_button	ImageButton Eine Schaltfläche mit Bild und der Aktion onclick.

FormAction

Eine Formularaktion beschreibt das Verhalten beim Senden des Formulars. Sie können beispielsweise Apps Script aufrufen, um das Formular zu verarbeiten.

Felder
action_method_name	string Der Methodenname wird verwendet, um zu ermitteln, welcher Teil des Formulars die Formularübermittlung ausgelöst hat. Diese Informationen werden im Rahmen des Kartenklickereignisses an die Chat App zurückgegeben. Sie können denselben Methodennamen für mehrere Elemente verwenden, die ein gemeinsames Verhalten auslösen.
parameters[]	ActionParameter Liste der Aktionsparameter.

ActionParameter

Liste der Stringparameter, die beim Aufrufen der Aktionsmethode angegeben werden müssen. Stellen Sie sich beispielsweise drei Schlummer-Schaltflächen vor: „Jetzt schlummern“, „Einen Tag lang schlummern“ und „Nächste Woche schlummern“. Sie können action method = snooze() verwenden und den Schlummer-Typ und die Schlummerzeit in der Liste der Stringparameter übergeben.

Felder
key	string Der Name des Parameters für das Aktionsscript.
value	string Wert des Parameters.

Symbol

Die unterstützten Symbole.

Enums
ICON_UNSPECIFIED
AIRPLANE
BOOKMARK
BUS
CAR
CLOCK
CONFIRMATION_NUMBER_ICON
DOLLAR
DESCRIPTION
EMAIL
EVENT_PERFORMER
EVENT_SEAT
FLIGHT_ARRIVAL
FLIGHT_DEPARTURE
HOTEL
HOTEL_ROOM_TYPE
INVITE
MAP_PIN
MEMBERSHIP
MULTIPLE_PEOPLE
OFFER
PERSON
PHONE
RESTAURANT_ICON
SHOPPING_CART
STAR
STORE
TICKET
TRAIN
VIDEO_CAMERA
VIDEO_PLAY

Bild

Ein Bild, das über eine URL angegeben wird und eine onclick-Aktion haben kann.

Felder
image_url	string Die URL des Bildes.
on_click	OnClick Die Aktion onclick.
aspect_ratio	double Das Seitenverhältnis dieses Bildes (Breite und Höhe). Mit diesem Feld können Sie die richtige Höhe für das Bild reservieren, während es geladen wird. Es soll nicht das integrierte Seitenverhältnis des Bildes überschreiben. Wenn der Wert nicht festgelegt ist, wird er vom Server durch Vorabrufen des Bildes ausgefüllt.

ImageButton

Eine Bildschaltfläche mit einer onclick-Aktion.

Felder
on_click	OnClick Die Aktion onclick.
name	string Der Name dieses image_button, der für die Barrierefreiheit verwendet wird. Wenn dieser Name nicht angegeben ist, wird ein Standardwert verwendet.
Union-Feld icons. Das Symbol kann über ein Icon enum oder eine URL angegeben werden. Für icons ist nur einer der folgenden Werte zulässig:
icon	Icon Das Symbol, das durch ein enum angegeben wird, das auf ein von der Chat API bereitgestelltes Symbol verweist.
icon_url	string Das Symbol, das durch eine URL angegeben wird.

KeyValue

Ein UI-Element enthält einen Schlüssel (Label) und einen Wert (Inhalt). Dieses Element kann auch einige Aktionen wie die Schaltfläche onclick enthalten.

Felder
top_label	string Der Text des oberen Labels. 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.
content	string Der Text des Inhalts. Formatierter Text wird unterstützt und ist immer erforderlich. Weitere Informationen zum Formatieren von Text finden Sie unter Text in Google Chat-Apps formatieren und Text in Google Workspace-Add-ons formatieren.
content_multiline	bool Gibt an, ob der Inhalt mehrzeilig sein soll.
bottom_label	string Der Text des unteren Labels. 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.
on_click	OnClick Die Aktion onclick. Nur das obere Label, das untere Label und die Inhaltsregion sind klickbar.
Union-Feld icons. Es muss mindestens eines der Elemente „icons“, top_label und bottom_label definiert werden. Für icons ist nur einer der folgenden Werte zulässig:
icon	Icon Ein Enumerationswert, der von der Chat API durch das entsprechende Symbolbild ersetzt wird.
icon_url	string Das Symbol, das durch eine URL angegeben wird.
Union-Feld control. Ein Steuer-Widget. Sie können entweder button oder switch_widget festlegen, aber nicht beides. Für control ist nur einer der folgenden Werte zulässig:
button	Button Eine Schaltfläche, auf die geklickt werden kann, um eine Aktion auszulösen.

OnClick

Eine onclick-Aktion, z. B. das Öffnen eines Links.

Felder
Union-Feld data. Für data ist nur einer der folgenden Werte zulässig:
action	FormAction Eine Formularaktion wird durch diese onclick-Aktion ausgelöst, sofern angegeben.
open_link	OpenLink Diese onclick-Aktion löst eine „Link öffnen“-Aktion aus, sofern angegeben.

OpenLink

Ein Link, der ein neues Fenster öffnet.

Felder
url	string Die zu öffnende URL.

TextButton

Eine Schaltfläche mit Text und der Aktion onclick.

Felder
text	string Text der Schaltfläche
on_click	OnClick Die onclick-Aktion der Schaltfläche.

TextParagraph

Ein Textabsatz. 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.

Felder
text	string