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

Ressourcenname der Nachricht.

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

Dabei ist {space} die ID des Gruppenbereichs, in dem die Nachricht gepostet wird, und {message} eine vom System zugewiesene 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 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 sich Ihre Chat-App als Nutzer authentifiziert, werden in der Ausgabe die Felder Nutzer name und type ausgegeben.

createTime

string (Timestamp format)

Optional. Nicht veränderbar. Bei Gruppenbereichen, die in Google Chat erstellt wurden, der Zeitpunkt, zu dem die Nachricht erstellt wurde. Dieses Feld wird nur ausgegeben, es sei denn, es wird in Gruppenbereichen im Importmodus verwendet.

Legen Sie bei Gruppenbereichen im Importmodus dieses Feld auf den Zeitstempel der Vergangenheit fest, zu dem die Nachricht in der Quelle erstellt wurde, damit der ursprüngliche Erstellungszeitpunkt beibehalten wird.

lastUpdateTime

string (Timestamp format)

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

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

Nur-Text der Nachricht Für 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 im Gruppenbereich@erwähnen.

Weitere Informationen zum Erstellen von SMS finden Sie unter SMS senden.

formattedText

string

Nur Ausgabe Enthält die Nachricht „text“ mit zusätzlichen Markups, um die Formatierung zu kommunizieren Dieses Feld erfasst möglicherweise nicht alle in der Benutzeroberfläche sichtbaren Formatierungen, enthält jedoch Folgendes:

  • Markup-Syntax für fett, kursiv, durchgestrichen, Monospace, Festbreitenschrift und Aufzählungslisten

  • Nutzer erwähnt im Format <users/{user}>.

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

  • Benutzerdefinierte Emojis im Format :{emoji_name}:, z. B. :smile:. Das gilt nicht für Unicode-Emojis, z. B. U+1F600 für ein lächelndes Gesicht.

Weitere Informationen finden Sie unter In Nachrichten gesendete Textformatierung ansehen.

cards[]
(deprecated)

object (Card)

Eingestellt: Verwenden Sie stattdessen cardsV2.

Vielfältige, formatierte und interaktive Karten, mit denen Sie UI-Elemente wie formatierte Texte, Schaltflächen und anklickbare Bilder anzeigen können. Karten werden normalerweise unterhalb des Klartexttexts der Nachricht angezeigt. cards und cardsV2 dürfen maximal 32 KB groß sein.

cardsV2[]

object (CardWithId)

Ein Array mit Karten.

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

Weitere Informationen zu Karten und ihrer Erstellung finden Sie unter Kartennachrichten senden.

Mit dem Card Builder kannst du Karten entwerfen und sie dir als Vorschau ansehen.

Card Builder öffnen

annotations[]

object (Annotation)

Nur Ausgabe Annotationen, die mit text in dieser Nachricht verknüpft sind.

thread

object (Thread)

Der Thread, zu dem die Nachricht gehört. Informationen zur Verwendung finden Sie unter Unterhaltungen starten oder beantworten.

space

object (Space)

Wenn sich Ihre Chat-App als Nutzer authentifiziert, wird die Ausgabe in den Bereich name eingefügt.

fallbackText

string

Eine Nur-Text-Beschreibung der Karten der Nachricht, die verwendet wird, wenn die tatsächlichen Karten nicht angezeigt werden können, z. B. mobile Benachrichtigungen.

actionResponse

object (ActionResponse)

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

argumentText

string

Nur Ausgabe Nur-Text-Text der Nachricht ohne alle Erwähnungen in Chat-Apps.

slashCommand

object (SlashCommand)

Nur Ausgabe Slash-Befehlsinformationen, falls zutreffend.

attachment[]

object (Attachment)

Vom Nutzer hochgeladener Anhang

matchedUrl

object (MatchedUrl)

Nur Ausgabe Eine URL in spaces.messages.text, die einem Linkvorschaumuster entspricht. Weitere Informationen finden Sie unter Vorschaulinks.

threadReply

boolean

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

Wenn der Gruppenbereich keine Antworten in Threads unterstützt, ist dieses Feld immer „false“.

clientAssignedMessageId

string

Optional. Eine benutzerdefinierte ID für die Nachricht. Sie können ein 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 Emoji-Reaktionen-Zusammenfassungen in der Nachricht.

privateMessageViewer

object (User)

Nicht veränderbar. Eingabe zum Erstellen einer Nachricht, andernfalls nur Ausgabe. Der Nutzer, der die Nachricht sehen kann. Wenn festgelegt, ist die Nachricht privat und nur für den angegebenen Nutzer und die Chat-App sichtbar. Linkvorschauen und Anhänge werden für private Nachrichten nicht unterstützt.

Nur Chat-Apps können private Nachrichten senden. Wenn sich Ihre Chat-App zum Senden einer Nachricht als Nutzer authentifiziert, kann die Nachricht nicht privat sein und muss dieses Feld auslassen.

Weitere Informationen finden Sie im Hilfeartikel Private Nachrichten an Google Chat-Nutzer 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)

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 Nachrichten, die Dialogfelder 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.

CardWithId

Eine Karte in einer Google Chat-Nachricht.

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

Mit dem Card Builder kannst du Karten entwerfen und sie dir als Vorschau ansehen.

Card 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 Annotationen, die mit dem Nur-Text-Text der Nachricht verknüpft sind. Informationen zum einfachen Formatieren von SMS finden Sie unter Textnachrichten formatieren.

Beispiel für einen reinen Text einer Nachricht:

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 Annotation.

length

integer

Länge des Teilstrings im Text der Nur-Text-Nachricht, der diese Annotation entspricht.

startIndex

integer

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

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 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 (User)
  },
  "type": enum (Type)
}
Felder
user

object (User)

Der Nutzer hat dies erwähnt.

type

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

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)
  }
  // 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

Rich-Link-Typ In Zukunft werden möglicherweise weitere Typen hinzugefügt.

Enums
DRIVE_FILE Rich-Link-Typ aus Google Drive

DriveLinkData

Daten für Google Drive-Verknüpfungen.

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.

Thread

Ein Thread in einem Google Chat-Bereich. Informationen zur Verwendung finden Sie unter Unterhaltungen starten oder beantworten.

Wenn Sie beim Erstellen einer Nachricht einen Thread angeben, können Sie mit dem Feld messageReplyOption festlegen, was passiert, wenn keine passende Unterhaltung gefunden wird.

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

string

Nur Ausgabe Ressourcenname des Threads.

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

threadKey

string

Optional. Eingabe zum Erstellen oder Aktualisieren eines Threads. Ansonsten nur Ausgabe. 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 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 Feld „name“ der Unterhaltung an.

ActionResponse

Parameter, mit denen eine Chat-App konfiguriert werden kann, wie ihre Antwort gepostet wird.

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

enum (ResponseType)

Nur Eingabe. Der Antworttyp der Chat-App.

url

string

Nur Eingabe. URL, über die sich Nutzer authentifizieren oder konfigurieren können. (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 Antworttyp der Chat-App.

Enums
TYPE_UNSPECIFIED Standardtyp, der als NEW_MESSAGE verarbeitet 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 Absenders 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 Zeigt ein Dialogfeld an.
UPDATE_WIDGET Abfrage der Optionen für die automatische Vervollständigung von Widget-Texten.

DialogAction

Enthält ein Dialogfeld 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.

Für action ist nur einer der folgenden Werte zulässig:

dialog

object (Dialog)

Nur Eingabe. Dialog für die Anfrage.

Dialog

Wrapper um den Kartentext des Dialogfelds.

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

object (Card)

Nur Eingabe. Text des Dialogfelds, der in einem modalen Dialogfeld gerendert wird. Google Chat-Apps unterstützen die folgenden Kartenentitäten nicht: DateTimePicker, OnChangeAction.

ActionStatus

Stellt den Status für eine Anfrage zum Aufrufen oder Senden eines Dialogfelds dar.

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 die Richtlinie nicht konfiguriert ist, wird eine generische Nachricht gesendet, die auf statusCode basiert.

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. Wenn beispielsweise ein vom Client angegebenes „test-and-set“ fehlschlägt, weist dies darauf hin, dass der Client eine Read-Modify-Write-Sequenz neu starten soll. (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 zurückgegeben werden, da der Client den Vorgang nur dann wiederholen soll, 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, den spezifischeren Fehler OUT_OF_RANGE zu verwenden, damit Aufrufer, die durch einen Gruppenbereich iterieren, einfach nach einem OUT_OF_RANGE-Fehler suchen können, um zu erkennen, 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

Die Antwort des aktualisierten Widgets. Wird verwendet, um Optionen für die automatische Vervollständigung eines Widgets bereitzustellen.

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 für das Widget übereinstimmen, das die Aktualisierungsanfrage ausgelöst hat.

Union-Feld updated_widget.

Für updated_widget ist nur einer der folgenden Werte zulässig:

suggestions

object (SelectionItems)

Liste der Ergebnisse der automatischen Vervollständigung von Widgets

SelectionItems

Liste der Ergebnisse der automatischen Vervollständigung von Widgets.

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

object (SelectionItem)

Ein Array der SelectionItem-Objekte.

SlashCommand

Ein 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 als Vorschau angezeigt werden. Weitere Informationen

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

string

Nur Ausgabe Die URL, die abgeglichen wurde.

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)

Mit den Reaktionen verbundene Emojis.

reactionCount

integer

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

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, wenn sie abgelaufen ist.
CREATOR_VIA_APP Eine Chat-App hat die Nachricht 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

string

Nur Ausgabe Ressourcenname der in Anführungszeichen gesetzten Nachricht.

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

lastUpdateTime

string (Timestamp format)

Nur Ausgabe Der Zeitstempel für den Zeitpunkt, zu dem 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, die das GIF-Bild hostet.

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
{

  // 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.

Für action ist nur einer der folgenden Werte zulässig:

buttonList

object (ButtonList)

Eine Liste mit Schaltflächen.

Methoden

create

Erstellt eine Nachricht in einem Google Chat-Bereich.

delete

Löscht eine Nachricht.

get

Gibt Details zu einer Nachricht zurück.

list

Listet Nachrichten in einem Gruppenbereich auf, in dem der Anrufer Mitglied ist, einschließlich Nachrichten von blockierten Mitgliedern und Gruppenbereichen.

patch

Aktualisiert eine Nachricht.

update

Aktualisiert eine Nachricht.