Auf dieser Seite wird erläutert, wie Google Chat-Apps Text formatieren können, um Nachrichten zu senden, die Folgendes enthalten:
- 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 angezeigt wird, z. B. auf einer Schaltfläche.
Nachricht formatieren
In Google Chat können Sie Textnachrichten einfach formatieren, z. B. fett, kursiv oder durchgestrichen. Sie formatieren Text in SMS anders als in Karten-Nachrichten, da SMS mit derselben Syntax formatiert werden, die Chat-Nutzer verwenden.
Für Nachrichten, die über die Chat API gesendet werden, können Sie weiterhin die ursprüngliche Chat-Syntax oder die standardmäßige Markdown-Syntax verwenden. Letztere wird unterstützt, wenn Sie markup_syntax im Anfragetext angeben.
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) | `hallo` | hello |
| Festbreitenschriftblock | ` ` ` (drei Backquotes) | ` ` ` (drei Backquotes) | ``` Hallo Welt ``` |
Hello |
| Aufzählungsliste | * oder – (Bindestrich), gefolgt von einem Leerzeichen | * oder – (Bindestrich), gefolgt von einem Leerzeichen | * Dies ist der erste Eintrag in der Liste. * Dies ist das zweite Element in der Liste. |
|
| Verschachtelte Liste | * oder – (Bindestrich), gefolgt von einem Leerzeichen, dem vier Leerzeichen pro Verschachtelungsebene vorangestellt sind | * oder – (Bindestrich), gefolgt von einem Leerzeichen, dem vier Leerzeichen pro Verschachtelungsebene vorangestellt sind | * Dies ist das Element mit der verschachtelten Tiefe 1 in der Liste. * Dies ist das Element mit der verschachtelten Tiefe 2 in der Liste. * Dies ist das Element mit der verschachtelten Tiefe 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) | >hallo |
|
| Hyperlink | <hyperlink|display text> |
[display text](hyperlink) |
Oder:
|
Weitere Informationen zum Verlinken 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 Katzen-Smiley-Emoji) |
| 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 Zitationen finden Sie unter Zitationen zu einer Nachricht hinzufügen. |
Betrachten Sie beispielsweise das folgende JSON:
{
"text": "Your pizza delivery *has arrived*!\nThank you for using _Cymbal Pizza!_"
}
Diese formatierte Textnachricht zeigt Folgendes in einem Chatbereich an:
In einer Nachricht gesendete Textformatierung ansehen
Wenn ein Nutzer eine Nachricht sendet, befindet sich der Nur-Text-Inhalt der Nachricht im Feld text. Einige Formatierungen, die mit der Markdown-Syntax auf die Nachricht angewendet werden, befinden sich im Feld text. Zusätzliche Formatierungen sind im reinen Ausgabefeld formattedText enthalten, darunter:
- Zusätzliche Markdown-Syntax für Text
- Erwähnungen von Nutzern
- Benutzerdefinierte Hyperlinks
- Benutzerdefinierte Emojis
Hier ein Beispiel für einen 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. Im folgenden Beispiel sehen Sie 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*?",
}
Links formatieren
Wenn Sie eine einfache Link-URL in Ihren Nachrichtentext einfügen, z. B. http://www.example.com/, wird diese von Google Chat als Linktext verwendet und automatisch mit der angegebenen URL verlinkt.
Wenn Sie alternativen Linktext für Ihren Link angeben möchten, verwenden Sie die folgende Syntax:
Verwenden Sie für API-Nachrichten, die mit Markdown konfiguriert sind, die standardmäßige Markdown-Link-Syntax:
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>Das Pipe-Zeichen und der Linktext sind optional, sodass
<https://example.com>undhttps://example.comgleichwertig 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 sie 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 Nutzerauthentifizierung verwenden. Benutzerdefinierte Emojis werden nicht in Nachrichten, die als Webhook erstellt wurden, oder in Nachrichten, die mit der App-Authentifizierung erstellt wurden, unterstützt.
Wenn Sie dem Text einer Nachricht benutzerdefinierte Emojis hinzufügen möchten, geben Sie die name oder 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 customEmoji-Ressource.
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\">."
}
Oder Sie geben den Namen des benutzerdefinierten Emojis an:
{
"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 Shortcode-Namen des benutzerdefinierten Emojis.
Nutzer in einer Nachricht erwähnen
Chat-Apps können SMS-Nachrichten 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 noch nicht beigetreten sind oder Mitglieder eines Gruppenbereichs im Importmodus sind.
Bei stillen Nachrichten können Nutzer nicht erwähnt werden. Wenn Sie eine Erwähnung in eine stumme Nachricht einfügen, wird ein Fehler zurückgegeben.
Bestimmte Nutzer @erwähnen
Wenn Sie einen bestimmten Nutzer mit @erwähnen möchten, fügen Sie der Nachricht <users/{user}> hinzu. Dabei ist {user} die ID des Nutzers. 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 geben Sie die E‑Mail-Adresse an:
{
"text": "Assigning ticket #942 to <chat-user data-email=\"mahan@example.com\">."
}
Die Nachricht sieht so aus:
Sie können den users/{user}-Wert auf folgende Weise angeben:
- Wenn Ihre Google Chat App auf eine Nachricht antwortet, die vom Nutzer gesendet wurde, können Sie das Feld
message.sender.namedesMESSAGE-Interaktionsereignisses verwenden. Wenn Ihre Google Chat App eine asynchrone Nachricht 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
{user}-Wert. 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 Ihre Google Chat App als Nutzer authentifiziert werden.
- Verwenden Sie das Feld
Wenn Sie die People API verwenden, können Sie auch die
people.get-Methode verwenden, um die Nutzer-ID zu ermitteln.
Alle Nutzer @erwähnen
Wenn Sie eine Nachricht erstellen möchten, in der alle Personen in einem Gruppenbereich 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 chat-user-HTML-Tag-Format an:
{
"text": "Important message for <chat-user data-user=\"users/all\">: Code freeze starts at midnight tonight!"
}
Zitationen in eine Nachricht einfügen
Chat-Apps können Zitate in Textnachrichten einfügen, um Nutzern detaillierte Quellenangaben zu liefern. Sie können Quellen auf zwei Arten angeben:
- Inline-Zitationen: Fügen Sie interaktive Karten hinzu, die angezeigt werden, wenn Nutzer den Mauszeiger auf bestimmte Teile Ihres Nachrichtentexts bewegen.
- Quellen in der Fußzeile: Am Ende der Nachricht wird eine Liste mit Quellen als Links in der Fußzeile angezeigt.
Zitationen werden nur unterstützt, wenn markupSyntax der Nachricht auf MARKUP_SYNTAX_MARKDOWN festgelegt 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 Liste
citationsder Nachrichtelementsan und weisen Sie jedemCitation-Objekt eine eindeutigeidzu. - Schließen Sie den Text, den Sie zitieren möchten, im Nachrichtentext in das HTML-Tag
chat-citationein:<chat-citation data-id="{id}">{text}</chat-citation>. Achten Sie darauf, dass{id}mit der ID übereinstimmt, die Sie inelementsdefiniert haben. Nicht referenzierte Zitationen (ohne entsprechendes 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 als Fußzeilenlinks unter der Nachricht angezeigt. Inline-Tags im Nachrichtentext sind nicht erforderlich.
{
"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 wird in den meisten Textfeldern die grundlegende Textformatierung mithilfe einer kleinen Teilmenge von HTML-Tags unterstützt. Sie formatieren Text in Kartenmitteilungen anders als in Textnachrichten, da Textnachrichten mit derselben Syntax formatiert werden, die Chat-Nutzer verwenden.
Mit dem Card Builder 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>." |
Dieser Text ist fett. |
| Kursiv | "This is <i>italics</i>." |
Das ist kursiv. |
| Unterstrichen | "This is <u>underline</u>." |
Das ist unterstrichen. |
| Durchgestrichen | "This is <s>strikethrough</s>." |
Dies ist |
| Schriftfarbe | "This is <font color=\"#FF0000\">red font</font>." |
Das 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>." |
Das ist ein inline code. |
| Festbreitenschriftblock | "<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 | ~Hallo~ | |
| Festbreitenschrift | `hallo` | hello |
| Festbreitenschriftblock | ``` Hallo Welt ``` |
Hello |
| Aufzählungsliste | – Dies ist der erste Eintrag 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. Das ist das erste Element in der Liste. 2. Dies ist das zweite Element in der Liste. |
|
| Hyperlink | [Beispielwebsite](https://beispiel.de) | Beispielwebsite |
Symbole in Text einfü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 formatiertem Text oder Schaltflächen verwenden.
Symbole aus Google Chat verwenden
Wenn Sie ein in Chat verfügbares integriertes Symbol verwenden möchten, geben Sie eines der folgenden Elemente an:
In der folgenden Tabelle sind die integrierten Symbole aufgeführt, die für Kartenmitteilungen 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 |
Hier ein Beispiel für eine Karte mit einem E‑Mail-Symbol:
Google Material-Symbole verwenden
Sie können Google Material-Symbole verwenden, um aus über 2.500 Symboloptionen auszuwählen und die Stärke, Füllung und den Grad der Symbole anzupassen.
Hier sehen Sie ein Beispiel für eine Karte mit einem Google Material Design-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: