Auf dieser Seite wird erläutert, wie Google Chat-Apps Text formatieren können, um Nachrichten mit folgenden Elementen zu senden:
- RTF, der Hyperlinks oder @Erwähnungen eines oder aller Nutzer in einem Chatbereich enthält.
- Text, der in einer Kartenschnittstelle angezeigt wird, einschließlich Absatztext oder UI-Text, der neben einem Symbol wie einer Schaltfläche angezeigt wird.
Nachricht formatieren
In Google Chat können Sie Nachrichten grundlegend formatieren, z. B. fett, kursiv und durchgestrichen. Textnachrichten werden anders formatiert als Kartennachrichten, da sie dieselbe Syntax wie Chatnachrichten von Nutzern verwenden.
Für Nachrichten, die über die Chat API gesendet oder abgerufen werden, können Sie die Standard-Markdown-Syntax (MARKUP_SYNTAX_MARKDOWN) oder die Chat-Markup-Syntax (MARKUP_SYNTAX_CHAT) verwenden. Sie können in der Google Cloud Console eine Standard-Markup-Syntax auf App-Ebene konfigurieren (siehe Google Chat API konfigurieren):
- Markdown: Standard-Markdown-Syntax (
MARKUP_SYNTAX_MARKDOWN), basierend auf der CommonMark-Spezifikation mit zusätzlichen Erweiterungen. Neu erstellte Chat-Apps verwenden standardmäßig Markdown. - Chat: Chat-Markup-Syntax (
MARKUP_SYNTAX_CHAT). Vorhandene Chat-Apps verwenden standardmäßig Chat, um die Abwärtskompatibilität zu gewährleisten.
Sie können markup_syntax auch für einzelne Chat API-Anfragen angeben, um den Standardwert auf App-Ebene zu überschreiben. Wenn markup_syntax in einer API-Anfrage nicht angegeben ist, wird das Markup basierend darauf festgelegt, wie Sie die Chat API aufrufen:
- Konfigurierte Chat-Apps:Verwendet die Markup-Syntax, die auf der Seite „Chat API-Konfiguration“ gespeichert ist.
- Nicht konfigurierte Cloud-Projekte (ohne Konfiguration): Wenn Ihr Cloud-Projekt die Chat API ohne gespeicherte Chat-App-Konfiguration aufruft, werden Anfragen standardmäßig an
MARKUP_SYNTAX_MARKDOWNgesendet. - Eingehende Webhooks: Standardmäßig
MARKUP_SYNTAX_CHAT. Weitere Informationen finden Sie unter Nachrichten mit eingehenden Webhooks senden.
Verwenden Sie die folgende Syntax, um Textnachrichten zu formatieren:
| Format | MARKUP_SYNTAX_CHAT | MARKUP_SYNTAX_MARKDOWN | Beispielsyntax | In Google Chat angezeigter Text |
|---|---|---|---|---|
| Fett | * |
** |
Oder:
|
hallo |
| Kursiv | _ (Unterstrich) |
* |
Oder:
|
hallo |
| Durchgestrichen | ~ |
~~ |
Oder:
|
|
| Festbreitenschrift | ` (Backquote) | ` (Backquote) | `hello` | hello |
| Festbreitenschrift-Block | ` ` ` (drei Backticks) | ` ` ` (drei Backticks) | ``` Hello World ``` |
Hello |
| Aufzählungsliste | * oder - (Bindestrich) gefolgt von einem Leerzeichen | * oder - (Bindestrich), gefolgt von einem Leerzeichen | * Dies ist das erste Element in der Liste. * Dies ist das zweite Element in der Liste. |
|
| Verschachtelte Liste | * oder - (Bindestrich), gefolgt von einem Leerzeichen, vorangestellt von vier Leerzeichen pro Verschachtelungsebene | * oder - (Bindestrich), gefolgt von einem Leerzeichen, vorangestellt von vier Leerzeichen pro Verschachtelungsebene | * Dies ist das Element mit der Verschachtelungstiefe 1 in der Liste. * This is the item with nested depth two in the list. * Dies ist das Element mit der Verschachtelungstiefe 3 in der Liste. |
|
| Nummerierte Liste | Nicht unterstützt | 1. (Zahl gefolgt von einem Punkt und einem Leerzeichen) | 1. Dies ist das erste Element in der Liste. 2. Dies ist das zweite Element in der Liste. |
|
| Blockzitat | > (Größer-als-Zeichen) | > (Größer-als-Zeichen) | >hello |
|
| Hyperlink | <hyperlink|display text> |
[display text](hyperlink) |
Oder:
|
Weitere Informationen zu Hyperlinks finden Sie unter Links formatieren. |
| Nutzer erwähnen | <users/{user}>, wobei {user} die Nutzer-ID ist. |
Oder:
|
Oder:
|
@Mahan S Weitere Informationen zum Erwähnen von Nutzern finden Sie unter Nutzer in einer Nachricht erwähnen. |
| Custom Emoji |
Oder:
|
Oder:
|
Oder:
Oder:
Oder:
|
🐱 (Benutzerdefiniertes Emoji „Katzen-Smiley“) |
| Zitation | Nicht unterstützt | <chat-citation data-id="{id}">{text}</chat-citation>, wobei {id} die in der Nachricht elements definierte Zitations-ID ist. |
<chat-citation data-id="cite_1">cited text</chat-citation> |
zitierter Text Weitere Informationen zu Zitaten finden Sie unter Zitate zu einer Textnachricht hinzufügen. |
Betrachten Sie beispielsweise den folgenden JSON-Code:
{
"text": "Your pizza delivery *has arrived*!\nThank you for using _Cymbal Pizza!_"
}
Diese formatierte Textnachricht wird in einem Chatbereich so angezeigt:
Textformatierung in einer Nachricht ansehen
Wenn ein Nutzer eine Nachricht sendet, befindet sich der Nur-Text-Inhalt der Nachricht im Feld text. Ein Teil der Formatierung, die mit der Markdown-Syntax auf die Textnachricht angewendet wird, befindet sich im Feld text. Zusätzliche Formatierungen sind im Nur-Ausgabe-Feld formattedText enthalten, darunter:
- Zusätzliche Markdown-Syntax für Text
- Erwähnungen von Nutzern
- Benutzerdefinierte Hyperlinks
- Benutzerdefinierte Emojis
Betrachten Sie beispielsweise den folgenden Text, der von einem Nutzer gesendet wurde:
Wenn die Nachricht über das Menü Format in der Chat-Benutzeroberfläche formatiert wurde, enthält das Feld text nur den Text, während das Feld formattedText die Markups, den Text und den Hyperlink enthält. Das folgende Beispiel zeigt den Entwurf einer Nachricht mit einem verlinkten Wort, Elementen in einer Liste und einem fett formatierten Wort:
Die Nachricht wird im folgenden Format empfangen:
{
"text": "I can meet there at:\nNoon\n3 pm\n5 pm\nWhat time works for you?",
"formattedText": "I can meet <http://example.com|there> at:\n* Noon\n* 3 pm\n* 5 pm\nWhat time works for *you*?",
}
Format links
Wenn Sie eine einfache Link-URL in den Nachrichtentext einfügen, z. B. http://www.example.com/, verwendet Google Chat diese als Linktext und verlinkt diesen Text automatisch mit der angegebenen URL.
Verwenden Sie die folgende Syntax, um einen alternativen Linktext für Ihren Link anzugeben:
Verwenden Sie für API-Nachrichten, die mit Markdown konfiguriert sind, die Standard-Markdown-Linksyntax:
Beispielsyntax In Google Chat angezeigter Text [Example website](https://example.com)Verwenden Sie für Standard-Nur-Text-Nachrichten die Pipe-Syntax:
Beispielsyntax In Google Chat angezeigter Text <https://example.com|Example website>Der senkrechte Strich und der Linktext sind optional, sodass
<https://example.com>undhttps://example.comäquivalent sind.
Benutzerdefinierte Emojis in einer Nachricht verwenden
Chat-Apps können Textnachrichten mit benutzerdefinierten Emojis senden, um Nachrichten zu personalisieren. Benutzerdefinierte Emojis sind nur für Google Workspace-Organisationen verfügbar und der Administrator muss benutzerdefinierte Emojis für die Organisation aktivieren. Weitere Informationen finden Sie unter Benutzerdefinierte Emojis in Google Chat und Berechtigungen für benutzerdefinierte Emojis verwalten.
Wenn Sie Nachrichten mit benutzerdefinierten Emojis erstellen möchten, muss Ihre App die Nutzerauthentifizierung verwenden. Benutzerdefinierte Emojis werden in Nachrichten, die als Webhook erstellt wurden, oder in Nachrichten, die mit App-Authentifizierung erstellt wurden, nicht unterstützt.
Wenn Sie dem Text einer Nachricht benutzerdefinierte Emojis hinzufügen möchten, geben Sie die name oder die emoji_name der customEmoji-Ressource an:
{
"text": "Hello <customEmojis/CUSTOM_EMOJI_ID>."
}
Wenn Sie dieses Beispiel verwenden möchten, ersetzen Sie CUSTOM_EMOJI_ID durch die ID des benutzerdefinierten Emojis. Sie finden diese ID im Feld name oder emoji_name der Ressource customEmoji.
Wenn Ihre App Nachrichten mit der Markdown-Syntax sendet, können Sie benutzerdefinierte Emojis im HTML-Tag-Format mit der benutzerdefinierten Emoji-ID angeben:
{
"text": "Hello <chat-emoji data-custom-emoji=\"customEmojis/CUSTOM_EMOJI_ID\">."
}
Alternativ können Sie den Namen des benutzerdefinierten Emojis angeben:
{
"text": "Hello <chat-emoji data-emoji-name=\"CUSTOM_EMOJI_NAME\">."
}
Wenn Sie diese Beispiele verwenden möchten, ersetzen Sie CUSTOM_EMOJI_ID durch die ID des benutzerdefinierten Emojis und CUSTOM_EMOJI_NAME durch den Kurznamen des benutzerdefinierten Emojis.
Nutzer in einer Nachricht erwähnen
Chat-Apps können Textnachrichten senden, in denen ein oder alle Nutzer in einem Chatbereich mit @erwähnt werden. Chat-Apps können auch Nutzer erwähnen, die dem Gruppenbereich nicht beigetreten sind oder Mitglieder eines Gruppenbereichs im Importmodus sind.
Stille Nachrichten unterstützen keine Erwähnungen von Nutzern. Wenn Sie eine Erwähnung in eine Nachricht ohne Benachrichtigung einfügen, wird ein Fehler zurückgegeben.
Bestimmte Nutzer mit @erwähnen
Wenn Sie einen bestimmten Nutzer mit @erwähnen möchten, fügen Sie der Textnachricht <users/{user}> hinzu, wobei {user} die ID des Nutzers ist. Betrachten Sie beispielsweise die folgende SMS, in der 123456789012345678901 die ID für den Nutzer Mahan S. darstellt:
{
"text": "A customer has reported an issue. Assigning ticket #942 to <users/123456789012345678901>."
}
Wenn Ihre App Nachrichten mit der Markdown-Syntax sendet, verwenden Sie das HTML-Tag-Format chat-user, um die Nutzer-ID anzugeben:
{
"text": "Assigning ticket #942 to <chat-user data-user=\"users/123456789012345678901\">."
}
Oder per E‑Mail:
{
"text": "Assigning ticket #942 to <chat-user data-email=\"mahan@example.com\">."
}
Die Nachricht sieht so aus:
Sie können den Wert users/{user} auf folgende Weise angeben:
- Wenn Ihre Google Chat-App auf eine vom Nutzer gesendete Nachricht antwortet, können Sie das Feld
message.sender.namedes InteraktionsereignissesMESSAGEverwenden. Wenn Ihre Google Chat-App eine asynchrone Textnachricht erstellt, können Sie den Wert für
users/{user}auf folgende Weise angeben:- Verwenden Sie das Feld
nameder Google Chat-RessourceUser, z. B.users/123456789012345678901. - Verwenden Sie die E-Mail-Adresse des Nutzers als Alias für den Wert
{user}. Wenn die E-Mail-Adresse beispielsweisemahan@example.comlautet, können Sie den Nutzer alsusers/mahan@example.comangeben. Wenn Sie einen E‑Mail-Alias verwenden möchten, muss sich Ihre Google Chat-App als Nutzer authentifizieren.
- Verwenden Sie das Feld
Wenn Sie die People API verwenden, können Sie auch die Methode
people.getverwenden, um die Nutzer-ID zu ermitteln.
Alle Nutzer mit @erwähnen
Wenn Sie eine Nachricht erstellen möchten, in der alle Personen in einem Gruppenbereich mit @erwähnt werden, ersetzen Sie {user} durch all. Im folgenden JSON-Beispiel werden alle Nutzer in einer Nachricht erwähnt:
{
"text": "Important message for <users/all>: Code freeze starts at midnight tonight!"
}
Wenn Ihre App Nachrichten mit der Markdown-Syntax sendet, geben Sie die Erwähnung im HTML-Tag-Format chat-user an:
{
"text": "Important message for <chat-user data-user=\"users/all\">: Code freeze starts at midnight tonight!"
}
Zitationen zu einer Nachricht hinzufügen
Chat-Apps können Zitate in Nachrichten einfügen, um Nutzern detaillierte Quelleninformationen bereitzustellen. Sie können Quellen auf zwei Arten angeben:
- Inline-Zitate: Fügen Sie interaktive Karten hinzu, die angezeigt werden, wenn Nutzer den Mauszeiger auf bestimmte Teile des Nachrichtentexts bewegen.
- Quellen in der Fußzeile: Am Ende der Nachricht wird eine Liste mit Quellen als Links in der Fußzeile angezeigt.
Zitate werden nur unterstützt, wenn die markupSyntax der Nachricht auf MARKUP_SYNTAX_MARKDOWN gesetzt ist. Diese Funktion wird nur über die asynchrone Nachrichtenerstellung mit der Chat API unterstützt.
So fügen Sie einer Nachricht Inline-Zitationen hinzu:
- Geben Sie die Quellen in der
citations-Liste der Nachrichtelementsan und weisen Sie jedemCitation-Objekt eine eindeutigeidzu. - Setzen Sie den Text, den Sie zitieren möchten, im Nachrichtentext in das HTML-Tag-Format
chat-citation:<chat-citation data-id="{id}">{text}</chat-citation>. Achten Sie darauf, dass die{id}mit der ID übereinstimmt, die Sie in derelementsdefiniert haben. Nicht referenzierte Zitate (ohne übereinstimmendes Tag) werden ignoriert.
{
"text": "This is a <chat-citation data-id=\"cite_1\">cited</chat-citation> text.",
"markupSyntax": "MARKUP_SYNTAX_MARKDOWN",
"elements": {
"citations": [
{
"id": "cite_1",
"citedSources": [
{
"title": "Example Source",
"uri": "https://example.com"
}
]
}
]
}
}
Wenn Sie einer Nachricht Quellen in der Fußzeile hinzufügen möchten, geben Sie die Quellen in der Liste citedSources der Nachricht elements an. Alle hier angegebenen Quellen werden automatisch unter der Nachricht als Links in der Fußzeile angezeigt und erfordern keine Inline-Tags im Nachrichtentext.
{
"text": "This is a message with a footer source.",
"markupSyntax": "MARKUP_SYNTAX_MARKDOWN",
"elements": {
"citedSources": [
{
"title": "Example Source",
"uri": "https://example.com"
}
]
}
}
Text in Karten formatieren
In Karten unterstützen die meisten Textfelder eine einfache Textformatierung mit einer kleinen Teilmenge von HTML-Tags. Text in Kartennachrichten wird anders formatiert als in Textnachrichten, da Textnachrichten mit derselben Syntax formatiert werden, die auch von Chat-Nutzern verwendet wird.
Mit dem Kartenersteller können Sie Nachrichten und Benutzeroberflächen für Chat-Apps entwerfen und in der Vorschau ansehen:
Card Builder öffnenAbsatztext formatieren
Die unterstützten Tags und ihr Zweck sind in der folgenden Tabelle aufgeführt:
| Format | Beispiel | Gerendertes Ergebnis |
|---|---|---|
| Fett | "This is <b>bold</b>." |
Dies ist fett. |
| Kursiv | "This is <i>italics</i>." |
Dies ist kursiv. |
| Unterstrichen | "This is <u>underline</u>." |
Dies ist unterstrichen. |
| Durchgestrichen | "This is <s>strikethrough</s>." |
Dies ist |
| Schriftfarbe | "This is <font color=\"#FF0000\">red font</font>." |
Dies ist rote Schrift. |
| Hyperlink | "This is a <a href=\"https://www.google.com\">hyperlink</a>." |
Dies ist ein Hyperlink. |
| Zeit | "This is a time format: <time>2023-02-16 15:00</time>." |
Dies ist ein Zeitformat: . |
| Zeilenvorschub | "This is the first line. <br> This is a new line." |
Dies ist die erste Zeile. Dies ist eine neue Zeile. |
Verwenden Sie die folgenden Tags, um Listen und Codeblöcke zu definieren:
| Format | Beispiel | Gerendertes Ergebnis |
|---|---|---|
| Neue Zeile | "Line 1<br>Line 2" |
Zeile 1 Zeile 2 |
| Festbreitenschrift | "This is an <code>inline code</code>." |
Dies ist ein inline code. |
| Festbreitenschrift-Block | "<pre><code>This a code block.</code></pre>" |
|
| Aufzählungsliste | "<ul><li>List item 1</li><li>List item 2</li></ul>" |
|
| Sortierte Liste | "<ol><li>List item 1</li><li>List item 2</li></ol>" |
|
Markdown
Wenn die Markdown-Syntax aktiviert ist, können Sie die folgende Syntax verwenden:
| Format | Beispiel | Gerendertes Ergebnis |
|---|---|---|
| Fett | **hallo** oder __hallo__ | hallo |
| Kursiv | *hallo* oder _hallo_ | hallo |
| Durchgestrichen | ~hello~ | |
| Festbreitenschrift | `hello` | hello |
| Festbreitenschrift-Block | ``` Hello World ``` |
Hello |
| Aufzählungsliste | - Dies ist das erste Element in der Liste - Dies ist das zweite Element in der Liste |
|
|
* Dies ist das erste Element in der Liste. * Dies ist das zweite Element in der Liste. |
|
|
| Sortierte Liste | 1. Dies ist das erste Element in der Liste 2. Dies ist das zweite Element in der Liste. |
|
| Hyperlink | [Beispielwebsite](https://example.com) | Beispielwebsite |
Symbole zu Text hinzufügen
Wenn Sie Symbole neben Text auf einer Karte anzeigen möchten, können Sie die Widgets DecoratedText und ButtonList verwenden.
In den folgenden Abschnitten wird erläutert, wie Sie integrierte Symbole, Google Material-Symbole oder benutzerdefinierte Symbole in dekoriertem Text oder Schaltflächen verwenden.
Symbole aus Google Chat verwenden
Wenn Sie ein integriertes Symbol verwenden möchten, das in Google Chat verfügbar ist, geben Sie einen der folgenden Werte an:
In der folgenden Tabelle sind die integrierten Symbole aufgeführt, die für Kartennachrichten verfügbar sind:
| AIRPLANE | BOOKMARK | ||
| BUS | CAR | ||
| UHR | CONFIRMATION_NUMBER_ICON | ||
| DESCRIPTION | DOLLAR | ||
| EVENT_SEAT | |||
| FLIGHT_ARRIVAL | FLIGHT_DEPARTURE | ||
| HOTEL | HOTEL_ROOM_TYPE | ||
| EINLADEN | MAP_PIN | ||
| MITGLIEDSCHAFT | MULTIPLE_PEOPLE | ||
| PERSON | SMARTPHONE | ||
| RESTAURANT_ICON | SHOPPING_CART | ||
| STAR | STORE | ||
| TICKET | TRAIN | ||
| VIDEO_CAMERA | VIDEO_PLAY |
Im Folgenden finden Sie ein Beispiel für eine Karte mit einem E-Mail-Symbol:
Google Material-Symbole verwenden
Mit Google Material Design-Symbolen können Sie aus über 2.500 Symboloptionen auswählen und die Strichstärke, Füllung und Abstufung der Symbole anpassen.
Hier ist ein Beispiel für eine Karte mit einem Google Material-Symbol:
Benutzerdefinierte Symbole verwenden
Wenn Sie ein benutzerdefiniertes Symbol hinzufügen möchten, fügen Sie das Feld iconUrl ein und geben Sie die entsprechende URL des Symbols an.
Hier ein Beispiel für ein benutzerdefiniertes Symbol: