REST Resource: spaces.messages

{
  "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)
    }
  ],
  "deletionMetadata": {
    object (DeletionMetadata)
  },
  "quotedMessageMetadata": {
    object (QuotedMessageMetadata)
  },
  "attachedGifs": [
    {
      object (AttachedGif)
    }
  ]
}

string

Ressourcenname im Format spaces/*/messages/*.

Beispiel: spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB

object (User)

Nur Ausgabe. Der Nutzer, der die Nachricht erstellt hat. Wenn sich Ihre Chat-App als Nutzer authentifiziert, werden die Werte für name und type für Nutzer ausgegeben.

string (Timestamp format)

Bei Gruppenbereichen, die in Google Chat erstellt wurden, der Zeitpunkt, zu dem die Nachricht erstellt wurde. Dieses Feld wird nur ausgegeben, wenn es nicht in importierten Gruppenbereichen verwendet wird.

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.

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.

string

Nur-Text-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 Verfassen von SMS finden Sie unter SMS senden.

string

Nur Ausgabe. Enthält die Nachricht text mit hinzugefügten 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 und monospace
• Nutzererwähnung 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 :{emoji_name}:, z. B. :smile:. Das gilt nicht für Unicode-Emojis, z. B. U+1F600 für ein lächelndes Emoji.

Weitere Informationen finden Sie unter In einer Nachricht gesendete Textformatierung ansehen.

object (Card)

Eingestellt: Verwende stattdessen cardsV2.

Vielfältige, formatierte und interaktive Karten, die Sie zur Anzeige von UI-Elementen wie formatierten Texten, Schaltflächen und anklickbaren Bildern verwenden können. Karten werden normalerweise unter dem Text der Nachricht angezeigt. cards und cardsV2 dürfen maximal 32 KB groß sein.

object (CardWithId)

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.

object (Annotation)

Nur Ausgabe. Anmerkungen zu text in dieser Nachricht.

object (Thread)

Der Thread, zu dem die Nachricht gehört. Ein Beispiel dafür finden Sie unter E-Mail-Konversationen starten oder beantworten.

object (Space)

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

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.

object (ActionResponse)

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

string

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

object (SlashCommand)

Nur Ausgabe. Informationen zu Slash-Befehlen, falls zutreffend.

object (Attachment)

Vom Nutzer hochgeladener Anhang.

object (MatchedUrl)

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

boolean

Nur Ausgabe. Wenn true, ist die Nachricht eine Antwort in einem Antwortthread. Wenn false, wird die Nachricht in der Unterhaltung auf oberster Ebene des Gruppenbereichs entweder als erste Nachricht einer Unterhaltung oder als Nachricht ohne Antworten mit Unterhaltungsthreads angezeigt.

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

string

Ein benutzerdefinierter Name für eine Chatnachricht, der bei der Erstellung zugewiesen wurde. Muss mit client- beginnen und darf nur Kleinbuchstaben, Ziffern und Bindestriche enthalten, die maximal 63 Zeichen lang sind. Geben Sie dieses Feld an, um die Nachricht mit dem angegebenen Wert abzurufen, zu aktualisieren oder zu löschen. Wenn Sie einen benutzerdefinierten Namen zuweisen, kann eine Chat-App die Nachricht abrufen, ohne dass die Nachricht name aus dem Antworttext gespeichert wird, der beim Erstellen der Nachricht zurückgegeben wurde. Das Zuweisen eines benutzerdefinierten Namens ersetzt nicht das generierte Feld name, also den Ressourcennamen der Nachricht. Stattdessen wird der benutzerdefinierte Name als clientAssignedMessageId-Feld festgelegt, auf das Sie bei der Verarbeitung späterer Vorgänge wie dem Aktualisieren oder Löschen der Nachricht verweisen können. Beispiele für die Verwendung finden Sie unter Erstellte Nachricht benennen.

object (EmojiReactionSummary)

Nur Ausgabe. Die Liste der Emoji-Reaktionszusammenfassungen in der Nachricht.

object (DeletionMetadata)

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

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.

object (AttachedGif)

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

{
  "cardId": string,
  "card": {
    object (Card)
  }
}

string

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

object (Card)

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

{
  "type": enum (AnnotationType),
  "length": integer,
  "startIndex": integer,

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

enum (AnnotationType)

Der Typ dieser Annotation.

integer

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

integer

Startindex (0-basiert, einschließlich) im Nur-Text-Nachrichtentext, dem diese Annotation entspricht.

object (UserMentionMetadata)

Die Metadaten der Nutzererwähnung.

object (SlashCommandMetadata)

Die Metadaten für einen Slash-Befehl.

{
  "user": {
    object (User)
  },
  "type": enum (Type)
}

object (User)

Der erwähnte Nutzer.

enum (Type)

Die Art der Nutzererwähnung.

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

object (User)

Die Chat-App, deren Befehl aufgerufen wurde.

enum (Type)

Der Typ des Slash-Befehls.

string

Der Name des aufgerufenen Slash-Befehls.

string (int64 format)

Die Befehls-ID des aufgerufenen Slash-Befehls.

boolean

Gibt an, ob der Slash-Befehl für ein Dialogfeld bestimmt ist.

{
  "name": string,
  "threadKey": string
}

string

Nur Ausgabe. Ressourcenname des Threads.

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

string

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 „name“ der Unterhaltung an.

{
  "type": enum (ResponseType),
  "url": string,
  "dialogAction": {
    object (DialogAction)
  }
}

enum (ResponseType)

Nur Eingabe. Der Antworttyp der Chat-App.

string

Nur Eingabe. URL für die Authentifizierung oder Konfiguration durch Nutzer. (Nur für REQUEST_CONFIG-Antworttypen.)

object (DialogAction)

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

{
  "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.
}

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 im Falle eines Fehlers oder Erfolgs.

object (Dialog)

Nur Eingabe. Dialog für die Anfrage.

{
  "body": {
    object (Card)
  }
}

object (Card)

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

{
  "statusCode": enum (Code),
  "userFacingMessage": string
}

enum (Code)

Der Statuscode.

string

Die Nachricht, die Nutzer über den Status ihrer Anfrage senden soll. Wenn kein Wert festgelegt ist, wird eine generische Nachricht gesendet, die auf statusCode basiert.

{
  "commandId": string
}

string (int64 format)

Die ID des aufgerufenen Slash-Befehls.

{
  "url": string
}

string

Nur Ausgabe. Die übereinstimmende URL.

{
  "emoji": {
    object (Emoji)
  },
  "reactionCount": integer
}

object (Emoji)

Mit den Reaktionen verbundene Emojis.

integer

Die Gesamtzahl der Reaktionen mit dem zugehörigen Emoji.

{
  "deletionType": enum (DeletionType)
}

enum (DeletionType)

Gibt an, wer die Nachricht gelöscht hat.

{
  "name": string,
  "lastUpdateTime": string
}

string

Nur Ausgabe. Ressourcenname der zitierten Nachricht.

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

string (Timestamp format)

Nur Ausgabe. Der Zeitstempel für den Zeitpunkt, zu dem die zitierte Nachricht erstellt oder die zitierte Nachricht zuletzt aktualisiert wurde.

{
  "uri": string
}

string

Nur Ausgabe. Die URL, die das GIF-Bild hostet.