Method: spaces.messages.create

Erstellt eine Nachricht in einem Google Chat-Bereich. Ein Beispiel finden Sie unter Nachricht senden.

Unterstützt die folgenden Authentifizierungstypen: authentication

  • App-Authentifizierung mit dem Autorisierungsbereich:
    • https://www.googleapis.com/auth/chat.bot
  • Nutzerauthentifizierung mit einem der folgenden Autorisierungsbereiche:
    • https://www.googleapis.com/auth/chat.messages.create
    • https://www.googleapis.com/auth/chat.messages
    • https://www.googleapis.com/auth/chat.import (nur für Bereiche im Importmodus)

Chat schreibt den Absender der Nachricht je nach Art der Authentifizierung, die Sie in Ihrer Anfrage verwenden, unterschiedlich zu.

Die folgende Abbildung zeigt, wie Chat eine Nachricht zuordnet, wenn Sie die App-Authentifizierung verwenden. Chat zeigt die Chat-App als Absender der Nachricht an. Der Inhalt der Nachricht kann Text (text), Karten (cardsV2) und Zubehör-Widgets (accessoryWidgets) enthalten.

Nachricht mit App-Authentifizierung gesendet

Die folgende Abbildung zeigt, wie Chat eine Nachricht zuordnet, wenn Sie die Nutzerauthentifizierung verwenden. Chat zeigt den Nutzer als Absender der Nachricht an und ordnet die Chat-App der Nachricht zu, indem der Name der App angezeigt wird. Der Inhalt der Nachricht kann nur Text (text) enthalten.

Nachricht mit Nutzerauthentifizierung gesendet

Die maximale Nachrichtengröße einschließlich des Nachrichteninhalts beträgt 32.000 Byte.

Bei Webhook-Anfragen enthält die Antwort nicht die vollständige Nachricht. In der Antwort werden zusätzlich zu den Informationen aus der Anfrage nur die Felder name und thread.name ausgefüllt.

HTTP-Anfrage

POST https://chat.googleapis.com/v1/{parent=spaces/*}/messages

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
parent

string

Erforderlich. Der Ressourcenname des Bereichs, in dem eine Nachricht erstellt werden soll.

Format: spaces/{space}

Suchparameter

Parameter
threadKey
(deprecated)

string

Optional. Nicht mehr unterstützt: Verwenden Sie stattdessen thread.thread_key. ID für den Thread. Unterstützt bis zu 4.000 Zeichen. Wenn Sie einen Thread starten oder ihm etwas hinzufügen möchten, erstellen Sie eine Nachricht und geben Sie einen threadKey oder den thread.name an. Ein Anwendungsbeispiel finden Sie unter Nachrichtenthread starten oder darauf antworten.
requestId

string

Optional. Eine eindeutige Anfrage-ID für diese Nachricht. Wenn Sie eine vorhandene Anfrage-ID angeben, wird die mit dieser ID erstellte Nachricht zurückgegeben, anstatt eine neue Nachricht zu erstellen.
messageReplyOption

enum (MessageReplyOption)

Optional. Gibt an, ob eine Nachricht einen Thread startet oder auf einen Thread antwortet. Wird nur in benannten Bereichen unterstützt.

Bei der Reaktion auf Nutzerinteraktionen wird dieses Feld ignoriert. Bei Interaktionen in einem Thread wird die Antwort im selben Thread erstellt. Andernfalls wird die Antwort als neuer Thread erstellt.
messageId

string

Optional. Eine benutzerdefinierte ID für eine Nachricht. Ermöglicht es Chat-Apps, eine Nachricht abzurufen, zu aktualisieren oder zu löschen, ohne die vom System zugewiesene ID im Ressourcennamen der Nachricht speichern zu müssen (dargestellt im Feld name der Nachricht).

Der Wert für dieses Feld muss die folgenden Anforderungen erfüllen:

  • Beginnt mit client-. Beispiel: client-custom-name ist eine gültige benutzerdefinierte ID, custom-name jedoch nicht.
  • Enthält bis zu 63 Zeichen und nur Kleinbuchstaben, Zahlen und Bindestriche.
  • Ist innerhalb eines Bereichs eindeutig. Eine Chat-App kann nicht dieselbe benutzerdefinierte ID für verschiedene Nachrichten verwenden.

Weitere Informationen finden Sie unter Nachricht benennen.
createMessageNotificationOptions

object (CreateMessageNotificationOptions)

Optional. Steuert das Benachrichtigungsverhalten, wenn die Nachricht gepostet wird. Weitere Informationen finden Sie unter Benachrichtigungen erzwingen oder stumme Nachrichten senden.

Anfragetext

Der Anfragetext enthält eine Instanz von Message.

Antworttext

Wenn der Vorgang erfolgreich abgeschlossen wurde, enthält der Antworttext eine neu erstellte Instanz von Message.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.create

Weitere Informationen finden Sie im Autorisierungsleitfaden.

MessageReplyOption

Gibt an, wie auf eine Nachricht geantwortet werden soll. Möglicherweise werden in Zukunft weitere Status hinzugefügt.

Enums
MESSAGE_REPLY_OPTION_UNSPECIFIED Standard. Startet einen neuen Thread. Bei Verwendung dieser Option werden alle enthaltenen thread ID oder threadKey ignoriert.
REPLY_MESSAGE_FALLBACK_TO_NEW_THREAD Erstellt die Nachricht als Antwort auf den Thread, der durch thread ID oder threadKey angegeben wird. Wenn das nicht möglich ist, wird stattdessen ein neuer Thread gestartet.
REPLY_MESSAGE_OR_FAIL Erstellt die Nachricht als Antwort auf den Thread, der durch thread ID oder threadKey angegeben wird. Wenn ein neuer threadKey verwendet wird, wird ein neuer Thread erstellt. Wenn die Nachrichtenerstellung fehlschlägt, wird stattdessen ein NOT_FOUND-Fehler zurückgegeben.

CreateMessageNotificationOptions

Optionen für das Benachrichtigungsverhalten, wenn die Nachricht gepostet wird.

JSON-Darstellung 
{
  "notificationType": enum (NotificationType)
}
Felder
notificationType

enum (NotificationType)

Der Benachrichtigungstyp für die Nachricht.

NotificationType

Die Optionen für die Benachrichtigungstypen für die Nachricht.

Enums
NOTIFICATION_TYPE_NONE Standardverhalten. Das Benachrichtigungsverhalten ähnelt dem, wenn der Nutzer die Nachricht über die Chat-UI sendet: Der Nutzer erhält keine Benachrichtigung.
NOTIFICATION_TYPE_FORCE_NOTIFY

Empfänger benachrichtigen. Dadurch werden die Benachrichtigungseinstellungen für Bereiche und die „Bitte nicht stören“-Einstellungen von Chat umgangen. Diese Option umgeht nicht die „Nicht stören“-Einstellungen auf Geräteebene.

Erfordert die App-Authentifizierung.
NOTIFICATION_TYPE_SILENT

Empfänger nicht benachrichtigen und die Nachricht nicht als ungelesen markieren. Das Verhalten ähnelt dem, wenn der Nutzer die Unterhaltung stumm schaltet oder „Bitte nicht stören“ in Chat aktiviert.

Erfordert die App-Authentifizierung.