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)
• 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)
• 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 es 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 die App-Authentifizierung und die domainweite Delegierung. 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 Leitfaden zur Autorisierung.

CreateCustomEmoji

rpc CreateCustomEmoji(CreateCustomEmojiRequest) returns (CustomEmoji) Vorabversion für Entwickler:Verfügbar im Rahmen des Google Workspace-Vorabversionsprogramms für Entwickler, das Vorabzugriff auf bestimmte Funktionen gewährt. Erstellt ein benutzerdefiniertes Emoji. Erfordert die Nutzerauthentifizierung. Autorisierungsbereiche Erfordert den folgenden OAuth-Bereich: https://www.googleapis.com/auth/chat.customemojis Weitere Informationen finden Sie im Leitfaden zur Autorisierung.

CreateMembership

rpc CreateMembership(CreateMembershipRequest) returns (Membership) Hiermit wird eine Mitgliedschaft für die anrufende Chat-App, einen Nutzer oder eine Google-Gruppe erstellt. Das Erstellen von Mitgliedschaften für andere Chat-Apps wird nicht unterstützt. Wenn beim Erstellen einer Mitgliedschaft die automatische Annahme für das angegebene Mitglied deaktiviert ist, wird es eingeladen und muss die Einladung zum Gruppenbereich annehmen, bevor es beitreten kann. Andernfalls wird das Mitglied durch das Erstellen einer Mitgliedschaft direkt dem angegebenen Gruppenbereich hinzugefügt. Unterstützt die folgenden Authentifizierungstypen: App-Authentifizierung mit Administratorgenehmigung in der Entwicklervorschau Nutzerauthentifizierung: Sie können diese Methode mit Administratorberechtigungen authentifizieren und autorisieren, indem Sie das Feld use_admin_access in der Anfrage festlegen. Beispiele zur Verwendung: Nutzer in einen Gruppenbereich einladen oder hinzufügen Sie laden eine Google-Gruppe in einen Gruppenbereich ein oder fügen sie ihm hinzu. Fügen Sie der Chat-App einen Gruppenbereich hinzu. Autorisierungsbereiche Erfordert einen der folgenden OAuth-Bereiche: https://www.googleapis.com/auth/chat.app.memberships https://www.googleapis.com/auth/chat.admin.memberships https://www.googleapis.com/auth/chat.import https://www.googleapis.com/auth/chat.memberships https://www.googleapis.com/auth/chat.memberships.app Weitere Informationen finden Sie im Leitfaden zur Autorisierung.

CreateMessage

rpc CreateMessage(CreateMessageRequest) returns (Message) Erstellt eine Nachricht in einem Google Chat-Gruppenbereich. Ein Beispiel finden Sie unter Nachricht senden. Für die Methode create() ist entweder eine Nutzerauthentifizierung oder eine App-Authentifizierung erforderlich. In Google Chat wird der Absender der Nachricht je nach Art der Authentifizierung, die Sie in Ihrer Anfrage verwenden, unterschiedlich zugeordnet. Auf dem folgenden Bild ist zu sehen, wie eine Nachricht in Google Chat zugeordnet wird, 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. In Google Chat wird der Nutzer als Absender der Nachricht angezeigt und die Chat-App wird der Nachricht durch Angabe 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. 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 Leitfaden zur Autorisierung.

CreateReaction

rpc CreateReaction(CreateReactionRequest) returns (Reaction) Erstellt eine Reaktion und fügt sie einer Nachricht hinzu. Es werden nur Unicode-Emojis unterstützt. Ein Beispiel finden Sie unter Reaktionen auf Nachrichten hinzufügen. Erfordert die Nutzerauthentifizierung. 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 Leitfaden zur Autorisierung.

CreateSpace

rpc CreateSpace(CreateSpaceRequest) returns (Space) Erstellt einen Gruppenbereich. Kann verwendet werden, um einen benannten Gruppenbereich oder einen Gruppenchat in Import mode zu erstellen. Ein Beispiel finden Sie unter Bereich erstellen. Unterstützt die folgenden Authentifizierungstypen: App-Authentifizierung mit Administratorgenehmigung in der Entwicklervorschau Nutzerauthentifizierung Bei der Authentifizierung als App muss das Feld space.customer in der Anfrage festgelegt sein. Die Mitgliedschaft im Gruppenbereich beim Erstellen hängt davon ab, wo der Gruppenbereich erstellt wird:Import mode 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 Nutzer bei Verwendung der Nutzerauthentifizierung. Wenn Sie beim Erstellen eines Gruppenbereichs 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. 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 Leitfaden zur Autorisierung.

DeleteCustomEmoji

rpc DeleteCustomEmoji(DeleteCustomEmojiRequest) returns (Empty) Vorabversion für Entwickler:Verfügbar im Rahmen des Google Workspace-Vorabversionsprogramms für Entwickler, das Vorabzugriff auf bestimmte Funktionen gewährt. Löscht ein benutzerdefiniertes Emoji. Erfordert die Nutzerauthentifizierung. Autorisierungsbereiche Erfordert den folgenden OAuth-Bereich: https://www.googleapis.com/auth/chat.customemojis Weitere Informationen finden Sie im Leitfaden zur Autorisierung.

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 Authentifizierungstypen: App-Authentifizierung mit Administratorgenehmigung in der Entwicklervorschau Nutzerauthentifizierung: Sie können diese Methode mit Administratorberechtigungen authentifizieren und autorisieren, indem Sie das Feld use_admin_access in der Anfrage festlegen. 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 Leitfaden zur Autorisierung.

DeleteMessage

rpc DeleteMessage(DeleteMessageRequest) returns (Empty) Löscht eine Nachricht. Ein Beispiel finden Sie unter Nachricht löschen. Unterstützt die folgenden Authentifizierungstypen: App-Authentifizierung Nutzerauthentifizierung Bei der App-Authentifizierung können mit Anfragen nur Nachrichten gelöscht werden, die von der anrufenden 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 Leitfaden zur Autorisierung.

DeleteReaction

rpc DeleteReaction(DeleteReactionRequest) returns (Empty) Löscht eine Reaktion auf eine Nachricht. Es werden nur Unicode-Emojis unterstützt. Ein Beispiel finden Sie unter Reaktion löschen. Erfordert die Nutzerauthentifizierung. 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 Leitfaden zur Autorisierung.

DeleteSpace

rpc DeleteSpace(DeleteSpaceRequest) returns (Empty) Löscht einen benannten Gruppenbereich. Es wird immer ein abfolgebasiertes Löschen durchgeführt. 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 Authentifizierungstypen: App-Authentifizierung mit Administratorgenehmigung in der Entwicklervorschau Nutzerauthentifizierung: Sie können diese Methode mit Administratorberechtigungen authentifizieren und autorisieren, indem Sie das Feld use_admin_access in der Anfrage festlegen. 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 Leitfaden zur Autorisierung.

FindDirectMessage

rpc FindDirectMessage(FindDirectMessageRequest) returns (Space) Gibt die vorhandene Direktnachricht mit dem angegebenen Nutzer zurück. Wenn kein Direktnachrichtenbereich gefunden wird, wird der Fehler 404 NOT_FOUND zurückgegeben. Ein Beispiel finden Sie unter Direktnachrichten suchen. Bei der App-Authentifizierung wird der Direktnachrichtenbereich zwischen dem angegebenen Nutzer und der anrufenden Chat-App zurückgegeben. Bei Nutzerauthentifizierung wird der Direktnachrichtenbereich zwischen dem angegebenen Nutzer und dem authentifizierten Nutzer zurückgegeben. // Unterstützt die folgenden Arten der Authentifizierung: App-Authentifizierung Nutzerauthentifizierung 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 Leitfaden zur Autorisierung.

GetAttachment

rpc GetAttachment(GetAttachmentRequest) returns (Attachment) Ruft die Metadaten eines Nachrichtenanhangs ab. Die Anhangsdaten werden mit der Media API abgerufen. Ein Beispiel finden Sie unter Metadaten zu einem E-Mail-Anhang abrufen. Erfordert die App-Authentifizierung. Autorisierungsbereiche Erfordert den folgenden OAuth-Bereich: https://www.googleapis.com/auth/chat.bot Weitere Informationen finden Sie im Leitfaden zur Autorisierung.

GetCustomEmoji

rpc GetCustomEmoji(GetCustomEmojiRequest) returns (CustomEmoji) Vorabversion für Entwickler:Verfügbar im Rahmen des Google Workspace-Vorabversionsprogramms für Entwickler, das Vorabzugriff auf bestimmte Funktionen gewährt. Gibt Details zu einem benutzerdefinierten Emoji zurück. Erfordert die Nutzerauthentifizierung. 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 Leitfaden zur Autorisierung.

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 Authentifizierungstypen: App-Authentifizierung Nutzerauthentifizierung: Sie können diese Methode mit Administratorberechtigungen authentifizieren und autorisieren, indem Sie das Feld use_admin_access in der Anfrage festlegen. 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 Leitfaden zur Autorisierung.

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 Authentifizierungstypen: App-Authentifizierung Nutzerauthentifizierung Hinweis: Es kann sein, dass eine Nachricht von einem blockierten Mitglied oder aus einem blockierten Gruppenbereich zurückgegeben wird. 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 Leitfaden zur Autorisierung.

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 Authentifizierungstypen: App-Authentifizierung Nutzerauthentifizierung: Sie können diese Methode mit Administratorberechtigungen authentifizieren und autorisieren, indem Sie das Feld use_admin_access in der Anfrage festlegen. 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 Leitfaden zur Autorisierung.

GetSpaceEvent

rpc GetSpaceEvent(GetSpaceEventRequest) returns (SpaceEvent) Gibt ein Ereignis aus einem Google Chat-Bereich zurück. Die Ereignisnutzlast enthält die neueste Version der geänderten Ressource. Wenn Sie beispielsweise ein Ereignis für eine neue Nachricht anfordern, die Nachricht aber später aktualisiert wurde, gibt der Server die aktualisierte Message-Ressource in der Ereignisnutzlast zurück. Hinweis: Das Feld permissionSettings wird für diese Anfrage nicht im Gruppenbereichsobjekt der Gruppenbereichsereignisdaten zurückgegeben. Erfordert die Nutzerauthentifizierung. Damit ein Ereignis abgerufen werden kann, muss der authentifizierte Nutzer Mitglied des Gruppenbereichs sein. Ein Beispiel finden Sie im Hilfeartikel Details zu einem Ereignis 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 Leitfaden zur Autorisierung.

GetSpaceNotificationSetting

rpc GetSpaceNotificationSetting(GetSpaceNotificationSettingRequest) returns (SpaceNotificationSetting) Vorabversion für Entwickler:Verfügbar im Rahmen des Google Workspace-Vorabversionsprogramms für Entwickler, das Vorabzugriff auf bestimmte Funktionen gewährt. Ruft die Einstellungen für den Benachrichtigungsstatus des Gruppenbereichs ab. Erfordert die Nutzerauthentifizierung. Autorisierungsbereiche Erfordert den folgenden OAuth-Bereich: https://www.googleapis.com/auth/chat.users.spacesettings Weitere Informationen finden Sie im Leitfaden zur Autorisierung.

GetSpaceReadState

rpc GetSpaceReadState(GetSpaceReadStateRequest) returns (SpaceReadState) Gibt Details zum Lesestatus eines Nutzers in einem Gruppenbereich zurück, um gelesene und ungelesene Nachrichten zu identifizieren. Ein Beispiel finden Sie unter Details zum Lesestatus eines Nutzers in einem Gruppenbereich abrufen. Erfordert die Nutzerauthentifizierung. 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 Leitfaden zur Autorisierung.

GetThreadReadState

