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)CreateMembershipRequest
(Meldung)CreateMessageRequest
(Meldung)CreateMessageRequest.MessageReplyOption
(Aufzählung)CreateReactionRequest
(Meldung)CreateSpaceRequest
(Meldung)CustomEmoji
(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)GetMembershipRequest
(Meldung)GetMessageRequest
(Meldung)GetSpaceEventRequest
(Meldung)GetSpaceReadStateRequest
(Meldung)GetSpaceRequest
(Meldung)GetThreadReadStateRequest
(Meldung)Group
(Meldung)HistoryState
(Aufzählung)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)SpaceReadState
(Meldung)SpaceUpdatedEventData
(Meldung)Thread
(Meldung)ThreadReadState
(Meldung)UpdateMembershipRequest
(Meldung)UpdateMessageRequest
(Meldung)UpdateSpaceReadStateRequest
(Meldung)UpdateSpaceRequest
(Meldung)User
(Meldung)User.Type
(Aufzählung)UserMentionMetadata
(Meldung)UserMentionMetadata.Type
(Aufzählung)WidgetMarkup
(Meldung)WidgetMarkup.Button
(Meldung)WidgetMarkup.FormAction
(Meldung)WidgetMarkup.FormAction.ActionParameter
(Meldung)WidgetMarkup.Icon
(Aufzählung)WidgetMarkup.Image
(Meldung)WidgetMarkup.ImageButton
(Meldung)WidgetMarkup.KeyValue
(Meldung)WidgetMarkup.OnClick
(Meldung)WidgetMarkup.OpenLink
(Meldung)WidgetMarkup.TextButton
(Meldung)WidgetMarkup.TextParagraph
(Meldung)
ChatService
Ermöglicht Entwicklern, Chat-Apps und -Integrationen auf der Google Chat-Plattform zu erstellen.
CompleteImportSpace |
---|
Schließt den Importvorgang für den angegebenen Gruppenbereich ab und macht ihn für Nutzer sichtbar. Erfordert eine App-Authentifizierung und eine domainweite Delegierung. Weitere Informationen finden Sie im Hilfeartikel Google Chat-Apps zum Importieren von Daten autorisieren.
|
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 das angegebene Mitglied beim Erstellen einer Mitgliedschaft die Richtlinie für die automatische Annahme deaktiviert hat, wird es eingeladen. Es muss die Einladung zum Gruppenbereich annehmen, bevor es beitreten kann. Andernfalls wird das Mitglied beim Erstellen einer Mitgliedschaft direkt dem angegebenen Gruppenbereich hinzugefügt. Erfordert eine Nutzerauthentifizierung. Anwendungsbeispiele:
|
CreateMessage |
---|
Eine Nachricht in einem Google Chat-Bereich erstellen. Ein Beispiel finden Sie im Hilfeartikel Nachrichten senden. Für die Methode Die folgende Abbildung zeigt, wie Google Chat eine Nachricht zuordnet, wenn Sie die App-Authentifizierung verwenden. In Google Chat wird die Chat-App als Absender der Nachricht angezeigt. Der Inhalt der Nachricht kann Text ( Die folgende Abbildung zeigt, wie Google Chat eine Nachricht zuordnet, wenn Sie die Nutzerauthentifizierung verwenden. In Google Chat wird der Nutzer als Absender der Nachricht angezeigt. Die Chat-App wird der Nachricht durch Anzeigen des Namens zugeordnet. Der Inhalt der Nachricht darf nur Text enthalten ( 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 im Hilfeartikel Reaktion auf eine Nachricht hinzufügen. Erfordert eine Nutzerauthentifizierung.
|
CreateSpace |
---|
Ein Gruppenbereich ohne Mitglieder wird erstellt. Kann zum Erstellen eines benannten Gruppenbereichs verwendet werden. Nach Themen gruppierte Gruppenbereiche werden nicht unterstützt. Ein Beispiel finden Sie unter Gruppenbereich erstellen. Wenn Sie beim Erstellen eines Gruppenbereichs die Fehlermeldung Wenn du am Vorschauprogramm für Entwickler teilnimmst, kannst du mit Erfordert eine Nutzerauthentifizierung.
|
DeleteMembership |
---|
Löscht eine Mitgliedschaft. Ein Beispiel finden Sie unter Nutzer oder Google Chat-Apps aus einem Gruppenbereich entfernen. Erfordert eine Nutzerauthentifizierung.
|
DeleteMessage |
---|
Löscht eine Nachricht. Ein Beispiel finden Sie unter Nachrichten löschen. Erfordert eine Authentifizierung. Unterstützt die App-Authentifizierung und die Nutzerauthentifizierung. Bei der App-Authentifizierung können Anfragen nur Nachrichten löschen, die von der aufrufenden Chat-App erstellt wurden.
|
DeleteReaction |
---|
Löscht eine Reaktion auf eine Nachricht. Es werden nur Unicode-Emojis unterstützt. Ein Beispiel finden Sie unter Reaktionen löschen. Erfordert eine Nutzerauthentifizierung.
|
DeleteSpace |
---|
Löscht einen benannten Gruppenbereich. Es wird immer ein kaskadierendes Löschen durchgeführt. Das bedeutet, dass die untergeordneten Ressourcen des Gruppenbereichs, z. B. im Gruppenbereich gepostete Nachrichten und Mitgliedschaften im Gruppenbereich, ebenfalls gelöscht werden. Ein Beispiel finden Sie unter Gruppenbereiche löschen. Erfordert die Nutzerauthentifizierung eines Nutzers, der berechtigt ist, den Gruppenbereich zu löschen.
|
FindDirectMessage |
---|
Gibt die vorhandene Direktnachricht an den angegebenen Nutzer zurück Wenn kein Gruppenbereich für Direktnachrichten gefunden wird, wird der Fehler Bei der Nutzerauthentifizierung wird der Direktnachrichtbereich zwischen dem angegebenen Nutzer und dem authentifizierten Nutzer zurückgegeben. Bei der App-Authentifizierung wird der Direktnachrichtbereich zwischen dem angegebenen Nutzer und der aufrufenden Chat-App zurückgegeben. Dafür ist eine Nutzerauthentifizierung oder App-Authentifizierung erforderlich.
|
GetAttachment |
---|
Ruft die Metadaten eines Nachrichtenanhangs ab. Die Daten der Anhänge werden mithilfe der Media API abgerufen. Ein Beispiel finden Sie unter Metadaten zu einem Nachrichtenanhang abrufen. Erfordert eine App-Authentifizierung.
|
GetMembership |
---|
Gibt Details zu einer Mitgliedschaft zurück. Ein Beispiel finden Sie unter Details zur Mitgliedschaft eines Nutzers oder der Google Chat App abrufen. Erfordert eine Authentifizierung. Unterstützt die App-Authentifizierung und die Nutzerauthentifizierung.
|
GetMessage |
---|
Gibt Details zu einer Nachricht zurück. Ein Beispiel finden Sie unter Details zu einer Nachricht abrufen. Erfordert eine Authentifizierung. Unterstützt die App-Authentifizierung und die Nutzerauthentifizierung. Hinweis: Möglicherweise wird eine Nachricht von einem blockierten Mitglied oder Gruppenbereich zurückgegeben.
|
GetSpace |
---|
Gibt Details zu einem Gruppenbereich zurück. Ein Beispiel finden Sie unter Details zu einem Gruppenbereich abrufen. Erfordert eine Authentifizierung. Unterstützt die App-Authentifizierung und die Nutzerauthentifizierung.
|
GetSpaceEvent |
---|
Gibt einen Termin aus einem Google Chat-Bereich zurück. Die Ereignisnutzlast enthält die neueste Version der Ressource, die sich geändert hat. Wenn Sie beispielsweise ein Ereignis zu einer neuen Nachricht anfordern, die Nachricht aber später aktualisiert wurde, gibt der Server die aktualisierte Ressource Erfordert die Nutzerauthentifizierung. Um ein Ereignis abzurufen, muss der authentifizierte Nutzer Mitglied des Gruppenbereichs sein. Ein Beispiel finden Sie im Hilfeartikel Termindetails aus einem Google Chat-Bereich abrufen.
|
GetSpaceReadState |
---|
Gibt Details zum Lesestatus eines Nutzers innerhalb eines Gruppenbereichs zurück. Diese Informationen werden verwendet, um gelesene und ungelesene Nachrichten zu identifizieren. Ein Beispiel finden Sie unter Details zum Lesestatus eines Gruppenbereichs eines Nutzers abrufen. Erfordert eine Nutzerauthentifizierung.
|
GetThreadReadState |
---|
Gibt Details zum Lesestatus eines Nutzers innerhalb eines Threads zurück, um gelesene und ungelesene Nachrichten zu identifizieren. Ein Beispiel finden Sie unter Details zum Thread-Lesestatus eines Nutzers abrufen. Erfordert eine Nutzerauthentifizierung.
|
ListMemberships |
---|
Listet Mitgliedschaften in einem Gruppenbereich auf. Ein Beispiel finden Sie unter Nutzer und Google Chat-Apps in einem Gruppenbereich auflisten. Wenn Sie Mitgliedschaften über die App-Authentifizierung auflisten, werden Mitgliedschaften in Gruppenbereichen aufgelistet, auf die die Chat-App Zugriff hat. Mitgliedschaften in der Chat-App, einschließlich ihrer eigenen, werden jedoch ausgeschlossen. Wenn Sie Mitgliedschaften über die Nutzerauthentifizierung auflisten, werden Mitgliedschaften in Gruppenbereichen aufgelistet, auf die der authentifizierte Nutzer Zugriff hat. Erfordert eine Authentifizierung. Unterstützt die App-Authentifizierung und die Nutzerauthentifizierung.
|
ListMessages |
---|
Listet Nachrichten in einem Gruppenbereich auf, in dem der Anrufer Mitglied ist, einschließlich Nachrichten von blockierten Mitgliedern und Gruppenbereichen. Wenn Sie Nachrichten aus einem Gruppenbereich ohne Nachrichten auflisten, ist die Antwort ein leeres Objekt. Wenn Sie eine REST/HTTP-Schnittstelle verwenden, enthält die Antwort ein leeres JSON-Objekt,
|
ListReactions |
---|
Listet Reaktionen auf eine Nachricht auf. Ein Beispiel finden Sie unter Reaktionen für eine Nachricht auflisten. Erfordert eine Nutzerauthentifizierung.
|
ListSpaceEvents |
---|
Listet Ereignisse aus einem Google Chat-Bereich auf. Für jedes Ereignis enthält die Nutzlast die neueste Version der Chatressource. Wenn Sie beispielsweise Ereignisse zu neuen Mitgliedern des Gruppenbereichs auflisten, gibt der Server Erfordert eine Nutzerauthentifizierung. Um Ereignisse aufzulisten, muss der authentifizierte Nutzer Mitglied des Gruppenbereichs sein. Ein Beispiel finden Sie im Hilfeartikel Ereignisse aus einem Google Chat-Bereich auflisten.
|
ListSpaces |
---|
Listet Gruppenbereiche auf, in denen der Aufrufer Mitglied ist. Gruppenchats und DNs werden erst aufgeführt, wenn die erste Nachricht gesendet wurde. Ein Beispiel finden Sie unter Gruppenbereiche auflisten. Erfordert eine Authentifizierung. Unterstützt die App-Authentifizierung und die Nutzerauthentifizierung. Listet Gruppenbereiche auf, die für den Aufrufer oder authentifizierten Nutzer sichtbar sind. Gruppenchats und DNs werden erst aufgeführt, wenn die erste Nachricht gesendet wurde. Wenn Sie alle benannten Gruppenbereiche nach Google Workspace-Organisation auflisten möchten, verwenden Sie stattdessen die Methode
|
SearchSpaces |
---|
use_admin_access auf true fest.
|
SetUpSpace |
---|
Erstellt einen Gruppenbereich und fügt ihm angegebene Nutzer hinzu. Der aufrufende Nutzer wird dem Gruppenbereich automatisch hinzugefügt und sollte in der Anfrage nicht als Mitgliedschaft angegeben werden. Ein Beispiel finden Sie unter Gruppenbereich mit ersten Mitgliedern einrichten. Um die hinzuzufügenden menschlichen Mitglieder anzugeben, fügen Sie Mitgliedschaften mit der entsprechenden Um die hinzuzufügenden Google-Gruppen anzugeben, fügen Sie Mitgliedschaften mit der entsprechenden Wenn der Anrufer in einem benannten Gruppenbereich oder Gruppenchat von einigen Mitgliedern blockiert oder blockiert wird oder nicht berechtigt ist, einige Mitglieder hinzuzufügen, werden diese Mitglieder dem erstellten Gruppenbereich nicht hinzugefügt. Wenn Sie eine Direktnachricht (DN) zwischen dem aufrufenden Nutzer und einem anderen menschlichen Nutzer erstellen möchten, geben Sie genau eine Mitgliedschaft für den menschlichen Nutzer an. Wenn ein Nutzer den anderen blockiert, schlägt die Anfrage fehl und die DM wird nicht erstellt. Wenn Sie eine DN zwischen dem aufrufenden Nutzer und der anrufenden App erstellen möchten, setzen Sie Wenn bereits eine DM zwischen zwei Nutzern existiert, wird die vorhandene DM zurückgegeben, selbst wenn ein Nutzer den anderen bei der Anfrage blockiert. Gruppenbereiche mit Antworten mit Unterhaltungsthreads werden nicht unterstützt. Wenn Sie beim Einrichten eines Gruppenbereichs die Fehlermeldung Erfordert eine Nutzerauthentifizierung.
|
UpdateMembership |
---|
Aktualisiert eine Mitgliedschaft. Ein Beispiel finden Sie unter Mitgliedschaft eines Nutzers in einem Gruppenbereich aktualisieren. Erfordert die Nutzerauthentifizierung.
|
UpdateMessage |
---|
Aktualisiert eine Nachricht. Es gibt einen Unterschied zwischen den Methoden Erfordert eine Authentifizierung. Unterstützt die App-Authentifizierung und die Nutzerauthentifizierung. Bei Verwendung der App-Authentifizierung können Anfragen nur Nachrichten aktualisieren, die von der aufrufenden Chat-App erstellt wurden.
|
UpdateSpace |
---|
Aktualisiert einen Gruppenbereich. Ein Beispiel finden Sie unter Gruppenbereiche aktualisieren. Wenn Sie das Feld Erfordert eine Nutzerauthentifizierung.
|
UpdateSpaceReadState |
---|
Aktualisiert den Lesestatus eines Nutzers in einem Gruppenbereich. Er wird verwendet, um gelesene und ungelesene Nachrichten zu identifizieren. Ein Beispiel finden Sie unter Lesestatus des Gruppenbereichs eines Nutzers aktualisieren. Erfordert eine Nutzerauthentifizierung.
|
AccessoryWidget
Ein oder mehrere interaktive Widgets, die unten in einer Nachricht angezeigt werden. Weitere Informationen finden Sie im Hilfeartikel Interaktive Widgets am Ende einer Nachricht hinzufügen.
Felder | |
---|---|
Union-Feld action . Die Art der Aktion. Für action ist nur einer der folgenden Werte zulässig: |
|
button_list |
Eine Liste mit Schaltflächen. |
ActionResponse
Parameter, mit denen in einer Chat-App konfiguriert werden kann, wie Antworten gepostet werden.
Felder | |
---|---|
type |
Nur Eingabe. Der Typ der Chat-App-Antwort. |
url |
Nur Eingabe. URL zum Authentifizieren oder Konfigurieren. (Nur für |
dialog_action |
Nur Eingabe. Eine Antwort auf ein Interaktionsereignis, das mit einem Dialogfeld zusammenhängt. Muss von |
updated_widget |
Nur Eingabe. Die Antwort des aktualisierten Widgets. |
ResponseType
Der Typ der Chat-App-Antwort.
Enums | |
---|---|
TYPE_UNSPECIFIED |
Standardtyp, der als NEW_MESSAGE behandelt wird. |
NEW_MESSAGE |
Als neue Nachricht im Thema posten. |
UPDATE_MESSAGE |
Aktualisieren Sie die Nachricht der Chat-App. Dies ist nur bei einem CARD_CLICKED -Ereignis zulässig, bei dem der Absendertyp der Nachricht BOT ist. |
UPDATE_USER_MESSAGE_CARDS |
Karten in der Nachricht eines Nutzers aktualisieren. Dies ist nur als Antwort auf ein MESSAGE -Ereignis mit einer übereinstimmenden URL oder auf ein CARD_CLICKED -Ereignis mit dem Absendertyp HUMAN zulässig. Text wird ignoriert. |
REQUEST_CONFIG |
Nutzer privat um eine zusätzliche Authentifizierung oder Konfiguration bitten |
DIALOG |
Zeigt ein Dialogfeld an. |
UPDATE_WIDGET |
Abfrage der Optionen für die automatische Vervollständigung von Widget-Texten. |
SelectionItems
Liste der Ergebnisse der automatischen Vervollständigung von Widgets.
Felder | |
---|---|
items[] |
Ein Array der SelectionItem-Objekte. |
UpdatedWidget
Die Antwort des aktualisierten Widgets. Wird verwendet, um Optionen zur automatischen 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 von Widgets |
ActionStatus
Stellt den Status für eine Anfrage zum Aufrufen oder Senden eines Dialogfelds dar.
Felder | |
---|---|
status_code |
Der Statuscode. |
user_facing_message |
Die Nachricht, die Nutzern über den Status ihrer Anfrage gesendet wird. Wenn die Richtlinie nicht konfiguriert ist, wird eine generische Nachricht basierend auf dem |
Annotation
Nur Ausgabe. Mit dem Nur-Text-Text der Nachricht verknüpfte Annotationen. Informationen zum grundlegenden Formatieren von SMS finden Sie unter Textnachrichten formatieren.
Beispiel für einen Nachrichtentext:
Hello @FooBot how are you!"
Die entsprechenden Metadaten der Annotationen:
"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 der Teilzeichenfolge im Nur-Text-Nachrichtentext, der diese Anmerkung entspricht. |
start_index |
Startindex (0-basiert, einschließlich) im Nur-Text-Nachrichtentext, dem diese Annotation entspricht. |
Union-Feld metadata . Zusätzliche Metadaten zur Anmerkung. Für metadata ist nur einer der folgenden Werte zulässig: |
|
user_mention |
Die Metadaten der Nutzererwähnung. |
slash_command |
Die Metadaten für einen Slash-Befehl. |
rich_link_metadata |
Die Metadaten für einen Rich-Link. |
AnnotationType
Typ der Anmerkung.
Enums | |
---|---|
ANNOTATION_TYPE_UNSPECIFIED |
Standardwert für die Aufzählung. Nicht verwenden. |
USER_MENTION |
Ein Nutzer wird erwähnt. |
SLASH_COMMAND |
Ein Slash-Befehl wird aufgerufen. |
RICH_LINK |
Eine Rich-Link-Anmerkung. |
AttachedGif
Ein GIF-Bild, das durch eine URL angegeben wird.
Felder | |
---|---|
uri |
Nur Ausgabe. Die URL, auf der das GIF-Bild gehostet wird. |
Anhang
Ein Anhang in Google Chat.
Felder | |
---|---|
name |
Ressourcenname des Anhangs im Format |
content_name |
Nur Ausgabe. Der Name der ursprünglichen Datei für den Inhalt, nicht der vollständige Pfad. |
content_type |
Nur Ausgabe. Der Inhaltstyp (MIME-Typ) der Datei. |
thumbnail_uri |
Nur Ausgabe. Die URL der Miniaturansicht, die verwendet werden soll, um eine Vorschau des Anhangs für einen Nutzer anzuzeigen. Chat-Apps sollten diese URL nicht verwenden, um Inhalte von Anhängen herunterzuladen. |
download_uri |
Nur Ausgabe. Die Download-URL, mit der ein menschlicher Nutzer den Anhang herunterladen kann. Chat-Apps sollten diese URL nicht verwenden, um Inhalte von Anhängen herunterzuladen. |
source |
Nur Ausgabe. Die Quelle des Anhangs. |
Union-Feld data_ref . Der Datenverweis auf den Anhang. Für data_ref ist nur einer der folgenden Werte zulässig: |
|
attachment_data_ref |
Ein Verweis auf die Anhangsdaten. Dieses Feld wird mit der Media API verwendet, um die Anhangsdaten herunterzuladen. |
drive_data_ref |
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 |
Der Ressourcenname der Anhangsdaten. Dieses Feld wird mit der Media API verwendet, um die Anhangsdaten herunterzuladen. |
attachment_upload_token |
Intransparentes Token mit einem Verweis auf einen hochgeladenen Anhang. Wird von Clients als opaker 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.
Entwerfen Sie Karten mit dem Card Builder und zeigen Sie Vorschauen an.
Card Builder öffnenFelder | |
---|---|
card_id |
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 für Links zu Chatbereichen.
Felder | |
---|---|
space |
Der Bereich der verknüpften Chatbereich-Ressource. Format: |
thread |
Der Thread der verknüpften Chatbereich-Ressource. Format: |
message |
Die Nachricht der verknüpften Chatbereichsressource. Format: |
CompleteImportSpaceRequest
Anfragenachricht zum Abschluss des Importvorgangs für einen Gruppenbereich.
Felder | |
---|---|
name |
Erforderlich. Ressourcenname des Bereichs im Importmodus. Format: |
CompleteImportSpaceResponse
Antwortnachricht zum Abschließen des Importvorgangs für einen Gruppenbereich.
Felder | |
---|---|
space |
Bereich für den Importmodus |
ContextualAddOnMarkup
Dieser Typ hat keine Felder.
Das Markup für Entwickler zur Angabe der Inhalte eines kontextbezogenen Add-ons.
Infokarte
Eine Karte ist ein UI-Element, das UI-Widgets wie Text und Bilder enthalten kann.
Felder | |
---|---|
header |
Der Header der Karte. Eine Kopfzeile enthält normalerweise einen Titel und ein Bild. |
sections[] |
Die einzelnen Abschnitte sind durch eine Trennlinie voneinander getrennt. |
card_actions[] |
Die Aktionen dieser Karte. |
name |
Name der Karte. |
CardAction
Eine Kartenaktion ist die mit der Karte verknüpfte Aktion. Eine typische Aktion für eine Rechnungskarte wäre: eine Rechnung löschen, eine E-Mail-Rechnung senden oder die Rechnung im Browser öffnen.
Wird von Google Chat-Apps nicht unterstützt.
Felder | |
---|---|
action_label |
Das Label, das früher im Aktionsmenü angezeigt wurde. |
on_click |
Die "onclick"-Aktion für diese Aufgabe. |
CardHeader
Felder | |
---|---|
title |
Der Titel muss angegeben werden. Die Kopfzeile hat eine feste Höhe: Wenn sowohl ein Titel als auch eine Unterüberschrift angegeben sind, belegt jede eine Zeile. Wenn nur der Titel angegeben ist, werden beide Zeilen ausgefüllt. |
subtitle |
Der Untertitel der Kartenüberschrift. |
image_style |
Der Bildtyp, z. B. quadratischer oder kreisförmiger Rahmen |
image_url |
Die URL des Bildes in der Kopfzeile der Karte. |
ImageStyle
Enums | |
---|---|
IMAGE_STYLE_UNSPECIFIED |
|
IMAGE |
Quadratische Rahmenlinie. |
AVATAR |
Kreisförmiger Rahmen. |
Abschnitt
Ein Abschnitt enthält eine Sammlung von Widgets, die (vertikal) in der angegebenen Reihenfolge gerendert werden. Auf allen Plattformen haben Infokarten eine schmale feste Breite, sodass derzeit keine Layouteigenschaften (z. B. Float) erforderlich sind.
Felder | |
---|---|
header |
Die Kopfzeile 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. |
CreateMembershipRequest
Anfragenachricht zum Erstellen einer Mitgliedschaft.
Felder | |
---|---|
parent |
Erforderlich. Der Ressourcenname des Gruppenbereichs, für den die Mitgliedschaft erstellt werden soll. Format: Leerzeichen/{Leerzeichen} |
membership |
Erforderlich. Die zu erstellende Mitgliedschaftsbeziehung. Das Feld |
use_admin_access |
true , 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 Das Erstellen von App-Mitgliedschaften oder das Erstellen von Mitgliedschaften für Nutzer außerhalb der Google Workspace-Organisation des Administrators wird über den 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. Eingestellt: Verwende stattdessen |
request_id |
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 |
Optional. Gibt an, ob eine Nachricht einen Thread startet oder darauf antwortet. Wird nur in benannten Gruppenbereichen unterstützt. |
message_id |
Optional. Eine benutzerdefinierte ID für eine Nachricht. Hiermit können Chat-Apps Nachrichten abrufen, aktualisieren oder löschen, ohne die vom System zugewiesene ID im Ressourcennamen der Nachricht speichern zu müssen (wird im Feld Der Wert für dieses Feld muss die folgenden Anforderungen erfüllen:
Weitere Informationen finden Sie im Hilfeartikel Nachrichten benennen. |
MessageReplyOption
Gibt an, wie auf eine Nachricht geantwortet wird. In Zukunft werden möglicherweise weitere Bundesstaaten hinzugefügt.
Enums | |
---|---|
MESSAGE_REPLY_OPTION_UNSPECIFIED |
Standard. Eine neue Unterhaltung wird gestartet. Bei dieser Option werden alle enthaltenen thread ID oder ignoriert. |
REPLY_MESSAGE_FALLBACK_TO_NEW_THREAD |
Erstellt die Nachricht als Antwort auf den in thread ID oder angegebenen Thread. Wenn der Vorgang fehlschlägt, wird stattdessen ein neuer Thread gestartet. |
REPLY_MESSAGE_OR_FAIL |
Erstellt die Nachricht als Antwort auf den in thread ID oder angegebenen Thread. Wenn eine neue thread_key verwendet wird, wird ein neuer Thread erstellt. Wenn die Nachricht nicht erstellt werden kann, wird stattdessen der Fehler NOT_FOUND zurückgegeben. |
CreateReactionRequest
Erstellt eine Reaktion auf eine Nachricht.
Felder | |
---|---|
parent |
Erforderlich. Die Nachricht, in der die Reaktion erstellt wird. Format: |
reaction |
Erforderlich. Die zu erstellende Reaktion. |
CreateSpaceRequest
Eine Anfrage zum Erstellen eines Gruppenbereichs ohne Mitglieder.
Felder | |
---|---|
space |
Erforderlich. Wenn Sie die Fehlermeldung Wenn du am Vorschauprogramm für Entwickler teilnimmst, kannst du Der Bereich |
request_id |
Optional. Eine eindeutige Kennung für diese Anfrage. Eine zufällige UUID wird empfohlen. Wenn Sie eine vorhandene Anfrage-ID angeben, wird der mit dieser ID erstellte Gruppenbereich zurückgegeben, anstatt einen neuen Gruppenbereich zu erstellen. Wenn Sie eine vorhandene Anfrage-ID aus derselben Chat-App für einen anderen authentifizierten Nutzer angeben, wird ein Fehler zurückgegeben. |
CustomEmoji
Stellt ein benutzerdefiniertes Emoji dar.
Felder | |
---|---|
uid |
Nur Ausgabe. Eindeutiger Schlüssel für die benutzerdefinierte Emoji-Ressource. |
DeleteMembershipRequest
Anfrage zum Löschen einer Mitgliedschaft in einem Gruppenbereich.
Felder | |
---|---|
name |
Erforderlich. Ressourcenname der zu löschenden Mitgliedschaft. Chat-Apps können Nutzer von Nutzern löschen oder eine eigene Mitgliedschaft. Chat-Apps können keine Mitgliedschaften anderer Apps löschen. Beim Löschen einer menschlichen Mitgliedschaft sind der Bereich Beim Löschen einer App-Mitgliedschaft sind der Bereich Format: |
use_admin_access |
true , 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 Das Löschen von App-Mitgliedschaften in einem Gruppenbereich wird bei Verwendung des Administratorzugriffs 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 |
Wenn Gilt nur, wenn Sie sich als Nutzer authentifizieren. Hat keine Auswirkungen, wenn Sie sich als Chat-App authentifizieren. |
DeleteReactionRequest
Löscht eine Reaktion auf eine Nachricht.
Felder | |
---|---|
name |
Erforderlich. Name der zu löschenden Reaktion. Format: |
DeleteSpaceRequest
Anfrage zum Löschen eines Gruppenbereichs.
Felder | |
---|---|
name |
Erforderlich. Ressourcenname des zu löschenden Gruppenbereichs. Format: |
use_admin_access |
true , 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 |
DeletionMetadata
Informationen zu einer gelöschten Nachricht. Eine Nachricht wird gelöscht, wenn delete_time
festgelegt ist.
Felder | |
---|---|
deletion_type |
Gibt an, wer die Nachricht gelöscht hat. |
DeletionType
Wer die Nachricht gelöscht hat und wie sie gelöscht wurde.
Enums | |
---|---|
DELETION_TYPE_UNSPECIFIED |
Dieser Wert wird nicht verwendet. |
CREATOR |
Ein 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 Inhabers des Gruppenbereichs gelöscht. |
Dialog
Wrapper um den Kartentext des Dialogfelds.
Felder | |
---|---|
body |
Nur Eingabe. Text des Dialogfelds, der in einem modalen Fenster gerendert wird. Google Chat-Apps unterstützen die folgenden Kartenentitäten nicht: |
DialogAction
Enthält ein dialog-Fenster und einen Statuscode für die Anfrage.
Felder | |
---|---|
action_status |
Nur Eingabe. Status für eine 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 (Dialogfeld) für die Anfrage. |
DriveDataRef
Ein Verweis auf die Daten eines Drive-Anhangs.
Felder | |
---|---|
drive_file_id |
Die ID der Drive-Datei. Wird mit der Drive API verwendet. |
DriveLinkData
Daten für Google Drive-Links.
Felder | |
---|---|
drive_data_ref |
Eine DriveDataRef, die auf eine Google Drive-Datei verweist. |
mime_type |
Der MIME-Typ der verknüpften Google Drive-Ressource. |
Emoji
Ein Emoji, das als Reaktion auf eine Nachricht verwendet wird.
Felder | |
---|---|
Union-Feld content . Der Inhalt des Emojis. Für content ist nur einer der folgenden Werte zulässig: |
|
unicode |
Ein einfaches Emoji, das durch einen Unicode-String dargestellt wird. |
custom_emoji |
Nur Ausgabe. Ein benutzerdefiniertes Emoji. |
EmojiReactionSummary
Die Anzahl der Personen, die auf eine Nachricht mit einem bestimmten Emoji reagiert haben.
Felder | |
---|---|
emoji |
Mit den Reaktionen verknüpftes Emoji. |
reaction_count |
Die Gesamtzahl der Reaktionen mit dem zugehörigen Emoji. |
FindDirectMessageRequest
Eine Anfrage zum Abrufen des Gruppenbereichs für Direktnachrichten basierend auf der Nutzerressource.
Felder | |
---|---|
name |
Erforderlich. Ressourcenname des Nutzers, bei dem die Direktnachricht gesucht werden soll. Format: |
GetAttachmentRequest
Anfrage zum Abrufen eines Anhangs
Felder | |
---|---|
name |
Erforderlich. Ressourcenname des Anhangs im Format |
GetMembershipRequest
Beantragen Sie die Mitgliedschaft in einem Gruppenbereich.
Felder | |
---|---|
name |
Erforderlich. Ressourcenname der abzurufenden Mitgliedschaft. Um die eigene Mitgliedschaft der Anwendung über die Nutzerauthentifizierung zu erhalten, können Sie optional Format: Wenn Sie als Nutzer authentifiziert sind, können Sie die E-Mail-Adresse des Nutzers als Alias für |
use_admin_access |
true , 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 OAuth 2.0-Bereich Wenn Sie Administratorzugriff haben, wird der Kauf von App-Mitgliedschaften in einem Gruppenbereich nicht unterstützt. |
GetMessageRequest
Anfrage, um eine Nachricht zu erhalten.
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 Raumereignisses.
Felder | |
---|---|
name |
Erforderlich. Der Ressourcenname des Gruppenbereichsereignisses. Format: |
GetSpaceReadStateRequest
Anfragenachricht für GetSpaceReadState API.
Felder | |
---|---|
name |
Erforderlich. Ressourcenname des abzurufenden Lesestatus des Gruppenbereichs. Unterstützt nur das Abrufen des Lesestatus für den aufrufenden Nutzer. Legen Sie einen der folgenden Werte fest, um auf den aufrufenden Nutzer zu verweisen:
Format: users/{user}/spaces/{space}/spaceReadState |
GetSpaceRequest
Eine Anfrage zum Zurückgeben eines einzelnen Leerzeichens.
Felder | |
---|---|
name |
Erforderlich. Ressourcenname des Gruppenbereichs im Format Format: |
use_admin_access |
true , 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 OAuth 2.0-Bereich |
GetThreadReadStateRequest
Anfragenachricht für die GetThreadReadStateRequest API.
Felder | |
---|---|
name |
Erforderlich. Ressourcenname des abzurufenden Thread-Lesestatus. Unterstützt nur das Abrufen des Lesestatus für den aufrufenden Nutzer. Legen Sie einen der folgenden Werte fest, um auf den aufrufenden Nutzer zu verweisen:
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 gespeichert werden.
Enums | |
---|---|
HISTORY_STATE_UNSPECIFIED |
Standardwert. Nicht verwenden. |
HISTORY_OFF |
Verlauf deaktiviert. Nachrichten und Threads werden 24 Stunden lang aufbewahrt. |
HISTORY_ON |
Verlauf aktiviert. In den Vault-Aufbewahrungsregeln der Organisation ist festgelegt, wie lange Nachrichten und Threads aufbewahrt werden. |
ListMembershipsRequest
Anfragenachricht zum Auflisten von Mitgliedschaften.
Felder | |
---|---|
parent |
Erforderlich. Der Ressourcenname des Gruppenbereichs, für den eine Mitgliederliste abgerufen werden soll. Format: Leerzeichen/{Leerzeichen} |
page_size |
Optional. Die maximale Anzahl von Mitgliedschaften, die zurückgegeben werden sollen. Der Dienst gibt möglicherweise weniger als diesen Wert zurück. Wenn keine Angabe gemacht wird, werden maximal 100 Mitgliedschaften zurückgegeben. Der Höchstwert beträgt 1.000. Wenn Sie einen höheren Wert als 1.000 verwenden, wird er automatisch in 1.000 geändert. Bei negativen Werten wird der Fehler |
page_token |
Optional. Seitentoken, das von einem vorherigen Aufruf zur Auflistung von Mitgliedschaften erhalten 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. Die Übergabe unterschiedlicher Werte an die anderen Parameter kann zu unerwarteten Ergebnissen führen. |
filter |
Optional. Einen Abfragefilter. Du kannst Mitgliedschaften nach der Rolle eines Mitglieds ( Wenn Sie nach Rolle filtern möchten, setzen Sie Wenn Sie nach Typ filtern möchten, setzen Sie Verwenden Sie den Operator
Die folgenden Abfragen sind beispielsweise gültig:
Die folgenden Abfragen sind ungültig:
Ungültige Anfragen werden vom Server mit dem Fehler |
show_groups |
Optional. Bei |
show_invited |
Optional. Bei Erfordert derzeit die Nutzerauthentifizierung. |
use_admin_access |
true , 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 OAuth 2.0-Bereich Wenn Sie Administratorzugriff haben, wird das Auflisten von App-Mitgliedschaften in einem Gruppenbereich nicht unterstützt. |
ListMembershipsResponse
Antwort auf die Auflistung der Mitgliedschaften des Gruppenbereichs.
Felder | |
---|---|
memberships[] |
Unsortierte Liste. Liste der Mitgliedschaften auf der angeforderten (oder ersten) Seite. |
next_page_token |
Ein Token, das Sie als |
ListMessagesRequest
Listet Nachrichten im angegebenen Gruppenbereich auf, in dem der Nutzer Mitglied ist.
Felder | |
---|---|
parent |
Erforderlich. Der Ressourcenname des Gruppenbereichs, aus dem Nachrichten aufgelistet werden sollen. Format: |
page_size |
Die maximale Anzahl zurückgegebener Nachrichten. Der Dienst gibt möglicherweise weniger Nachrichten als diesen Wert zurück. Wenn keine Angabe gemacht wird, werden höchstens 25 zurückgegeben. Der Höchstwert beträgt 1.000. Wenn Sie einen höheren Wert als 1.000 verwenden, wird er automatisch in 1.000 geändert. Bei negativen Werten wird der Fehler |
page_token |
Optional, wenn die Pausierung von einer vorherigen Abfrage aufgehoben wird. Ein Seitentoken, das von einem vorherigen Aufruf der Nachrichtenliste 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. Die Übergabe unterschiedlicher Werte an die anderen Parameter kann zu unerwarteten Ergebnissen führen. |
filter |
Einen Abfragefilter. Du kannst Nachrichten nach Datum ( Wenn Sie Nachrichten nach dem Erstellungsdatum filtern möchten, geben Sie Geben Sie Verwenden Sie in Ihrer Abfrage den Operator Die folgenden Abfragen sind beispielsweise gültig:
Ungültige Anfragen werden vom Server mit dem Fehler |
order_by |
Optional, wenn die Pausierung von einer vorherigen Abfrage aufgehoben wird. Die Reihenfolge der Nachrichtenliste. Geben Sie einen Sortierwert an. Gültige Werte für Sortiervorgänge sind:
Die Standardsortierung ist |
show_deleted |
Gibt an, ob gelöschte Nachrichten berücksichtigt werden sollen. Gelöschte Nachrichten enthalten das Löschdatum und ‑metadaten, der Inhalt der Nachricht ist jedoch nicht verfügbar. |
ListMessagesResponse
Antwortnachricht zum Auflisten von Nachrichten.
Felder | |
---|---|
messages[] |
Liste der Nachrichten. |
next_page_token |
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_size |
Optional. Die maximale Anzahl zurückgegebener Reaktionen. Der Dienst kann weniger Reaktionen als dieser Wert zurückgeben. Wenn keine Vorgabe erfolgt, gilt der Standardwert 25. Der Maximalwert ist 200. werden die Werte über 200 in 200 geändert. |
page_token |
Optional. (Bei Fortsetzung einer vorherigen Abfrage.) Ein Seitentoken, das von einem vorherigen Aufruf von Listenreaktionen empfangen wurde. Geben Sie diese an, um die nachfolgende Seite abzurufen. Beim Paginieren sollte der Filterwert mit dem Aufruf übereinstimmen, der das Seitentoken bereitgestellt hat. Die Übergabe eines anderen Werts kann zu unerwarteten Ergebnissen führen. |
filter |
Optional. Einen Abfragefilter. Du kannst Reaktionen nach Emoji ( Wenn Sie Reaktionen auf mehrere Emojis oder Nutzer filtern möchten, können Sie ähnliche Felder mit dem Operator Mit dem Operator Wenn in Ihrer Abfrage sowohl Die folgenden Abfragen sind beispielsweise gültig:
Die folgenden Abfragen sind ungültig:
Ungültige Anfragen 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_page_token |
Fortsetzungs-Token zum Abrufen der nächsten Ergebnisseite. Auf der letzten Seite der Ergebnisse ist kein Eintrag vorhanden. |
ListSpaceEventsRequest
Anfragenachricht für Listen von Veranstaltungsräumen
Felder | |
---|---|
parent |
Erforderlich. Ressourcenname des Google Chat-Bereichs, in dem die Ereignisse aufgetreten sind. Format: |
page_size |
Optional. Die maximale Anzahl zurückgegebener Space-Ereignisse. Der Dienst gibt möglicherweise weniger als diesen Wert zurück. Bei negativen Werten wird der Fehler |
page_token |
Seitentoken, das von einem vorherigen Aufruf einer Gruppenbereichsereignisliste erhalten wurde. Geben Sie diese an, um die nachfolgende Seite abzurufen. Beim Paginieren müssen alle anderen Parameter, die zum Auflisten von Space-Ereignissen zur Verfügung gestellt werden, mit dem Aufruf übereinstimmen, der das Seitentoken bereitgestellt hat. Die Übergabe unterschiedlicher Werte an die anderen Parameter kann zu unerwarteten Ergebnissen führen. |
filter |
Erforderlich. Einen Abfragefilter. Sie müssen mindestens einen Ereignistyp ( Optional können Sie auch nach Beginn (
Um eine Start- oder Endzeit anzugeben, verwenden Sie den Gleichheitsoperator Die folgenden Abfragen sind beispielsweise gültig:
Die folgenden Abfragen sind ungültig:
Ungültige Anfragen werden vom Server mit dem Fehler |
ListSpaceEventsResponse
Antwortnachricht zum Auflisten von Space-Ereignissen.
Felder | |
---|---|
space_events[] |
Die Ergebnisse werden in chronologischer Reihenfolge zurückgegeben (ältestes Ereignis zuerst). |
next_page_token |
Fortsetzungs-Token zum Abrufen weiterer Ereignisse. Wenn dieses Feld weggelassen wird, gibt es keine nachfolgenden Seiten. |
ListSpacesRequest
Eine Anfrage zum Auflisten der Gruppenbereiche, in denen der Aufrufer Mitglied ist.
Felder | |
---|---|
page_size |
Optional. Die maximale Anzahl von Leerzeichen, die zurückgegeben werden sollen. Der Dienst gibt möglicherweise weniger als diesen Wert zurück. Wenn nicht angegeben, werden maximal 100 Leerzeichen zurückgegeben. Der Höchstwert beträgt 1.000. Wenn Sie einen höheren Wert als 1.000 verwenden, wird er automatisch in 1.000 geändert. Bei negativen Werten wird der Fehler |
page_token |
Optional. Seitentoken, das von einem vorherigen Aufruf einer Gruppenbereichsliste erhalten wurde. Geben Sie diesen Parameter an, um die nachfolgende Seite abzurufen. Beim Paginieren sollte der Filterwert mit dem Aufruf übereinstimmen, der das Seitentoken bereitgestellt hat. Das Übergeben eines anderen Werts kann zu unerwarteten Ergebnissen führen. |
filter |
Optional. Einen Abfragefilter. Sie können Gruppenbereiche nach dem Typ des Gruppenbereichs filtern ( Zum Filtern nach Gruppenbereichstyp müssen Sie einen gültigen ENUM-Wert wie Die folgenden Abfragen sind beispielsweise gültig:
Ungültige Anfragen 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. |
next_page_token |
Sie können ein Token als |
MatchedUrl
Eine übereinstimmende URL in einer Chatnachricht. Chat-Apps können sich übereinstimmende URLs in der Vorschau ansehen. Weitere Informationen finden Sie unter Vorschaulinks.
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 wird, Teil eines Gruppenbereichs ist oder nicht in einem Gruppenbereich vorhanden ist.
Felder | |
---|---|
name |
Ressourcenname der Mitgliedschaft, der vom Server zugewiesen wird. Format: |
state |
Nur Ausgabe. Status der Mitgliedschaft. |
role |
Optional. Die Rolle des Nutzers in einem Chatbereich, durch die die zulässigen Aktionen im Gruppenbereich bestimmt werden. Dieses Feld kann nur in |
create_time |
Optional. Nicht veränderbar. Der Erstellungszeitpunkt der Mitgliedschaft, z. B. wann ein Mitglied einem Gruppenbereich beigetreten ist oder eingeladen wurde Dieses Feld wird nur ausgegeben, wenn es nicht zum Importieren von historischen Mitgliedschaften in Gruppenbereiche im Importmodus verwendet wird. |
delete_time |
Optional. Nicht veränderbar. Der Zeitpunkt des Löschens der Mitgliedschaft, z. B. wann ein Mitglied das Unternehmen verlassen hat oder aus einem Gruppenbereich entfernt wurde. Dieses Feld wird nur ausgegeben, wenn es nicht zum Importieren von historischen Mitgliedschaften in Gruppenbereiche im Importmodus verwendet wird. |
Union-Feld memberType . Mit dieser Mitgliedschaft verknüpftes Mitglied. In Zukunft werden möglicherweise noch weitere Mitgliedstypen unterstützt. Für memberType ist nur einer der folgenden Werte zulässig: |
|
member |
Der Google Chat-Nutzer oder die Google Chat-App, zu der die Mitgliedschaft gehört. Wenn sich Ihre Chat-App als Nutzer authentifiziert, wird die Ausgabe in den Feldern Nutzer |
group_member |
Die Google-Gruppe, zu der die Mitgliedschaft gehört. |
MembershipRole
Stellt die zulässigen Aktionen eines Nutzers in einem Chatbereich dar. In Zukunft werden möglicherweise weitere enum-Werte hinzugefügt.
Enums | |
---|---|
MEMBERSHIP_ROLE_UNSPECIFIED |
Standardwert. users : Die Person ist kein Mitglied des Gruppenbereichs, kann aber eingeladen werden. Für Google Groups : Dem Nutzer wird immer diese Rolle zugewiesen. In Zukunft werden möglicherweise noch andere enum-Werte verwendet. |
ROLE_MEMBER |
Ein Mitglied des Gruppenbereichs. Der Nutzer hat grundlegende Berechtigungen, z. B. das Senden von Nachrichten in den Gruppenbereich. In Einzelunterhaltungen und unbenannten Gruppenunterhaltungen haben alle Nutzer diese Rolle. |
ROLE_MANAGER |
Ein Administrator des Gruppenbereichs. 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. In Zukunft werden möglicherweise noch weitere Mitgliedschaftsstatus unterstützt.
Enums | |
---|---|
MEMBERSHIP_STATE_UNSPECIFIED |
Standardwert. Nicht verwenden. |
JOINED |
Der Nutzer wird dem Gruppenbereich hinzugefügt und kann ihm beitreten. |
INVITED |
Der Nutzer wurde in den Gruppenbereich eingeladen, ist ihm aber noch nicht beigetreten. |
NOT_A_MEMBER |
Der Nutzer gehört dem Gruppenbereich nicht an und hat keine ausstehende Einladung zum Beitritt. |
MembershipBatchCreatedEventData
Ereignisnutzlast für mehrere neue Mitgliedschaften.
Ereignistyp: google.workspace.chat.membership.v1.batchCreated
Felder | |
---|---|
memberships[] |
Eine Liste neuer 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 |
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 sich Ihre Chat-App als Nutzer authentifiziert, wird die Ausgabe in den Feldern Nutzer |
create_time |
Optional. Nicht veränderbar. Bei Gruppenbereichen, die in Google Chat erstellt wurden, der Zeitpunkt, zu dem die Nachricht erstellt wurde. Dieses Feld wird nur für die Ausgabe verwendet, es sei denn, es wird in Bereichen im Importmodus verwendet. Legen Sie für Gruppenbereiche im Importmodus dieses Feld auf den historischen Zeitstempel fest, zu dem die Nachricht in der Quelle erstellt wurde, um den ursprünglichen Erstellungszeitpunkt beizubehalten. |
last_update_time |
Nur Ausgabe. Der Zeitpunkt, zu dem die Nachricht zuletzt von einem Nutzer bearbeitet wurde. Wenn die Nachricht noch nie bearbeitet wurde, ist dieses Feld leer. |
delete_time |
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 |
Nur-Text der Nachricht. Über den ersten Link zu einem Bild, einem Video oder einer Webseite wird ein Vorschau-Chip generiert. Sie können auch einen Google Chat-Nutzer oder alle Personen im Gruppenbereich@erwähnen. Weitere Informationen zum Erstellen von SMS finden Sie unter Nachrichten senden. |
formatted_text |
Nur Ausgabe. Enthält die Nachricht
Weitere Informationen finden Sie im Hilfeartikel In Nachrichten gesendete Textformatierungen ansehen. |
cards[] |
Eingestellt: Verwende stattdessen Umfangreiche, formatierte und interaktive Karten, mit denen Sie UI-Elemente wie formatierte Texte, Schaltflächen und anklickbare Bilder darstellen können. Karten werden normalerweise unter dem Nur-Text der Nachricht angezeigt. |
cards_v2[] |
Ein Array mit Karten. Nur Chat-Apps können Karten erstellen. Wenn sich Ihre Chat-App als Nutzer authentifiziert, dürfen die Nachrichten keine Karten enthalten. Informationen zum Erstellen einer Nachricht, die Karten enthält, finden Sie im Hilfeartikel Nachrichten senden. Entwerfen Sie Karten mit dem Card Builder und zeigen Sie Vorschauen an. Card Builder öffnen |
annotations[] |
Nur Ausgabe. Anmerkungen, die mit der |
thread |
Der Thread, zu dem die Nachricht gehört. Anwendungsbeispiele finden Sie im Hilfeartikel Unterhaltungen starten oder beantworten. |
space |
Wenn sich Ihre Chat-App als Nutzer authentifiziert, wird die Ausgabe im Bereich |
fallback_text |
Eine Klartextbeschreibung der Karten der Nachricht, die verwendet wird, wenn die eigentlichen Karten nicht angezeigt werden können, z. B. mobile Benachrichtigungen. |
action_response |
Nur Eingabe. Parameter, mit denen in einer Chat-App konfiguriert werden kann, wie Antworten gepostet werden. |
argument_text |
Nur Ausgabe. Nur-Text der Nachricht, wobei alle Erwähnungen in der Google Chat App entfernt wurden. |
slash_command |
Nur Ausgabe. Informationen zu Slash-Befehlen, falls vorhanden. |
attachment[] |
Vom Nutzer hochgeladener Anhang. |
matched_url |
Nur Ausgabe. Eine URL in |
thread_reply |
Nur Ausgabe. Wenn Wenn in einem Gruppenbereich keine Antworten in Threads unterstützt werden, lautet das Feld immer |
client_assigned_message_id |
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. Geben Sie beim Erstellen der Nachricht das Feld |
emoji_reaction_summaries[] |
Nur Ausgabe. Die Liste der Zusammenfassungen der Emoji-Reaktionen in der Nachricht. |
private_message_viewer |
Nicht veränderbar. Eingabe zum Erstellen einer Nachricht, andernfalls nur Ausgabe. Der Nutzer, der die Nachricht ansehen kann. Wenn dies 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 mithilfe der App-Authentifizierung aufrufen und Folgendes weglassen: Weitere Informationen finden Sie im Hilfeartikel Nachrichten privat senden. |
deletion_metadata |
Nur Ausgabe. Informationen zu einer gelöschten Nachricht. Eine Nachricht wird gelöscht, wenn |
quoted_message_metadata |
Nur Ausgabe. Informationen zu einer Nachricht, die von einem Google Chat-Nutzer in einem Gruppenbereich zitiert wurde. Google Chat-Nutzer können eine Nachricht zitieren, um darauf zu antworten. |
attached_gifs[] |
Nur Ausgabe. GIF-Bilder, die an die Nachricht angehängt sind. |
accessory_widgets[] |
Ein oder mehrere interaktive Widgets, die unten in einer Nachricht angezeigt werden. Sie können Zubehör-Widgets zu Nachrichten hinzufügen, die Text, Karten oder sowohl Text als auch Karten enthalten. Nicht unterstützt für Meldungen, die Dialogfelder enthalten. Weitere Informationen finden Sie im Hilfeartikel Interaktive Widgets am Ende einer Nachricht hinzufügen. Zum Erstellen einer Mitteilung mit Zubehör-Widgets ist die 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 in Anführungszeichen gesetzten Nachricht. Format: |
last_update_time |
Nur Ausgabe. Der Zeitstempel, der angibt, wann die zitierte Nachricht erstellt oder die zitierte Nachricht zuletzt aktualisiert wurde. |
Reaktion
Eine Reaktion auf eine Nachricht.
Felder | |
---|---|
name |
Der Ressourcenname der Reaktion. Format: |
user |
Nur Ausgabe. Der Nutzer, der die Reaktion erstellt hat. |
emoji |
Das in der Reaktion verwendete Emoji. |
ReactionBatchCreatedEventData
Ereignisnutzlast für mehrere neue Reaktionen.
Ereignistyp: google.workspace.chat.reaction.v1.batchCreated
Felder | |
---|---|
reactions[] |
Eine Liste neuer 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_link_type |
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 |
Daten für eine Drive-Verknüpfung. |
chat_space_link_data |
Daten für einen Link zu einem Chatbereich. |
RichLinkType
Der Rich-Link-Typ. In Zukunft werden möglicherweise weitere Typen hinzugefügt.
Enums | |
---|---|
RICH_LINK_TYPE_UNSPECIFIED |
Standardwert für die Aufzählung. Nicht verwenden. |
DRIVE_FILE |
Ein Rich-Link-Typ für Google Drive. |
CHAT_SPACE |
Ein Rich-Link-Typ für Chatbereiche. Beispiel: ein Smartchip für den Weltraum. |
SearchSpacesRequest
Anfrage zum Suchen nach einer Liste von Gruppenbereichen basierend auf einer Abfrage.
Felder | |
---|---|
use_admin_access |
Wenn Der anrufende Nutzer muss ein Google Workspace-Administrator mit der Berechtigung „Unterhaltungen in Chats und Gruppenbereichen verwalten“ sein. Erfordert den OAuth 2.0-Bereich Diese Methode unterstützt derzeit nur Administratorzugriff. Daher wird für dieses Feld nur |
page_size |
Die maximale Anzahl von Leerzeichen, die zurückgegeben werden sollen. Der Dienst gibt möglicherweise weniger als diesen Wert zurück. Wenn nicht angegeben, werden maximal 100 Leerzeichen zurückgegeben. Der Höchstwert beträgt 1.000. Wenn Sie einen Wert über 1.000 verwenden, wird er automatisch in 1.000 geändert. |
page_token |
Ein Token, das vom vorherigen Aufruf von Gruppenbereichen für die Suche 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. Die Übergabe unterschiedlicher Werte an die anderen Parameter kann zu unerwarteten Ergebnissen führen. |
query |
Erforderlich. Eine Suchanfrage. Sie können mithilfe der folgenden Parameter suchen:
Für Für Für
In verschiedenen Feldern werden nur Bei demselben Feld unterstützt Die folgenden Beispielabfragen sind gültig:
|
order_by |
Optional. Die Reihenfolge der Liste der Gruppenbereiche. Folgende Attribute werden für die Sortierung unterstützt:
Gültige Werte für Sortiervorgänge sind:
Folgende Syntax wird unterstützt:
|
SearchSpacesResponse
Antwort mit einer Liste von Gruppenbereichen, die der Anfrage für Gruppenbereiche entsprechen.
Felder | |
---|---|
spaces[] |
Eine Seite der angeforderten Gruppenbereiche. |
next_page_token |
Ein Token, mit dem die nächste Seite abgerufen werden kann. Wenn dieses Feld leer ist, gibt es keine nachfolgenden Seiten. |
total_size |
Die Gesamtzahl der Gruppenbereiche, die der Suchanfrage entsprechen, auf allen Seiten. Wenn das Ergebnis mehr als 10.000 Leerzeichen beträgt, ist dieser Wert eine Schätzung. |
SetUpSpaceRequest
Anfrage zum Erstellen eines Gruppenbereichs und zum Hinzufügen bestimmter Nutzer.
Felder | |
---|---|
space |
Erforderlich. Wenn Sie einen Gruppenbereich erstellen möchten, setzen Sie Wenn du einen Gruppenchat erstellen möchtest, setze Wenn Sie eine 1:1-Unterhaltung zwischen Personen erstellen möchten, setzen Sie Wenn Sie eine 1:1-Unterhaltung zwischen einem Nutzer und der anrufenden Chat-App erstellen möchten, setzen Sie Wenn bereits ein |
request_id |
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 für einen anderen authentifizierten Nutzer angeben, wird ein Fehler zurückgegeben. |
memberships[] |
Optional. Die Google Chat-Nutzer oder -Gruppen, die in den Gruppenbereich eingeladen werden sollen. Lassen Sie den aufrufenden Nutzer aus, da er automatisch hinzugefügt wird. Derzeit sind zusätzlich zum Anrufer bis zu 20 Mitgliedschaften möglich. Für die menschliche Mitgliedschaft muss das Feld Für die Mitgliedschaft in einer Google-Gruppe muss das Feld Optional, wenn Erforderlich, wenn Erforderlich, wenn Muss leer sein, wenn Sie eine 1:1-Unterhaltung zwischen einem Nutzer und der anrufenden Chat-App erstellen (wenn |
SlashCommand
Einen Slash-Befehl in Google Chat.
Felder | |
---|---|
command_id |
Die ID des aufgerufenen Slash-Befehls. |
SlashCommandMetadata
Annotationsmetadaten für Slash-Befehle (/).
Felder | |
---|---|
bot |
Die Chat-App, deren Befehl aufgerufen wurde. |
type |
Der Typ des Slash-Befehls. |
command_name |
Der Name des aufgerufenen Slash-Befehls. |
command_id |
Die Befehls-ID des aufgerufenen Slash-Befehls. |
triggers_dialog |
Gibt an, ob der Slash-Befehl für ein Dialogfeld bestimmt ist. |
Typ
Enums | |
---|---|
TYPE_UNSPECIFIED |
Standardwert für die Aufzählung. Nicht verwenden. |
ADD |
Fügen Sie dem Gruppenbereich die Chat-App hinzu. |
INVOKE |
Rufen Sie den Slash-Befehl im Leerzeichen auf. |
Leerzeichen
Ein Gruppenbereich in Google Chat. Gruppenbereiche sind Unterhaltungen zwischen zwei oder mehr Nutzern oder 1:1-Nachrichten zwischen einem Nutzer und einer Chat-App.
Felder | |
---|---|
name |
Ressourcenname des Gruppenbereichs. Format: Dabei steht |
type |
Nur Ausgabe. Eingestellt: Verwende stattdessen |
space_type |
Die Art des Gruppenbereichs. Erforderlich beim Erstellen eines Gruppenbereichs oder Aktualisieren des Gruppenbereichstyps. Ausgabe nur für andere Zwecke. |
single_user_bot_dm |
Optional. Gibt an, ob der Gruppenbereich eine DN zwischen einer Chat-App und einem einzelnen Nutzer ist. |
threaded |
Nur Ausgabe. Eingestellt: Verwende stattdessen |
display_name |
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_user_allowed |
Nicht veränderbar. Gibt an, ob für diesen Gruppenbereich alle Google Chat-Nutzer als Mitglied zugelassen sind. Eingabe beim Erstellen eines Gruppenbereichs in einer Google Workspace-Organisation. Lassen Sie dieses Feld weg, wenn Sie unter den folgenden Bedingungen Gruppenbereiche erstellen:
Für vorhandene Gruppenbereiche wird dieses Feld nur für die Ausgabe verwendet. |
space_threading_state |
Nur Ausgabe. Der Status der Unterhaltungsthreads im Chatbereich. |
space_details |
Details zum Gruppenbereich, einschließlich einer Beschreibung und Regeln |
space_history_state |
Der Status des Nachrichtenverlaufs für Nachrichten und Threads in diesem Gruppenbereich. |
import_mode |
Optional. Gibt an, ob dieser Gruppenbereich in |
create_time |
Optional. Nicht veränderbar. Bei Gruppenbereichen, die in Google Chat erstellt wurden, ist dies der Zeitpunkt, zu dem der Gruppenbereich erstellt wurde. Dieses Feld wird nur für die Ausgabe verwendet, es sei denn, es wird in Bereichen im Importmodus verwendet. Legen Sie für Gruppenbereiche im Importmodus für dieses Feld den historischen Zeitstempel fest, zu dem der Gruppenbereich in der Quelle erstellt wurde, um den ursprünglichen Erstellungszeitpunkt beizubehalten. Wird nur in der Ausgabe dargestellt, wenn |
last_active_time |
Nur Ausgabe. Zeitstempel der letzten Nachricht im Gruppenbereich. |
admin_installed |
Nur Ausgabe. Gibt bei Gruppenbereichen mit Direktnachrichten (DM) mit einer Chat-App an, ob der Gruppenbereich von einem Google Workspace-Administrator erstellt wurde. Administratoren können im Namen von Nutzern in ihrer Organisation eine Direktnachricht mit einer Chat-App installieren und einrichten. Damit die Installation durch Administratoren unterstützt wird, muss die Chat-App Direktnachrichten enthalten. |
membership_count |
Nur Ausgabe. Die Anzahl der verbundenen Mitgliedschaften, gruppiert nach Mitgliedstyp. Wird ausgefüllt, wenn |
access_settings |
Optional. Gibt die Zugriffseinstellung des Gruppenbereichs an. Wird nur ausgefüllt, wenn |
space_uri |
Nur Ausgabe. Der URI für einen Nutzer, um auf den Gruppenbereich zuzugreifen. |
Union-Feld space_permission_settings . Stellt die Berechtigungseinstellungen eines Gruppenbereichs dar. Wird nur ausgefüllt, wenn space_type den Wert SPACE hat. Für space_permission_settings ist nur einer der folgenden Werte zulässig: |
|
predefined_permission_settings |
Optional. Nur Eingabe. Berechtigungseinstellungen für den Gruppenbereich. Eingabe zum Erstellen eines Gruppenbereichs. Wenn dieses Feld nicht festgelegt ist, wird ein Gruppenbereich für die Zusammenarbeit erstellt. Nachdem Sie den Gruppenbereich erstellt haben, werden die Einstellungen im Feld |
permission_settings |
Optional. Genaue Berechtigungseinstellungen, die zum Aktualisieren des Gruppenbereichs festgelegt werden können. Eingabe zum Aktualisieren eines Gruppenbereichs. Andernfalls wird nur die Ausgabe ausgegeben. Verwenden Sie zum Erstellen des Gruppenbereichs stattdessen |
AccessSettings
Die Zugriffseinstellung für den Gruppenbereich.
Felder | |
---|---|
access_state |
Nur Ausgabe. Gibt den Zugriffsstatus des Gruppenbereichs an. |
audience |
Optional. Der Ressourcenname der Zielgruppe, die den Gruppenbereich entdecken, ihm beitreten und die Nachrichten im Gruppenbereich als Vorschau ansehen kann. Wenn die Richtlinie nicht konfiguriert 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 Einen Gruppenbereich für eine Zielgruppe sichtbar machen. Format: Wenn Sie die Standardzielgruppe für die Google Workspace-Organisation verwenden möchten, legen Sie |
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 des Gruppenbereichs hat einer Zielgruppe Zugriff auf den Gruppenbereich gewährt. Nutzer oder Google-Gruppen, die einzeln zum Gruppenbereich hinzugefügt oder dazu eingeladen wurden, können den Gruppenbereich ebenfalls finden und darauf zugreifen. Weitere Informationen finden Sie im Hilfeartikel Gruppenbereiche für bestimmte Nutzer sichtbar machen. |
MembershipCount
Felder | |
---|---|
joined_direct_human_user_count |
Anzahl der menschlichen Nutzer, die dem Gruppenbereich direkt beigetreten sind. Nicht berücksichtigt werden Nutzer, die durch Mitgliedschaft in einer verbundenen Gruppe beigetreten sind. |
joined_group_count |
Anzahl aller Gruppen, die dem Gruppenbereich direkt beigetreten sind. |
PermissionSetting
Stellt eine Berechtigungseinstellung für den Gruppenbereich dar.
Felder | |
---|---|
managers_allowed |
Ob Administratoren von Gruppenbereichen diese Berechtigung haben. |
members_allowed |
Gibt an, ob Nutzer, die keine Administratoren sind, diese Berechtigung haben. |
PermissionSettings
Berechtigungseinstellungen für einen benannten Gruppenbereich. Wenn Sie beim Erstellen eines Gruppenbereichs Berechtigungseinstellungen festlegen möchten, geben Sie in Ihrer Anfrage das Feld PredefinedPermissionSettings
an.
Felder | |
---|---|
manage_members_and_groups |
Einstellung zum Verwalten von Mitgliedern und Gruppen in einem Gruppenbereich. |
modify_space_details |
Einstellung zum Aktualisieren des Namens, des Avatars, der Beschreibung und der Richtlinien des Gruppenbereichs. |
toggle_history |
Einstellung zum Aktivieren und Deaktivieren des Gruppenbereichsverlaufs. |
use_at_mention_all |
Einstellung für die Verwendung von @alle in einem Gruppenbereich. |
manage_apps |
Einstellung zum Verwalten von Apps in einem Gruppenbereich. |
manage_webhooks |
Einstellung zum Verwalten von Webhooks in einem Gruppenbereich. |
post_messages |
Nur Ausgabe. Einstellung zum Posten von Nachrichten in einem Gruppenbereich. |
reply_messages |
Einstellung zum Beantworten von Nachrichten in einem Gruppenbereich. |
PredefinedPermissionSettings
Die Berechtigungseinstellungen für den Gruppenbereich, die Sie beim Erstellen eines benannten Gruppenbereichs festlegen können. Weitere Einstellungen werden möglicherweise in Zukunft hinzugefügt. Weitere Informationen zu Berechtigungseinstellungen für benannte Gruppenbereiche finden Sie unter Weitere Informationen zu Gruppenbereichen.
Enums | |
---|---|
PREDEFINED_PERMISSION_SETTINGS_UNSPECIFIED |
Nicht angegeben Nicht verwenden. |
COLLABORATION_SPACE |
Einstellung, um den Gruppenbereich zu einem Gruppenbereich für die Zusammenarbeit zu machen, in dem alle Mitglieder Nachrichten posten können. |
ANNOUNCEMENT_SPACE |
Einstellung, um einen Gruppenbereich für Ankündigungen zu erstellen, in dem nur Administratoren des Gruppenbereichs Nachrichten posten können. |
SpaceDetails
Details zum Gruppenbereich, einschließlich einer Beschreibung und Regeln
Felder | |
---|---|
description |
Optional. Eine Beschreibung des Gruppenbereichs. Beschreiben Sie beispielsweise das Diskussionsthema, den funktionalen Zweck oder die Teilnehmenden des Gruppenbereichs. Unterstützt bis zu 150 Zeichen. |
guidelines |
Optional. Regeln, Erwartungen und Etikette im Raum. Unterstützt bis zu 5.000 Zeichen. |
SpaceThreadingState
Gibt den Typ des Threading-Status im Chatbereich an.
Enums | |
---|---|
SPACE_THREADING_STATE_UNSPECIFIED |
Reserviert. |
THREADED_MESSAGES |
Benannte Gruppenbereiche, die Nachrichtenthreads unterstützen. Wenn Nutzer auf eine Nachricht antworten, können sie innerhalb des Threads antworten, sodass die Antwort im Kontext der ursprünglichen Nachricht bleibt. |
GROUPED_MESSAGES |
Benannte Gruppenbereiche, in denen die Unterhaltung nach Themen geordnet ist. Themen und die dazugehörigen Antworten werden gruppiert. |
UNTHREADED_MESSAGES |
Direktnachrichten (DNs) zwischen zwei Personen und Gruppenunterhaltungen zwischen drei oder mehr Personen. |
SpaceType
Die Art des Gruppenbereichs. Erforderlich, wenn Sie einen Gruppenbereich erstellen oder aktualisieren. Ausgabe nur für andere Zwecke.
Enums | |
---|---|
SPACE_TYPE_UNSPECIFIED |
Reserviert. |
SPACE |
Ein Ort, an dem Nutzer Nachrichten senden, Dateien freigeben und mit anderen zusammenarbeiten. Ein SPACE kann Chat-Apps enthalten. |
GROUP_CHAT |
Gruppenunterhaltungen mit drei oder mehr Personen. Eine GROUP_CHAT kann Chat-Apps enthalten. |
DIRECT_MESSAGE |
1:1-Nachrichten zwischen zwei Personen oder einer Person und einer Chat-App |
Typ
Eingestellt: Verwende stattdessen SpaceType
.
Enums | |
---|---|
TYPE_UNSPECIFIED |
Reserviert. |
ROOM |
Unterhaltungen zwischen zwei oder mehr Menschen. |
DM |
1:1-Direktnachricht zwischen einem Nutzer und einer Chat-App, bei der alle Nachrichten in einer flachen Form dargestellt werden. Dies gilt nicht für Direktnachrichten zwischen zwei Personen. |
SpaceBatchUpdatedEventData
Ereignisnutzlast für mehrere Updates 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-Bereich darstellt. Weitere Informationen finden Sie im Hilfeartikel Mit Terminen aus Google Chat arbeiten.
Felder | |
---|---|
name |
Ressourcenname des Gruppenbereichsereignisses. Format: |
event_time |
Zeitpunkt des Ereignisses. |
event_type |
Art des Raumfahrtereignisses. Für jeden Ereignistyp gibt es eine Batch-Version, die mehrere Instanzen der Ereignisart darstellt, die innerhalb kurzer Zeit auftreten. Lassen Sie bei Unterstützte Ereignistypen für messages:
Unterstützte Ereignistypen für Kanalmitgliedschaften:
Unterstützte Ereignistypen für Reaktionen:
Unterstützte Ereignistypen zum Bereich:
|
Union-Feld Für |
|
message_created_event_data |
Ereignisnutzlast für eine neue Nachricht. Ereignistyp: |
message_updated_event_data |
Ereignisnutzlast für eine aktualisierte Nachricht. Ereignistyp: |
message_deleted_event_data |
Ereignisnutzlast für eine gelöschte Nachricht. Ereignistyp: |
message_batch_created_event_data |
Ereignisnutzlast für mehrere neue Nachrichten. Ereignistyp: |
message_batch_updated_event_data |
Ereignisnutzlast für mehrere aktualisierte Nachrichten. Ereignistyp: |
message_batch_deleted_event_data |
Ereignisnutzlast für mehrere gelöschte Nachrichten. Ereignistyp: |
space_updated_event_data |
Ereignisnutzlast für eine Gruppenbereichsaktualisierung. Ereignistyp: |
space_batch_updated_event_data |
Ereignisnutzlast für mehrere Updates eines Gruppenbereichs. Ereignistyp: |
membership_created_event_data |
Ereignisnutzlast für eine neue Mitgliedschaft. Ereignistyp: |
membership_updated_event_data |
Ereignisnutzlast für eine aktualisierte Mitgliedschaft. Ereignistyp: |
membership_deleted_event_data |
Ereignisnutzlast für eine gelöschte Mitgliedschaft. Ereignistyp: |
membership_batch_created_event_data |
Ereignisnutzlast für mehrere neue Mitgliedschaften. Ereignistyp: |
membership_batch_updated_event_data |
Ereignisnutzlast für mehrere aktualisierte Mitgliedschaften. Ereignistyp: |
membership_batch_deleted_event_data |
Ereignisnutzlast für mehrere gelöschte Mitgliedschaften. Ereignistyp: |
reaction_created_event_data |
Ereignisnutzlast für eine neue Reaktion. Ereignistyp: |
reaction_deleted_event_data |
Ereignisnutzlast für eine gelöschte Reaktion. Ereignistyp: |
reaction_batch_created_event_data |
Ereignisnutzlast für mehrere neue Reaktionen. Ereignistyp: |
reaction_batch_deleted_event_data |
Ereignisnutzlast für mehrere gelöschte Reaktionen. Ereignistyp: |
SpaceReadState
Der Lesestatus eines Nutzers in einem Gruppenbereich. Er dient dazu, gelesene und ungelesene Nachrichten zu identifizieren.
Felder | |
---|---|
name |
Ressourcenname des Lesestatus des Gruppenbereichs. Format: |
last_read_time |
Optional. Der Zeitpunkt, zu dem der Lesestatus des Gruppenbereichs des Nutzers aktualisiert wurde. In der Regel entspricht dies entweder dem Zeitstempel der zuletzt gelesenen Nachricht oder einem Zeitstempel, der vom Nutzer angegeben wurde, um die zuletzt gelesene Position in einem Bereich zu markieren. |
SpaceUpdatedEventData
Ereignisnutzlast für einen aktualisierten Bereich.
Ereignistyp: google.workspace.chat.space.v1.updated
Felder | |
---|---|
space |
Der aktualisierte Gruppenbereich. |
Thread
Thread in einem Google Chat-Bereich. Anwendungsbeispiele finden Sie im Hilfeartikel Unterhaltungen starten oder beantworten.
Wenn Sie beim Erstellen einer Nachricht einen Thread angeben, können Sie über das Feld messageReplyOption
festlegen, was passiert, wenn keine passende Unterhaltung gefunden wird.
Felder | |
---|---|
name |
Ressourcenname des Threads. Beispiel: |
thread_key |
Optional. Eingabe zum Erstellen oder Aktualisieren eines Threads. Andernfalls wird nur die Ausgabe ausgegeben. ID für den Thread. Unterstützt bis zu 4.000 Zeichen. Diese ID ist für die Chat-App eindeutig, durch die sie festgelegt wird. Wenn beispielsweise mehrere Chat-Apps eine Nachricht mit demselben Threadschlüssel erstellen, werden die Nachrichten in verschiedenen Threads gepostet. Wenn Sie in einer Unterhaltung antworten möchten, die von einer Person oder einer anderen Chat-App erstellt wurde, geben Sie stattdessen das Thread-Feld |
ThreadReadState
Der Lesestatus eines Nutzers innerhalb eines Threads, mit dem gelesene und ungelesene Nachrichten identifiziert werden.
Felder | |
---|---|
name |
Ressourcenname des Thread-Lesestatus. Format: |
last_read_time |
Der Zeitpunkt, zu dem der Thread-Lesestatus des Nutzers aktualisiert wurde. In der Regel entspricht dies dem Zeitstempel der letzten gelesenen Nachricht in einem Thread. |
UpdateMembershipRequest
Anfragenachricht zum Aktualisieren einer Mitgliedschaft.
Felder | |
---|---|
membership |
Erforderlich. Die zu aktualisierende Mitgliedschaft. Nur die in „ |
update_mask |
Erforderlich. Die Feldpfade, die aktualisiert werden sollen. Trennen Sie mehrere Werte durch Kommas oder verwenden Sie Derzeit unterstützte Feldpfade:
|
use_admin_access |
true , 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 |
UpdateMessageRequest
Anfrage zum Aktualisieren einer Nachricht.
Felder | |
---|---|
message |
Erforderlich. Nachricht mit aktualisierten Feldern. |
update_mask |
Erforderlich. Die Feldpfade, die aktualisiert werden sollen. Trennen Sie mehrere Werte durch Kommas oder verwenden Sie Derzeit unterstützte Feldpfade:
|
allow_missing |
Optional. Wenn die Nachricht |
UpdateSpaceReadStateRequest
Anfragenachricht für die UpdateSpaceReadState API.
Felder | |
---|---|
space_read_state |
Erforderlich. Der Lesestatus und die zu aktualisierenden Felder des Gruppenbereichs. Unterstützt nur die Aktualisierung des Lesestatus für den aufrufenden Nutzer. Legen Sie einen der folgenden Werte fest, um auf den aufrufenden Nutzer zu verweisen:
Format: users/{user}/spaces/{space}/spaceReadState |
update_mask |
Erforderlich. Die Feldpfade, die aktualisiert werden sollen. Derzeit unterstützte Feldpfade:
Wenn Wenn Sie den Gruppenbereich als gelesen markieren möchten, legen Sie für |
UpdateSpaceRequest
Eine Anfrage zum Aktualisieren eines einzelnen Gruppenbereichs.
Felder | |
---|---|
space |
Erforderlich. Gruppenbereich mit Feldern, die aktualisiert werden sollen. |
update_mask |
Erforderlich. Die aktualisierten Feldpfade, durch Kommas getrennt, wenn es mehrere gibt. Sie können die folgenden Felder für einen Gruppenbereich aktualisieren:
|
use_admin_access |
true , 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 Einige |
Nutzer
Ein Nutzer in Google Chat. Wenn Ihre Chat-App als Ausgabe einer Anfrage als Nutzer authentifiziert wird, füllt die Ausgabe für eine User
-Ressource nur die Werte name
und type
des Nutzers aus.
Felder | |
---|---|
name |
Ressourcenname für eine Google Chat- Format: Für
|
display_name |
Nur Ausgabe. Der Anzeigename des Nutzers. |
domain_id |
Eindeutige Kennung der Google Workspace-Domain des Nutzers. |
type |
Nutzertyp. |
is_anonymous |
Nur Ausgabe. Wenn |
Typ
Enums | |
---|---|
TYPE_UNSPECIFIED |
Standardwert für die Aufzählung. NICHT VERWENDEN. |
HUMAN |
Menschlicher Nutzer. |
BOT |
Chat-App-Nutzer. |
UserMentionMetadata
Annotationsmetadaten für Nutzererwähnungen (@).
Felder | |
---|---|
user |
Der Nutzer hat etwas erwähnt. |
type |
Der Typ der Nutzererwähnung. |
Typ
Enums | |
---|---|
TYPE_UNSPECIFIED |
Standardwert für die Aufzählung. Nicht verwenden. |
ADD |
Nutzer zu Gruppenbereich hinzufügen. |
MENTION |
Nutzer im Gruppenbereich erwähnen. |
WidgetMarkup
Ein Widget ist ein UI-Element, das Text und Bilder darstellt.
Felder | |
---|---|
buttons[] |
Eine Liste mit Schaltflächen. Für die Schaltfläche 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_paragraph |
Textabschnitt in diesem Widget anzeigen. |
image |
Bild in diesem Widget anzeigen. |
key_value |
Zeigt ein Schlüsselwertelement in diesem Widget an. |
Schaltfläche
Eine Schaltfläche. Es kann sich um eine Text- oder eine Bildschaltfläche handeln.
Felder | |
---|---|
Union-Feld Für |
|
text_button |
Eine Schaltfläche mit Text und |
image_button |
Eine Schaltfläche mit einem Bild und der Aktion „ |
FormAction
Mit einer Formularaktion wird das Verhalten beim Senden des Formulars beschrieben. Sie können beispielsweise Apps Script aufrufen, um das Formular zu verarbeiten.
Felder | |
---|---|
action_method_name |
Der Methodenname wird verwendet, um zu identifizieren, welcher Teil des Formulars die Übermittlung des Formulars ausgelöst hat. Diese Informationen werden beim Klick auf eine Karte 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 Aufrufen der Aktionsmethode angegeben werden sollen. Betrachten Sie zum Beispiel drei Schaltflächen für die Schlummerfunktion: "Jetzt pausieren", "Schlummern an einem Tag" und "Schlummern für 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 Aktionsskript. |
value |
Wert des Parameters. |
Symbol
Die Gruppe der 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 |
Die URL des Bildes. |
on_click |
Die Aktion |
aspect_ratio |
Das Seitenverhältnis dieses Bildes (Breite und Höhe). In diesem Feld können Sie die richtige Höhe für das Bild reservieren, während Sie auf das Laden warten. Das integrierte Seitenverhältnis des Bildes wird dadurch nicht überschrieben. Wenn die Richtlinie nicht konfiguriert ist, wird das Bild vom Server per Vorabruf gefüllt. |
ImageButton
Eine Bildschaltfläche mit der Aktion onclick
.
Felder | |
---|---|
on_click |
Die Aktion |
name |
Der Name dieses |
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 von einem |
icon_url |
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 Aktionen wie die Schaltfläche „onclick
“ enthalten.
Felder | |
---|---|
top_label |
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_multiline |
Ob der Inhalt mehrzeilig sein soll. |
bottom_label |
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 |
Die Aktion |
Union-Feld icons . Mindestens eines der Symbole, top_label und bottom_label , muss definiert werden. 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_url |
Das durch eine URL angegebene Symbol. |
Union-Feld control . Ein Kontroll-Widget. Sie können entweder button oder switch_widget festlegen, aber nicht beides. Für control ist nur einer der folgenden Werte zulässig: |
|
button |
Eine Schaltfläche, auf die zum Auslösen einer Aktion geklickt werden kann. |
OnClick
Eine onclick
-Aktion (z. B. Öffnen eines Links)
Felder | |
---|---|
Union-Feld Für |
|
action |
Sofern angegeben, wird durch diese |
open_link |
Diese |
OpenLink
Ein Link, der ein neues Fenster öffnet.
Felder | |
---|---|
url |
Die zu öffnende URL. |
TextButton
Eine Schaltfläche mit Text und der Aktion onclick
.
Felder | |
---|---|
text |
Text der Schaltfläche |
on_click |
Die Aktion „ |
TextParagraph
Ein 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 |
|