- Ressource: Nachricht
- Karte
- CardHeader
- ImageStyle
- Abschnitt
- WidgetMarkup
- TextParagraph
- Bild
- OnClick
- FormAction
- ActionParameter
- OpenLink
- KeyValue (Schlüssel/Wert)
- Symbol
- Schaltfläche
- TextButton
- ImageButton
- CardAction:
- CardWithId
- Karte
- CardHeader
- ImageType
- Abschnitt
- Widget
- TextParagraph
- Bild
- OnClick
- Aktion
- ActionParameter
- LoadIndicator
- Interaktion
- OpenLink
- OpenAs
- OnClose
- DecoratedText
- Symbol
- Schaltfläche
- Farbe
- SwitchControl
- ControlType
- ButtonList (Schaltflächenliste)
- TextInput
- Typ
- Vorschläge
- SuggestionItem
- SelectionInput (Auswahleingabe)
- SelectionType
- SelectionItem
- PlatformDataSource
- CommonDataSource
- HostAppDataSourceMarkup
- ChatClientDataSourceMarkup
- SpaceDataSource
- DateTimePicker
- DateTimePickerType
- Fahrbahntrennung
- Raster
- GridItem
- ImageComponent
- ImageCropStyle
- ImageCropType
- BorderStyle
- BorderType
- GridItemLayout
- Spalten
- Spalte
- HorizontalSizeStyle
- HorizontalAlignment
- VerticalAlignment
- Widgets
- DividerStyle
- CardAction:
- CardFixedFooter
- DisplayStyle
- Anmerkung
- AnnotationType
- UserMentionMetadata
- Typ
- SlashCommandMetadata
- Typ
- Thread
- ActionResponse
- ResponseType
- DialogAction
- Dialog
- ActionStatus
- Code
- UpdatedWidget:
- SelectionItems
- SlashCommand
- MatchedUrl
- EmojiReactionSummary
- DeletionMetadata
- DeletionType
- QuotedMessageMetadata
- AttachedGif:
- Methoden
Ressource: Nachricht
Eine Nachricht in einem Google Chat-Bereich.
JSON-Darstellung |
---|
{ "name": string, "sender": { object ( |
Felder | |
---|---|
name |
Ressourcenname im Format Beispiel: |
sender |
Nur Ausgabe Der Nutzer, der die Nachricht erstellt hat. Wenn sich Ihre Chat-App als Nutzer authentifiziert, werden in der Ausgabe die Werte für user |
createTime |
Der Zeitpunkt, zu dem die Nachricht bei Gruppenbereichen in Google Chat erstellt wurde. Dieses Feld wird nur ausgegeben, wenn es nicht in importierten Gruppenbereichen verwendet wird. Legen Sie für importierte Gruppenbereiche dieses Feld auf den bisherigen Zeitstempel fest, zu dem die Nachricht in der Quelle erstellt wurde, damit der ursprüngliche Erstellungszeitpunkt beibehalten wird. |
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-Text der Nachricht. Durch den ersten Link zu einem Bild, 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 SMS senden. |
formattedText |
Nur Ausgabe Enthält die Nachricht
Weitere Informationen finden Sie unter Textformatierungen in Nachrichten ansehen. |
cards[] |
Eingestellt: Verwende stattdessen Vielfältige, formatierte und interaktive Karten, mit denen Sie UI-Elemente wie formatierte Texte, Schaltflächen und anklickbare Bilder anzeigen können. Infokarten werden normalerweise unterhalb des Klartexttexts 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. Weitere Informationen zu Karten und deren Erstellung finden Sie unter Mit Karten dynamische, interaktive und einheitliche Benutzeroberflächen entwerfen. |
annotations[] |
Nur Ausgabe Annotationen, die mit |
thread |
Der Thread, zu dem die Nachricht gehört. Ein Beispiel dazu finden Sie unter Nachrichten-Thread starten oder beantworten. |
space |
Wenn sich Ihre Chat-App als Nutzer authentifiziert, wird die Ausgabe in den Bereich |
fallbackText |
Eine Nur-Text-Beschreibung der Karten in der Nachricht, die verwendet wird, wenn die eigentlichen Karten nicht angezeigt werden können, z. B. mobile Benachrichtigungen. |
actionResponse |
Nur Eingabe. Parameter, mit denen eine Chat-App konfiguriert werden kann, wie ihre Antwort gepostet wird. |
argumentText |
Nur Ausgabe Nur-Text-Text der Nachricht ohne alle Erwähnungen in der Chat-App. |
slashCommand |
Nur Ausgabe Gegebenenfalls Informationen zum Slash-Befehl. |
attachment[] |
Vom Nutzer hochgeladener Anhang |
matchedUrl |
Nur Ausgabe Eine URL in |
threadReply |
Nur Ausgabe Wenn Wenn im Gruppenbereich keine Antworten in Threads unterstützt werden, ist dieses Feld immer |
clientAssignedMessageId |
Ein benutzerdefinierter Name für eine Chatnachricht, der bei der Erstellung zugewiesen wurde. Muss mit |
emojiReactionSummaries[] |
Nur Ausgabe Die Liste der Emoji-Reaktionszusammenfassungen in der Nachricht. |
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 wird. Google Chat-Nutzer können eine Nachricht zitieren, um darauf zu antworten. |
attachedGifs[] |
Nur Ausgabe GIF-Bilder, die an die Nachricht angehängt sind. |
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.
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. |
Annotation
Nur Ausgabe Annotationen, die mit dem Nur-Text-Text der Nachricht verknüpft sind. Informationen zum grundlegenden Formatieren von SMS finden Sie unter Textnachrichten formatieren.
Beispiel für einen reinen Text einer Nachricht:
Hello @FooBot how are you!"
Die zugehörigen Metadaten der Anmerkungen:
"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 Text der Nur-Text-Nachricht, 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 Annotation. 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. |
AnnotationType
Typ der Anmerkung.
Enums | |
---|---|
ANNOTATION_TYPE_UNSPECIFIED |
Standardwert für Enum. Nicht verwenden. |
USER_MENTION |
Ein Nutzer wird erwähnt. |
SLASH_COMMAND |
Ein Slash-Befehl wird aufgerufen. |
UserMentionMetadata
Annotationsmetadaten für Nutzererwähnungen (@).
JSON-Darstellung |
---|
{ "user": { object ( |
Felder | |
---|---|
user |
Der Nutzer hat erwähnt. |
type |
Die Art der Nutzererwähnung. |
Typ
Enums | |
---|---|
TYPE_UNSPECIFIED |
Standardwert für Enum. Nicht verwenden. |
ADD |
Nutzer zu Gruppenbereich hinzufügen. |
MENTION |
Erwähne den Nutzer im Gruppenbereich. |
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 Enum. Nicht verwenden. |
ADD |
Die Chat-App dem Gruppenbereich hinzufügen. |
INVOKE |
Rufen Sie den Slash-Befehl in einem Leerzeichen auf. |
Thread
Ein Thread in einem Google Chat-Bereich. Ein Beispiel dazu finden Sie unter Nachrichten-Thread starten oder beantworten.
Wenn Sie beim Erstellen einer Nachricht einen Thread angeben, können Sie im Feld messageReplyOption
festlegen, was passiert, wenn keine passende Unterhaltung gefunden wird.
JSON-Darstellung |
---|
{ "name": string, "threadKey": string } |
Felder | |
---|---|
name |
Nur Ausgabe 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 eindeutig, in der 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 Feld |
ActionResponse
Parameter, mit denen eine Chat-App konfiguriert werden kann, wie ihre Antwort gepostet wird.
JSON-Darstellung |
---|
{ "type": enum ( |
Felder | |
---|---|
type |
Nur Eingabe. Der Antworttyp der Chat-App. |
url |
Nur Eingabe. URL für die Authentifizierung oder Konfiguration durch Nutzer. (Nur für |
dialogAction |
Nur Eingabe. Eine Antwort auf ein Interaktionsereignis im Zusammenhang mit einem Dialog. Muss von |
updatedWidget |
Nur Eingabe. Die Antwort des aktualisierten Widgets. |
ResponseType
Der Antworttyp der Chat-App.
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 ein CARD_CLICKED -Ereignis mit dem Typ HUMAN des Absenders der Nachricht zulässig. Text wird ignoriert. |
REQUEST_CONFIG |
Bitten Sie den Nutzer privat um eine zusätzliche Authentifizierung oder Konfiguration. |
DIALOG |
Öffnet ein Dialogfeld. |
UPDATE_WIDGET |
Abfrage der Optionen für die automatische Vervollständigung von Widgettext-Optionen. |
DialogAction
Enthält ein Dialogfeld und einen Anfragestatuscode.
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. z. B. bei einem Fehler oder bei Erfolg. |
Union-Feld Für |
|
dialog |
Nur Eingabe. Dialog 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 Dialogfeld 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 kein Wert festgelegt ist, wird eine allgemeine Nachricht gesendet, die auf |
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 für die automatische Vervollständigung eines Widgets bereitzustellen.
JSON-Darstellung |
---|
{ "widget": string, // Union field |
Felder | |
---|---|
widget |
Die ID des aktualisierten Widgets. Die ID muss mit der ID für das Widget übereinstimmen, das die Aktualisierungsanfrage ausgelöst hat. |
Union-Feld Für |
|
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
Ein 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 eine Vorschau übereinstimmender URLs anzeigen. Weitere Informationen finden Sie unter Vorschaulinks.
JSON-Darstellung |
---|
{ "url": string } |
Felder | |
---|---|
url |
Nur Ausgabe Die URL mit der Übereinstimmung. |
EmojiReactionSummary
Die Anzahl der Personen, die auf eine Nachricht mit einem bestimmten Emoji reagiert haben.
JSON-Darstellung |
---|
{
"emoji": {
object ( |
Felder | |
---|---|
emoji |
Mit den Reaktionen verbundene Emojis. |
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 |
Der Nutzer hat seine eigene Nachricht gelöscht. |
SPACE_OWNER |
Der Eigentümer des Gruppenbereichs hat die Nachricht gelöscht. |
ADMIN |
Ein Google Workspace-Administrator hat die Nachricht gelöscht. |
APP_MESSAGE_EXPIRY |
Eine Chat-App hat ihre eigene Nachricht gelöscht, nachdem sie abgelaufen ist. |
CREATOR_VIA_APP |
Die Nachricht wurde von einer Chat-App im Namen des Nutzers gelöscht. |
SPACE_OWNER_VIA_APP |
Die Nachricht wurde von einer Chat-App im Namen des Eigentümers des Gruppenbereichs gelöscht. |
QuotedMessageMetadata
Informationen zu einer zitierten Nachricht.
JSON-Darstellung |
---|
{ "name": string, "lastUpdateTime": string } |
Felder | |
---|---|
name |
Nur Ausgabe Ressourcenname der zitierten Nachricht. Format: |
lastUpdateTime |
Nur Ausgabe Zeitstempel für die Erstellung der zitierten Nachricht oder die letzte Aktualisierung der zitierten Nachricht |
AttachedGif
Ein durch eine URL angegebenes GIF-Bild.
JSON-Darstellung |
---|
{ "uri": string } |
Felder | |
---|---|
uri |
Nur Ausgabe Die URL, die das GIF-Bild hostet. |
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 Anrufer Mitglied ist, einschließlich Nachrichten von blockierten Mitgliedern und Gruppenbereichen. |
|
Aktualisiert eine Nachricht. |
|
Aktualisiert eine Nachricht. |