rpc GetThreadReadState(GetThreadReadStateRequest) returns (ThreadReadState) Gibt Details zum Lesestatus eines Nutzers in einem Thread zurück, um gelesene und ungelesene Nachrichten zu identifizieren. Ein Beispiel finden Sie unter Details zum Lesestatus eines Threads für einen Nutzer abrufen. Erfordert die Nutzerauthentifizierung. 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 Leitfaden zur Autorisierung.

ListCustomEmojis

rpc ListCustomEmojis(ListCustomEmojisRequest) returns (ListCustomEmojisResponse) Vorabversion für Entwickler:Verfügbar im Rahmen des Google Workspace-Vorabversionsprogramms für Entwickler, das Vorabzugriff auf bestimmte Funktionen gewährt. Listet benutzerdefinierte Emojis auf, die für den authentifizierten Nutzer sichtbar sind. Erfordert die Nutzerauthentifizierung. 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 Leitfaden zur Autorisierung.

ListMemberships

rpc ListMemberships(ListMembershipsRequest) returns (ListMembershipsResponse) Listet die Mitgliedschaften in einem Gruppenbereich auf. Ein Beispiel finden Sie unter Nutzer und Google Chat-Apps in einem Gruppenbereich auflisten. Wenn Sie Mitgliedschaften mit App-Authentifizierung auflisten, werden Mitgliedschaften in Gruppenbereichen aufgeführt, auf die die Chat-App Zugriff hat. Mitgliedschaften in der Chat-App selbst werden jedoch nicht berücksichtigt. Wenn Sie die Mitgliedschaften mit Nutzerauthentifizierung auflisten, werden Mitgliedschaften in Gruppenbereichen aufgeführt, auf die der authentifizierte Nutzer Zugriff hat. Unterstützt die folgenden Authentifizierungstypen: App-Authentifizierung Nutzerauthentifizierung: Sie können diese Methode mit Administratorberechtigungen authentifizieren und autorisieren, indem Sie das Feld use_admin_access in der Anfrage festlegen. 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 Leitfaden zur Autorisierung.

ListMessages

rpc ListMessages(ListMessagesRequest) returns (ListMessagesResponse) Hier werden Nachrichten in einem Gruppenbereich aufgelistet, in dem der Anrufer Mitglied ist, einschließlich Nachrichten von blockierten Mitgliedern und Gruppenbereichen. Wenn Sie Nachrichten aus einem Gruppenbereich auflisten, in dem keine Nachrichten vorhanden sind, 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 die Nutzerauthentifizierung. 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 Leitfaden zur Autorisierung.

ListReactions

rpc ListReactions(ListReactionsRequest) returns (ListReactionsResponse) Listet Reaktionen auf eine Nachricht auf. Ein Beispiel finden Sie unter Reaktionen auf eine Nachricht auflisten. Erfordert die Nutzerauthentifizierung. 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 Leitfaden zur Autorisierung.

ListSpaceEvents

rpc ListSpaceEvents(ListSpaceEventsRequest) returns (ListSpaceEventsResponse) Hier werden Ereignisse aus einem Google Chat-Gruppenbereich aufgeführt. Die Nutzlast enthält für jedes Ereignis die neueste Version der Chatressource. Wenn Sie beispielsweise Ereignisse zu neuen Mitgliedern eines Gruppenbereichs auflisten, gibt der Server Membership Ressourcen zurück, die die neuesten Mitgliedschaftsdetails enthalten. Wenn neue Mitglieder im angeforderten Zeitraum entfernt wurden, enthält die Ereignisnutzlast eine leere Membership-Ressource. Erfordert die Nutzerauthentifizierung. Damit der authentifizierte Nutzer Ereignisse auflisten kann, muss er Mitglied des Gruppenbereichs sein. Ein Beispiel finden Sie unter Ereignisse aus einem Google Chat-Gruppenbereich auflisten. Autorisierungsbereiche Erfordert einen der folgenden OAuth-Bereiche: https://www.googleapis.com/auth/chat.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 Leitfaden zur Autorisierung.

ListSpaces

rpc ListSpaces(ListSpacesRequest) returns (ListSpacesResponse) Listet Gruppenbereiche auf, in denen der Anrufer 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 Authentifizierungstypen: App-Authentifizierung Nutzerauthentifizierung Wenn Sie alle benannten Gruppenbereiche 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 Leitfaden zur Autorisierung.

SearchSpaces

rpc SearchSpaces(SearchSpacesRequest) returns (SearchSpacesResponse) Gibt eine Liste der Gruppenbereiche in einer Google Workspace-Organisation zurück, die auf der Suche eines Administrators basiert. Erfordert die Nutzerauthentifizierung mit Administratorberechtigungen. 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 Leitfaden zur Autorisierung.

SetUpSpace

rpc SetUpSpace(SetUpSpaceRequest) returns (Space) Erstellt einen Gruppenbereich und fügt ihm bestimmte Nutzer hinzu. Der anfragende Nutzer wird dem Gruppenbereich automatisch hinzugefügt und sollte in der Anfrage nicht als Mitglied angegeben werden. Ein Beispiel finden Sie unter Gruppenbereich mit ersten Mitgliedern einrichten. Wenn Sie die hinzuzufügenden natürlichen Personen angeben möchten, fügen Sie Mitgliedschaften mit der entsprechenden membership.member.name hinzu. Wenn Sie einen Nutzer hinzufügen möchten, verwenden Sie users/{user}. {user} kann die E-Mail-Adresse des Nutzers sein. Bei Nutzern 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 ID des Personenprofils in der People API für [e-mail] beispielsweise 123456789 lautet, können Sie den Nutzer dem Gruppenbereich hinzufügen, indem Sie membership.member.name auf users/[e-mail] oder users/123456789 festlegen. Um die hinzuzufügenden Google-Gruppen anzugeben, fügen Sie Mitgliedschaften mit der entsprechenden membership.group_member.name hinzu. Wenn Sie eine Google-Gruppe hinzufügen oder einladen möchten, verwenden Sie groups/{group}. Dabei ist {group} die id der Gruppe aus der Cloud Identity Groups API. Sie können beispielsweise die Cloud Identity Groups Lookup API verwenden, um die ID 123456789 für die Gruppen-E-Mail-Adresse [e-mail] abzurufen. Anschließend können Sie die Gruppe dem Gruppenbereich hinzufügen, indem Sie membership.group_member.name auf groups/123456789 festlegen. E-Mail-Adressen von Gruppen werden nicht unterstützt und Google-Gruppen können nur als Mitglieder zu benannten Gruppenbereichen hinzugefügt werden. Wenn der Anrufer einige Mitglieder blockiert oder von ihnen blockiert wird oder keine Berechtigung zum Hinzufügen bestimmter Mitglieder hat, werden diese Mitglieder dem erstellten Gruppenbereich nicht hinzugefügt. Wenn Sie eine Direktnachricht (DM) 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 Direktnachricht mit der Anruf-App einrichten. Wenn Sie die Anruf-App als Mitglied eines Gruppenbereichs oder einer bestehenden Direktnachricht zwischen zwei Nutzern hinzufügen möchten, lesen Sie den Hilfeartikel Nutzer oder App zu einem Gruppenbereich einladen oder hinzufügen. Wenn zwischen zwei Nutzern bereits eine Direktnachricht besteht, wird diese zurückgegeben, auch wenn einer der Nutzer den anderen blockiert, während eine Anfrage gestellt wird. Gruppenbereiche mit verschachtelten Antworten werden nicht unterstützt. Wenn Sie beim Einrichten eines Gruppenbereichs 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. Erfordert die Nutzerauthentifizierung. 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 Leitfaden zur Autorisierung.

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 Authentifizierungstypen: App-Authentifizierung mit Administratorgenehmigung in der Entwicklervorschau Nutzerauthentifizierung: Sie können diese Methode mit Administratorberechtigungen authentifizieren und autorisieren, indem Sie das Feld use_admin_access in der Anfrage festlegen. 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 Leitfaden zur Autorisierung.

UpdateMessage

rpc UpdateMessage(UpdateMessageRequest) returns (Message) Aktualisiert eine Nachricht. Zwischen den Methoden patch und update gibt es einen Unterschied. Bei der Methode patch wird eine patch-Anfrage verwendet, bei der Methode update eine put-Anfrage. Wir empfehlen die Methode patch. Ein Beispiel finden Sie unter Nachricht aktualisieren. Unterstützt die folgenden Authentifizierungstypen: App-Authentifizierung Nutzerauthentifizierung Bei der App-Authentifizierung können Anfragen nur Nachrichten aktualisieren, die von der anrufenden 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 Leitfaden zur Autorisierung.

UpdateSpace

rpc UpdateSpace(UpdateSpaceRequest) returns (Space) Aktualisiert einen Gruppenbereich. Ein Beispiel finden Sie unter Gruppenbereich 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 Authentifizierungstypen: App-Authentifizierung mit Administratorgenehmigung in der Entwicklervorschau Nutzerauthentifizierung: Sie können diese Methode mit Administratorberechtigungen authentifizieren und autorisieren, indem Sie das Feld use_admin_access in der Anfrage festlegen. 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 Leitfaden zur Autorisierung.

UpdateSpaceNotificationSetting

rpc UpdateSpaceNotificationSetting(UpdateSpaceNotificationSettingRequest) returns (SpaceNotificationSetting) Vorabversion für Entwickler:Verfügbar im Rahmen des Google Workspace-Vorabversionsprogramms für Entwickler, das Vorabzugriff auf bestimmte Funktionen gewährt. Aktualisiert die Einstellungen für den Benachrichtigungsstatus des Gruppenbereichs. Erfordert die Nutzerauthentifizierung. Autorisierungsbereiche Erfordert den folgenden OAuth-Bereich: https://www.googleapis.com/auth/chat.users.spacesettings Weitere Informationen finden Sie im Leitfaden zur Autorisierung.

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 Gruppenbereich aktualisieren. Erfordert die Nutzerauthentifizierung. Autorisierungsbereiche Erfordert den folgenden OAuth-Bereich: https://www.googleapis.com/auth/chat.users.readstate Weitere Informationen finden Sie im Leitfaden zur Autorisierung.

AccessoryWidget

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

Felder
Union-Feld action. Der Aktionstyp. Für action ist nur einer der folgenden Werte zulässig:
button_list	ButtonList Eine Liste von Schaltflächen.

ActionResponse

Parameter, mit denen eine Chat-App konfigurieren kann, wie ihre Antwort gepostet wird.

Felder
type	ResponseType Nur Eingabe. Der Typ der Antwort in der Google Chat App.
url	string Nur Eingabe. URL, über die sich Nutzer authentifizieren oder konfigurieren können. (Nur für REQUEST_CONFIG-Antworttypen.)
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 Antwort in der Google Chat App.

Enums
TYPE_UNSPECIFIED	Standardtyp, der als NEW_MESSAGE behandelt wird.
NEW_MESSAGE	Posten Sie als neue Nachricht im Thema.
UPDATE_MESSAGE	Aktualisieren Sie die Nachricht in der Chat App. Dies ist nur bei einem CARD_CLICKED-Ereignis zulässig, bei dem der Typ des Nachrichtensenders BOT ist.
UPDATE_USER_MESSAGE_CARDS	Karten in der Nachricht eines Nutzers aktualisieren Dies ist nur als Antwort 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	Bitten Sie den Nutzer privat um eine zusätzliche Authentifizierung oder Konfiguration.
DIALOG	Ein Dialogfeld wird angezeigt.
UPDATE_WIDGET	Abfrage zu Optionen für die automatische Vervollständigung von Widget-Text

SelectionItems

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

Felder
items[]	SelectionItem Ein Array von „SelectionItem“-Objekten.

UpdatedWidget

Die Antwort des aktualisierten Widgets. Wird verwendet, um Optionen für die automatische Vervollständigung für ein Widget bereitzustellen.

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

Der Status einer Anfrage zum Aufrufen oder Senden eines Dialogfelds.

