REST Resource: spaces.messages

Ressource: Nachricht

Eine Nachricht in einem Google Chat-Bereich

JSON-Darstellung 
{
  "name": string,
  "sender": {
    object (User)
  },
  "createTime": string,
  "lastUpdateTime": string,
  "deleteTime": string,
  "text": string,
  "formattedText": string,
  "cards": [
    {
      object (Card)
    }
  ],
  "cardsV2": [
    {
      object (CardWithId)
    }
  ],
  "annotations": [
    {
      object (Annotation)
    }
  ],
  "thread": {
    object (Thread)
  },
  "space": {
    object (Space)
  },
  "fallbackText": string,
  "actionResponse": {
    object (ActionResponse)
  },
  "argumentText": string,
  "slashCommand": {
    object (SlashCommand)
  },
  "attachment": [
    {
      object (Attachment)
    }
  ],
  "matchedUrl": {
    object (MatchedUrl)
  },
  "threadReply": boolean,
  "clientAssignedMessageId": string,
  "emojiReactionSummaries": [
    {
      object (EmojiReactionSummary)
    }
  ],
  "privateMessageViewer": {
    object (User)
  },
  "deletionMetadata": {
    object (DeletionMetadata)
  },
  "quotedMessageMetadata": {
    object (QuotedMessageMetadata)
  },
  "attachedGifs": [
    {
      object (AttachedGif)
    }
  ],
  "accessoryWidgets": [
    {
      object (AccessoryWidget)
    }
  ]
}
Felder
name

string

Kennung. Ressourcenname der Nachricht.

Format: spaces/{space}/messages/{message}

Dabei steht {space} für die ID des Gruppenbereichs, in dem die Nachricht gepostet wurde, und {message} für eine systemzugewiesene ID für die Nachricht. Beispiel: spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB

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 {message} durch den Wert aus dem Feld clientAssignedMessageId. Beispiel: spaces/AAAAAAAAAAA/messages/client-custom-name Weitere Informationen finden Sie im Hilfeartikel Nachrichten benennen.
sender

object (User)

Nur Ausgabe. Der Nutzer, der die Nachricht erstellt hat. Wenn Ihre Chat-App als Nutzer authentifiziert wird, werden in der Ausgabe die Nutzer name und type eingefügt.
createTime

string (Timestamp format)

Optional. Nicht veränderbar. Bei in Google Chat erstellten Gruppenbereichen die Uhrzeit, zu der die Nachricht erstellt wurde. Dieses Feld dient nur der Ausgabe, es sei denn, es wird in Gruppenbereichen im Importmodus verwendet.

Legen Sie für Gruppenbereiche im Importmodus in diesem Feld den Zeitstempel fest, zu dem die Nachricht in der Quelle erstellt wurde, um den ursprünglichen Erstellungszeitpunkt beizubehalten.
lastUpdateTime

string (Timestamp format)

Nur Ausgabe. Die Uhrzeit, zu der die Nachricht zuletzt von einem Nutzer bearbeitet wurde. Wenn die Nachricht noch nie bearbeitet wurde, ist dieses Feld leer.
deleteTime

string (Timestamp format)

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

string

Optional. Der Textkörper der Nachricht im Nur-Text-Format. Der erste Link zu einem Bild, Video oder einer Webseite generiert einen Vorschau-Chip. Sie können auch einen Google Chat-Nutzer oder alle Nutzer im Gruppenbereich erwähnen.

Weitere Informationen zum Erstellen von Nachrichten finden Sie unter Nachricht senden.
formattedText

string

Nur Ausgabe. Enthält die Nachricht text mit Markups zur Angabe der Formatierung. Dieses Feld enthält möglicherweise nicht alle Formatierungen, die in der Benutzeroberfläche sichtbar sind, aber Folgendes:

  • Markup-Syntax für Fettdruck, Kursivschrift, Durchstreichen, einzeilige Schrift, einzeiligen Block und Aufzählungsliste.

  • Nutzererwähnungen im Format <users/{user}>

  • Benutzerdefinierte Hyperlinks im Format <{url}|{rendered_text}>, wobei der erste String die URL und der zweite der gerenderte Text ist, z. B. <http://example.com|custom text>.

  • Benutzerdefinierte Emojis im Format :{emojiName}:, z. B. :smile:. Dies gilt nicht für Unicode-Emojis, z. B. U+1F600 für ein grinsendes Gesicht.

