- Ressource: Nachricht
- JSON-Darstellung
- Karte
- CardHeader
- ImageStyle
- Abschnitt
- WidgetMarkup
- TextParagraph
- Image
- OnClick
- FormAction
- ActionParameter
- OpenLink
- KeyValue
- Symbol
- Button
- TextButton
- ImageButton
- CardAction
- CardWithId
- Karte
- CardHeader
- ImageType
- Abschnitt
- Widget
- TextParagraph
- TextSyntax
- Image
- OnClick
- Aktion
- ActionParameter
- LoadIndicator
- Interaktion
- OpenLink
- OpenAs
- OnClose
- OverflowMenu
- OverflowMenuItem
- Symbol
- MaterialIcon
- DecoratedText
- VerticalAlignment
- Button
- Farbe
- Typ
- SwitchControl
- ControlType
- ButtonList
- TextInput
- Typ
- Vorschläge
- SuggestionItem
- Validierung
- InputType
- HostAppDataSourceMarkup
- ChatClientDataSourceMarkup
- SpaceDataSource
- WorkflowDataSourceMarkup
- Typ
- SelectionInput
- SelectionType
- SelectionItem
- PlatformDataSource
- CommonDataSource
- DataSourceConfig
- DateTimePicker
- DateTimePickerType
- Trennlinie
- Raster
- GridItem
- ImageComponent
- ImageCropStyle
- ImageCropType
- BorderStyle
- BorderType
- GridItemLayout
- Spalten
- Spalte
- HorizontalSizeStyle
- HorizontalAlignment
- VerticalAlignment
- Widgets
- ChipList
- Layout
- Chip
- Karussell
- CarouselCard
- NestedWidget
- Sichtbarkeit
- EventAction
- Trigger
- CommonWidgetAction
- UpdateVisibilityAction
- CollapseControl
- DividerStyle
- CardAction
- CardFixedFooter
- DisplayStyle
- ExpressionData
- Bedingung
- ExpressionDataCondition
- ConditionType
- Annotation
- AnnotationType
- UserMentionMetadata
- Typ
- SlashCommandMetadata
- Typ
- RichLinkMetadata
- RichLinkType
- DriveLinkData
- ChatSpaceLinkData
- MeetSpaceLinkData
- Typ
- HuddleStatus
- CalendarEventLinkData
- CustomEmojiMetadata
- Thread
- ActionResponse
- ResponseType
- DialogAction
- Dialog
- ActionStatus
- Code
- UpdatedWidget
- SelectionItems
- SlashCommand
- MatchedUrl
- EmojiReactionSummary
- DeletionMetadata
- DeletionType
- QuotedMessageMetadata
- QuoteType
- QuotedMessageSnapshot
- ForwardedMetadata
- AttachedGif
- AccessoryWidget
- Elemente
- CitedSource
- Snippet
- ElementsImage
- Footer
- Citation
- MarkupSyntax
- Methoden
Ressource: Nachricht
Eine Nachricht in einem Google Chat-Bereich.
| JSON-Darstellung |
|---|
{ "name": string, "sender": { object ( |
| Felder | |
|---|---|
name |
ID. 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, werden in der Ausgabe nur die user-Felder |
createTime |
Optional. Nicht veränderbar. Bei in Google Chat erstellten Gruppenbereichen der Zeitpunkt, zu dem die Nachricht erstellt wurde. Dieses Feld dient nur der Ausgabe, außer wenn es in Gruppenbereichen im Importmodus verwendet wird. Legen Sie für Bereiche im Importmodus dieses Feld auf den historischen Zeitstempel fest, zu dem die Nachricht in der Quelle erstellt wurde, um die ursprüngliche Erstellungszeit beizubehalten. |
lastUpdateTime |
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. |
deleteTime |
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. Nur-Text-Inhalt der Nachricht. Der erste Link zu einem Bild, Video oder einer Webseite generiert einen Vorschau-Chip. Sie können auch einen Google Chat-Nutzer oder alle Personen im Gruppenbereich mit@erwähnen. Informationen zum Erstellen von Nachrichten finden Sie unter Nachricht senden. |
formattedText |
Nur Ausgabe. Enthält die Nachricht
Weitere Informationen finden Sie unter Textformatierung in einer Nachricht ansehen. |
cards[] |
Nicht mehr unterstützt: Verwenden Sie stattdessen Umfangreiche, formatierte und interaktive Karten, mit denen Sie UI-Elemente wie formatierten Text, Schaltflächen und anklickbare Bilder anzeigen können. Karten werden normalerweise unter dem Nur-Text-Inhalt der Nachricht angezeigt. |
cardsV2[] |
Optional. Ein Array von Karten. Chat-Apps können Karten mit App-Authentifizierung erstellen. Im Rahmen des Entwicklervorschauprogramms kann Ihre Chat-App Kartennachrichten erstellen, wenn sie sich als Nutzer authentifiziert. Wenn Ihre Chat-App nicht Teil des Entwicklervorschau-Programms ist, können damit keine Karten mit Nutzerauthentifizierung erstellt werden. Informationen zum Erstellen einer Nachricht mit Karten finden Sie unter Nachricht senden. Mit dem Card Builder können Sie Karten entwerfen und in der Vorschau ansehen. Card Builder öffnen |
annotations[] |
Nur Ausgabe. Anmerkungen können mit dem Nur-Text-Inhalt der Nachricht oder mit Chips verknüpft werden, die auf Google Workspace-Ressourcen wie Google Docs oder Google Sheets mit |
thread |
Die Unterhaltung, zu der die Nachricht gehört. Beispiele für die Verwendung finden Sie unter Unterhaltung starten oder auf eine Nachricht antworten. |
space |
Nur Ausgabe. Wenn sich Ihre Chat-App als Nutzer authentifiziert, wird in der Ausgabe nur der Gruppenbereich |
fallbackText |
Optional. Eine Nur-Text-Beschreibung der Karten der Nachricht, die verwendet wird, wenn die eigentlichen Karten nicht angezeigt werden können, z. B. bei mobilen Benachrichtigungen. |
actionResponse |
Nur Eingabe. Parameter, mit denen eine Chat-App konfigurieren kann, wie ihre Antwort gepostet wird. |
argumentText |
Nur Ausgabe. Nur-Text-Inhalt der Nachricht, wobei alle Erwähnungen der Chat-App entfernt wurden. |
slashCommand |
Nur Ausgabe. Informationen zum Slash-Befehl, falls zutreffend. |
attachment[] |
Optional. Vom Nutzer hochgeladener Anhang. |
matchedUrl |
Nur Ausgabe. Eine URL im Feld |
threadReply |
Nur Ausgabe. Wenn Wenn der Gruppenbereich keine Antworten in Threads unterstützt, ist dieses Feld immer |
silent |
Nur Ausgabe. Gibt an, ob es sich um eine lautlose Nachricht handelt. Lautlose Nachrichten sind Nachrichten, bei denen Google Chat Push-Benachrichtigungen für Empfänger unterdrückt. |
clientAssignedMessageId |
Optional. Eine benutzerdefinierte ID für die Nachricht. Sie können das Feld verwenden, um eine Nachricht zu identifizieren oder um 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 |
emojiReactionSummaries[] |
Nur Ausgabe. Die Liste der Zusammenfassungen von Emoji-Reaktionen auf die Nachricht. |
privateMessageViewer |
Optional. Nicht veränderbar. Eingabe zum Erstellen einer Nachricht, andernfalls nur Ausgabe. Der Nutzer, der die Nachricht sehen kann. Wenn dieses Feld festgelegt ist, ist die Nachricht privat und nur für den angegebenen Nutzer und die Chat-App sichtbar. Wenn Sie dieses Feld in Ihre Anfrage aufnehmen möchten, müssen Sie die Chat API mit der App-Authentifizierung aufrufen und Folgendes weglassen: Weitere Informationen finden Sie unter Private Nachrichten senden. |
deletionMetadata |
Nur Ausgabe. Informationen zu einer gelöschten Nachricht. Eine Nachricht wird gelöscht, wenn |
quotedMessageMetadata |
Optional. Informationen zu einer Nachricht, die in einer anderen Nachricht zitiert wird. Wenn Sie eine Nachricht erstellen, können Sie Nachrichten innerhalb desselben Threads zitieren oder eine Stammnachricht zitieren, um eine neue Stammnachricht zu erstellen. Sie können jedoch keine Antwort auf eine Nachricht aus einem anderen Thread zitieren. Wenn Sie eine Nachricht aktualisieren, können Sie das Feld Ein Beispiel für die Verwendung finden Sie unter Andere Nachricht zitieren. |
attachedGifs[] |
Nur Ausgabe. GIF-Bilder, die an die Nachricht angehängt sind. |
accessoryWidgets[] |
Optional. Ein oder mehrere interaktive Widgets, die unten in einer Nachricht angezeigt werden. Sie können Nachrichten, die Text, Karten oder beides enthalten, Zubehör-Widgets hinzufügen. Nicht unterstützt für Nachrichten, die Dialoge enthalten. Weitere Informationen finden Sie unter Interaktive Widgets am Ende einer Nachricht hinzufügen. Zum Erstellen einer Nachricht mit Zubehör-Widgets ist eine App-Authentifizierung erforderlich. |
elements |
Optional. Elemente sind zusätzliche Komponenten, die beim Erstellen von Nachrichten bereitgestellt werden und mit bestimmten Teilen des Nachrichtentexts verknüpft sein können. Diese unterscheiden sich von Annotationen, die nur ausgegeben werden und zusätzliche Informationen zu Nachrichtenfragmenten oder dem gesamten Nachrichtentext enthalten. |
markupSyntax |
Optional. Gibt an, wie der Server den Inhalt des Nachrichtenfelds |
CardWithId
Eine Karte in einer Google Chat-Nachricht.
Chat-Apps können Karten mit App-Authentifizierung erstellen. Im Rahmen des Entwicklervorschauprogramms kann Ihre Chat-App Kartennachrichten erstellen, wenn sie sich als Nutzer authentifiziert. Wenn Ihre Chat-App nicht Teil des Entwicklervorschau-Programms ist, können damit keine Karten mit Nutzerauthentifizierung erstellt werden.
Informationen zum Erstellen einer Nachricht mit Karten finden Sie unter Nachricht senden.
Mit dem Card Builder können Sie Karten entwerfen und in der Vorschau ansehen.
Karten-Builder öffnen| JSON-Darstellung |
|---|
{ "cardId": string, "card": { object ( |
| Felder | |
|---|---|
cardId |
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. |
ownerUser |
Nur Ausgabe. Die App, zu der die Karte gehört. |
Vermerk
Anmerkungen können mit dem Nur-Text-Inhalt der Nachricht oder mit Chips verknüpft werden, die auf Google Workspace-Ressourcen wie Google Docs oder Google Sheets mit startIndex und length von 0 verweisen. Informationen zum Hinzufügen einer einfachen Formatierung zu einer Textnachricht finden Sie unter Textnachrichten formatieren.
Beispiel für einen Nur-Text-Nachrichtentext:
Hello @FooBot how are you!"
Die entsprechenden Annotationsmetadaten:
"annotations":[{
"type":"USER_MENTION",
"startIndex":6,
"length":7,
"userMention": {
"user": {
"name":"users/{user}",
"displayName":"FooBot",
"avatarUrl":"https://goo.gl/aeDtrS",
"type":"BOT"
},
"type":"MENTION"
}
}]
| JSON-Darstellung |
|---|
{ "type": enum ( |
| Felder | |
|---|---|
type |
Der Typ dieser Annotation. |
length |
Länge des Teilstrings im Nur-Text-Inhalt der Nachricht, dem diese Annotation entspricht. Wenn nicht vorhanden, wird eine Länge von 0 angegeben. |
startIndex |
Startindex (0-basiert, einschließlich) im Nur-Text-Nachrichtentext, dem diese Annotation entspricht. |
| Zusätzliche Metadaten zur Annotation. Im Folgenden finden Sie eine Liste der Felder, die sich gegenseitig ausschließen. In einer Antwort wird höchstens eines der Felder festgelegt: | |
userMention |
Die Metadaten der Nutzererwähnung. |
slashCommand |
Die Metadaten für einen Slash-Befehl. |
richLinkMetadata |
Die Metadaten für einen Rich-Link. |
customEmojiMetadata |
Die Metadaten für ein benutzerdefiniertes Emoji. |
| Ende der sich gegenseitig ausschließenden Felder. | |
AnnotationType
Typ der Annotation.
| Enums | |
|---|---|
ANNOTATION_TYPE_UNSPECIFIED |
Standardwert für das Enum. Nicht verwenden. |
USER_MENTION |
Ein Nutzer wird erwähnt. |
SLASH_COMMAND |
Ein Slash-Befehl wird aufgerufen. |
RICH_LINK |
Eine Annotation für einen Link mit zusätzlichen Funktionen. |
CUSTOM_EMOJI |
Eine benutzerdefinierte Emoji-Anmerkung. |
UserMentionMetadata
Anmerkungsmetadaten für Nutzererwähnungen (@).
| JSON-Darstellung |
|---|
{ "user": { object ( |
| Felder | |
|---|---|
user |
Der erwähnte Nutzer. |
type |
Der Typ der Nutzererwähnung. |
Typ
| Enums | |
|---|---|
TYPE_UNSPECIFIED |
Standardwert für das Enum. Nicht verwenden. |
ADD |
Nutzer zum Gruppenbereich hinzufügen |
MENTION |
Nutzer im Gruppenbereich erwähnen. |
SlashCommandMetadata
Anmerkungsmetadaten für Slash-Befehle (/).
| JSON-Darstellung |
|---|
{ "bot": { object ( |
| Felder | |
|---|---|
bot |
Die Chat-App, deren Befehl aufgerufen wurde. |
type |
Der Typ des Slash-Befehls. |
commandName |
Der Name des aufgerufenen Slash-Befehls. |
commandId |
Die Befehls-ID des aufgerufenen Slash-Befehls. |
triggersDialog |
Gibt an, ob der Slash-Befehl für einen Dialog ist. |
Typ
| Enums | |
|---|---|
TYPE_UNSPECIFIED |
Standardwert für das Enum. Nicht verwenden. |
ADD |
Fügen Sie die Chat-App dem Gruppenbereich hinzu. |
INVOKE |
Slash-Befehl in einem Gruppenbereich aufrufen. |
RichLinkMetadata
Ein Rich-Link zu einer Ressource. Rich-Links können mit dem Nur-Text-Inhalt der Nachricht verknüpft sein oder Chips darstellen, die auf Google Workspace-Ressourcen wie Google Docs oder Google Sheets mit startIndex und length von 0 verweisen.
| JSON-Darstellung |
|---|
{ "uri": string, "richLinkType": enum ( |
| Felder | |
|---|---|
uri |
Der URI dieses Links. |
richLinkType |
Der Typ des Rich-Links. |
| Daten für die verknüpfte Ressource. Im Folgenden finden Sie eine Liste der Felder, die sich gegenseitig ausschließen. In einer Antwort wird höchstens eines der Felder festgelegt: | |
driveLinkData |
Daten für einen Drive-Link. |
chatSpaceLinkData |
Daten für einen Link zu einem Chatbereich. |
meetSpaceLinkData |
Daten für einen Meet-Raum-Link. |
calendarEventLinkData |
Daten für einen Kalendertermin-Link. |
| Ende der sich gegenseitig ausschließenden Felder. | |
RichLinkType
Der Typ des Rich-Links. In Zukunft werden möglicherweise weitere Typen hinzugefügt.
| Enums | |
|---|---|
RICH_LINK_TYPE_UNSPECIFIED |
Standardwert für das Enum. Nicht verwenden. |
DRIVE_FILE |
Ein Typ für Rich-Links in Google Drive. |
CHAT_SPACE |
Ein Rich-Link-Typ für Google Chat-Bereiche. Beispiel: ein Smartchip für einen Gruppenbereich. |
GMAIL_MESSAGE |
Ein Rich-Link-Typ für Gmail-Nachrichten. Konkret geht es um einen Gmail-Chip aus In Chat teilen. Die API unterstützt nur das Lesen von Nachrichten mit GMAIL_MESSAGE-Rich-Links. |
MEET_SPACE |
Ein Rich-Link-Typ für Meet-Nachrichten. Beispiel: ein Meet-Chip. |
CALENDAR_EVENT |
Ein Rich-Link-Typ für Kalendernachrichten. Beispiel: ein Kalender-Chip. |
DriveLinkData
Daten für Google Drive-Links.
| JSON-Darstellung |
|---|
{
"driveDataRef": {
object ( |
| Felder | |
|---|---|
driveDataRef |
Ein DriveDataRef, der auf eine Google Drive-Datei verweist. |
mimeType |
Der MIME-Typ der verknüpften Google Drive-Ressource. |
ChatSpaceLinkData
Daten für Links zu Chatbereichen.
| JSON-Darstellung |
|---|
{ "space": string, "thread": string, "message": string } |
| 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: |
MeetSpaceLinkData
Daten für Meet-Konferenzraumlinks.
| JSON-Darstellung |
|---|
{ "meetingCode": string, "type": enum ( |
| Felder | |
|---|---|
meetingCode |
Besprechungscode des verknüpften Meet-Konferenzraums. |
type |
Gibt den Typ des Konferenzraums an. |
huddleStatus |
Optional. Nur Ausgabe. Wenn es sich bei der Meet-Besprechung um ein Huddle handelt, wird der Status des Huddles angezeigt. Andernfalls ist dieser Wert nicht festgelegt. |
Typ
Der Typ des Meet-Bereichs.
| Enums | |
|---|---|
TYPE_UNSPECIFIED |
Standardwert für das Enum. Nicht verwenden. |
MEETING |
Der Meet-Bereich ist eine Videokonferenz. |
HUDDLE |
Der Meet-Bereich ist ein Huddle. |
HuddleStatus
Status des Huddles
| Enums | |
|---|---|
HUDDLE_STATUS_UNSPECIFIED |
Standardwert für das Enum. Nicht verwenden. |
STARTED |
Das Huddle hat begonnen. |
ENDED |
Das Huddle wurde beendet. In diesem Fall sind die URI und die IDs des Meet-Bereichs nicht mehr gültig. |
MISSED |
Das Huddle wurde verpasst. In diesem Fall sind die URI und die IDs des Meet-Bereichs nicht mehr gültig. |
CalendarEventLinkData
Daten für Links zu Kalenderterminen.
| JSON-Darstellung |
|---|
{ "calendarId": string, "eventId": string } |
| Felder | |
|---|---|
calendarId |
Die Kalender-ID des verknüpften Kalenders. |
eventId |
Die Termin-ID des verknüpften Kalendertermins. |
CustomEmojiMetadata
Anmerkungsmetadaten für benutzerdefinierte Emojis.
| JSON-Darstellung |
|---|
{
"customEmoji": {
object ( |
| Felder | |
|---|---|
customEmoji |
Das benutzerdefinierte Emoji. |
Thread
Ein Thread in einem Google Chat-Gruppenbereich. Beispiele für die Verwendung finden Sie unter Unterhaltung starten oder auf eine Nachricht antworten.
Wenn Sie beim Erstellen einer Nachricht einen Thread angeben, können Sie im Feld messageReplyOption festlegen, was passiert, wenn kein übereinstimmender Thread gefunden wird.
| JSON-Darstellung |
|---|
{ "name": string, "threadKey": string } |
| Felder | |
|---|---|
name |
ID. Ressourcenname des Threads. Beispiel: |
threadKey |
Optional. Eingabe zum Erstellen oder Aktualisieren eines Threads. Andernfalls nur Ausgabe. 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 Threadschlü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-Feld |
ActionResponse
Parameter, mit denen eine Chat-App konfigurieren kann, wie ihre Antwort gepostet wird.
| JSON-Darstellung |
|---|
{ "type": enum ( |
| Felder | |
|---|---|
type |
Nur Eingabe. Der Typ der Chat-App-Antwort. |
url |
Nur Eingabe. URL für die Authentifizierung oder Konfiguration durch Nutzer. (Nur für Antworttypen vom Typ |
dialogAction |
Nur Eingabe. Eine Antwort auf ein Interaktionsereignis im Zusammenhang mit einem Dialog. Muss zusammen mit |
updatedWidget |
Nur Eingabe. Die Antwort des aktualisierten Widgets. |
ResponseType
Der Typ der Chat-App-Antwort.
| Enums | |
|---|---|
TYPE_UNSPECIFIED |
Standardtyp, der als NEW_MESSAGE behandelt wird. |
NEW_MESSAGE |
Als neue Nachricht im Thema posten. |
UPDATE_MESSAGE |
Aktualisieren Sie die Nachricht der Chat-App. Dies ist nur bei einem CARD_CLICKED-Ereignis zulässig, bei dem der Absendertyp der Nachricht BOT ist. |
UPDATE_USER_MESSAGE_CARDS |
Aktualisieren Sie die Karten in der Nachricht eines Nutzers. 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 |
Nutzer privat um zusätzliche Authentifizierung oder Konfiguration bitten. |
DIALOG |
Zeigt ein Dialogfeld an. |
UPDATE_WIDGET |
Abfrage der Optionen für die automatische Vervollständigung von Widget-Text. |
DialogAction
Enthält einen Dialog und einen Anfragestatuscode.
| JSON-Darstellung |
|---|
{ "actionStatus": { object ( |
| Felder | |
|---|---|
actionStatus |
Nur Eingabe. Status einer Anfrage zum Aufrufen oder Senden eines Dialogfelds. Zeigt Nutzern bei Bedarf einen Status und eine Nachricht an. Beispielsweise im Falle eines Fehlers oder Erfolgs. |
| Auszuführende Aktion. Im Folgenden finden Sie eine Liste der Felder, die sich gegenseitig ausschließen. In einer Antwort wird höchstens eines der Felder festgelegt: | |
dialog |
Nur Eingabe. Dialog für die Anfrage. |
| Ende der sich gegenseitig ausschließenden Felder. | |
Dialog
Wrapper um den Kartentext des Dialogfelds.
| JSON-Darstellung |
|---|
{
"body": {
object ( |
| Felder | |
|---|---|
body |
Nur Eingabe. Text des Dialogfelds, der in einem modalen Fenster gerendert wird. Google Chat-Apps unterstützen die folgenden Kartenentitäten nicht: |
ActionStatus
Stellt den Status einer Anfrage zum Aufrufen oder Senden eines Dialogfelds dar.
| JSON-Darstellung |
|---|
{
"statusCode": enum ( |
| Felder | |
|---|---|
statusCode |
Der Statuscode. |
userFacingMessage |
Die Nachricht, die Nutzer zum Status ihrer Anfrage erhalten sollen. Wenn nicht festgelegt, wird eine allgemeine Nachricht basierend auf dem |
Code
Die kanonischen Fehlercodes für gRPC APIs.
Manchmal können mehrere Fehlercodes zutreffen. Dienste sollten den spezifischsten Fehlercode liefern, der zutrifft. Beispiel: OUT_OF_RANGE sollte gegenüber FAILED_PRECONDITION bevorzugt werden, wenn beide Codes zutreffen. Entsprechend ist NOT_FOUND oder ALREADY_EXISTS gegenüber FAILED_PRECONDITION vorzuziehen.
| Enums | |
|---|---|
OK |
Kein Fehler; wird bei Erfolg angezeigt HTTP Mapping: 200 OK |
CANCELLED |
Der Vorgang wurde abgebrochen, üblicherweise vom Aufrufer. HTTP Mapping: 499 Client Closed Request |
UNKNOWN |
Unbekannter Fehler. Dieser Fehler wird z. B. angezeigt, wenn ein von einem anderen Adressbereich erhaltener HTTP-Mapping: 500 Interner Serverfehler |
INVALID_ARGUMENT |
Der Client hat ein ungültiges Argument angegeben. Dieser Wert ist nicht identisch mit HTTP Mapping: 400 Bad Request |
DEADLINE_EXCEEDED |
Die Frist ist abgelaufen, bevor der Vorgang abgeschlossen werden konnte. Bei Vorgängen, die den Systemstatus verändern, kann dieser Fehler angezeigt werden, auch wenn der Vorgang erfolgreich abgeschlossen wurde. Zum Beispiel könnte eine erfolgreiche Antwort von einem Server so lange verzögert worden sein, dass die Frist abgelaufen ist. HTTP Mapping: 504 Gateway Timeout |
NOT_FOUND |
Eine angeforderte Entität (z. B. Datei oder Verzeichnis) wurde nicht gefunden. Hinweis für Serverentwickler: Wenn eine Anfrage, z. B. eine schrittweise Einführung von Funktionen oder eine undokumentierte Zulassungsliste, für eine gesamte Nutzerklasse abgelehnt wird, kann HTTP-Zuordnung: 404 Nicht gefunden |
ALREADY_EXISTS |
Die Entität, die ein Client erstellen wollte (z. B. eine Datei oder ein Verzeichnis), ist bereits vorhanden. HTTP Mapping: 409 Conflict |
PERMISSION_DENIED |
Der Aufrufer hat keine Berechtigung zur Ausführung des angegebenen Vorgangs. HTTP Mapping: 403 Forbidden |
UNAUTHENTICATED |
Die Anfrage enthält keine gültigen Authentifizierungsdaten für diesen Vorgang. HTTP Mapping: 401 Unauthorized |
RESOURCE_EXHAUSTED |
Eine Ressource, z. B. ein nutzerbezogenes Kontingent, ist erschöpft oder der Speicherplatz für das gesamte Dateisystem ist ausgegangen. HTTP Mapping: 429 Too Many Requests |
FAILED_PRECONDITION |
Der Vorgang wurde abgelehnt, weil der Systemzustand nicht für die Ausführung des Vorgangs geeignet ist. Beispielsweise ist das zu löschende Verzeichnis nicht leer, ein rmdir-Vorgang wird auf eine Ressource angewendet, die kein Verzeichnis ist, usw. Dienstimplementierungen können anhand der folgenden Richtlinien zwischen HTTP Mapping: 400 Bad Request |
ABORTED |
Der Vorgang wurde abgebrochen, in der Regel aufgrund eines Parallelitätsproblems wie einer fehlgeschlagenen Sequencer-Überprüfung oder einer abgebrochenen Transaktion. Siehe obige Richtlinien zum Abwägen zwischen HTTP Mapping: 409 Conflict |
OUT_OF_RANGE |
Beim Vorgang wurde versucht, den gültigen Bereich zu überschreiten. Beispiel: Such- oder Lesevorgang über das Dateiende hinaus. Im Gegensatz zu Es gibt einige Überschneidungen zwischen HTTP Mapping: 400 Bad Request |
UNIMPLEMENTED |
Dieser Vorgang ist nicht implementiert oder wird bei diesem Dienst nicht unterstützt bzw. ist bei diesem Dienst nicht aktiviert. HTTP Mapping: 501 Not Implemented |
INTERNAL |
Interne Fehler. Das bedeutet, dass einige Invarianten, die vom zugrunde liegenden System erwartet werden, nicht erfüllt wurden. Dieser Fehlercode ist für schwerwiegende Fehler reserviert. HTTP-Mapping: 500 Interner Serverfehler |
UNAVAILABLE |
Der Dienst ist derzeit nicht verfügbar. Dies ist höchstwahrscheinlich ein vorübergehender Zustand, der durch Wiederholen mit einem Backoff korrigiert werden kann. Es ist nicht immer sicher, nicht idempotente Vorgänge zu wiederholen. Siehe obige Richtlinien zum Abwägen zwischen HTTP Mapping: 503 Service Unavailable |
DATA_LOSS |
Nicht wiederherstellbarer Datenverlust oder Datenkorruption. HTTP-Mapping: 500 Interner Serverfehler |
UpdatedWidget
Gibt für selectionInput-Widgets automatisch vervollständigte Vorschläge für ein Menü mit Mehrfachauswahl zurück.
| JSON-Darstellung |
|---|
{
"widget": string,
// The following is a list of mutually exclusive fields. At most one of the
// fields will be set in a response:
"suggestions": {
object ( |
| Felder | |
|---|---|
widget |
Die ID des aktualisierten Widgets. Die ID muss mit der ID des Widgets übereinstimmen, das die Aktualisierungsanfrage ausgelöst hat. |
| Das Widget wurde als Reaktion auf eine Nutzeraktion aktualisiert. Im Folgenden finden Sie eine Liste der Felder, die sich gegenseitig ausschließen. In einer Antwort wird höchstens eines der Felder festgelegt: | |
suggestions |
Liste der automatisch vervollständigten Widget-Ergebnisse |
| Ende der sich gegenseitig ausschließenden Felder. | |
SelectionItems
Liste der Ergebnisse der automatischen Vervollständigung des Widgets.
| JSON-Darstellung |
|---|
{
"items": [
{
object ( |
| Felder | |
|---|---|
items[] |
Ein Array von SelectionItem-Objekten. |
SlashCommand
Metadaten zu einem Slash-Befehl in Google Chat.
| JSON-Darstellung |
|---|
{ "commandId": string } |
| Felder | |
|---|---|
commandId |
Die ID des Slash-Befehls. |
MatchedUrl
Eine übereinstimmende URL in einer Chatnachricht. Chat-Apps können eine Vorschau von übereinstimmenden URLs anzeigen. Weitere Informationen finden Sie unter Vorschau von Links anzeigen.
| JSON-Darstellung |
|---|
{ "url": string } |
| Felder | |
|---|---|
url |
Nur Ausgabe. Die URL, die übereinstimmt. |
EmojiReactionSummary
Die Anzahl der Personen, die mit einem bestimmten Emoji auf eine Nachricht reagiert haben.
| JSON-Darstellung |
|---|
{
"emoji": {
object ( |
| Felder | |
|---|---|
emoji |
Nur Ausgabe. Emoji, das mit den Reaktionen verknüpft ist. |
reactionCount |
Nur Ausgabe. Die Gesamtzahl der Reaktionen mit dem zugehörigen Emoji. |
DeletionMetadata
Informationen zu einer gelöschten Nachricht. Eine Nachricht wird gelöscht, wenn deleteTime festgelegt ist.
| JSON-Darstellung |
|---|
{
"deletionType": enum ( |
| Felder | |
|---|---|
deletionType |
Gibt an, wer die Nachricht gelöscht hat. |
DeletionType
Wer die Nachricht gelöscht hat und wie sie gelöscht wurde. In Zukunft werden möglicherweise weitere Werte hinzugefügt. Weitere Informationen dazu, wann Nachrichten gelöscht werden können, finden Sie im Hilfeartikel Nachrichten in Google Chat bearbeiten oder löschen.
| Enums | |
|---|---|
DELETION_TYPE_UNSPECIFIED |
Dieser Wert wird nicht verwendet. |
CREATOR |
Der Nutzer hat seine eigene Nachricht gelöscht. |
SPACE_OWNER |
Ein Inhaber oder Manager hat die Nachricht gelöscht. |
ADMIN |
Ein Google Workspace-Administrator hat die Nachricht gelöscht. Administratoren können jede Nachricht im Gruppenbereich löschen, einschließlich Nachrichten, die von einem Mitglied des Gruppenbereichs oder einer Chat-App gesendet wurden. |
APP_MESSAGE_EXPIRY |
Eine Chat-App hat ihre eigene Nachricht gelöscht, als sie abgelaufen ist. |
CREATOR_VIA_APP |
Eine Chat-App hat die Nachricht im Namen des Erstellers gelöscht (über die Nutzerauthentifizierung). |
SPACE_OWNER_VIA_APP |
Eine Chat-App hat die Nachricht im Namen eines Administrators des Gruppenbereichs gelöscht (über die Nutzerauthentifizierung). |
SPACE_MEMBER |
Ein Mitglied des Gruppenbereichs hat die Nachricht gelöscht. Nutzer können von Apps gesendete Nachrichten löschen. |
QuotedMessageMetadata
Informationen zu einer Nachricht, die in einer anderen Nachricht zitiert wird.
Wenn Sie eine Nachricht aktualisieren, können Sie das Feld quotedMessageMetadata nicht hinzufügen oder ersetzen, aber Sie können es entfernen.
Ein Beispiel für die Verwendung finden Sie unter Andere Nachricht zitieren.
| JSON-Darstellung |
|---|
{ "name": string, "lastUpdateTime": string, "quoteType": enum ( |
| Felder | |
|---|---|
name |
Erforderlich. Ressourcenname der zitierten Nachricht. Format: |
lastUpdateTime |
Erforderlich. Der Zeitstempel, der angibt, wann die zitierte Nachricht erstellt oder zuletzt aktualisiert wurde. Wenn die Nachricht bearbeitet wurde, verwenden Sie dieses Feld: Wenn |
quoteType |
Optional. Gibt den Angebotstyp an. Wenn nicht festgelegt, wird aus Gründen der Abwärtskompatibilität standardmäßig REPLY im Lese-/Schreibpfad der Nachricht verwendet. |
quotedMessageSnapshot |
Nur Ausgabe. Eine Momentaufnahme des Inhalts der zitierten Nachricht. |
forwardedMetadata |
Nur Ausgabe. Metadaten zum Quell-Space der zitierten Nachricht. Wird nur für den Angebotstyp FORWARD ausgefüllt. |
QuoteType
Der Typ des Zitats der zitierten Nachricht.
| Enums | |
|---|---|
QUOTE_TYPE_UNSPECIFIED |
Reserviert. Dieser Wert wird nicht verwendet. |
REPLY |
Wenn
|
FORWARD |
Wenn
|
QuotedMessageSnapshot
Bietet eine Momentaufnahme des Inhalts der zitierten Nachricht zum Zeitpunkt des Zitierens oder Weiterleitens
| JSON-Darstellung |
|---|
{ "sender": string, "text": string, "formattedText": string, "annotations": [ { object ( |
| Felder | |
|---|---|
sender |
Nur Ausgabe. Der Name des Autors der zitierten Nachricht. Wird sowohl für die Zitattypen REPLY als auch FORWARD ausgefüllt. |
text |
Nur Ausgabe. Snapshot des Textinhalts der zitierten Nachricht. |
formattedText |
Nur Ausgabe. Enthält die zitierte Nachricht |
annotations[] |
Nur Ausgabe. Anmerkungen, die aus dem Text der zitierten Nachricht geparst wurden. Wird nur für den Angebotstyp FORWARD ausgefüllt. |
attachments[] |
Nur Ausgabe. Anhänge, die Teil der zitierten Nachricht waren. Dies sind Kopien der Anhangsmetadaten der zitierten Nachricht. Wird nur für den Angebotstyp FORWARD ausgefüllt. |
ForwardedMetadata
Metadaten zum Quell-Space, aus dem eine Nachricht weitergeleitet wurde.
| JSON-Darstellung |
|---|
{ "space": string, "spaceDisplayName": string } |
| Felder | |
|---|---|
space |
Nur Ausgabe. Der Ressourcenname des Quell-Space. Format: spaces/{space} |
spaceDisplayName |
Nur Ausgabe. Der Anzeigename des Quell-Space oder der Quell-DM zum Zeitpunkt der Weiterleitung. Bei |
AttachedGif
Ein GIF-Bild, das durch eine URL angegeben wird.
| JSON-Darstellung |
|---|
{ "uri": string } |
| Felder | |
|---|---|
uri |
Nur Ausgabe. Die URL, unter der das GIF-Bild gehostet wird. |
AccessoryWidget
Ein oder mehrere interaktive Widgets, die unten in einer Nachricht angezeigt werden. Weitere Informationen finden Sie unter Interaktive Widgets am Ende einer Nachricht hinzufügen.
| JSON-Darstellung |
|---|
{
// The following is a list of mutually exclusive fields. At most one of the
// fields will be set in a response:
"buttonList": {
object ( |
| Felder | |
|---|---|
| Die Art der Aktion. Im Folgenden finden Sie eine Liste der Felder, die sich gegenseitig ausschließen. In einer Antwort wird höchstens eines der Felder festgelegt: | |
buttonList |
Eine Liste mit Schaltflächen. |
| Ende der sich gegenseitig ausschließenden Felder. | |
Elemente
| JSON-Darstellung |
|---|
{ "citedSources": [ { object ( |
| Felder | |
|---|---|
citedSources[] |
Eine Liste von Quellen, die unter der Nachricht als Links in der Fußzeile angezeigt werden sollen. Diese werden nicht inline referenziert. Verwenden Sie für Inline-Verweise |
citations[] |
Eine Liste von Inline-Quellenangaben, auf die im Nachrichtentext (über |
CitedSource
| JSON-Darstellung |
|---|
{ "title": string, "uri": string, "snippet": { object ( |
| Felder | |
|---|---|
title |
Erforderlich. Der Klartext-Titel des |
uri |
Erforderlich. Der URI, der auf die Ressource verweist, auf die sich dieses |
snippet |
Optional. Snippet mit Informationen direkt aus der Quelle. |
footer |
Optional. Zusätzliche Informationen, die neben dem Snippet in Form einer Fußzeile angezeigt werden sollen. |
Snippet
| JSON-Darstellung |
|---|
{
"text": string,
"imagePreview": {
object ( |
| Felder | |
|---|---|
text |
Optional. Ein kurzer Klartextauszug direkt aus dem Korpus, der in Google Chat gerendert werden kann. Das Markdown-Format wird nicht unterstützt. |
imagePreview |
Optional. Bildvorschau des Snippets, das beim Erstellen des Zitats als Eingabe bereitgestellt wurde. |
ElementsImage
| JSON-Darstellung |
|---|
{ "imageUri": string } |
| Felder | |
|---|---|
| Erforderlich. Eine der unterstützten Bilddarstellungen. Im Folgenden finden Sie eine Liste der Felder, die sich gegenseitig ausschließen. In einer Antwort wird höchstens eines der Felder festgelegt: | |
imageUri |
Erforderlich. Ein öffentlich zugänglicher URI für ein Bild. |
| Ende der sich gegenseitig ausschließenden Felder. | |
Zitation
<chat-citation data-id="{id}">{text}</chat-citation> vorhanden sein. Zitate werden nur unterstützt, wenn markupSyntax der Nachricht auf MARKDOWN gesetzt ist.Nicht referenzierte Zitate in Elements.citations (ohne entsprechendes <chat-citation>-Tag im Nachrichtentext) werden ignoriert und führen nicht dazu, dass die Nachricht abgelehnt wird.
| JSON-Darstellung |
|---|
{
"id": string,
"citedSources": [
{
object ( |
| Felder | |
|---|---|
id |
Erforderlich. Von der App definierte ID. Darf nur ASCII-Buchstaben und -Ziffern enthalten und muss weniger als 63 Zeichen lang sein. |
citedSources[] |
Optional. Eine Liste von Quellen, die für die Zitation relevant sind. Quellen werden in der Kurzinfo für Zitate angezeigt. |
MarkupSyntax
Gibt die Markup-Syntax an, die zum Formatieren des Textes der Chatnachricht verwendet wird. Gilt für das Feld text der Ressource Message.
| Enums | |
|---|---|
MARKUP_SYNTAX_UNSPECIFIED |
Stellt den nicht angegebenen Wert dar. |
MARKUP_SYNTAX_CHAT |
Verwendet die Markup-Syntax von Google Chat. Weitere Informationen finden Sie unter https://developers.google.com/workspace/chat/format-messages#format-texts. |
MARKUP_SYNTAX_MARKDOWN |
Verwendet Markdown-Syntax. Diese Syntax basiert auf der CommonMark-Spezifikation mit zusätzlichen Erweiterungen. Weitere Informationen finden Sie unter https://developers.google.com/workspace/chat/format-messages#format-texts. |
Methoden |
|
|---|---|
|
Erstellt eine Nachricht in einem Google Chat-Bereich. |
|
Löscht eine Nachricht. |
|
Gibt Details zu einer Nachricht zurück. |
|
Listet Nachrichten in einem Gruppenbereich auf, in dem der Aufrufer Mitglied ist, einschließlich Nachrichten von blockierten Mitgliedern und Gruppenbereichen. |
|
Aktualisiert eine Nachricht. |
|
Ersetzt die in einer Nachricht enthaltenen Karten. |
|
Sucht nach Nachrichten in Google Chat, auf die der aufrufende Nutzer Zugriff hat. |
|
Aktualisiert eine Nachricht. |