Felder
status_code	Code Der Statuscode.
user_facing_message	string Die Nachricht, die Nutzern über den Status ihrer Anfrage gesendet werden soll. Wenn diese Option nicht festgelegt ist, wird eine generische Nachricht basierend auf der status_code gesendet.

Annotation

Nur Ausgabe. Anmerkungen, die mit dem Nur-Text-Textkörper der Nachricht verknüpft sind. Wie Sie einer SMS eine einfache Formatierung hinzufügen, erfahren Sie unter SMS formatieren.

Beispiel für einen Nur-Text-Textkörper:

Hello @FooBot how are you!"

Die entsprechenden Anmerkungsmetadaten:

"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 Anmerkung.
length	int32 Länge des Teilstrings im Textkörper der Nachricht, dem diese Anmerkung entspricht.
start_index	int32 Der Startindex (basierend auf 0, einschließlich) im Textkörper der Nachricht, der dieser 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 Nutzererwähnung.
slash_command	SlashCommandMetadata Die Metadaten für einen Slash-Befehl.
rich_link_metadata	RichLinkMetadata Die Metadaten für einen Rich-Link.

AnnotationType

Der Typ der Anmerkung.

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 Anmerkung mit einem Link.

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 für den Inhalt, 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 Nutzer verwendet werden soll. Chat-Apps sollten diese URL nicht zum Herunterladen von Anhängen verwenden.
download_uri	string Nur Ausgabe. Die Download-URL, über die ein 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 Anhangsdaten. Dieses Feld wird verwendet, um Nachrichten mit Anhängen zu erstellen oder zu aktualisieren, oder mit der Media API, um 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 Google Chat hochgeladen.

AttachmentDataRef

Ein Verweis auf die Anhangsdaten.

Felder
resource_name	string Optional. Der Ressourcenname der Anhangsdaten. Dieses Feld wird mit der Media API verwendet, um die Anhangsdaten herunterzuladen.
attachment_upload_token	string Optional. Opaque-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 sich Ihre Chat-App als Nutzer authentifiziert, darf die Nachricht keine Karten enthalten.

Mit dem Card Builder Karten entwerfen und eine Vorschau anzeigen

Karten-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 zu Links zu Chatbereichen.

Felder
space	string Der Bereich der verknüpften Chatbereichsressource. Format: spaces/{space}
thread	string Der Thread der verknüpften Chatbereichsressource. Format: spaces/{space}/threads/{thread}
message	string Die Nachricht der verknüpften Chatbereichsressource. 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 Abschluss 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. Ein Header 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. Für eine Rechnungskarte sind typische Aktionen: 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 Menüpunkt „Aktion“ angezeigt.
on_click	OnClick Die onclick-Aktion für dieses Aktionselement.

CardHeader

Felder
title	string Der Titel muss angegeben werden. Die Überschrift hat eine feste Höhe: Wenn sowohl ein Titel als auch ein Untertitel angegeben werden, nimmt jeder eine Zeile ein. 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 Kartenüberschrift.

ImageStyle

Enums
IMAGE_STYLE_UNSPECIFIED
IMAGE	Quadratische Ränder
AVATAR	Kreisförmiger Rahmen.

Abschnitt

Ein Bereich enthält eine Sammlung von Widgets, die in der Reihenfolge, in der sie angegeben sind, 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 Abschnitt muss mindestens ein Widget enthalten.

CreateCustomEmojiRequest

Eine Anfrage zum Erstellen eines benutzerdefinierten Emojis.

Vorabversion für Entwickler:Verfügbar im Rahmen des Google Workspace-Vorabversionsprogramms für Entwickler, das Vorabzugriff auf bestimmte Funktionen gewährt.

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 Gruppenbereichs, 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 Angaben. Wenn eine Chat-App eine Mitgliedschaftsbeziehung für einen 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 Ländern verfügbar: Vorabversion für Entwickler:Verfügbar im Rahmen des Google Workspace-Vorabversionsprogramms für Entwickler, das Vorabzugriff auf bestimmte Funktionen gewährt. Legen Sie user.type auf HUMAN und user.name auf das 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 des Nutzers in der Directory API sein. Wenn die ID des Personenprofils in der People API für [e-mail] beispielsweise 123456789 lautet, können Sie den Nutzer dem Gruppenbereich hinzufügen, indem Sie membership.member.name auf users/[e-mail] oder users/123456789 festlegen. Wenn Sie Nutzer einladen möchten, die nicht zur Workspace-Organisation gehören, der der Gruppenbereich zugewiesen ist, 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 festgelegt ist, wird die Methode mit den Google Workspace-Administratorberechtigungen des 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. Unterstützt bis zu 4.000 Zeichen. Wenn Sie einen Thread starten oder ihm eine Nachricht hinzufügen möchten, erstellen Sie eine Nachricht und geben Sie eine threadKey oder die thread.name an. Eine Beispielanwendung finden Sie unter Nachrichtenthreads starten oder beantworten.
request_id	string Optional. Eine eindeutige Anfrage-ID für diese Nachricht. Wenn Sie eine vorhandene Anfrage-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 antwortet. Nur in benannten Gruppenbereichen unterstützt. Wenn Sie auf Nutzerinteraktionen reagieren, 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. Ermöglicht es Chat-Apps, eine Nachricht abzurufen, zu aktualisieren oder zu 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. Darf innerhalb eines Gruppenbereichs nur einmal vorkommen. Eine Chat-App kann nicht dieselbe benutzerdefinierte ID für unterschiedliche Nachrichten verwenden. Weitere Informationen

MessageReplyOption

Gibt an, wie auf eine Nachricht geantwortet werden soll. Weitere Bundesländer werden möglicherweise in Zukunft hinzugefügt.

Enums
MESSAGE_REPLY_OPTION_UNSPECIFIED	Standard. Startet einen neuen Thread. Bei Verwendung dieser Option werden alle enthaltenen thread ID oder thread_key ignoriert.
REPLY_MESSAGE_FALLBACK_TO_NEW_THREAD	Die Nachricht wird als Antwort auf den Thread erstellt, der durch thread ID oder thread_key angegeben wird. Andernfalls wird mit der Nachricht stattdessen ein neuer Thread gestartet.
REPLY_MESSAGE_OR_FAIL	Die Nachricht wird als Antwort auf den Thread erstellt, 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, auf die die Reaktion erfolgt. Format: spaces/{space}/messages/{message}
reaction	Reaction Erforderlich. Die zu erstellende Reaktion.

CreateSpaceRequest

Eine Anfrage zum Erstellen eines benannten Gruppenbereichs ohne Mitglieder.

Felder
space	Space Erforderlich. Die Felder displayName und spaceType müssen ausgefüllt sein. Es werden nur SpaceType.SPACE und SpaceType.GROUP_CHAT unterstützt. SpaceType.GROUP_CHAT kann nur verwendet werden, wenn importMode auf „wahr“ gesetzt ist. Wenn du die Fehlermeldung ALREADY_EXISTS erhältst, versuche es mit einer 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 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} Vorabversion für Entwickler:Verfügbar im Rahmen des Google Workspace-Vorabversionsprogramms für Entwickler, das Vorabzugriff auf bestimmte Funktionen gewährt.
uid	string Nur Ausgabe. Eindeutiger Schlüssel für die benutzerdefinierte Emoji-Ressource.
emoji_name	string Optional. Nicht veränderbar. Vom Nutzer angegebener Name für das benutzerdefinierte Emoji, der innerhalb der Organisation eindeutig sein muss. Erforderlich, wenn das benutzerdefinierte Emoji erstellt wird, andernfalls nur Ausgabe. Emoji-Namen müssen mit Doppelpunkten 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: Vorabversion für Entwickler:Verfügbar im Rahmen des Google Workspace-Vorabversionsprogramms für Entwickler, das Vorabzugriff auf bestimmte Funktionen gewährt.
temporary_image_uri	string Nur Ausgabe. Die Bild-URL für das benutzerdefinierte Emoji, gültig für mindestens 10 Minuten. Hinweis: Dieser Wert wird nicht in die Antwort eingefügt, wenn das benutzerdefinierte Emoji erstellt wird. Vorabversion für Entwickler:Verfügbar im Rahmen des Google Workspace-Vorabversionsprogramms für Entwickler, das Vorabzugriff auf bestimmte Funktionen gewährt.
payload	CustomEmojiPayload Optional. Nur Eingabe. Nutzlastdaten Erforderlich, wenn das benutzerdefinierte Emoji erstellt wird. Vorabversion für Entwickler:Verfügbar im Rahmen des Google Workspace-Vorabversionsprogramms für Entwickler, das Vorabzugriff auf bestimmte Funktionen gewährt.

CustomEmojiPayload

Nutzlastdaten für das benutzerdefinierte Emoji.

Vorabversion für Entwickler:Verfügbar im Rahmen des Google Workspace-Vorabversionsprogramms für Entwickler, das Vorabzugriff auf bestimmte Funktionen gewährt.

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 die Größe des Bildes muss zwischen 64 und 500 Pixel liegen. Die Einschränkungen können sich ändern.
filename	string Erforderlich. Nur Eingabe. Der Name der Bilddatei. Unterstützte Dateiendungen: .png, .jpg, .gif.

DeleteCustomEmojiRequest

Anfrage zum Löschen eines benutzerdefinierten Emojis.

Vorabversion für Entwickler:Verfügbar im Rahmen des Google Workspace-Vorabversionsprogramms für Entwickler, das Vorabzugriff auf bestimmte Funktionen gewährt.

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 Mitgliedschaft, die gelöscht werden soll. Chat-Apps können die Mitgliedschaften von Nutzern oder die eigenen Mitgliedschaften löschen. Chat-Apps können keine Mitgliedschaften anderer Apps löschen. Zum Löschen einer Mitgliedschaft einer natürlichen Person sind der chat.memberships-Umfang und das spaces/{space}/members/{member}-Format 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 chat.memberships.app-Umfang und das spaces/{space}/members/app-Format erforderlich. Format: spaces/{space}/members/{member} oder spaces/{space}/members/app
use_admin_access	bool Optional. Wenn true festgelegt ist, wird die Methode mit den Google Workspace-Administratorberechtigungen des 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 Nachricht festgelegt haben, können Sie den Wert aus dem Feld clientAssignedMessageId für {message} verwenden. Weitere Informationen
force	bool Optional. Wenn true ausgewählt ist, werden beim Löschen einer Nachricht auch die Antworten im Thread gelöscht. Wenn false und eine Nachricht Antworten in einem Thread enthält, schlägt das Löschen fehl. Gilt nur bei der Authentifizierung als Nutzer. Hat keine Auswirkungen bei der Authentifizierung als Chat-App.

DeleteReactionRequest

Löscht eine Reaktion auf eine Nachricht.

Felder
name	string Erforderlich. Name der Reaktion, die gelöscht werden soll. Format: spaces/{space}/messages/{message}/reactions/{reaction}

DeleteSpaceRequest

Anfrage zum Löschen eines Gruppenbereichs.

Felder
name	string Erforderlich. Ressourcenname des zu löschenden Gruppenbereichs. Format: spaces/{space}
use_admin_access	bool Optional. Wenn true festgelegt ist, wird die Methode mit den Google Workspace-Administratorberechtigungen des 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.

Enums
DELETION_TYPE_UNSPECIFIED	Dieser Wert wird nicht verwendet.
CREATOR	Der Nutzer hat seine eigene Nachricht gelöscht.
SPACE_OWNER	Der Eigentümer des Gruppenbereichs hat die Nachricht gelöscht.
ADMIN	Ein Google Workspace-Administrator hat die Nachricht gelöscht.
APP_MESSAGE_EXPIRY	Eine Chat-App hat ihre eigene Nachricht gelöscht, nachdem sie abgelaufen ist.
CREATOR_VIA_APP	Eine Chat-App hat die Nachricht im Namen des Nutzers gelöscht.
SPACE_OWNER_VIA_APP	Eine Chat-App hat die Nachricht im Namen des Eigentümers des Gruppenbereichs gelöscht.