Weitere Informationen finden Sie unter In einer Nachricht gesendete Textformatierung ansehen.
cards[]
(deprecated)

object (Card)

Eingestellt: Verwende stattdessen cardsV2.

Reichhaltige, formatierte und interaktive Karten, mit denen Sie UI-Elemente wie formatierten Text, Schaltflächen und anklickbare Bilder anzeigen können. Karten werden normalerweise unter dem Nur-Text der Nachricht angezeigt. cards und cardsV2 können eine maximale Größe von 32 KB haben.
cardsV2[]

object (CardWithId)

Optional. Ein Array von Karten.

Nur Chat-Apps können Karten erstellen. Wenn sich Ihre Chat-App als Nutzer authentifiziert, können die Nachrichten keine Karten enthalten.

Informationen zum Erstellen einer Nachricht mit Karten finden Sie unter Nachricht senden.

Mit dem Card Builder Karten entwerfen und eine Vorschau anzeigen

Karten-Builder öffnen
annotations[]

object (Annotation)

Nur Ausgabe. Anmerkungen, die mit der text in dieser Nachricht verknüpft sind.
thread

object (Thread)

Der Thread, zu dem die Nachricht gehört. Eine Beispielanwendung finden Sie unter Nachrichtenthreads starten oder beantworten.
space

object (Space)

Nur Ausgabe. Wenn sich Ihre Chat-App als Nutzer authentifiziert, wird in der Ausgabe nur der Gruppenbereich name eingefügt.
fallbackText

string

Optional. Eine Beschreibung der Karten der Nachricht in Nur-Text, die verwendet wird, wenn die Karten nicht angezeigt werden können, z. B. bei Benachrichtigungen auf Mobilgeräten.
actionResponse

object (ActionResponse)

Nur Eingabe. Parameter, mit denen eine Chat-App konfigurieren kann, wie ihre Antwort gepostet wird.
argumentText

string

Nur Ausgabe. Der Nur-Text-Textkörper der Nachricht ohne Erwähnungen der Chat App
slashCommand

object (SlashCommand)

Nur Ausgabe. Informationen zum Slash-Befehl, falls zutreffend.
attachment[]

object (Attachment)

Optional. Von einem Nutzer hochgeladener Anhang.
matchedUrl

object (MatchedUrl)

Nur Ausgabe. Eine URL in spaces.messages.text, die mit einem Muster für die Linkvorschau übereinstimmt. Weitere Informationen finden Sie unter Vorschaulinks.
threadReply

boolean

Nur Ausgabe. Wenn true, ist die Nachricht eine Antwort in einem Antwort-Thread. Bei false ist die Nachricht in der Unterhaltung auf oberster Ebene des Gruppenbereichs entweder als erste Nachricht eines Threads oder als Nachricht ohne Antworten im Thread sichtbar.

Wenn das Gruppenbereich das Antworten in Threads nicht unterstützt, ist dieses Feld immer false.
clientAssignedMessageId

string

Optional. Eine benutzerdefinierte ID für die Nachricht. Sie können das Feld verwenden, um eine Nachricht zu identifizieren oder eine Nachricht abzurufen, zu löschen oder zu aktualisieren. Wenn Sie eine benutzerdefinierte ID festlegen möchten, geben Sie beim Erstellen der Nachricht das Feld messageId an. Weitere Informationen finden Sie im Hilfeartikel Nachrichten benennen.
emojiReactionSummaries[]

object (EmojiReactionSummary)

Nur Ausgabe. Die Liste der Zusammenfassungen der Emoji-Reaktionen auf die Nachricht.
privateMessageViewer

object (User)

Optional. Nicht veränderbar. Eingabe für das Erstellen einer Nachricht, andernfalls nur Ausgabe. Der Nutzer, der die Nachricht sehen kann. Wenn diese Option 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 unter Private Nachrichten senden.
deletionMetadata

object (DeletionMetadata)

Nur Ausgabe. Informationen zu einer gelöschten Nachricht. Eine Nachricht wird gelöscht, wenn deleteTime festgelegt ist.
quotedMessageMetadata

