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 |
---|
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.
|
CreateCustomEmoji |
---|
Erfordert die Nutzerauthentifizierung.
|
CreateMembership |
---|
Es 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:
Beispiele zur Verwendung:
|
CreateMessage |
---|
Erstellt eine Nachricht in einem Google Chat-Gruppenbereich. Ein Beispiel finden Sie unter Nachricht senden. Für die Methode 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 ( 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 ( Die maximale Nachrichtengröße, einschließlich des Nachrichteninhalts, beträgt 32.000 Byte.
|
CreateReaction |
---|
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.
|
CreateSpace |
---|
Erstellt einen Gruppenbereich. Kann verwendet werden, um einen benannten Gruppenbereich oder einen Gruppenchat in Unterstützt die folgenden Authentifizierungstypen: Bei der Authentifizierung als App muss das Feld Die Mitgliedschaft im Gruppenbereich beim Erstellen hängt davon ab, wo der Gruppenbereich erstellt wird:
Wenn Sie beim Erstellen eines Gruppenbereichs die Fehlermeldung
|
DeleteCustomEmoji |
---|
Erfordert die Nutzerauthentifizierung.
|
DeleteMembership |
---|
Löscht eine Mitgliedschaft. Ein Beispiel finden Sie unter Nutzer oder Google Chat-App aus einem Gruppenbereich entfernen. Unterstützt die folgenden Authentifizierungstypen:
|
DeleteMessage |
---|
Löscht eine Nachricht. Ein Beispiel finden Sie unter Nachricht löschen. Unterstützt die folgenden Authentifizierungstypen: Bei der App-Authentifizierung können mit Anfragen nur Nachrichten gelöscht werden, die von der anrufenden Chat-App erstellt wurden.
|
DeleteReaction |
---|
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.
|
DeleteSpace |
---|
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. im Gruppenbereich gepostete Nachrichten und Mitgliedschaften im Gruppenbereich. Ein Beispiel finden Sie unter Chatbereich löschen. Unterstützt die folgenden Authentifizierungstypen:
|
FindDirectMessage |
---|
Gibt die vorhandene Direktnachricht mit dem angegebenen Nutzer zurück. Wenn kein Direktnachrichtenbereich gefunden wird, wird der Fehler 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:
|
GetAttachment |
---|
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.
|
GetCustomEmoji |
---|
Erfordert die Nutzerauthentifizierung.
|
GetMembership |
---|
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:
|
GetMessage |
---|
Gibt Details zu einer Nachricht zurück. Ein Beispiel finden Sie unter Details zu einer Nachricht abrufen. Unterstützt die folgenden Authentifizierungstypen: Hinweis: Möglicherweise wird eine Nachricht von einem blockierten Mitglied oder aus einem blockierten Gruppenbereich zurückgegeben.
|
GetSpace |
---|
Gibt Details zu einem Gruppenbereich zurück. Ein Beispiel finden Sie unter Details zu einem Gruppenbereich abrufen. Unterstützt die folgenden Authentifizierungstypen:
|
GetSpaceEvent |
---|
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 Hinweis: Das Feld 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.
|
GetSpaceNotificationSetting |
---|
Erfordert die Nutzerauthentifizierung.
|
GetSpaceReadState |
---|
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.
|
GetThreadReadState |
---|
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.
|
ListCustomEmojis |
---|
Erfordert die Nutzerauthentifizierung.
|
ListMemberships |
---|
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:
|
ListMessages |
---|
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, Erfordert die Nutzerauthentifizierung.
|
ListReactions |
---|
Listet Reaktionen auf eine Nachricht auf. Ein Beispiel finden Sie unter Reaktionen auf eine Nachricht auflisten. Erfordert die Nutzerauthentifizierung.
|
ListSpaceEvents |
---|
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 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.
|
ListSpaces |
---|
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: Wenn Sie alle benannten Gruppenbereiche nach Google Workspace-Organisation auflisten möchten, verwenden Sie stattdessen die Methode
|
SearchSpaces |
---|
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
|
SetUpSpace |
---|
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 Mitgliedschaft 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 Um die hinzuzufügenden Google-Gruppen anzugeben, fügen Sie Mitgliedschaften mit der entsprechenden 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 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 Erfordert die Nutzerauthentifizierung.
|
UpdateMembership |
---|
Aktualisiert eine Mitgliedschaft. Ein Beispiel finden Sie unter Teilnahme eines Nutzers an einem Gruppenbereich aktualisieren. Unterstützt die folgenden Authentifizierungstypen:
|
UpdateMessage |
---|
Aktualisiert eine Nachricht. Zwischen den Methoden Unterstützt die folgenden Authentifizierungstypen: Bei der App-Authentifizierung können Anfragen nur Nachrichten aktualisieren, die von der anrufenden Chat-App erstellt wurden.
|
UpdateSpace |
---|
Aktualisiert einen Gruppenbereich. Ein Beispiel finden Sie unter Gruppenbereich aktualisieren. Wenn Sie das Feld Unterstützt die folgenden Authentifizierungstypen:
|
UpdateSpaceNotificationSetting |
---|
Erfordert die Nutzerauthentifizierung.
|
UpdateSpaceReadState |
---|
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.
|
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_ |
Eine Liste von Schaltflächen. |
ActionResponse
Parameter, mit denen eine Chat-App konfigurieren kann, wie ihre Antwort gepostet wird.
Felder | |
---|---|
type |
Nur Eingabe. Der Typ der Antwort in der Google Chat App. |
url |
Nur Eingabe. URL, über die sich Nutzer authentifizieren oder konfigurieren können. (Nur für |
dialog_ |
Nur Eingabe. Eine Antwort auf ein Interaktionsereignis im Zusammenhang mit einem Dialog. Muss von |
updated_ |
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 eine 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[] |
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 |
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 |
Liste der Ergebnisse der automatischen Vervollständigung für das Widget |
ActionStatus
Der Status einer Anfrage zum Aufrufen oder Senden eines Dialogfelds.
Felder | |
---|---|
status_ |
Der Statuscode. |
user_ |
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 |
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 |
Der Typ dieser Anmerkung. |
length |
Länge des Teilstrings im Textkörper der Nachricht, dem diese Anmerkung entspricht. |
start_ |
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_ |
Die Metadaten der Nutzererwähnung. |
slash_ |
Die Metadaten für einen Slash-Befehl. |
rich_ |
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 |
Nur Ausgabe. Die URL, unter der das GIF-Bild gehostet wird. |
Anhang
Ein Anhang in Google Chat.
Felder | |
---|---|
name |
Optional. Ressourcenname des Anhangs im Format |
content_ |
Nur Ausgabe. Der ursprüngliche Dateiname für den Inhalt, nicht der vollständige Pfad. |
content_ |
Nur Ausgabe. Der Inhaltstyp (MIME-Typ) der Datei. |
thumbnail_ |
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_ |
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 |
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_ |
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_ |
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_ |
Optional. Der Ressourcenname der Anhangsdaten. Dieses Feld wird mit der Media API verwendet, um die Anhangsdaten herunterzuladen. |
attachment_ |
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 öffnenFelder | |
---|---|
card_ |
Erforderlich, wenn die Nachricht mehrere Karten enthält. Eine eindeutige Kennung für eine Karte in einer Nachricht. |
card |
Eine Infokarte Die maximale Größe beträgt 32 KB. |
ChatSpaceLinkData
Daten zu Links zu Chatbereichen.
Felder | |
---|---|
space |
Der Bereich der verknüpften Chatbereichsressource. Format: |
thread |
Der Thread der verknüpften Chatbereichsressource. Format: |
message |
Die Nachricht der verknüpften Chatbereichsressource. Format: |
CompleteImportSpaceRequest
Anfragenachricht zum Abschließen des Importvorgangs für einen Gruppenbereich
Felder | |
---|---|
name |
Erforderlich. Ressourcenname des Gruppenbereichs im Importmodus. Format: |
CompleteImportSpaceResponse
Antwortnachricht zum Abschluss des Importvorgangs für einen Gruppenbereich.
Felder | |
---|---|
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 |
Die Kopfzeile der Karte. Ein Header enthält in der Regel einen Titel und ein Bild. |
sections[] |
Abschnitte sind durch eine Trennlinie getrennt. |
card_ |
Die Aktionen dieser Karte. |
name |
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_ |
Das Label wurde früher im Menüpunkt „Aktion“ angezeigt. |
on_ |
Die onclick-Aktion für dieses Aktionselement. |
CardHeader
Felder | |
---|---|
title |
Der Titel muss angegeben werden. Die Überschrift hat eine feste Höhe: Wenn sowohl ein Titel als auch ein Untertitel angegeben ist, nimmt jeder eine Zeile ein. Wenn nur der Titel angegeben ist, nimmt er beide Zeilen ein. |
subtitle |
Der Untertitel der Kartenüberschrift. |
image_ |
Der Typ des Bildes (z. B. quadratischer oder kreisförmiger Rahmen) |
image_ |
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 |
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[] |
Ein Abschnitt muss mindestens ein Widget enthalten. |
CreateCustomEmojiRequest
Eine Anfrage zum Erstellen eines benutzerdefinierten Emojis.
Felder | |
---|---|
custom_ |
Erforderlich. Das benutzerdefinierte Emoji, das erstellt werden soll. |
CreateMembershipRequest
Anfrage zum Erstellen einer Mitgliedschaft.
Felder | |
---|---|
parent |
Erforderlich. Der Ressourcenname des Gruppenbereichs, für den die Mitgliedschaft erstellt werden soll. Format: spaces/{space} |
membership |
Erforderlich. Die zu erstellende Mitgliedschaftsbeziehung. Das Feld Wenn eine Chat-App eine Mitgliedschaftsbeziehung für einen Nutzer erstellt, muss sie bestimmte Autorisierungsbereiche verwenden und bestimmte Werte für bestimmte Felder 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 und den Bereich |
use_ |
Optional. Wenn Der anrufende Nutzer muss ein Google Workspace-Administrator mit der Berechtigung Unterhaltungen in Chats und Gruppenbereichen verwalten sein. Erfordert den 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 |
Erforderlich. Der Ressourcenname des Gruppenbereichs, in dem eine Nachricht erstellt werden soll. Format: |
message |
Erforderlich. Nachrichtentext |
thread_key |
Optional. Verworfen. Verwenden Sie stattdessen |
request_ |
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_ |
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_ |
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 Der Wert für dieses Feld muss die folgenden Anforderungen erfüllen:
|
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 ignoriert. |
REPLY_MESSAGE_FALLBACK_TO_NEW_THREAD |
Die Nachricht wird als Antwort auf den Thread erstellt, der durch thread ID oder 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 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 |
Erforderlich. Die Nachricht, auf die die Reaktion erfolgt. Format: |
reaction |
Erforderlich. Die zu erstellende Reaktion. |
CreateSpaceRequest
Eine Anfrage zum Erstellen eines benannten Gruppenbereichs ohne Mitglieder.
Felder | |
---|---|
space |
Erforderlich. Die Felder Wenn du die Fehlermeldung Der Bereich |
request_ |
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 |
Kennung. Der vom Server zugewiesene Ressourcenname des benutzerdefinierten Emojis. Format: |
uid |
Nur Ausgabe. Eindeutiger Schlüssel für die benutzerdefinierte Emoji-Ressource. |
emoji_ |
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: |
temporary_ |
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. |
payload |
Optional. Nur Eingabe. Nutzlastdaten Erforderlich, wenn das benutzerdefinierte Emoji erstellt wird. |
CustomEmojiPayload
Nutzlastdaten für das benutzerdefinierte Emoji.
Felder | |
---|---|
file_ |
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 |
Erforderlich. Nur Eingabe. Der Name der Bilddatei. Unterstützte Dateiendungen: |
DeleteCustomEmojiRequest
Anfrage zum Löschen eines benutzerdefinierten Emojis.
Felder | |
---|---|
name |
Erforderlich. Ressourcenname des zu löschenden benutzerdefinierten Emojis. Format: Sie können den Emoji-Namen als Alias für |
DeleteMembershipRequest
Anfrage zum Löschen einer Mitgliedschaft in einem Gruppenbereich
Felder | |
---|---|
name |
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 Bereich Zum Löschen einer App-Mitgliedschaft sind der Format: |
use_ |
Optional. Wenn Der anrufende Nutzer muss ein Google Workspace-Administrator mit der Berechtigung Unterhaltungen in Chats und Gruppenbereichen verwalten sein. Erfordert den Das Löschen von App-Mitgliedschaften in einem Gruppenbereich wird mit Administratorzugriff nicht unterstützt. |
DeleteMessageRequest
Anfrage zum Löschen einer Nachricht
Felder | |
---|---|
name |
Erforderlich. Ressourcenname der Nachricht. Format: Wenn Sie eine benutzerdefinierte ID für Ihre Nachricht festgelegt haben, können Sie den Wert aus dem Feld |
force |
Optional. Wenn 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 |
Erforderlich. Name der Reaktion, die gelöscht werden soll. Format: |
DeleteSpaceRequest
Anfrage zum Löschen eines Gruppenbereichs.
Felder | |
---|---|
name |
Erforderlich. Ressourcenname des zu löschenden Gruppenbereichs. Format: |
use_ |
Optional. Wenn Der anrufende Nutzer muss ein Google Workspace-Administrator mit der Berechtigung Unterhaltungen in Chats und Gruppenbereichen verwalten sein. Erfordert den |
DeletionMetadata
Informationen zu einer gelöschten Nachricht. Eine Nachricht wird gelöscht, wenn delete_time
festgelegt ist.
Felder | |
---|---|
deletion_ |
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 |
Nur Eingabe. Textkörper des Dialogfelds, der in einem modalen Dialogfeld gerendert wird. Google Chat-Apps unterstützen die folgenden Kartenentitäten nicht: |
DialogAction
Enthält einen Dialog und einen Anfragestatuscode.
Felder | |
---|---|
action_ |
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 |
Nur Eingabe. Dialog für die Anfrage. |
DriveDataRef
Ein Verweis auf die Daten eines Drive-Anhangs.
Felder | |
---|---|
drive_ |
Die ID der Drive-Datei. Mit der Drive API verwenden |
DriveLinkData
Daten für Google Drive-Links
Felder | |
---|---|
drive_ |
Eine DriveDataRef, die auf eine Google Drive-Datei verweist. |
mime_ |
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 |
Optional. Ein einfaches Emoji, das durch einen Unicode-String dargestellt wird. |
custom_ |
Nur Ausgabe. Ein benutzerdefiniertes Emoji. |
EmojiReactionSummary
Die Anzahl der Personen, die auf eine Nachricht mit einem bestimmten Emoji reagiert haben.
Felder | |
---|---|
emoji |
Nur Ausgabe. Das mit den Reaktionen verknüpfte Emoji. |
reaction_ |
Nur Ausgabe. Die Gesamtzahl der Reaktionen mit dem entsprechenden Emoji. |
FindDirectMessageRequest
Eine Anfrage zum Abrufen des Direktnachrichtenbereichs basierend auf der Nutzerressource.
Felder | |
---|---|
name |
Erforderlich. Ressourcenname des Nutzers, für den Direktnachrichten gesucht werden sollen. Format: |
GetAttachmentRequest
Anhang anfordern
Felder | |
---|---|
name |
Erforderlich. Ressourcenname des Anhangs im Format |
GetCustomEmojiRequest
Eine Anfrage, um ein einzelnes benutzerdefiniertes Emoji zurückzugeben.
Felder | |
---|---|
name |
Erforderlich. Ressourcenname des benutzerdefinierten Emojis. Format: Sie können den Emoji-Namen als Alias für |
GetMembershipRequest
Anfrage zum Abrufen einer Mitgliedschaft in einem Gruppenbereich.
Felder | |
---|---|
name |
Erforderlich. Ressourcenname der abzurufenden Mitgliedschaft. Wenn du die Mitgliedschaft der App über die Nutzerauthentifizierung abrufen möchtest, kannst du optional Format: Sie können die E-Mail-Adresse des Nutzers als Alias für |
use_ |
Optional. Wenn Der anrufende Nutzer muss ein Google Workspace-Administrator mit der Berechtigung Unterhaltungen in Chats und Gruppenbereichen verwalten sein. Erfordert die OAuth 2.0-Bereiche 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 |
Erforderlich. Ressourcenname der Nachricht. Format: Wenn Sie eine benutzerdefinierte ID für Ihre Nachricht festgelegt haben, können Sie den Wert aus dem Feld |
GetSpaceEventRequest
Anfragenachricht zum Abrufen eines Gruppenbereichsereignisses
Felder | |
---|---|
name |
Erforderlich. Der Ressourcenname des Gruppenbereichsereignisses. Format: |
GetSpaceNotificationSettingRequest
Anfragenachricht zum Abrufen der Einstellung für Benachrichtigungen zu Gruppenbereichen Unterstützt nur das Abrufen der Benachrichtigungseinstellungen für den anrufenden Nutzer.
Felder | |
---|---|
name |
Erforderlich. Format: users/{user}/spaces/{space}/spaceNotificationSetting
|
GetSpaceReadStateRequest
Anfragenachricht für die GetSpaceReadState API
Felder | |
---|---|
name |
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:
Format: users/{user}/spaces/{space}/spaceReadState |
GetSpaceRequest
Eine Anfrage, um einen einzelnen Gruppenbereich zurückzugeben.
Felder | |
---|---|
name |
Erforderlich. Ressourcenname des Gruppenbereichs im Format Format: |
use_ |
Optional. Wenn Der anrufende Nutzer muss ein Google Workspace-Administrator mit der Berechtigung Unterhaltungen in Chats und Gruppenbereichen verwalten sein. Erfordert die OAuth 2.0-Bereiche |
GetThreadReadStateRequest
Anfragenachricht für die API „GetThreadReadStateRequest“.
Felder | |
---|---|
name |
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:
Format: users/{user}/spaces/{space}/threads/{thread}/threadReadState |
Gruppe
Eine Google-Gruppe in Google Chat.
Felder | |
---|---|
name |
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.
Felder | |
---|---|
page_ |
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_ |
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 |
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 Die folgende Abfrage gibt beispielsweise benutzerdefinierte Emojis zurück, die vom Anrufer erstellt wurden:
Ungültige Abfragen werden vom Server mit dem Fehler |
ListCustomEmojisResponse
Eine Antwort auf eine Liste mit benutzerdefinierten Emojis.
Felder | |
---|---|
custom_ |
Unsortierte Liste. Liste der benutzerdefinierten Emojis auf der angeforderten (oder ersten) Seite. |
next_ |
Ein Token, das als |
ListMembershipsRequest
Anfragenachricht für die Auflistung von Mitgliedschaften
Felder | |
---|---|
parent |
Erforderlich. Der Ressourcenname des Gruppenbereichs, für den eine Mitgliederliste abgerufen werden soll. Format: spaces/{space} |
page_ |
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 |
page_ |
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 |
Optional. Einen Abfragefilter. Sie können Mitgliedschaften nach der Rolle ( Wenn Sie nach Rolle filtern möchten, legen Sie Wenn Sie nach Typ filtern möchten, legen Sie Wenn Sie sowohl nach Rolle als auch nach Typ filtern möchten, verwenden Sie den Operator Entweder Die folgenden Abfragen sind beispielsweise gültig:
Die folgenden Abfragen sind ungültig:
Ungültige Abfragen werden vom Server mit dem Fehler |
show_ |
Optional. Wenn |
show_ |
Optional. Wenn Derzeit ist eine Nutzerauthentifizierung erforderlich. |
use_ |
Optional. Wenn Der anrufende Nutzer muss ein Google Workspace-Administrator mit der Berechtigung Unterhaltungen in Chats und Gruppenbereichen verwalten sein. Erfordert entweder den OAuth 2.0-Bereich 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[] |
Unsortierte Liste. Liste der Mitgliedschaften auf der angeforderten (oder ersten) Seite. |
next_ |
Ein Token, das als |
ListMessagesRequest
Hier werden Nachrichten im angegebenen Gruppenbereich aufgelistet, in dem der Nutzer Mitglied ist.
Felder | |
---|---|
parent |
Erforderlich. Der Ressourcenname des Gruppenbereichs, aus dem Nachrichten aufgelistet werden sollen. Format: |
page_ |
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 |
page_ |
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 |
Optional. Einen Abfragefilter. Sie können Nachrichten nach Datum ( Wenn Sie Nachrichten nach dem Erstellungsdatum filtern möchten, geben Sie Wenn Sie nach Thread filtern möchten, geben Sie die Wenn Sie sowohl nach Thread als auch nach Datum filtern möchten, verwenden Sie den Operator Die folgenden Abfragen sind beispielsweise gültig:
Ungültige Abfragen werden vom Server mit dem Fehler |
order_ |
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:
Die Standardreihenfolge ist |
show_ |
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[] |
Liste der Nachrichten. |
next_ |
Sie können ein Token als |
ListReactionsRequest
Listet Reaktionen auf eine Nachricht auf.
Felder | |
---|---|
parent |
Erforderlich. Die Nachricht, auf die Nutzer reagiert haben. Format: |
page_ |
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_ |
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 |
Optional. Einen Abfragefilter. Du kannst Reaktionen nach Emoji ( Wenn Sie Reaktionen nach mehreren Emojis oder Nutzern filtern möchten, können Sie ähnliche Felder mit dem Operator Wenn Sie Reaktionen nach Emoji und Nutzer filtern möchten, verwenden Sie den Operator Wenn in Ihrer Abfrage sowohl Die folgenden Abfragen sind beispielsweise gültig:
Die folgenden Abfragen sind ungültig:
Ungültige Abfragen werden vom Server mit dem Fehler |
ListReactionsResponse
Antwort auf eine Anfrage zum Auflisten von Reaktionen
Felder | |
---|---|
reactions[] |
Liste der Reaktionen auf der angeforderten (oder ersten) Seite. |
next_ |
Fortsetzungstoken zum Abrufen der nächsten Ergebnisseite. Bei der letzten Ergebnisseite ist er leer. |
ListSpaceEventsRequest
Anfragenachricht für Listen von Veranstaltungsräumen
Felder | |
---|---|
parent |
Erforderlich. Ressourcenname des Google Chat-Bereichs, in dem die Ereignisse aufgetreten sind. Format: |
page_ |
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 |
page_ |
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 Parameter, die zum Auflisten von Gruppenbereichsereignissen bereitgestellt werden, 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 |
Erforderlich. Einen Abfragefilter. Sie müssen mindestens einen Ereignistyp ( Optional können Sie auch nach Startzeit (
Verwenden Sie den Operator „ist gleich“ Die folgenden Abfragen sind beispielsweise gültig:
Die folgenden Abfragen sind ungültig:
Ungültige Abfragen werden vom Server mit dem Fehler |
ListSpaceEventsResponse
Antwortnachricht für das Auflisten von Gruppenbereichsereignissen.
Felder | |
---|---|
space_ |
Die Ergebnisse werden in chronologischer Reihenfolge zurückgegeben (ältestes Ereignis zuerst). Hinweis: Das Feld |
next_ |
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_ |
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 |
page_ |
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 |
Optional. Einen Abfragefilter. Sie können Gruppenbereiche nach dem Gruppenbereichstyp ( Wenn Sie nach Gruppentyp filtern möchten, müssen Sie einen gültigen enum-Wert angeben, z. B. Die folgenden Abfragen sind beispielsweise gültig:
Ungültige Abfragen werden vom Server mit dem Fehler |
ListSpacesResponse
Die Antwort auf eine Anfrage zum Auflisten von Gruppenbereichen.
Felder | |
---|---|
spaces[] |
Liste der Gruppenbereiche auf der angeforderten (oder ersten) Seite. Hinweis: Das Feld |
next_ |
Sie können ein Token als |
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 |
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 |
Kennung. Vom Server zugewiesener Ressourcenname der Mitgliedschaft. Format: |
state |
Nur Ausgabe. Status der Mitgliedschaft. |
role |
Optional. Die Rolle des Nutzers in einem Chatbereich, die seine zulässigen Aktionen im Bereich bestimmt. Dieses Feld kann nur in |
create_ |
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_ |
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 |
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 |
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[] |
Eine Liste der neuen Mitgliedschaften. |
MembershipBatchDeletedEventData
Ereignisnutzlast für mehrere gelöschte Mitgliedschaften.
Ereignistyp: google.workspace.chat.membership.v1.batchDeleted
Felder | |
---|---|
memberships[] |
Eine Liste der gelöschten Mitgliedschaften. |
MembershipBatchUpdatedEventData
Ereignisnutzlast für mehrere aktualisierte Mitgliedschaften.
Ereignistyp: google.workspace.chat.membership.v1.batchUpdated
Felder | |
---|---|
memberships[] |
Eine Liste der aktualisierten Mitgliedschaften. |
MembershipCreatedEventData
Ereignisnutzlast für eine neue Mitgliedschaft.
Ereignistyp: google.workspace.chat.membership.v1.created
.
Felder | |
---|---|
membership |
Die neue Mitgliedschaft. |
MembershipDeletedEventData
Ereignisnutzlast für eine gelöschte Mitgliedschaft.
Ereignistyp: google.workspace.chat.membership.v1.deleted
Felder | |
---|---|
membership |
Die gelöschte Mitgliedschaft. Nur die Felder |
MembershipUpdatedEventData
Ereignisnutzlast für eine aktualisierte Mitgliedschaft.
Ereignistyp: google.workspace.chat.membership.v1.updated
Felder | |
---|---|
membership |
Die aktualisierte Mitgliedschaft. |
Meldung
Eine Nachricht in einem Google Chat-Bereich
Felder | |
---|---|
name |
Kennung. Ressourcenname der Nachricht. Format: Dabei ist 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 |
sender |
Nur Ausgabe. Der Nutzer, der die Nachricht erstellt hat. Wenn Ihre Chat-App als Nutzer authentifiziert wird, werden in der Ausgabe die Nutzer |
create_ |
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_ |
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_ |
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 |
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_ |
Nur Ausgabe. Enthält die Nachricht
Weitere Informationen finden Sie unter In einer Nachricht gesendete Textformatierung ansehen. |
cards[] |
Verworfen. Verwenden Sie stattdessen 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_ |
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[] |
Nur Ausgabe. Anmerkungen, die mit der |
thread |
Der Thread, zu dem die Nachricht gehört. Eine Beispielanwendung finden Sie unter Nachrichtenthreads starten oder beantworten. |
space |
Nur Ausgabe. Wenn sich Ihre Chat-App als Nutzer authentifiziert, wird in der Ausgabe nur der Gruppenbereich |
fallback_ |
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_ |
Nur Eingabe. Parameter, mit denen eine Chat-App konfigurieren kann, wie ihre Antwort gepostet wird. |
argument_ |
Nur Ausgabe. Der Nur-Text-Textkörper der Nachricht ohne Erwähnungen der Chat App |
slash_ |
Nur Ausgabe. Informationen zum Slash-Befehl, falls zutreffend. |
attachment[] |
Optional. Von einem Nutzer hochgeladener Anhang. |
matched_ |
Nur Ausgabe. Eine URL in |
thread_ |
Nur Ausgabe. Wenn Wenn das Gruppenbereich das Antworten in Threads nicht unterstützt, ist dieses Feld immer |
client_ |
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 |
emoji_ |
Nur Ausgabe. Die Liste der Zusammenfassungen der Emoji-Reaktionen auf die Nachricht. |
private_ |
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 App-Authentifizierung aufrufen und Folgendes auslassen: Weitere Informationen finden Sie unter Private Nachrichten senden. |
deletion_ |
Nur Ausgabe. Informationen zu einer gelöschten Nachricht. Eine Nachricht wird gelöscht, wenn |
quoted_ |
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_ |
Nur Ausgabe. GIF-Bilder, die an die Nachricht angehängt sind. |
accessory_ |
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[] |
Eine Liste der neuen Nachrichten. |
MessageBatchDeletedEventData
Ereignisnutzlast für mehrere gelöschte Nachrichten.
Ereignistyp: google.workspace.chat.message.v1.batchDeleted
Felder | |
---|---|
messages[] |
Eine Liste der gelöschten Nachrichten. |
MessageBatchUpdatedEventData
Ereignisnutzlast für mehrere aktualisierte Nachrichten.
Ereignistyp: google.workspace.chat.message.v1.batchUpdated
Felder | |
---|---|
messages[] |
Eine Liste der aktualisierten Nachrichten. |
MessageCreatedEventData
Ereignisnutzlast für eine neue Nachricht.
Ereignistyp: google.workspace.chat.message.v1.created
Felder | |
---|---|
message |
Die neue Nachricht. |
MessageDeletedEventData
Ereignisnutzlast für eine gelöschte Nachricht.
Ereignistyp: google.workspace.chat.message.v1.deleted
Felder | |
---|---|
message |
Die gelöschte Nachricht. Nur die Felder |
MessageUpdatedEventData
Ereignisnutzlast für eine aktualisierte Nachricht.
Ereignistyp: google.workspace.chat.message.v1.updated
Felder | |
---|---|
message |
Die aktualisierte Nachricht. |
QuotedMessageMetadata
Informationen zu einer zitierten Nachricht.
Felder | |
---|---|
name |
Nur Ausgabe. Ressourcenname der zitierten Nachricht. Format: |
last_ |
Nur Ausgabe. Der Zeitstempel, der angibt, wann die zitierte Nachricht erstellt oder zuletzt aktualisiert wurde. |
Reaktion
Eine Reaktion auf eine Nachricht.
Felder | |
---|---|
name |
Kennung. Der Ressourcenname der Reaktion. Format: |
user |
Nur Ausgabe. Der Nutzer, der die Reaktion erstellt hat. |
emoji |
Erforderlich. Das in der Reaktion verwendete Emoji. |
ReactionBatchCreatedEventData
Ereignisnutzlast für mehrere neue Reaktionen
Ereignistyp: google.workspace.chat.reaction.v1.batchCreated
Felder | |
---|---|
reactions[] |
Eine Liste der neuen Reaktionen. |
ReactionBatchDeletedEventData
Ereignisnutzlast für mehrere gelöschte Reaktionen.
Ereignistyp: google.workspace.chat.reaction.v1.batchDeleted
Felder | |
---|---|
reactions[] |
Eine Liste der gelöschten Reaktionen. |
ReactionCreatedEventData
Ereignisnutzlast für eine neue Reaktion.
Ereignistyp: google.workspace.chat.reaction.v1.created
Felder | |
---|---|
reaction |
Die neue Reaktion. |
ReactionDeletedEventData
Ereignisnutzlast für eine gelöschte Reaktion.
Typ: google.workspace.chat.reaction.v1.deleted
Felder | |
---|---|
reaction |
Die gelöschte Reaktion. |
RichLinkMetadata
Ein Rich-Link zu einer Ressource.
Felder | |
---|---|
uri |
Der URI dieses Links. |
rich_ |
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_ |
Daten für einen Drive-Link. |
chat_ |
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 Suchanfrage basieren.
Felder | |
---|---|
use_ |
Wenn Der anrufende Nutzer muss ein Google Workspace-Administrator mit der Berechtigung Unterhaltungen in Chats und Gruppenbereichen verwalten sein. Erfordert entweder den OAuth 2.0-Bereich Diese Methode unterstützt derzeit nur den Administratorzugriff. Daher ist für dieses Feld nur |
page_ |
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_ |
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 |
Erforderlich. Eine Suchanfrage. Sie können mit den folgenden Parametern suchen:
Für
Für Für Für
Für verschiedene Felder werden nur Innerhalb desselben Felds werden für Die folgenden Beispielabfragen sind gültig:
|
order_ |
Optional. Die Reihenfolge der Gruppenbereiche. Folgende Attribute werden unterstützt:
Gültige Werte für den Sortiervorgang:
Folgende Syntax wird unterstützt:
|
SearchSpacesResponse
Antwort mit einer Liste der Gruppenbereiche, die der Anfrage entsprechen.
Felder | |
---|---|
spaces[] |
Eine Seite der angeforderten Gruppenbereiche. |
next_ |
Ein Token, mit dem die nächste Seite abgerufen werden kann. Wenn dieses Feld leer ist, gibt es keine nachfolgenden Seiten. |
total_ |
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 |
Erforderlich. Wenn Sie einen Gruppenbereich erstellen möchten, setzen Sie Wenn Sie einen Gruppenchat erstellen möchten, setzen Sie Wenn Sie eine Unterhaltung zwischen zwei Menschen erstellen möchten, legen Sie Wenn Sie eine Unterhaltung zwischen einer natürlichen Person und der anrufenden Chat-App starten möchten, legen Sie Wenn ein |
request_ |
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[] |
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 Für die Mitgliedschaft in Google-Gruppen muss das Feld Optional, wenn Erforderlich, wenn Erforderlich, wenn Muss leer sein, wenn eine Unterhaltung zwischen einem Nutzer und der anrufenden Chat-App erstellt wird (wenn |
SlashCommand
Slash-Befehl in Google Chat
Felder | |
---|---|
command_ |
Die ID des aufgerufenen Slash-Befehls. |
SlashCommandMetadata
Anmerkungsmetadaten für Slash-Befehle (/).
Felder | |
---|---|
bot |
Die Chat-App, deren Befehl aufgerufen wurde. |
type |
Der Typ des Slash-Befehls. |
command_ |
Der Name des aufgerufenen Slash-Befehls. |
command_ |
Die Befehls-ID des aufgerufenen Slash-Befehls. |
triggers_ |
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 |
Kennung. Ressourcenname des Gruppenbereichs. Format: Dabei steht |
type |
Nur Ausgabe. Verworfen. Verwenden Sie stattdessen |
space_ |
Optional. Der Typ des Gruppenbereichs. Erforderlich beim Erstellen eines Gruppenbereichs oder Aktualisieren des Gruppenbereichstyps. Ausgabe nur für andere Zwecke. |
single_ |
Optional. Gibt an, ob es sich bei dem Gruppenbereich um eine Direktnachricht zwischen einer Chat-App und einer einzelnen Person handelt. |
threaded |
Nur Ausgabe. Verworfen. Verwenden Sie stattdessen |
display_ |
Optional. Der Anzeigename des Gruppenbereichs. Erforderlich, wenn Sie einen Gruppenbereich mit einer Bei Direktnachrichten ist dieses Feld möglicherweise leer. Unterstützt bis zu 128 Zeichen. |
external_ |
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:
Bei bestehenden Gruppenbereichen dient dieses Feld nur der Ausgabe. |
space_ |
Nur Ausgabe. Der Status der Unterhaltungsbereiche im Chatbereich. |
space_ |
Optional. Details zum Gruppenbereich, einschließlich Beschreibung und Regeln. |
space_ |
Optional. Der Status des Nachrichtenverlaufs für Nachrichten und Threads in diesem Gruppenbereich. |
import_ |
Optional. Gibt an, ob dieser Gruppenbereich in Für das Erstellen eines Gruppenbereichs in |
create_ |
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 |
last_ |
Nur Ausgabe. Zeitstempel der letzten Nachricht im Gruppenbereich. |
admin_ |
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 werden kann, muss Ihre Chat-App Direktnachrichten unterstützen. |
membership_ |
Nur Ausgabe. Die Anzahl der Mitgliedschaften, gruppiert nach Mitgliedstyp. Wird ausgefüllt, wenn |
access_ |
Optional. Gibt die Zugriffseinstellung des Gruppenbereichs an. Wird nur ausgefüllt, wenn |
space_ |
Nur Ausgabe. Der URI, über den ein Nutzer auf den Gruppenbereich zugreifen kann. |
import_ |
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 Dieses Feld wird nur für Gruppenbereiche ausgefüllt, die im Importmodus erstellt wurden. |
customer |
Optional. Nicht veränderbar. Die Kunden-ID der Domain des Gruppenbereichs. Nur erforderlich, wenn Sie einen Gruppenbereich mit App-Authentifizierung erstellen und Im Format Bei DMs ist dieses Feld nicht ausgefüllt. |
Union-Feld Erfordert die Nutzerauthentifizierung. Für |
|
predefined_ |
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 |
permission_ |
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_ |
Nur Ausgabe. Gibt den Zugriffsstatus des Gruppenbereichs an. |
audience |
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: Wenn Sie die Standardzielgruppe für die Google Workspace-Organisation verwenden möchten, legen Sie Das Lesen der Zielgruppe unterstützt:
Dieses Feld wird nicht ausgefüllt, wenn der Umfang 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_ |
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_ |
Nur Ausgabe. Die Anzahl aller Gruppen, die dem Gruppenbereich direkt beigetreten sind. |
PermissionSetting
Stellt eine Berechtigungseinstellung für einen Gruppenbereich dar.
Felder | |
---|---|
managers_ |
Optional. Ob Administratoren von Gruppenbereichen diese Berechtigung haben. |
members_ |
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_ |
Optional. Einstellung zum Verwalten von Mitgliedern und Gruppen in einem Gruppenbereich. |
modify_ |
Optional. Einstellung zum Aktualisieren des Namens, des Avatars, der Beschreibung und der Richtlinien eines Gruppenbereichs |
toggle_ |
Optional. Einstellung zum Aktivieren und Deaktivieren des Gruppenbereichsverlaufs. |
use_ |
Optional. Einstellung für die Verwendung von @alle in einem Gruppenbereich. |
manage_ |
Optional. Einstellung zum Verwalten von Apps in einem Gruppenbereich. |
manage_ |
Optional. Einstellung zum Verwalten von Webhooks in einem Gruppenbereich. |
post_ |
Nur Ausgabe. Einstellung für das Posten von Nachrichten in einem Gruppenbereich. |
reply_ |
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 |
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 |
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[] |
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 |
Ressourcenname des Gruppenbereichsereignisses. Format: |
event_ |
Zeit, zu der das Ereignis aufgetreten ist. |
event_ |
Art des Gruppenbereichsereignisses. Jeder Ereignistyp hat eine Batchversion, die mehrere Instanzen des Ereignistyps darstellt, die in einem kurzen Zeitraum auftreten. Lassen Sie bei Unterstützte Ereignistypen für Nachrichten:
Unterstützte Ereignistypen für Kanalmitgliedschaften:
Unterstützte Ereignistypen für Reaktionen:
Unterstützte Ereignistypen für den Raum:
|
Union-Feld Für |
|
message_ |
Ereignisnutzlast für eine neue Nachricht. Ereignistyp: |
message_ |
Ereignisnutzlast für eine aktualisierte Nachricht. Ereignistyp: |
message_ |
Ereignisnutzlast für eine gelöschte Nachricht. Ereignistyp: |
message_ |
Ereignisnutzlast für mehrere neue Nachrichten. Ereignistyp: |
message_ |
Ereignisnutzlast für mehrere aktualisierte Nachrichten. Ereignistyp: |
message_ |
Ereignisnutzlast für mehrere gelöschte Nachrichten. Ereignistyp: |
space_ |
Ereignisnutzlast für eine Gruppenbereichsaktualisierung. Ereignistyp: |
space_ |
Ereignisnutzlast für mehrere Aktualisierungen eines Gruppenbereichs. Ereignistyp: |
membership_ |
Ereignisnutzlast für eine neue Mitgliedschaft. Ereignistyp: |
membership_ |
Ereignisnutzlast für eine aktualisierte Mitgliedschaft. Ereignistyp: |
membership_ |
Ereignisnutzlast für eine gelöschte Mitgliedschaft. Ereignistyp: |
membership_ |
Ereignisnutzlast für mehrere neue Mitgliedschaften. Ereignistyp: |
membership_ |
Ereignisnutzlast für mehrere aktualisierte Mitgliedschaften. Ereignistyp: |
membership_ |
Ereignisnutzlast für mehrere gelöschte Mitgliedschaften. Ereignistyp: |
reaction_ |
Ereignisnutzlast für eine neue Reaktion. Ereignistyp: |
reaction_ |
Ereignisnutzlast für eine gelöschte Reaktion. Ereignistyp: |
reaction_ |
Ereignisnutzlast für mehrere neue Reaktionen Ereignistyp: |
reaction_ |
Ereignisnutzlast für mehrere gelöschte Reaktionen. Ereignistyp: |
SpaceNotificationSetting
Die Benachrichtigungseinstellungen eines Nutzers in einem Gruppenbereich.
Felder | |
---|---|
name |
Kennung. Der Ressourcenname der Einstellung für Benachrichtigungen in Gruppenbereichen. Format: |
notification_ |
Die Benachrichtigungseinstellung. |
mute_ |
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 |
Ressourcenname des Lesestatus des Gruppenbereichs. Format: |
last_ |
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 |
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 |
Kennung. Ressourcenname des Threads. Beispiel: |
thread_ |
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- |
ThreadReadState
Der Lesestatus eines Nutzers in einem Thread, der zum Identifizieren gelesener und ungelesener Nachrichten verwendet wird.
Felder | |
---|---|
name |
Ressourcenname des Lesestatus des Threads. Format: |
last_ |
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 |
Erforderlich. Die zu aktualisierende Mitgliedschaft. Nur die mit |
update_ |
Erforderlich. Die zu aktualisierenden Feldpfade. Trennen Sie mehrere Werte durch Kommas oder verwenden Sie Derzeit unterstützte Feldpfade:
|
use_ |
Optional. Wenn Der anrufende Nutzer muss ein Google Workspace-Administrator mit der Berechtigung Unterhaltungen in Chats und Gruppenbereichen verwalten sein. Erfordert den |
UpdateMessageRequest
Anfrage zum Aktualisieren einer Nachricht
Felder | |
---|---|
message |
Erforderlich. Nachricht mit aktualisierten Feldern. |
update_ |
Erforderlich. Die zu aktualisierenden Feldpfade. Trennen Sie mehrere Werte durch Kommas oder verwenden Sie Derzeit unterstützte Feldpfade:
|
allow_ |
Optional. Wenn |
UpdateSpaceNotificationSettingRequest
Anfrage zum Aktualisieren der Benachrichtigungseinstellungen für Gruppenbereiche Es wird nur die Aktualisierung der Benachrichtigungseinstellung für den anrufenden Nutzer unterstützt.
Felder | |
---|---|
space_ |
Erforderlich. Der Ressourcenname für die Benachrichtigungseinstellungen des Gruppenbereichs muss im Format |
update_ |
Erforderlich. Unterstützte Feldpfade: – |
UpdateSpaceReadStateRequest
Anfragenachricht für UpdateSpaceReadState API.
Felder | |
---|---|
space_ |
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:
Format: users/{user}/spaces/{space}/spaceReadState |
update_ |
Erforderlich. Die zu aktualisierenden Feldpfade. Derzeit unterstützte Feldpfade:
Wenn das Wenn Sie den Gruppenbereich als gelesen markieren möchten, setzen Sie |
UpdateSpaceRequest
Eine Anfrage zum Aktualisieren eines einzelnen Gruppenbereichs.
Felder | |
---|---|
space |
Erforderlich. Gruppenbereich mit Feldern, die aktualisiert werden sollen. |
update_ |
Erforderlich. Die aktualisierten Feldpfade, bei mehreren durch Kommas getrennt. Sie können die folgenden Felder für einen Gruppenbereich aktualisieren:
|
use_ |
Optional. Wenn Der anrufende Nutzer muss ein Google Workspace-Administrator mit der Berechtigung Unterhaltungen in Chats und Gruppenbereichen verwalten sein. Erfordert den Einige |
Nutzer
Ein Nutzer in Google Chat. Wenn Ihre Chat-App sich als Nutzer authentifiziert und die Ausgabe einer Anfrage zurückgibt, werden in der Ausgabe für eine User
-Ressource nur die name
und type
des Nutzers ausgefüllt.
Felder | |
---|---|
name |
Ressourcenname für eine Google Chat- Format: Für
|
display_ |
Nur Ausgabe. Der Anzeigename des Nutzers. |
domain_ |
Die eindeutige Kennung der Google Workspace-Domain des Nutzers. |
type |
Nutzertyp |
is_ |
Nur Ausgabe. Wenn |
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 |
Der erwähnte Nutzer. |
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[] |
Eine Liste von Schaltflächen. Buttons ist ebenfalls |
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_ |
In diesem Widget wird ein Textabsatz angezeigt. |
image |
In diesem Widget wird ein Bild angezeigt. |
key_ |
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 Für |
|
text_ |
Eine Schaltfläche mit Text und |
image_ |
Eine Schaltfläche mit Bild und |
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_ |
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[] |
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 |
Der Name des Parameters für das Aktionsscript. |
value |
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_ |
Die URL des Bildes. |
on_ |
Die Aktion |
aspect_ |
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_ |
Die Aktion |
name |
Der Name dieser |
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 |
Das Symbol, das durch ein |
icon_ |
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_ |
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 |
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_ |
Ob der Inhalt mehrzeilig sein soll. |
bottom_ |
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_ |
Die Aktion |
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 |
Ein enum-Wert, der von der Chat API durch das entsprechende Symbolbild ersetzt wird. |
icon_ |
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 beide. Für control ist nur einer der folgenden Werte zulässig: |
|
button |
Eine Schaltfläche, über die eine Aktion ausgelöst werden kann. |
OnClick
Eine onclick
-Aktion (z. B. Öffnen eines Links)
Felder | |
---|---|
Union-Feld Für |
|
action |
Wenn angegeben, wird durch diese |
open_ |
Diese |
OpenLink
Ein Link, über den ein neues Fenster geöffnet wird.
Felder | |
---|---|
url |
Die URL, die geöffnet werden soll. |
TextButton
Eine Schaltfläche mit Text und onclick
-Aktion.
Felder | |
---|---|
text |
Text der Schaltfläche |
on_ |
Die |
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 |
|