Dialog

Umhüllung um den Kartenkörper des Dialogfelds.

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

DialogAction

Enthält einen Dialog und einen Anfragestatuscode.

Felder
action_status	ActionStatus Nur Eingabe. Status einer Anfrage zum Aufrufen oder Senden eines Dialogfelds. Zeigt Nutzern bei Bedarf einen Status und eine Nachricht an. Beispielsweise bei einem Fehler oder Erfolg.
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 der 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 Nur Ausgabe. Ein benutzerdefiniertes Emoji.

EmojiReactionSummary

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

Felder
emoji	Emoji Nur Ausgabe. Das mit den Reaktionen verknüpfte Emoji.
reaction_count	int32 Nur Ausgabe. Die Gesamtzahl der Reaktionen mit dem zugehörigen Emoji.

FindDirectMessageRequest

Eine Anfrage zum Abrufen des Direktnachrichtenbereichs basierend auf der Nutzerressource.

Felder

name

string Erforderlich. Ressourcenname des Nutzers, für den 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 an diese 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

Anhang anfordern

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

GetCustomEmojiRequest

Eine Anfrage, um ein einzelnes benutzerdefiniertes Emoji zurückzugeben.

Vorabversion für Entwickler:Verfügbar im Rahmen des Google Workspace-Vorabversionsprogramms für Entwickler, das Vorabzugriff auf bestimmte Funktionen gewährt.

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 du die Mitgliedschaft der App über die Nutzerauthentifizierung abrufen möchtest, kannst du 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 festgelegt ist, wird die Methode mit den Google Workspace-Administratorberechtigungen des 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-Bereichechat.admin.memberships oder chat.admin.memberships.readonly. Das Abrufen von App-Mitgliedschaften in einem Gruppenbereich wird nicht unterstützt, wenn Sie den Administratorzugriff verwenden.

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 Nachricht festgelegt haben, können Sie den Wert aus dem Feld clientAssignedMessageId für {message} verwenden. Weitere Informationen

GetSpaceEventRequest

Anfragenachricht zum Abrufen eines Gruppenbereichsereignisses

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

GetSpaceNotificationSettingRequest

Anfragenachricht zum Abrufen der Einstellung für Benachrichtigungen zu Gruppenbereichen Unterstützt nur das Abrufen der Benachrichtigungseinstellungen für den anrufenden Nutzer.

Vorabversion für Entwickler:Verfügbar im Rahmen des Google Workspace-Vorabversionsprogramms für Entwickler, das Vorabzugriff auf bestimmte Funktionen gewährt.

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 ist 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 Gruppenbereichs. Unterstützt nur das Abrufen des Lesestatus für den anrufenden Nutzer. Um sich auf den anrufenden Nutzer zu beziehen, legen Sie einen der folgenden Parameter fest: Der Alias für me. Beispiel: users/me/spaces/{space}/spaceReadState. Ihre Workspace-E-Mail-Adresse. Beispiel: users/[e-mail]/spaces/{space}/spaceReadState. Die Nutzer-ID. Beispiel: users/123456789/spaces/{space}/spaceReadState. Format: users/{user}/spaces/{space}/spaceReadState

GetSpaceRequest

Eine Anfrage, um einen einzelnen Gruppenbereich zurückzugeben.

Felder
name	string Erforderlich. Ressourcenname des Gruppenbereichs im Format spaces/{space}. Format: spaces/{space}
use_admin_access	bool Optional. Wenn true festgelegt ist, wird die Methode mit den Google Workspace-Administratorberechtigungen des 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-Bereichechat.admin.spaces oder chat.admin.spaces.readonly.

GetThreadReadStateRequest

Anfragenachricht für die API „GetThreadReadStateRequest“.

Felder

name

string Erforderlich. Ressourcenname des abzurufenden Threads. Unterstützt nur das Abrufen des Lesestatus für den anrufenden Nutzer. Um sich auf den anrufenden Nutzer zu beziehen, legen Sie einen der folgenden Parameter fest: Der Alias für me. Beispiel: users/me/spaces/{space}/threads/{thread}/threadReadState. Ihre Workspace-E-Mail-Adresse. Beispiel: users/[e-mail]/spaces/{space}/threads/{thread}/threadReadState. Die 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 Ressourcenname für eine Google-Gruppe. Stellt eine Gruppe in der Cloud Identity Groups API dar. Format: groups/{group}

HistoryState

Der Verlaufsstatus für Nachrichten und Gruppenbereiche. Gibt an, wie lange Nachrichten und Unterhaltungsthreads nach dem Erstellen aufbewahrt werden.

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

ListCustomEmojisRequest

Eine Anfrage, um eine Liste der benutzerdefinierten Emojis zurückzugeben.

Vorabversion für Entwickler:Verfügbar im Rahmen des Google Workspace-Vorabversionsprogramms für Entwickler, das Vorabzugriff auf bestimmte Funktionen gewährt.

Felder
page_size	int32 Optional. Die maximale Anzahl der zurückgegebenen benutzerdefinierten Emojis. Der Dienst kann weniger benutzerdefinierte Emojis als diesen Wert zurückgeben. Wenn keine Angabe erfolgt, beträgt der Standardwert 25. Der Maximalwert ist 200. Werte über 200 werden in 200 geändert.
page_token	string Optional. (Wenn die Abfrage fortgesetzt wird.) Ein Seitentoken, das von einem vorherigen Aufruf der Liste mit benutzerdefinierten 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. Wenn Sie einen anderen Wert übergeben, kann das zu unerwarteten Ergebnissen führen.
filter	string Optional. Einen Abfragefilter. Es wird die Filterung nach Creator unterstützt. Wenn du nach Creator filtern möchtest, musst du einen gültigen Wert angeben. Derzeit können benutzerdefinierte Emojis nur mit creator("users/me") und NOT creator("users/me") danach gefiltert werden, ob sie vom anrufenden Nutzer erstellt wurden oder nicht. Die folgende Abfrage gibt beispielsweise benutzerdefinierte Emojis zurück, die vom Anrufer erstellt wurden: creator("users/me") Ungültige Abfragen werden vom Server mit dem Fehler INVALID_ARGUMENT abgelehnt.

ListCustomEmojisResponse

Eine Antwort auf eine Liste mit benutzerdefinierten Emojis.

Vorabversion für Entwickler:Verfügbar im Rahmen des Google Workspace-Vorabversionsprogramms für Entwickler, das Vorabzugriff auf bestimmte Funktionen gewährt.

Felder
custom_emojis[]	CustomEmoji Unsortierte Liste. Liste der benutzerdefinierten Emojis 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 dieses Feld leer ist, gibt es keine nachfolgenden Seiten.

ListMembershipsRequest

Anfragenachricht für die Auflistung von Mitgliedschaften

Felder
parent	string Erforderlich. Der Ressourcenname des Gruppenbereichs, für den eine Mitgliederliste abgerufen werden soll. Format: spaces/{space}
page_size	int32 Optional. Die maximale Anzahl der Mitgliedschaften, die zurückgegeben werden sollen. Der Dienst gibt möglicherweise weniger als diesen Wert zurück. Wenn nicht angegeben, werden maximal 100 Kanalmitgliedschaften 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 der Fehler INVALID_ARGUMENT zurückgegeben.
page_token	string Optional. Ein Seitentoken, das von einem vorherigen Aufruf zur Auflistung von Mitgliedschaften empfangen wurde. Geben Sie diesen Parameter an, um die nachfolgende Seite abzurufen. Beim Paginieren müssen alle anderen angegebenen 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. Einen 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 sowohl nach Rolle als auch nach Typ filtern möchten, verwenden Sie den Operator AND. Verwenden Sie den Operator OR, um nach Rolle oder Typ zu filtern. Entweder member.type = "HUMAN" oder member.type != "BOT" ist erforderlich, wenn use_admin_access auf „wahr“ festgelegt ist. Andere Filter für den Mitgliedertyp 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 neben anderen Mitgliedschaftstypen auch Mitgliedschaften zurückgegeben, die mit einer Google Group verknüpft sind. Wenn ein filter festgelegt ist, werden Google Group-Kanalmitgliedschaften, die nicht mit den Filterkriterien übereinstimmen, nicht zurückgegeben.
show_invited	bool Optional. Wenn true, werden neben anderen Mitgliedschaftstypen auch Mitgliedschaften zurückgegeben, die mit invited-Mitgliedern verknüpft sind. Wenn ein Filter festgelegt ist, werden invited-Kanalmitgliedschaften, die nicht den Filterkriterien entsprechen, nicht zurückgegeben. Derzeit ist eine Nutzerauthentifizierung erforderlich.
use_admin_access	bool Optional. Wenn true festgelegt ist, wird die Methode mit den Google Workspace-Administratorberechtigungen des Nutzers ausgeführt. Der anrufende Nutzer muss ein Google Workspace-Administrator mit der Berechtigung Unterhaltungen in Chats und Gruppenbereichen verwalten sein. Erfordert entweder den OAuth 2.0-Bereichchat.admin.memberships.readonly oder chat.admin.memberships. Die Auflistung von App-Mitgliedschaften in einem Gruppenbereich wird nicht unterstützt, wenn Sie den Administratorzugriff verwenden.

ListMembershipsResponse

Antwort, um die Mitgliedschaften im Gruppenbereich aufzulisten.

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 dieses Feld leer ist, gibt es keine nachfolgenden Seiten.

ListMessagesRequest

Hier werden Nachrichten im angegebenen Gruppenbereich aufgelistet, in dem der Nutzer Mitglied ist.

Felder
parent	string Erforderlich. Der Ressourcenname des Gruppenbereichs, 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 der Fehler INVALID_ARGUMENT zurückgegeben.
page_token	string Optional. Ein Seitentoken, das von einem vorherigen Aufruf zum Listen von Nachrichten empfangen wurde. Geben Sie diesen Parameter an, um die nachfolgende Seite abzurufen. Beim Paginieren müssen alle anderen angegebenen 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. Einen Abfragefilter. Sie können Nachrichten nach Datum (create_time) und nach 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. Mit dem Operator „kleiner als“ < können Sie Nachrichten auflisten, die vor einem Zeitstempel erstellt wurden. Wenn Sie Nachrichten innerhalb eines bestimmten Zeitraums 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 eine thread.name angegeben werden. Wenn Sie sowohl nach Thread als auch nach Datum filtern möchten, verwenden Sie den Operator AND in Ihrer Abfrage. 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 Sortiervorgänge: ASC für aufsteigend. DESC für absteigend. Die Standardreihenfolge ist create_time ASC.
show_deleted	bool Optional. Ob gelöschte Nachrichten eingeschlossen werden sollen. Gelöschte Nachrichten enthalten das Löschdatum und ‑metadaten, der Inhalt der Nachricht ist jedoch nicht verfügbar.

ListMessagesResponse

Antwortnachricht für Nachrichten zum Eintrag

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 dieses 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 kann weniger Reaktionen als diesen Wert zurückgeben. Wenn keine Angabe erfolgt, beträgt der Standardwert 25. Der Maximalwert ist 200. Werte über 200 werden in 200 geändert.
page_token	string Optional. (Wenn die Abfrage fortgesetzt wird.) 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. Wenn Sie einen anderen Wert übergeben, kann das zu unerwarteten Ergebnissen führen.
filter	string Optional. Einen Abfragefilter. Du kannst Reaktionen nach Emoji (emoji.unicode oder emoji.custom_emoji.uid) und Nutzer (user.name) filtern. Wenn Sie Reaktionen nach mehreren Emojis oder Nutzern filtern möchten, können Sie ähnliche Felder mit dem Operator OR zusammenführen, 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, gruppieren Sie sie mit Klammern. 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 Abfragen werden vom Server 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. Bei der letzten Ergebnisseite ist er leer.