object (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[]

object (AttachedGif)

Nur Ausgabe. GIF-Bilder, die an die Nachricht angehängt sind.
accessoryWidgets[]

object (AccessoryWidget)

Optional. Ein oder mehrere interaktive Widgets, die unten in einer Nachricht angezeigt werden. Sie können Nachrichten, die Text, Karten oder Text und Karten enthalten, zusätzliche Widgets hinzufügen. Nicht unterstützt für Nachrichten, die Dialoge enthalten. Weitere Informationen finden Sie unter Interaktive Widgets unten in einer Nachricht einfügen.

Für das Erstellen einer Nachricht mit Zubehör-Widgets ist eine App-Authentifizierung erforderlich.

CardWithId

Eine Karte in einer Google Chat-Nachricht.

Nur Chat-Apps können Karten erstellen. Wenn sich Ihre Chat-App als Nutzer authentifiziert, darf die Nachricht keine Karten enthalten.

Mit dem Card Builder Karten entwerfen und eine Vorschau anzeigen

Karten-Builder öffnen

JSON-Darstellung 
{
  "cardId": string,
  "card": {
    object (Card)
  }
}
Felder
cardId

string

Erforderlich, wenn die Nachricht mehrere Karten enthält. Eine eindeutige Kennung für eine Karte in einer Nachricht.
card

object (Card)

Eine Infokarte Die maximale Größe beträgt 32 KB.

Annotation

Nur Ausgabe. Anmerkungen, die mit dem Nur-Text-Textkörper der Nachricht verknüpft sind. Wie Sie einer SMS eine einfache Formatierung hinzufügen, erfahren Sie unter SMS formatieren.

Beispiel für einen Nur-Text-Textkörper:

Hello @FooBot how are you!"

Die entsprechenden Anmerkungsmetadaten:

"annotations":[{
  "type":"USER_MENTION",
  "startIndex":6,
  "length":7,
  "userMention": {
    "user": {
      "name":"users/{user}",
      "displayName":"FooBot",
      "avatarUrl":"https://goo.gl/aeDtrS",
      "type":"BOT"
    },
    "type":"MENTION"
   }
}]
JSON-Darstellung 
{
  "type": enum (AnnotationType),
  "length": integer,
  "startIndex": integer,

  // Union field metadata can be only one of the following:
  "userMention": {
    object (UserMentionMetadata)
  },
  "slashCommand": {
    object (SlashCommandMetadata)
  },
  "richLinkMetadata": {
    object (RichLinkMetadata)
  }
  // End of list of possible types for union field metadata.
}
Felder
type

enum (AnnotationType)

Der Typ dieser Anmerkung.
length

integer

Länge der Teilzeichenfolge im Nur-Text-Nachrichtentext, der diese Anmerkung entspricht.
startIndex

integer

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

object (UserMentionMetadata)

Die Metadaten der Nutzererwähnung.
slashCommand

object (SlashCommandMetadata)

Die Metadaten für einen Slash-Befehl.

AnnotationType

Typ der Anmerkung.

Enums
ANNOTATION_TYPE_UNSPECIFIED Standardwert für die Enumeration. Nicht verwenden.
USER_MENTION Ein Nutzer wird erwähnt.
SLASH_COMMAND Ein Slash-Befehl wird aufgerufen.

UserMentionMetadata

Annotationsmetadaten für Nutzererwähnungen (@).

JSON-Darstellung 
{
  "user": {
    object (User)
  },
  "type": enum (Type)
}
Felder
user

object (User)

Der erwähnte Nutzer.
type

enum (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

Anmerkungsmetadaten für Slash-Befehle (/).

JSON-Darstellung 
{
  "bot": {
    object (User)
  },
  "type": enum (Type),
  "commandName": string,
  "commandId": string,
  "triggersDialog": boolean
}
Felder
bot

object (User)

Die Chat-App, deren Befehl aufgerufen wurde.
type

enum (Type)

Der Typ des Slash-Befehls.
commandName

string

Der Name des aufgerufenen Slash-Befehls.
commandId

string (int64 format)

Die Befehls-ID des aufgerufenen Slash-Befehls.
triggersDialog

boolean

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 Gruppenbereich auf.

RichLinkMetadata

Ein Rich-Link zu einer Ressource.

JSON-Darstellung 
{
  "uri": string,
  "richLinkType": enum (RichLinkType),

  // Union field data can be only one of the following:
  "driveLinkData": {
    object (DriveLinkData)
  },
  "chatSpaceLinkData": {
    object (ChatSpaceLinkData)
  }
  // End of list of possible types for union field data.
}
Felder
uri

string

Der URI dieses Links.
Union-Feld data. Daten für die verknüpfte Ressource. Für data ist nur einer der folgenden Werte zulässig:

RichLinkType

Der Rich-Link-Typ. Weitere Typen werden möglicherweise in Zukunft hinzugefügt.

Enums
DRIVE_FILE Ein Google Drive-Link-Typ mit erweiterten Funktionen.
CHAT_SPACE Ein Linktyp für einen Chatbereich. Beispiel: Smartchip für einen Gruppenbereich

DriveLinkData

Daten für Google Drive-Links

JSON-Darstellung 
{
  "driveDataRef": {
    object (DriveDataRef)
  },
  "mimeType": string
}
Felder
driveDataRef

object (DriveDataRef)

Eine DriveDataRef, die auf eine Google Drive-Datei verweist.
mimeType

string

Der MIME-Typ der verknüpften Google Drive-Ressource.

ChatSpaceLinkData

Daten zu Links zu Chatbereichen.

JSON-Darstellung 
{
  "space": string,
  "thread": string,
  "message": string
}
Felder
space

string

Der Bereich der verknüpften Chatbereichsressource.

Format: spaces/{space}
thread

string

Der Thread der verknüpften Chatbereich-Ressource.

Format: spaces/{space}/threads/{thread}
message

string

Die Nachricht der verknüpften Chatbereich-Ressource.

Format: spaces/{space}/messages/{message}

Thread

Einen Thread in einem Google Chat-Bereich. Anwendungsbeispiele finden Sie im Hilfeartikel Konversationen 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

string

Kennung. Ressourcenname des Threads.

Beispiel: spaces/{space}/threads/{thread}
threadKey

string

Optional. Eingabe zum Erstellen oder Aktualisieren eines Threads. Andernfalls wird nur die Ausgabe angezeigt. ID für den Thread. Unterstützt bis zu 4.000 Zeichen.

Diese ID ist für die Chat-App, die sie festlegt, eindeutig. Wenn beispielsweise mehrere Chat-Apps eine Nachricht mit demselben Thread-Schlüssel erstellen, werden die Nachrichten in verschiedenen Threads gepostet. Wenn Sie in einer Unterhaltung antworten möchten, die von einer Person oder einer anderen Chat-App erstellt wurde, geben Sie stattdessen das Thread-Feld name an.

ActionResponse

Parameter, mit denen in einer Chat-App konfiguriert werden kann, wie Antworten gepostet werden.

JSON-Darstellung 
{
  "type": enum (ResponseType),
  "url": string,
  "dialogAction": {
    object (DialogAction)
  },
  "updatedWidget": {
    object (UpdatedWidget)
  }
}
Felder
type

enum (ResponseType)

Nur Eingabe. Der Typ der Chat-App-Antwort.
url

string

Nur Eingabe. URL zum Authentifizieren oder Konfigurieren. (Nur für REQUEST_CONFIG-Antworttypen.)
dialogAction

object (DialogAction)

Nur Eingabe. Eine Antwort auf ein Interaktionsereignis im Zusammenhang mit einem Dialog. Muss von ResponseType.Dialog begleitet werden.
updatedWidget

object (UpdatedWidget)

Nur Eingabe. Die Antwort des aktualisierten Widgets.

ResponseType

Der Typ der Antwort in der Google Chat App.

Enums
TYPE_UNSPECIFIED Standardtyp, der als NEW_MESSAGE behandelt wird.
NEW_MESSAGE Posten Sie eine neue Nachricht im Thema.
UPDATE_MESSAGE Aktualisieren Sie die Nachricht der Chat-App. Dies ist nur bei einem CARD_CLICKED-Ereignis zulässig, bei dem der Typ des Nachrichtensenders BOT ist.
UPDATE_USER_MESSAGE_CARDS Karten in der Nachricht eines Nutzers aktualisieren. Dies ist nur als Antwort auf ein MESSAGE-Ereignis mit einer übereinstimmenden URL oder ein CARD_CLICKED-Ereignis zulässig, bei dem der Absendertyp der Nachricht HUMAN ist. Text wird ignoriert.
REQUEST_CONFIG Bitten Sie den Nutzer privat um eine zusätzliche Authentifizierung oder Konfiguration.
DIALOG Ein Dialogfeld wird angezeigt.
UPDATE_WIDGET Abfrage zu Optionen für die automatische Vervollständigung von Widget-Text

DialogAction

Enthält einen Dialog und einen Anfragestatuscode.

JSON-Darstellung 
{
  "actionStatus": {
    object (ActionStatus)
  },

  // Union field action can be only one of the following:
  "dialog": {
    object (Dialog)
  }
  // End of list of possible types for union field action.
}
Felder
actionStatus

object (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

object (Dialog)

Nur Eingabe. Dialog für die Anfrage.

Dialog

Umhüllung um den Kartenkörper des Dialogfelds.

JSON-Darstellung 
{
  "body": {
    object (Card)
  }
}
Felder
body

object (Card)

Nur Eingabe. Textkörper des Dialogfelds, der in einem modalen Dialogfeld gerendert wird. Die folgenden Kartenentitäten werden in Google Chat-Apps nicht unterstützt: DateTimePicker, OnChangeAction.

ActionStatus

Der Status einer Anfrage zum Aufrufen oder Senden eines Dialogfelds.

JSON-Darstellung 
{
  "statusCode": enum (Code),
  "userFacingMessage": string
}
Felder
statusCode

enum (Code)

Der Statuscode.
userFacingMessage

string

Die Nachricht, die Nutzern über den Status ihrer Anfrage gesendet werden soll. Wenn diese Option nicht festgelegt ist, wird eine generische Nachricht basierend auf der statusCode gesendet.

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 Status-Wert, der von einem anderen Adressbereich stammt, zu einem Fehlerbereich gehört, der in diesem Adressbereich nicht bekannt ist. Auch Fehler, die von APIs ausgelöst werden, die nicht genügend Fehlerinformationen liefern, können in diesen Fehler umgewandelt werden.

HTTP Mapping: 500 Internal Server Error
INVALID_ARGUMENT

Der Client hat ein ungültiges Argument angegeben. Dieser Wert ist nicht identisch mit FAILED_PRECONDITION. INVALID_ARGUMENT gibt Argumente an, die ungeachtet des Systemstatus problematisch sind (z. B. ein ungültiger Dateiname).

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 NOT_FOUND verwendet werden. Wenn eine Anfrage, z. B. nutzerbasierte Zugriffssteuerung, für einige Nutzer innerhalb einer Nutzerklasse abgelehnt wird, muss PERMISSION_DENIED verwendet werden.

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. PERMISSION_DENIED darf nicht für Ablehnungen verwendet werden, die dadurch verursacht werden, dass eine Ressource erschöpft ist (verwenden Sie stattdessen RESOURCE_EXHAUSTED für diese Fehler). PERMISSION_DENIED darf nicht verwendet werden, wenn der Aufrufer nicht ermittelt werden kann (verwenden Sie stattdessen UNAUTHENTICATED für diese Fehler). Dieser Fehlercode impliziert nicht, dass die Anfrage gültig ist oder die angefragte Entität existiert oder andere Vorbedingungen erfüllt.

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 FAILED_PRECONDITION, ABORTED und UNAVAILABLE entscheiden: (a) Verwenden Sie UNAVAILABLE, wenn der Client nur den fehlgeschlagenen Aufruf wiederholen kann. (b) Verwenden Sie ABORTED, wenn der Client den Vorgang auf einer höheren Ebene wiederholen soll. Dies bedeutet, dass der Client eine Read-Modify-Write-Sequenz startet. (c) Sollte der Client den Fehler nicht wiederholen, bis der Systemstatus ausdrücklich festgelegt wurde, verwenden Sie FAILED_PRECONDITION. Wenn beispielsweise ein "rmdir" fehlschlägt, weil das Verzeichnis nicht leer ist, sollte FAILED_PRECONDITION angezeigt werden, da der Client den erneuten Versuch erst dann machen sollte, wenn die Dateien aus dem Verzeichnis gelöscht wurden.

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 FAILED_PRECONDITION, ABORTED und UNAVAILABLE.

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 INVALID_ARGUMENT zeigt dieser Fehler ein Problem an, das behoben werden kann, wenn sich der Systemstatus ändert. Zum Beispiel erzeugt ein 32-Bit-Dateisystem INVALID_ARGUMENT, wenn es in einem Bereich lesen soll, der nicht innerhalb des Bereichs [0,2^32-1] liegt. Dagegen generiert es OUT_OF_RANGE, wenn für einen Bereich gelesen werden soll, der die aktuelle Dateigröße übersteigt.

Es gibt einige Überschneidungen zwischen FAILED_PRECONDITION und OUT_OF_RANGE. Wir empfehlen die Verwendung von OUT_OF_RANGE (der spezifischere Fehler), wenn dies zutrifft, damit die Aufrufer, die über einen Bereich iterieren, einfach nach einem OUT_OF_RANGE-Fehler suchen können, wenn sie fertig sind.

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 FAILED_PRECONDITION, ABORTED und UNAVAILABLE.

HTTP Mapping: 503 Service Unavailable
DATA_LOSS

Dauerhafter Datenverlust oder Datenkorruption.

HTTP Mapping: 500 Internal Server Error

UpdatedWidget

Für selectionInput-Widgets werden Vorschläge für die automatische Vervollständigung für ein Mehrfachauswahlmenü zurückgegeben.

JSON-Darstellung 
{
  "widget": string,

  // Union field updated_widget can be only one of the following:
  "suggestions": {
    object (SelectionItems)
  }
  // End of list of possible types for union field updated_widget.
}
Felder
widget

string

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

object (SelectionItems)

Liste der Ergebnisse der automatischen Vervollständigung für Widgets

SelectionItems

Liste der Ergebnisse der automatischen Vervollständigung für das Widget.

JSON-Darstellung 
{
  "items": [
    {
      object (SelectionItem)
    }
  ]
}
Felder
items[]

object (SelectionItem)

Ein Array von „SelectionItem“-Objekten.

SlashCommand

Einen Slash-Befehl in Google Chat.

JSON-Darstellung 
{
  "commandId": string
}
Felder
commandId

string (int64 format)

Die ID des aufgerufenen Slash-Befehls.

MatchedUrl

Eine übereinstimmende URL in einer Chatnachricht. In Chat-Apps können übereinstimmende URLs in einer Vorschau angezeigt werden. Weitere Informationen finden Sie unter Links in der Vorschau anzeigen.

JSON-Darstellung 
{
  "url": string
}
Felder
url

string

Nur Ausgabe. Die übereinstimmende URL.

EmojiReactionSummary

Die Anzahl der Personen, die auf eine Nachricht mit einem bestimmten Emoji reagiert haben.

JSON-Darstellung 
{
  "emoji": {
    object (Emoji)
  },
  "reactionCount": integer
}
Felder
emoji

object (Emoji)

Nur Ausgabe. Das mit den Reaktionen verknüpfte Emoji.
reactionCount

integer

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 (DeletionType)
}
Felder
deletionType

enum (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.

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 Eigentümers des Gruppenbereichs gelöscht.

QuotedMessageMetadata

Informationen zu einer zitierten Nachricht.

JSON-Darstellung 
{
  "name": string,
  "lastUpdateTime": string
}
Felder
name

string

Nur Ausgabe. Ressourcenname der zitierten Nachricht.

Format: spaces/{space}/messages/{message}
lastUpdateTime

string (Timestamp format)

Nur Ausgabe. Der Zeitstempel, der angibt, wann die zitierte Nachricht erstellt oder zuletzt aktualisiert wurde.

AttachedGif

Ein GIF-Bild, das durch eine URL angegeben wird.

JSON-Darstellung 
{
  "uri": string
}
Felder
uri

string

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 im Hilfeartikel Interaktive Widgets am Ende einer Nachricht hinzufügen.

JSON-Darstellung 
{

  // Union field action can be only one of the following:
  "buttonList": {
    object (ButtonList)
  }
  // End of list of possible types for union field action.
}
Felder
Union-Feld action. Die Art der Aktion. Für action ist nur einer der folgenden Werte zulässig:
buttonList

object (ButtonList)

Eine Liste von Schaltflächen.

Methoden

create

 Eine Nachricht in einem Google Chat-Bereich erstellen.

delete

 Löscht eine Nachricht.

get

 Gibt Details zu einer Nachricht zurück.

list

 Hier werden Nachrichten in einem Gruppenbereich aufgelistet, in dem der Anrufer Mitglied ist, einschließlich Nachrichten von blockierten Mitgliedern und Gruppenbereichen.

patch

 Aktualisiert eine Nachricht.

update

 Aktualisiert eine Nachricht.