- Ressource: Nachricht
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- Kartenspiele
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- CardHeader
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- ImageStyle
- Abschnitt
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- WidgetMarkup
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- TextParagraph
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- Bild
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- OnClick
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- FormAction
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- ActionParameter
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- OpenLink
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- KeyValue
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- Symbol
- Schaltfläche
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- TextButton
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- ImageButton
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- CardAction
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- CardWithId
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- Kartenspiele
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- CardHeader
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- ImageType
- Abschnitt
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- Widget
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- TextParagraph
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- Bild
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- OnClick
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- Aktion
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- ActionParameter
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- LoadIndicator
- Interaktion
- OpenLink
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- OpenAs
- OnClose
- OverflowMenu
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- OverflowMenuItem
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- Symbol
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- MaterialIcon
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- DecoratedText
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- Schaltfläche
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- Farbe
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- Typ
- SwitchControl
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- ControlType
- ButtonList
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- TextInput
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- Typ
- Vorschläge
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- SuggestionItem
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- Validierung
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- InputType
- SelectionInput
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- SelectionType
- SelectionItem
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- PlatformDataSource
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- CommonDataSource
- HostAppDataSourceMarkup
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- ChatClientDataSourceMarkup
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- SpaceDataSource
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- DateTimePicker
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- DateTimePickerType
- Fahrbahntrennung
- Raster
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- GridItem
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- ImageComponent
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- ImageCropStyle
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- ImageCropType
- BorderStyle
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- BorderType
- GridItemLayout
- Spalten
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- Spalte
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- HorizontalSizeStyle
- HorizontalAlignment
- VerticalAlignment
- Widgets
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- ChipList
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- Layout
- Chip
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- CollapseControl
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- DividerStyle
- CardAction
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- CardFixedFooter
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- DisplayStyle
- Anmerkung
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- AnnotationType
- UserMentionMetadata
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- Typ
- SlashCommandMetadata
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- Typ
- RichLinkMetadata
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- RichLinkType
- DriveLinkData
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- ChatSpaceLinkData
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- Thread
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- ActionResponse
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- ResponseType
- DialogAction
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- Dialogfeld
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- ActionStatus
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- Code
- UpdatedWidget
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- SelectionItems
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- SlashCommand
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- MatchedUrl
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- EmojiReactionSummary
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- DeletionMetadata
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- DeletionType
- QuotedMessageMetadata
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- AttachedGif
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- AccessoryWidget
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- Methoden
Ressource: Nachricht
Eine Nachricht in einem Google Chat-Bereich.
JSON-Darstellung |
---|
{ "name": string, "sender": { object ( |
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 |
createTime |
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. |
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 |
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. |
formattedText |
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. |
cardsV2[] |
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. Annotationen, die mit |
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 |
fallbackText |
Eine Klartextbeschreibung der Karten der Nachricht, die verwendet wird, wenn die eigentlichen Karten nicht angezeigt werden können, z. B. mobile Benachrichtigungen. |
actionResponse |
Nur Eingabe. Parameter, mit denen in einer Chat-App konfiguriert werden kann, wie Antworten gepostet werden. |
argumentText |
Nur Ausgabe. Nur-Text der Nachricht, wobei alle Erwähnungen in der Google Chat App entfernt wurden. |
slashCommand |
Nur Ausgabe. Informationen zu Slash-Befehlen, falls vorhanden. |
attachment[] |
Vom Nutzer hochgeladener Anhang. |
matchedUrl |
Nur Ausgabe. Eine URL in |
threadReply |
Nur Ausgabe. Wenn Wenn in einem Gruppenbereich keine Antworten in Threads unterstützt werden, lautet das Feld immer |
clientAssignedMessageId |
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 |
emojiReactionSummaries[] |
Nur Ausgabe. Die Liste der Zusammenfassungen der Emoji-Reaktionen in der Nachricht. |
privateMessageViewer |
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. |
deletionMetadata |
Nur Ausgabe. Informationen zu einer gelöschten Nachricht. Eine Nachricht wird gelöscht, wenn |
quotedMessageMetadata |
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. |
attachedGifs[] |
Nur Ausgabe. GIF-Bilder, die an die Nachricht angehängt sind. |
accessoryWidgets[] |
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. |
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 öffnenJSON-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. |
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"
}
}]
JSON-Darstellung |
---|
{ "type": enum ( |
Felder | |
---|---|
type |
Der Typ dieser Anmerkung. |
length |
Länge der Teilzeichenfolge im Nur-Text-Nachrichtentext, der diese Anmerkung entspricht. |
startIndex |
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: |
|
userMention |
Die Metadaten der Nutzererwähnung. |
slashCommand |
Die Metadaten für einen Slash-Befehl. |
richLinkMetadata |
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. |
UserMentionMetadata
Annotationsmetadaten für Nutzererwähnungen (@).
JSON-Darstellung |
---|
{ "user": { object ( |
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. |
SlashCommandMetadata
Annotationsmetadaten 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 ein Dialogfeld bestimmt ist. |
Typ
Enums | |
---|---|
TYPE_UNSPECIFIED |
Standardwert für die Aufzählung. Nicht verwenden. |
ADD |
Chat-App zu Gruppenbereich hinzufügen. |
INVOKE |
Rufen Sie den Slash-Befehl im Leerzeichen auf. |
RichLinkMetadata
Ein Rich-Link zu einer Ressource.
JSON-Darstellung |
---|
{ "uri": string, "richLinkType": enum ( |
Felder | |
---|---|
uri |
Der URI dieses Links. |
richLinkType |
Der Rich-Link-Typ. |
Union-Feld data . Daten für die verknüpfte Ressource. Für data ist nur einer der folgenden Werte zulässig: |
|
driveLinkData |
Daten für eine Drive-Verknüpfung. |
chatSpaceLinkData |
Daten für einen Link zu einem Chatbereich. |
RichLinkType
Der Rich-Link-Typ. In Zukunft werden möglicherweise weitere Typen hinzugefügt.
Enums | |
---|---|
RICH_LINK_TYPE_UNSPECIFIED |
Standardwert für die 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. |
DriveLinkData
Daten für Google Drive-Links.
JSON-Darstellung |
---|
{
"driveDataRef": {
object ( |
Felder | |
---|---|
driveDataRef |
Eine DriveDataRef, die 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 Chatbereich-Ressource. Format: |
thread |
Der Thread der verknüpften Chatbereich-Ressource. Format: |
message |
Die Nachricht der verknüpften Chatbereichsressource. Format: |
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.
JSON-Darstellung |
---|
{ "name": string, "threadKey": string } |
Felder | |
---|---|
name |
Ressourcenname des Threads. Beispiel: |
threadKey |
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 |
ActionResponse
Parameter, mit denen in einer Chat-App konfiguriert werden kann, wie Antworten gepostet werden.
JSON-Darstellung |
---|
{ "type": enum ( |
Felder | |
---|---|
type |
Nur Eingabe. Der Typ der Chat-App-Antwort. |
url |
Nur Eingabe. URL zum Authentifizieren oder Konfigurieren. (Nur für |
dialogAction |
Nur Eingabe. Eine Antwort auf ein Interaktionsereignis, das mit einem Dialogfeld zusammenhängt. Muss von |
updatedWidget |
Nur Eingabe. Die Antwort des aktualisierten Widgets. |
ResponseType
Der Typ der Chat-App-Antwort.
Enums | |
---|---|
TYPE_UNSPECIFIED |
Standardtyp, der als NEW_MESSAGE behandelt wird. |
NEW_MESSAGE |
Als neue Nachricht im Thema posten. |
UPDATE_MESSAGE |
Aktualisieren Sie die Nachricht der Chat-App. Dies ist nur bei einem CARD_CLICKED -Ereignis zulässig, bei dem der Absendertyp der Nachricht BOT ist. |
UPDATE_USER_MESSAGE_CARDS |
Karten in 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. |
DialogAction
Enthält ein dialog-Fenster und einen Statuscode für die Anfrage.
JSON-Darstellung |
---|
{ "actionStatus": { object ( |
Felder | |
---|---|
actionStatus |
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. |
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. Die folgenden Kartenentitäten werden in Google Chat-Apps nicht unterstützt: |
ActionStatus
Stellt den Status für eine Anfrage zum Aufrufen oder Senden eines Dialogfelds dar.
JSON-Darstellung |
---|
{
"statusCode": enum ( |
Felder | |
---|---|
statusCode |
Der Statuscode. |
userFacingMessage |
Die Nachricht, die Nutzern über den Status ihrer Anfrage gesendet wird. Wenn die Richtlinie nicht konfiguriert ist, wird eine generische 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 beispielsweise ausgegeben, wenn ein HTTP Mapping: 500 Internal Server Error |
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 Mapping: 404 Not Found |
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 Authentifizierungsanmeldedaten 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 Internal Server Error |
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 |
Dauerhafter Datenverlust oder Datenkorruption. HTTP Mapping: 500 Internal Server Error |
UpdatedWidget
Die Antwort des aktualisierten Widgets. Wird verwendet, um Optionen zur automatischen Vervollständigung für ein Widget bereitzustellen.
JSON-Darstellung |
---|
{ "widget": string, // Union field |
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 |
SelectionItems
Liste der Ergebnisse der automatischen Vervollständigung von Widgets.
JSON-Darstellung |
---|
{
"items": [
{
object ( |
Felder | |
---|---|
items[] |
Ein Array der SelectionItem-Objekte. |
SlashCommand
Einen Slash-Befehl in Google Chat.
JSON-Darstellung |
---|
{ "commandId": string } |
Felder | |
---|---|
commandId |
Die ID des aufgerufenen Slash-Befehls. |
MatchedUrl
Eine übereinstimmende URL in einer Chatnachricht. Chat-Apps können sich übereinstimmende URLs in der Vorschau ansehen. Weitere Informationen finden Sie unter Vorschaulinks.
JSON-Darstellung |
---|
{ "url": string } |
Felder | |
---|---|
url |
Nur Ausgabe. Die übereinstimmende URL. |
EmojiReactionSummary
Die Anzahl der Personen, die auf eine Nachricht mit einem bestimmten Emoji reagiert haben.
JSON-Darstellung |
---|
{
"emoji": {
object ( |
Felder | |
---|---|
emoji |
Mit den Reaktionen verknüpftes Emoji. |
reactionCount |
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.
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. |
QuotedMessageMetadata
Informationen zu einer zitierten Nachricht.
JSON-Darstellung |
---|
{ "name": string, "lastUpdateTime": string } |
Felder | |
---|---|
name |
Nur Ausgabe. Ressourcenname der in Anführungszeichen gesetzten Nachricht. Format: |
lastUpdateTime |
Nur Ausgabe. Der Zeitstempel, der angibt, wann die zitierte Nachricht erstellt oder die zitierte Nachricht zuletzt aktualisiert wurde. |
AttachedGif
Ein GIF-Bild, das durch eine URL angegeben wird.
JSON-Darstellung |
---|
{ "uri": string } |
Felder | |
---|---|
uri |
Nur Ausgabe. Die URL, auf der das GIF-Bild gehostet wird. |
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.
JSON-Darstellung |
---|
{ // Union field |
Felder | |
---|---|
Union-Feld action . Die Art der Aktion. Für action ist nur einer der folgenden Werte zulässig: |
|
buttonList |
Eine Liste mit Schaltflächen. |
Methoden |
|
---|---|
|
Eine Nachricht in einem Google Chat-Bereich erstellen. |
|
Löscht eine Nachricht. |
|
Gibt Details zu einer Nachricht zurück. |
|
Listet Nachrichten in einem Gruppenbereich auf, in dem der Anrufer Mitglied ist, einschließlich Nachrichten von blockierten Mitgliedern und Gruppenbereichen. |
|
Aktualisiert eine Nachricht. |
|
Aktualisiert eine Nachricht. |