ListSpaceEventsRequest

Anfragenachricht für Listen von Veranstaltungsräumen

Felder
parent	string Erforderlich. Ressourcenname des Google Chat-Bereichs, in dem die Ereignisse aufgetreten sind. Format: spaces/{space}.
page_size	int32 Optional. Die maximale Anzahl der zurückgegebenen Gruppenbereichsereignisse. Der Dienst gibt möglicherweise weniger als diesen Wert zurück. Bei negativen Werten wird der Fehler INVALID_ARGUMENT zurückgegeben.
page_token	string Optional. Ein Seitentoken, das von einem vorherigen Aufruf von Listenbereichsereignissen empfangen wurde. Geben Sie diese an, um die nachfolgende Seite abzurufen. Beim Paginieren müssen alle anderen für die Auflistung von Gruppenbereichsereignissen 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. Einen Abfragefilter. Sie müssen mindestens einen Ereignistyp (event_type) mit dem Operator „hat :“ angeben. Wenn Sie nach mehreren Ereignistypen filtern möchten, verwenden Sie den Operator OR. Schließen Sie Batch-Ereignistypen aus Ihrem Filter aus. Die Anfrage gibt automatisch alle zugehörigen Batch-Ereignisse zurück. Wenn du beispielsweise nach neuen Reaktionen (google.workspace.chat.reaction.v1.created) filterst, gibt der Server auch Ereignisse für neue Reaktionen im Batch (google.workspace.chat.reaction.v1.batchCreated) zurück. Eine Liste der unterstützten Ereignistypen findest du in der SpaceEvents-Referenzdokumentation. Optional können Sie auch nach Startzeit (start_time) und Endzeit (end_time) filtern: start_time: Exklusiver Zeitstempel, ab dem die Listen der Gruppenbereiche beginnen sollen. Sie können Ereignisse auflisten, die bis zu 28 Tage zurückliegen. Wenn Sie nichts angeben, werden Gruppenbereichsereignisse der letzten 28 Tage aufgeführt. end_time: Inklusiver Zeitstempel, bis zu dem Gruppenbereichsereignisse aufgeführt werden. Wenn nicht angegeben, werden Ereignisse bis zum Zeitpunkt der Anfrage aufgeführt. Verwenden Sie den Operator „ist gleich“ = und das Format RFC-3339, um eine Start- oder Endzeit anzugeben. Wenn Sie sowohl nach start_time als auch nach 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 für das Auflisten von Gruppenbereichsereignissen.

Felder
space_events[]	SpaceEvent Die Ergebnisse werden in chronologischer Reihenfolge zurückgegeben (das älteste Ereignis zuerst). Hinweis: Das Feld permissionSettings wird bei Listenanfragen nicht im Gruppenbereichsobjekt zurückgegeben.
next_page_token	string Fortsetzungstoken, das zum Abrufen weiterer Ereignisse verwendet wird. 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 Gruppenbereiche, die zurückgegeben werden sollen. Der Dienst gibt möglicherweise weniger als diesen Wert zurück. Wenn nicht angegeben, werden maximal 100 Gruppenbereiche 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 der Fehler INVALID_ARGUMENT zurückgegeben.
page_token	string Optional. Ein Seitentoken, das von einem vorherigen Aufruf zum Auflisten von Gruppenbereichen empfangen wurde. Geben Sie diesen Parameter an, um die nachfolgende Seite abzurufen. Beim Paginieren muss der Filterwert mit dem Aufruf übereinstimmen, der das Seitentoken bereitgestellt hat. Wenn Sie einen anderen Wert übergeben, kann das zu unerwarteten Ergebnissen führen.
filter	string Optional. Einen Abfragefilter. Sie können Gruppenbereiche nach dem Gruppenbereichstyp (space_type) filtern. Wenn Sie nach Gruppentyp filtern möchten, müssen Sie einen gültigen enum-Wert angeben, z. B. SPACE oder GROUP_CHAT. space_type darf nicht SPACE_TYPE_UNSPECIFIED sein. Wenn Sie nach mehreren Gruppentypen suchen 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 Gruppenbereichen.

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

MatchedUrl

Eine übereinstimmende URL in einer Chatnachricht. In Chat-Apps können übereinstimmende URLs in einer Vorschau angezeigt werden. Weitere Informationen finden Sie unter Links in der Vorschau anzeigen.

Felder
url	string Nur Ausgabe. Die übereinstimmende URL.

Mitgliedschaft

Stellt eine Mitgliedschaftsbeziehung in Google Chat dar, z. B. ob ein Nutzer oder eine Chat-App zu einem Gruppenbereich eingeladen wurde, zu einem Gruppenbereich gehört oder nicht zu einem Gruppenbereich gehört.

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, die seine zulässigen Aktionen im Bereich bestimmt. Dieses Feld kann nur in UpdateMembership als Eingabe verwendet werden.
create_time	Timestamp Optional. Nicht veränderbar. Die Erstellungszeit der Mitgliedschaft, z. B. wenn ein Mitglied einem Gruppenbereich beigetreten ist oder dazu eingeladen wurde. Dieses Feld dient nur der Ausgabe, es sei denn, es wird verwendet, um bisherige Mitgliedschaften in Gruppenbereichen im Importmodus zu importieren.
delete_time	Timestamp Optional. Nicht veränderbar. Das Datum und die Uhrzeit, zu dem die Mitgliedschaft gelöscht wurde, z. B. wenn ein Mitglied einen Gruppenbereich verlassen oder daraus entfernt wurde. Dieses Feld dient nur der Ausgabe, es sei denn, es wird verwendet, um bisherige Mitgliedschaften in Gruppenbereichen im Importmodus zu importieren.
Union-Feld memberType. Mitglied, das mit dieser Mitgliedschaft verknüpft ist. Weitere 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. die die Mitgliedschaft entspricht. Wenn Ihre Chat-App als Nutzer authentifiziert wird, werden in der Ausgabe die Nutzer name und type eingefügt.
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. Weitere Aufzählungswerte werden möglicherweise in Zukunft hinzugefügt.

Enums
MEMBERSHIP_ROLE_UNSPECIFIED	Standardwert. Für users: Diese Person ist kein Mitglied des Gruppenbereichs, kann aber eingeladen werden. Für Google Groups: Diese Rolle wird immer zugewiesen (in Zukunft können auch andere Aufzählungswerte verwendet werden).
ROLE_MEMBER	Ein Mitglied des Gruppenbereichs. Der Nutzer hat grundlegende Berechtigungen, z. B. das Senden von Nachrichten an den Gruppenbereich. In Einzelunterhaltungen 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. Nur in SpaceType.SPACE unterstützt.

MembershipState

Gibt die Beziehung des Mitglieds zu einem Gruppenbereich an. Weitere Mitgliedsstaaten werden möglicherweise in Zukunft 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 in den Gruppenbereich eingeladen, ist aber noch nicht Mitglied.
NOT_A_MEMBER	Der Nutzer gehört nicht zum Gruppenbereich und hat keine ausstehende Einladung zum Beitritt zum Gruppenbereich.

MembershipBatchCreatedEventData

Ereignisnutzlast für mehrere neue Mitgliedschaften.

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

Felder
memberships[]	MembershipCreatedEventData Eine Liste der neuen Mitgliedschaften.

MembershipBatchDeletedEventData

Ereignisnutzlast für mehrere gelöschte Mitgliedschaften.

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

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

MembershipBatchUpdatedEventData

Ereignisnutzlast für mehrere aktualisierte Mitgliedschaften.

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

Felder
memberships[]	MembershipUpdatedEventData Eine Liste der aktualisierten Mitgliedschaften.

MembershipCreatedEventData

Ereignisnutzlast für eine neue Mitgliedschaft.

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

Felder
membership	Membership Die neue Mitgliedschaft.

MembershipDeletedEventData

Ereignisnutzlast 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

Ereignisnutzlast für eine aktualisierte Mitgliedschaft.

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

Felder
membership	Membership Die aktualisierte Mitgliedschaft.

Nachricht senden

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 Gruppenbereichs, in dem die Nachricht gepostet wird, und {message} eine systemzugewiesene 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 Ihre Chat-App als Nutzer authentifiziert wird, werden in der Ausgabe die Nutzer name und type eingefügt.
create_time	Timestamp Optional. Nicht veränderbar. Bei in Google Chat erstellten Gruppenbereichen die Uhrzeit, zu der die Nachricht erstellt wurde. Dieses Feld dient nur der Ausgabe, es sei denn, es wird in Gruppenbereichen im Importmodus verwendet. Legen Sie für Gruppenbereiche im Importmodus in diesem Feld den Zeitstempel fest, zu dem die Nachricht in der Quelle erstellt wurde, um den ursprünglichen Erstellungszeitpunkt beizubehalten.
last_update_time	Timestamp Nur Ausgabe. Die Uhrzeit, zu der 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. Der Textkörper der Nachricht im Nur-Text-Format. Der erste Link zu einem Bild, Video oder einer Webseite generiert einen Vorschau-Chip. Sie können auch einen Google Chat-Nutzer oder alle Nutzer im Gruppenbereich erwähnen. Weitere Informationen zum Erstellen von Nachrichten finden Sie unter Nachricht senden.
formatted_text	string Nur Ausgabe. Enthält die Nachricht text mit Markups zur Angabe der Formatierung. Dieses Feld enthält möglicherweise nicht alle Formatierungen, die in der Benutzeroberfläche sichtbar sind, aber Folgendes: Markup-Syntax für Fettdruck, Kursivschrift, Durchstreichen, einzeilige Schrift, einzeiligen 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. Reichhaltige, 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 unformatierten Textkörper der Nachricht angezeigt. cards und cards_v2 können eine maximale Größe von 32 KB haben.
cards_v2[]	CardWithId Optional. Ein Array von Karten. Nur Chat-Apps können Karten erstellen. Wenn sich Ihre Chat-App als Nutzer authentifiziert, können die Nachrichten keine Karten enthalten. Weitere Informationen zum Erstellen einer Nachricht mit Karten finden Sie unter Nachricht senden. Mit dem Card Builder Karten entwerfen und eine Vorschau anzeigen Karten-Builder öffnen
annotations[]	Annotation Nur Ausgabe. Anmerkungen, die mit der text in dieser Nachricht verknüpft sind.
thread	Thread Der Thread, zu dem die Nachricht gehört. Eine Beispielanwendung finden Sie unter Nachrichtenthreads starten oder beantworten.
space	Space Nur Ausgabe. Wenn sich Ihre Chat-App als Nutzer authentifiziert, wird in der Ausgabe nur der Gruppenbereich name eingefügt.
fallback_text	string Optional. Eine Beschreibung der Karten der Nachricht in Nur-Text, die verwendet wird, wenn die Karten nicht angezeigt werden können, z. B. bei Benachrichtigungen auf Mobilgeräten.
action_response	ActionResponse Nur Eingabe. Parameter, mit denen eine Chat-App konfigurieren kann, wie ihre Antwort gepostet wird.
argument_text	string Nur Ausgabe. Der Nur-Text-Textkörper der Nachricht ohne Erwähnungen der Chat App
slash_command	SlashCommand Nur Ausgabe. Informationen zum Slash-Befehl, falls zutreffend.
attachment[]	Attachment Optional. Von einem Nutzer hochgeladener Anhang.
matched_url	MatchedUrl Nur Ausgabe. Eine URL in spaces.messages.text, die einem Muster für Linkvorschauen entspricht. Weitere Informationen finden Sie unter Vorschaulinks.
thread_reply	bool Nur Ausgabe. Wenn true, ist die Nachricht eine Antwort in einem Antwort-Thread. Bei false ist die Nachricht in der Unterhaltung auf oberster Ebene des Gruppenbereichs entweder als erste Nachricht eines Threads oder als Nachricht ohne Antworten im Thread sichtbar. Wenn das Gruppenbereich das Antworten in Threads nicht unterstützt, ist dieses Feld immer false.
client_assigned_message_id	string Optional. Eine benutzerdefinierte ID für die Nachricht. Sie können das Feld verwenden, um eine Nachricht zu identifizieren oder eine Nachricht 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 der Emoji-Reaktionen auf die Nachricht.
private_message_viewer	User Optional. Nicht veränderbar. Eingabe für das Erstellen einer Nachricht, andernfalls 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 der App-Authentifizierung aufrufen und Folgendes auslassen: 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 Text und Karten enthalten, zusätzliche Widgets hinzufügen. Nicht unterstützt für Nachrichten, die Dialoge enthalten. Weitere Informationen finden Sie unter Interaktive Widgets unten in einer Nachricht einfügen. Für das 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

Ereignisnutzlast für mehrere gelöschte Nachrichten.

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

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

MessageBatchUpdatedEventData

Ereignisnutzlast für mehrere aktualisierte Nachrichten.

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

Felder
messages[]	MessageUpdatedEventData Eine Liste der aktualisierten Nachrichten.

MessageCreatedEventData

Ereignisnutzlast für eine neue Nachricht.

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

Felder
message	Message Die neue Nachricht.

MessageDeletedEventData

Ereignisnutzlast 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 sind 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, der angibt, wann die zitierte Nachricht erstellt oder zuletzt aktualisiert wurde.

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 der neuen Reaktionen.

ReactionBatchDeletedEventData

Ereignisnutzlast für mehrere gelöschte Reaktionen.

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

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

ReactionCreatedEventData

Ereignisnutzlast für eine neue Reaktion.

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

Felder
reaction	Reaction Die neue Reaktion.

ReactionDeletedEventData

Ereignisnutzlast 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. Weitere Typen werden möglicherweise in Zukunft hinzugefügt.

Enums
RICH_LINK_TYPE_UNSPECIFIED	Standardwert für die Enumeration. Nicht verwenden.
DRIVE_FILE	Ein Google Drive-Link-Typ mit erweiterten Funktionen.
CHAT_SPACE	Ein Linktyp für einen Chatbereich. Beispiel: Smartchip für einen Gruppenbereich

SearchSpacesRequest

Anfrage, nach einer Liste von Gruppenbereichen zu suchen, die auf einer Abfrage basieren.

Felder
use_admin_access	bool Wenn true festgelegt ist, wird die Methode mit den Google Workspace-Administratorberechtigungen des Nutzers ausgeführt. Der anrufende Nutzer muss ein Google Workspace-Administrator mit der Berechtigung Unterhaltungen in Chats und Gruppenbereichen verwalten sein. Erfordert entweder den OAuth 2.0-Bereichchat.admin.spaces.readonly oder chat.admin.spaces. Diese Methode unterstützt derzeit nur den Administratorzugriff. Daher ist für dieses Feld nur true zulässig.
page_size	int32 Die maximale Anzahl der Gruppenbereiche, die zurückgegeben werden sollen. Der Dienst gibt möglicherweise weniger als diesen Wert zurück. Wenn nicht angegeben, werden maximal 100 Gruppenbereiche 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 Suchbereichsaufruf empfangen wurde. Geben Sie diesen Parameter an, um die nachfolgende Seite abzurufen. Beim Paginieren müssen alle anderen angegebenen 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 Für create_time und last_active_time ist ein Zeitstempel im RFC-3339 zulässig. Die unterstützten Vergleichsoperatoren sind: =, <, >, <= und >=. customer ist erforderlich und gibt an, 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 Token zerlegt. Jedes Token wird dann unabhängig voneinander und ohne Berücksichtigung der Groß- und Kleinschreibung als Substring an einer beliebigen Stelle in der display_name des Gruppenbereichs mit einem Präfix abgeglichen. Beispiel: Fun Eve entspricht Fun event oder The evening was fun, aber nicht notFun event oder even. Für external_user_allowed sind entweder true oder false zulässig. Für space_history_state sind nur Werte aus dem Feld historyState einer space-Ressource zulässig. 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". Innerhalb desselben Felds werden für space_type keine AND- oder OR-Operatoren unterstützt. Für display_name, „space_history_state“ und „external_user_allowed“ werden nur OR-Operatoren unterstützt. 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. Die Reihenfolge der Gruppenbereiche. Folgende Attribute werden unterstützt: membership_count.joined_direct_human_user_count: Gibt die Anzahl der Nutzer an, die einem Gruppenbereich direkt beigetreten sind. last_active_time: Gibt an, wann dem letzten Thema in diesem Gruppenbereich ein berechtigtes Element hinzugefügt wurde. create_time – Gibt die Zeit an, zu der der Gruppenbereich erstellt wurde. Gültige Werte für den Sortiervorgang: 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 der Gruppenbereiche, die der Anfrage 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 Gruppenbereiche, die der Suchanfrage entsprechen, auf allen Seiten. Wenn das Ergebnis mehr als 10.000 Plätze beträgt, 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. Wenn Sie einen Gruppenbereich erstellen möchten, setzen Sie Space.spaceType auf SPACE und Space.displayName. Wenn Sie beim Einrichten eines Gruppenbereichs 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. Wenn Sie einen Gruppenchat erstellen möchten, setzen Sie Space.spaceType auf GROUP_CHAT. Legen Sie Space.displayName nicht fest. Wenn Sie eine Unterhaltung zwischen zwei Menschen erstellen möchten, legen Sie Space.spaceType auf DIRECT_MESSAGE und Space.singleUserBotDm auf false fest. Legen Sie nicht Space.displayName oder Space.spaceDetails fest. Wenn Sie eine Unterhaltung zwischen einer natürlichen Person und der anrufenden Chat-App starten möchten, legen Sie Space.spaceType auf DIRECT_MESSAGE und Space.singleUserBotDm auf true fest. Legen Sie nicht Space.displayName oder Space.spaceDetails fest. Wenn ein DIRECT_MESSAGE-Bereich bereits vorhanden ist, wird dieser zurückgegeben, anstatt einen neuen Bereich 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 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 zum Beitritt zum Gruppenbereich eingeladen werden sollen. Den anrufenden Nutzer weglassen, da er automatisch hinzugefügt wird. Derzeit sind bis zu 20 Mitgliedschaften (zusätzlich zum Anrufer) möglich. Bei einer Mitgliedschaft für natürliche Personen muss das Feld Membership.member ein user mit ausgefülltem name enthalten (Format: users/{user}) und type auf User.Type.HUMAN festgelegt sein. Sie können nur bei der Einrichtung eines Gruppenbereichs Nutzer hinzufügen. Das Hinzufügen von Chat-Apps wird nur für die 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 Google-Gruppen muss das Feld Membership.group_member ein group mit 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, zusammen mit mindestens zwei Mitgliedschaften. Erforderlich, wenn Space.spaceType auf DIRECT_MESSAGE gesetzt ist und ein Nutzer dabei ist, sowie genau eine Mitgliedschaft. Muss leer sein, wenn eine Unterhaltung zwischen einem Nutzer und der anrufenden Chat-App erstellt wird (wenn Space.spaceType auf DIRECT_MESSAGE und Space.singleUserBotDm auf true gesetzt wird).

SlashCommand

Slash-Befehl in Google Chat

Felder
command_id	int64 Die ID des aufgerufenen Slash-Befehls.

SlashCommandMetadata

Anmerkungsmetadaten 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 Befehl für ein Dialogfeld gedacht ist.

Typ

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

Leerzeichen

Einen Gruppenbereich in Google Chat Gruppenbereiche sind Unterhaltungen zwischen zwei oder mehreren Nutzern oder Einzelunterhaltungen zwischen einem Nutzer und einer Chat-App.

Felder
name	string Kennung. Ressourcenname des Gruppenbereichs. Format: spaces/{space} Dabei steht {space} für die vom System zugewiesene ID des Gruppenbereichs. Sie können die Gruppenbereichs-ID durch Aufrufen der Methode spaces.list() oder über die Gruppenbereichs-URL abrufen. Wenn die Gruppenbereichs-URL beispielsweise https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA lautet, ist die Gruppenbereichs-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 Aktualisieren des Gruppenbereichstyps. Ausgabe nur für andere Zwecke.
single_user_bot_dm	bool Optional. Gibt an, ob es sich bei dem Gruppenbereich um eine Direktnachricht zwischen einer Chat-App und einer einzelnen Person handelt.
threaded (deprecated)	bool Dieses Element ist veraltet. Nur Ausgabe. Verworfen. Verwenden Sie stattdessen spaceThreadingState. Ob Nachrichten in diesem Gruppenbereich in Threads angezeigt werden.
display_name	string Optional. Der Anzeigename des Gruppenbereichs. Erforderlich, wenn Sie einen Gruppenbereich mit einer spaceType von SPACE erstellen. Wenn Sie beim Erstellen eines Gruppenbereichs oder Aktualisieren des displayName 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. 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 in diesem Gruppenbereich beliebige Google Chat-Nutzer als Mitglieder zugelassen sind. Wird beim Erstellen eines Gruppenbereichs in einer Google Workspace-Organisation eingegeben. Lassen Sie dieses Feld in den folgenden Fällen weg, wenn Sie Gruppenbereiche erstellen: Der authentifizierte Nutzer verwendet ein Privatkonto (nicht verwaltetes Nutzerkonto). In einem Gruppenbereich, der von einem privaten Konto erstellt wurde, ist standardmäßig der Zugriff für alle Google Chat-Nutzer erlaubt. Bei bestehenden Gruppenbereichen dient dieses Feld nur der Ausgabe.
space_threading_state	SpaceThreadingState Nur Ausgabe. Der Status der 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 zu Google Workspace erstellt wird. Während Gruppenbereiche importiert werden, sind sie für Nutzer erst sichtbar, wenn der Import abgeschlossen ist. Für das Erstellen eines Gruppenbereichs in Import Mode ist eine Nutzerauthentifizierung erforderlich.
create_time	Timestamp Optional. Nicht veränderbar. Bei in Google Chat erstellten Gruppenbereichen ist es die Uhrzeit, zu der der Gruppenbereich erstellt wurde. Dieses Feld dient nur der Ausgabe, es sei denn, es wird in Gruppenbereichen im Importmodus verwendet. Legen Sie für Gruppenbereiche im Importmodus in diesem Feld den Zeitstempel fest, zu dem der Gruppenbereich in der Quelle erstellt wurde, um den ursprünglichen Erstellungszeitpunkt beizubehalten. Wird nur in die Ausgabe aufgenommen, wenn spaceType GROUP_CHAT oder SPACE ist.
last_active_time	Timestamp Nur Ausgabe. Zeitstempel der letzten Nachricht im Gruppenbereich. Vorabversion für Entwickler:Verfügbar im Rahmen des Google Workspace-Vorabversionsprogramms für Entwickler, das Vorabzugriff auf bestimmte Funktionen gewährt.
admin_installed	bool Nur Ausgabe. Ob ein Gruppenbereich für Direktnachrichten (DM) mit einer Chat-App von einem Google Workspace-Administrator erstellt wurde. Administratoren können im Namen von Nutzern in ihrer Organisation eine Chat-App installieren und eine Direktnachricht 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, gruppiert nach Mitgliedstyp. Wird ausgefüllt, wenn space_type SPACE, DIRECT_MESSAGE oder GROUP_CHAT ist. Vorabversion für Entwickler:Verfügbar im Rahmen des Google Workspace-Vorabversionsprogramms für Entwickler, das Vorabzugriff auf bestimmte Funktionen gewährt.
access_settings	AccessSettings Optional. Gibt die Zugriffseinstellung des Gruppenbereichs an. Wird nur ausgefüllt, wenn space_type SPACE ist.
space_uri	string Nur Ausgabe. Der URI, über den ein Nutzer auf den Gruppenbereich zugreifen kann.
import_mode_expire_time	Timestamp Nur Ausgabe. Das Datum, an dem der Gruppenbereich automatisch vom System gelöscht wird, wenn er sich noch im Importmodus befindet. Jeder im Importmodus erstellte Gruppenbereich muss vor Ablauf dieser Frist mit spaces.completeImport aus diesem Modus herausgenommen werden. 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 Gruppenbereich 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 der Alias customers/my_customer auch verwendet werden, um den Gruppenbereich in derselben Google Workspace-Organisation wie die App zu erstellen. Bei DMs ist dieses Feld leer. Vorabversion für Entwickler:Verfügbar im Rahmen des Google Workspace-Vorabversionsprogramms für Entwickler, das Vorabzugriff auf bestimmte Funktionen gewährt.
Union-Feld space_permission_settings. Stellt die Berechtigungseinstellungen eines Gruppenbereichs dar. Wird nur ausgefüllt, wenn space_type SPACE ist. Erfordert die Nutzerauthentifizierung. 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. Wenn das Feld nicht festgelegt ist, wird ein Gruppenbereich erstellt. Nachdem Sie den Gruppenbereich erstellt haben, werden die Einstellungen in das Feld PermissionSettings eingefügt.
permission_settings	PermissionSettings Optional. Einstellungen für Berechtigungen für Gruppenbereiche für vorhandene Gruppenbereiche Eingabe für die Aktualisierung der genauen Berechtigungseinstellungen für Gruppenbereiche, bei der vorhandene Berechtigungseinstellungen ersetzt werden. Die Ausgabe enthält die aktuellen Berechtigungseinstellungen.

AccessSettings

Die Zugriffseinstellung des Gruppenbereichs.

Felder
access_state	AccessState Nur Ausgabe. Gibt den Zugriffsstatus des Gruppenbereichs an.
audience	string Optional. Der Ressourcenname der Zielgruppe, die den Gruppenbereich finden, ihm beitreten und sich eine Vorschau der Nachrichten im Gruppenbereich 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 Gruppenbereiche 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. Das Lesen der Zielgruppe unterstützt: Nutzerauthentifizierung App-Authentifizierung mit Administratorzustimmung mit dem Bereich chat.app.spaces in Vorabversion für Entwickler:Verfügbar im Rahmen des Google Workspace-Vorabversionsprogramms für Entwickler, das Vorabzugriff auf bestimmte Funktionen gewährt. Dieses Feld wird nicht ausgefüllt, wenn der Umfang chat.bot mit der App-Authentifizierung verwendet wird. Für die Festlegung der Zielgruppe ist eine Nutzerauthentifizierung erforderlich.

AccessState

Stellt den Zugriffsstatus des Gruppenbereichs dar.

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	Ein Administrator eines Gruppenbereichs hat einer Zielgruppe Zugriff auf den Gruppenbereich gewährt. Nutzer oder Google-Gruppen, die dem Gruppenbereich einzeln hinzugefügt oder eingeladen wurden, können ihn ebenfalls finden und darauf zugreifen. Weitere Informationen finden Sie unter Gruppenbereich für bestimmte Nutzer sichtbar machen. Für das Erstellen von Gruppenbereichen mit offenem Zugang ist eine Nutzerauthentifizierung erforderlich.

MembershipCount

Die Anzahl der Mitgliedschaften in einem Gruppenbereich, gruppiert nach Kategorien.

Felder
joined_direct_human_user_count	int32 Nur Ausgabe. Anzahl der natürlichen Personen, die dem Gruppenbereich direkt beigetreten sind. Nutzer, die über eine Mitgliedschaft in einer verknüpften Gruppe beigetreten sind, werden nicht gezählt.
joined_group_count	int32 Nur Ausgabe. Die 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. Ob Mitglieder ohne die Rolle „Administrator“ diese Berechtigung haben.

PermissionSettings

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

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

Felder
manage_members_and_groups	PermissionSetting Optional. Einstellung zum Verwalten von Mitgliedern und Gruppen in einem Gruppenbereich.
modify_space_details	PermissionSetting Optional. Einstellung zum Aktualisieren des Namens, des Avatars, der Beschreibung und der Richtlinien eines 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 Gruppenbereich.
manage_webhooks	PermissionSetting Optional. Einstellung zum Verwalten von Webhooks in einem Gruppenbereich.
post_messages	PermissionSetting Nur Ausgabe. Einstellung für das Posten von Nachrichten in einem Gruppenbereich.
reply_messages	PermissionSetting Optional. Einstellung für das Beantworten von 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 Gruppenbereiche finden Sie unter Gruppenbereiche.

Enums
PREDEFINED_PERMISSION_SETTINGS_UNSPECIFIED	Nicht angegeben Nicht verwenden.
COLLABORATION_SPACE	Einstellung, mit der der Gruppenbereich zu einem Gruppenbereich für die Zusammenarbeit wird, in dem alle Mitglieder Nachrichten posten können.
ANNOUNCEMENT_SPACE	Einstellung, mit der der Gruppenbereich in einen Gruppenbereich für Ankündigungen umgewandelt wird, 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. Sie können beispielsweise das Diskussionsthema, den Zweck oder die Teilnehmer des Gruppenbereichs beschreiben. Unterstützt bis zu 150 Zeichen.
guidelines	string Optional. die Regeln, Erwartungen und Umgangsformen des Gruppenbereichs Unterstützt bis zu 5.000 Zeichen.

SpaceThreadingState

Gibt den Thread-Status im Chatbereich an.

Enums
SPACE_THREADING_STATE_UNSPECIFIED	Reserviert.
THREADED_MESSAGES	Namensgruppenbereiche, die Nachrichtenthreads unterstützen Wenn Nutzer auf eine Nachricht antworten, können sie im Thread antworten. Dadurch bleibt ihre Antwort im Kontext der ursprünglichen Nachricht.
GROUPED_MESSAGES	Namensgruppenbereiche, in denen die Unterhaltung nach Thema organisiert ist. Themen und ihre Antworten werden gruppiert.
UNTHREADED_MESSAGES	Direktnachrichten zwischen zwei Personen und Gruppenunterhaltungen mit mindestens drei Personen

SpaceType

Der Typ des Gruppenbereichs. Erforderlich beim Erstellen oder Aktualisieren eines Gruppenbereichs. Ausgabe nur für andere Zwecke.

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 einer Person und einer Chat-App

Typ

Verworfen. Verwenden Sie stattdessen SpaceType.

Enums
TYPE_UNSPECIFIED	Reserviert.
ROOM	Unterhaltungen zwischen zwei oder mehr Personen.
DM	Direktnachricht zwischen einer natürlichen Person und einer Chat-App, bei der alle Nachrichten flach sind. Direktnachrichten zwischen zwei Personen sind davon ausgenommen.

SpaceBatchUpdatedEventData

Ereignisnutzlast für mehrere Aktualisierungen eines Gruppenbereichs.

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 finden Sie unter Mit Ereignissen aus Google Chat arbeiten.

Felder
name	string Ressourcenname des Gruppenbereichsereignisses. Format: spaces/{space}/spaceEvents/{spaceEvent}
event_time	Timestamp Zeit, zu der das Ereignis aufgetreten ist.
event_type	string Art des Gruppenbereichsereignisses. Jeder Ereignistyp hat eine Batchversion, die mehrere Instanzen des Ereignistyps darstellt, die in einem kurzen Zeitraum auftreten. Lassen Sie bei spaceEvents.list()-Anfragen Batchereignistypen aus dem Abfragefilter weg. Standardmäßig gibt der Server sowohl den Ereignistyp als auch die Batchversion zurück. Unterstützte Ereignistypen für Nachrichten: 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 Kanalmitgliedschaften: 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 Raum: Aktualisierter Gruppenbereich: google.workspace.chat.space.v1.updated Mehrere Updates für Gruppenbereiche: 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 Ereignisnutzlast 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 Ereignisnutzlast 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 Ereignisnutzlast für mehrere aktualisierte Nachrichten. Ereignistyp: google.workspace.chat.message.v1.batchUpdated
message_batch_deleted_event_data	MessageBatchDeletedEventData Ereignisnutzlast für mehrere gelöschte Nachrichten. Ereignistyp: google.workspace.chat.message.v1.batchDeleted
space_updated_event_data	SpaceUpdatedEventData Ereignisnutzlast für eine Gruppenbereichsaktualisierung. Ereignistyp: google.workspace.chat.space.v1.updated
space_batch_updated_event_data	SpaceBatchUpdatedEventData Ereignisnutzlast für mehrere Aktualisierungen eines Gruppenbereichs. Ereignistyp: google.workspace.chat.space.v1.batchUpdated
membership_created_event_data	MembershipCreatedEventData Ereignisnutzlast für eine neue Mitgliedschaft. Ereignistyp: google.workspace.chat.membership.v1.created
membership_updated_event_data	MembershipUpdatedEventData Ereignisnutzlast für eine aktualisierte Mitgliedschaft. Ereignistyp: google.workspace.chat.membership.v1.updated
membership_deleted_event_data	MembershipDeletedEventData Ereignisnutzlast für eine gelöschte Mitgliedschaft. Ereignistyp: google.workspace.chat.membership.v1.deleted
membership_batch_created_event_data	MembershipBatchCreatedEventData Ereignisnutzlast für mehrere neue Mitgliedschaften. Ereignistyp: google.workspace.chat.membership.v1.batchCreated
membership_batch_updated_event_data	MembershipBatchUpdatedEventData Ereignisnutzlast für mehrere aktualisierte Mitgliedschaften. Ereignistyp: google.workspace.chat.membership.v1.batchUpdated
membership_batch_deleted_event_data	MembershipBatchDeletedEventData Ereignisnutzlast für mehrere gelöschte Mitgliedschaften. Ereignistyp: google.workspace.chat.membership.v1.batchDeleted
reaction_created_event_data	ReactionCreatedEventData Ereignisnutzlast für eine neue Reaktion. Ereignistyp: google.workspace.chat.reaction.v1.created
reaction_deleted_event_data	ReactionDeletedEventData Ereignisnutzlast 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 Ereignisnutzlast für mehrere gelöschte Reaktionen. Ereignistyp: google.workspace.chat.reaction.v1.batchDeleted

SpaceNotificationSetting

Die Benachrichtigungseinstellungen eines Nutzers in einem Gruppenbereich.

Vorabversion für Entwickler:Verfügbar im Rahmen des Google Workspace-Vorabversionsprogramms für Entwickler, das Vorabzugriff auf bestimmte Funktionen gewährt.

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

MuteSetting

Die Arten von Einstellungen für die Stummschaltung von Benachrichtigungen für Gruppenbereiche.

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

NotificationSetting

Die Arten von Benachrichtigungseinstellungen.

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, es sei denn, der Nutzer hebt die Verknüpfung manuell auf.
MAIN_CONVERSATIONS	Die Benachrichtigung wird durch @Erwähnungen, Unterhaltungen, denen Sie folgen, und die erste Nachricht in neuen Unterhaltungen ausgelöst. Nicht verfügbar für Direktnachrichten (1:1).
FOR_YOU	Die Benachrichtigung wird durch @Erwähnungen und Unterhaltungen ausgelöst, denen Sie folgen. Nicht verfügbar für Direktnachrichten (1:1).
OFF	Die Benachrichtigung ist deaktiviert.

SpaceReadState

Der Lesestatus eines Nutzers in einem Gruppenbereich, der gelesene und ungelesene Nachrichten identifiziert.

Felder
name	string Ressourcenname des Lesestatus des Gruppenbereichs. Format: users/{user}/spaces/{space}/spaceReadState
last_read_time	Timestamp Optional. Die Uhrzeit, zu der der Lesestatus des Nutzers für den Gruppenbereich aktualisiert wurde. Normalerweise entspricht dies entweder dem Zeitstempel der zuletzt gelesenen Nachricht oder einem vom Nutzer angegebenen Zeitstempel, der die zuletzt gelesene Position in einem Gruppenbereich markiert.

SpaceUpdatedEventData

Ereignisnutzlast für einen aktualisierten Gruppenbereich.

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

Felder
space	Space Der aktualisierte Gruppenbereich.

Thread

Einen Thread in einem Google Chat-Bereich Eine Beispielanwendung finden Sie unter Nachrichtenthreads starten oder beantworten.

Wenn Sie beim Erstellen einer Nachricht einen Thread angeben, können Sie mit dem Feld messageReplyOption festlegen, was passieren soll, 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 wird nur die Ausgabe angezeigt. ID für den Thread. Unterstützt bis zu 4.000 Zeichen. Diese ID ist für die Chat-App, die sie festlegt, eindeutig. 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 Thread-name-Feld an.

ThreadReadState

Der Lesestatus eines Nutzers in einem Thread, der zum Identifizieren gelesener und ungelesener Nachrichten verwendet wird.

Felder
name	string Ressourcenname des Lesestatus des Threads. Format: users/{user}/spaces/{space}/threads/{thread}/threadReadState
last_read_time	Timestamp Die Uhrzeit, zu der der Lesestatus des Threads des Nutzers aktualisiert wurde. Normalerweise entspricht dies dem Zeitstempel der zuletzt gelesenen Nachricht in einem Thread.

UpdateMembershipRequest

Anfrage zum Aktualisieren einer Mitgliedschaft

Felder
membership	Membership Erforderlich. Die zu aktualisierende Mitgliedschaft. Nur die mit 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 festgelegt ist, wird die Methode mit den Google Workspace-Administratorberechtigungen des 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 vom Kunden zugewiesen sein, andernfalls schlägt die Anfrage fehl.

UpdateSpaceNotificationSettingRequest

Anfrage zum Aktualisieren der Benachrichtigungseinstellungen für Gruppenbereiche Es wird nur die Aktualisierung der Benachrichtigungseinstellung für den anrufenden Nutzer unterstützt.

Vorabversion für Entwickler:Verfügbar im Rahmen des Google Workspace-Vorabversionsprogramms für Entwickler, das Vorabzugriff auf bestimmte Funktionen gewährt.

Felder
space_notification_setting	SpaceNotificationSetting Erforderlich. Der Ressourcenname für die Benachrichtigungseinstellungen des Gruppenbereichs muss im Format users/{user}/spaces/{space}/spaceNotificationSetting angegeben werden. Nur die mit update_mask angegebenen Felder werden aktualisiert.
update_mask	FieldMask Erforderlich. Unterstützte Feldpfade: – notification_setting – mute_setting

UpdateSpaceReadStateRequest

Anfragenachricht für UpdateSpaceReadState API.

Felder
space_read_state	SpaceReadState Erforderlich. Der Lesestatus des Gruppenbereichs und die zu aktualisierenden Felder. Unterstützt nur die Aktualisierung des Lesestatus für den anrufenden Nutzer. Um sich auf den anrufenden Nutzer zu beziehen, legen Sie einen der folgenden Parameter fest: Der Alias für me. Beispiel: users/me/spaces/{space}/spaceReadState. Ihre Workspace-E-Mail-Adresse. Beispiel: users/[e-mail]/spaces/{space}/spaceReadState. Die 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 das last_read_time vor dem Erstellungszeitpunkt der letzten Nachricht liegt, wird der Gruppenbereich in der Benutzeroberfläche als ungelesen angezeigt. Wenn Sie den Gruppenbereich als gelesen markieren möchten, setzen Sie last_read_time auf einen Wert, der später (größer) als die Erstellungszeit der letzten Nachricht ist. Der Wert von last_read_time wird auf die Zeit des Erstellens der letzten Nachricht festgelegt. Der Lesestatus des Gruppenbereichs wirkt sich nur auf den Lesestatus von Nachrichten aus, die in der Unterhaltung auf oberster Ebene des Gruppenbereichs sichtbar sind. Antworten in Threads sind von diesem Zeitstempel nicht betroffen und basieren stattdessen auf dem Lesestatus des Threads.

UpdateSpaceRequest

Eine Anfrage zum Aktualisieren eines einzelnen Gruppenbereichs.

Felder
space	Space Erforderlich. Gruppenbereich mit Feldern, die aktualisiert werden sollen. Space.name muss im Format spaces/{space} ausgefüllt werden. Nur die mit update_mask angegebenen Felder werden aktualisiert.
update_mask	FieldMask Erforderlich. Die aktualisierten Feldpfade, bei mehreren durch Kommas getrennt. Sie können die folgenden Felder für einen Gruppenbereich aktualisieren: space_details: Aktualisiert die Beschreibung des Gruppenbereichs. Unterstützt bis zu 150 Zeichen. display_name: Der Anzeigename kann nur für Gruppenbereiche aktualisiert werden, in denen das Feld spaceType den Wert SPACE hat. 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: Unterstützt nur die Änderung des Typs eines GROUP_CHAT-Bereichs in SPACE. Fügen Sie display_name zusammen mit space_type in die Updatemaske ein und achten Sie darauf, dass der angegebene Gruppenbereich einen nicht leeren Anzeigenamen und den Gruppenbereichstyp SPACE hat. Wenn der vorhandene Gruppenbereich bereits den Typ SPACE hat, ist es optional, die space_type-Maske und den SPACE-Typ beim Aktualisieren des Anzeigenamens in den angegebenen Gruppenbereich aufzunehmen. Versuche, den Gruppenbereichstyp auf andere Weise zu aktualisieren, führen zu einem Fehler wegen ungültigen Arguments. space_type wird von useAdminAccess nicht unterstützt. space_history_state: Hier können Sie die Einstellungen für den Verlauf des Gruppenbereichs aktualisieren, indem Sie den Verlauf für den Gruppenbereich aktivieren oder deaktivieren. Nur unterstützt, wenn die Verlaufseinstellungen für die Google Workspace-Organisation aktiviert sind. Wenn Sie den Verlaufsstatus des Gruppenbereichs aktualisieren möchten, müssen Sie alle anderen Feldmasken in Ihrer Anfrage weglassen. space_history_state wird von useAdminAccess nicht unterstützt. access_settings.audience: Aktualisiert die Zugriffseinstellung für Nutzer, die den Gruppenbereich finden, ihm beitreten und sich eine Vorschau der Nachrichten im benannten Gruppenbereich ansehen können, in dem das Feld spaceType den Wert SPACE hat. Wenn für den vorhandenen Gruppenbereich eine Zielgruppe festgelegt ist, können Sie sie entfernen und den Zugriff auf den Gruppenbereich einschränken, indem Sie einen Wert für diese Feldmaske weglassen. Wenn Sie die Zugriffseinstellungen für einen Gruppenbereich aktualisieren möchten, muss der authentifizierende Nutzer ein Administrator des Gruppenbereichs sein und alle anderen Feldmasken in der Anfrage weglassen. Dieses Feld kann nicht aktualisiert werden, wenn sich der Gruppenbereich im Importmodus befindet. Weitere Informationen finden Sie unter Gruppenbereich für bestimmte Nutzer sichtbar machen. access_settings.audience wird von useAdminAccess nicht unterstützt. permission_settings: Unterstützt das Ändern der Berechtigungseinstellungen eines Gruppenbereichs. Beim Aktualisieren der Berechtigungseinstellungen können Sie nur permissionSettings-Feldmasken angeben. Andere Feldmasken können nicht gleichzeitig aktualisiert werden. permissionSettings wird von useAdminAccess nicht unterstützt. Zu den unterstützten Feldmasken gehören: 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 festgelegt ist, wird die Methode mit den Google Workspace-Administratorberechtigungen des 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 ohne Administratorzugriff nicht unterstützt. Weitere Informationen finden Sie in der Beschreibung von update_mask.

Nutzer

Ein Nutzer in Google Chat. Wenn Ihre Chat-App sich als Nutzer authentifiziert und die Daten als Ausgabe einer Anfrage zurückgegeben werden, werden in der Ausgabe für eine User-Ressource nur die name und type des Nutzers ausgefüllt.

Felder
name	string Ressourcenname für eine Google Chat-user. Format: users/{user}. users/app kann als Alias für den Nutzer bot der Anruf-App verwendet werden. Für human users ist {user} dieselbe Nutzer-ID wie: die id für die Person in der People API. Beispielsweise steht users/123456789 in der Chat API für dieselbe Person wie die 123456789-Personenprofil-ID in der People API. die id für einen Nutzer in der Admin SDK Directory API. Die E-Mail-Adresse des Nutzers kann in API-Anfragen als Alias für {user} verwendet werden. Wenn die Personenprofil-ID der People API für [e-mail] beispielsweise 123456789 lautet, können Sie users/[e-mail] als Alias verwenden, um auf users/123456789 zu verweisen. Es wird nur der kanonische Ressourcenname (z. B. users/123456789) von der API zurückgegeben.
display_name	string Nur Ausgabe. Der Anzeigename des Nutzers.
domain_id	string Die 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	Menschlicher Nutzer.
BOT	Nutzer der Chat-App

UserMentionMetadata

Anmerkungsmetadaten für Nutzererwähnungen (@).

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

Typ

Enums
TYPE_UNSPECIFIED	Standardwert für die Enumeration. Nicht verwenden.
ADD	Fügen Sie den Nutzer dem Gruppenbereich hinzu.
MENTION	Nutzer im Gruppenbereich erwähnen

WidgetMarkup

Ein Widget ist ein UI-Element, das Text und Bilder enthält.

Felder
buttons[]	Button Eine Liste von Schaltflächen. Buttons ist ebenfalls oneof data und nur eines dieser Felder sollte 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 In diesem Widget wird ein Textabsatz angezeigt.
image	Image In diesem Widget wird ein Bild angezeigt.
key_value	KeyValue Hier können Sie einen Schlüssel/Wert-Eintrag 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 onclick-Aktion.
image_button	ImageButton Eine Schaltfläche mit Bild und onclick-Aktion.

FormAction

Eine Formularaktion beschreibt das Verhalten, wenn das Formular gesendet wird. Sie können beispielsweise Apps Script aufrufen, um das Formular zu verarbeiten.

Felder
action_method_name	string Anhand des Methodennamens wird ermittelt, welcher Teil des Formulars die Formulareinreichung 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 Aufruf der Aktionsmethode angegeben werden müssen. Angenommen, Sie haben drei Schlummertasten: „Jetzt“, „Einen Tag“ und „Nächste Woche“. Sie können action method = snooze() verwenden und den Schlummertyp 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 durch 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 Bilds (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 ist nicht dazu gedacht, das integrierte Seitenverhältnis des Bildes zu überschreiben. Wenn das Attribut nicht festgelegt ist, wird es vom Server durch Vorabladen des Bildes ausgefüllt.

ImageButton

Eine Bildschaltfläche mit einer onclick-Aktion.

Felder
on_click	OnClick Die Aktion onclick.
name	string Der Name dieser 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 durch 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 und auf ein Symbol verweist, das von der Chat API bereitgestellt wird.
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 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 der Inhaltsbereich sind anklickbar.
Union-Feld icons. Es muss mindestens eines der Symbole, top_label und bottom_label, definiert sein. Für icons ist nur einer der folgenden Werte zulässig:
icon	Icon Ein enum-Wert, 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 angeben, aber nicht beides. Für control ist nur einer der folgenden Werte zulässig:
button	Button Eine Schaltfläche, über die eine Aktion ausgelöst werden kann.

OnClick

Eine onclick-Aktion (z. B. Öffnen eines Links)

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

OpenLink

Ein Link, über den ein neues Fenster geöffnet wird.

Felder
url	string Die URL, die geöffnet werden soll.

TextButton

Eine Schaltfläche mit Text und onclick-Aktion.

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

TextParagraph

Einen Textabschnitt. 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