Google Chat では、メッセージに次のような書式設定を追加できます。
- テキスト メッセージとカード メッセージにおける、太字、斜体、取り消し線などの基本的なテキスト書式設定。
- リンクされたテキスト。
- Chat スペースで 1 人またはすべてのユーザーに名前リンクを付ける。
- 組み込みアイコンとカスタム アイコンはカード メッセージにのみ追加します。
テキスト メッセージの書式を設定する
Chat では、Markdown 構文の小さなサブセットを使用して、太字、斜体、取り消し線などの基本的な書式設定をテキスト メッセージに追加できます。テキスト メッセージは Chat ユーザーが使用する構文と同じ構文で書式設定されるため、テキスト メッセージとカード メッセージではテキストの形式が異なります。カードに表示されるテキストを書式設定するには、カード メッセージの形式を設定するをご覧ください。
テキスト メッセージを書式設定するには、次の構文を使用します。
| 形式 | 記号 | 構文の例 | Google Chat に表示されるテキスト |
|---|---|---|---|
| 太字 | * | *こんにちは* | こんにちは |
| 斜体 | _（アンダースコア） | _こんにちは_ | こんにちは |
| 取り消し線 | ~ | ~こんにちは~ | |
| 等幅 | `（バッククォート） | 「hello」 | hello |
| 等幅ブロック | ` ` `（3 つのバッククォート） | 「 Hello World 」 |
Hello |
| 箇条書き | * または -（ハイフン）の後にスペース 1 つ | * これはリストの最初の項目です * これはリストの 2 番目の項目です |
|
たとえば、次の JSON について考えてみましょう。
{
"text": "Your pizza delivery *has arrived*!\nThank you for using _Cymbal Pizza!_"
}
この書式設定されたテキスト メッセージにより、Chat スペースに次の内容が表示されます。
メッセージで送信されたテキストの書式を確認する
ユーザーがメッセージを送信すると、メッセージの書式なしテキストの本文が text フィールドに格納されます。マークダウン構文を使用してテキスト メッセージに適用される書式設定の一部は、text フィールドにあります。出力専用の formattedText フィールドには、次のような追加の書式設定があります。
- テキスト用の追加のマークダウン構文
- ユーザーのメンション
- カスタム ハイパーリンク
- カスタム絵文字
たとえば、ユーザーが送信した次のテキストについて考えてみましょう。
メッセージがチャット UI の [Format] メニューを使用して書式設定された場合、text フィールドにはテキストのみが含まれ、formattedText フィールドにはマークアップ、テキスト、ハイパーリンクが含まれます。次の例は、単語がハイパーリンクされ、リスト内のアイテム、1 つの単語が太字になっているテキスト メッセージの下書きを示しています。
メッセージは次の形式で受信されます。
{
"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*?",
}
リンクの書式を設定する
メッセージ テキストに http://www.example.com/ のような書式なしリンクの URL を含めると、Google Chat はこれをリンクテキストとして使用し、指定された URL に自動的にハイパーリンクを設定します。
リンクに代替リンクテキストを指定するには、次の構文を使用します。
| 構文の例 | Google Chat に表示されるテキスト |
|---|---|
<https://example.com|Example website> |
パイプテキストとリンクテキストは省略可能です。つまり、<https://www.example.com/> と https://www.example.com/ は同じです。
テキスト メッセージでユーザーをメンションする
Chat アプリでは、Chat スペース内の 1 人またはすべてのユーザーに名前リンク付きのテキスト メッセージを送信できます。Chat アプリでは、インポート モードのスペースのユーザーや、スペースに参加していないユーザーにメンションすることはできません。
特定のユーザーの名前リンクを追加する
特定のユーザーの名前リンクを使用するには、テキスト メッセージに <users/{user}> を追加します。ここで、{user} はユーザーの ID です。たとえば、次のテキスト メッセージについて考えてみましょう。ここで、123456789012345678901 はユーザー Mahan S の ID を表します。
{
"text": "A customer has reported an issue. Assigning ticket #942 to <users/123456789012345678901>."
}
テキスト メッセージは次のように表示されます。
users/{user} 値は次の方法で指定できます。
- Google Chat アプリがユーザーから送信されたメッセージに応答する場合は、
MESSAGEインタラクション イベントのmessage.sender.nameフィールドを使用できます。 Google Chat アプリで非同期テキスト メッセージを作成する場合は、次の方法で
users/{user}の値を指定できます。People API を使用する場合は、
people.getメソッドを使用してユーザー ID を識別することもできます。
すべてのユーザーの名前リンクを追加
スペース内の全員に名前リンクを付けるテキスト メッセージを作成するには、{user} を all に置き換えます。次の JSON の例では、メッセージにすべてのユーザーが含まれています。
{
"text": "Important message for <users/all>: Code freeze starts at midnight tonight!"
}
カード メッセージをフォーマットする
カード内のほとんどのテキスト フィールドでは、HTML タグの小規模なサブセットを使用して、基本的なテキスト形式がサポートされます。テキスト メッセージは Chat ユーザーが使用する構文と同じ構文で書式設定されるため、カード メッセージとテキスト メッセージではテキストの形式が異なります。テキスト メッセージに表示されるテキストの書式を設定するには、テキスト メッセージの書式を設定するをご覧ください。
カードビルダーを使用して、Chat アプリ用の JSON カード メッセージを設計し、プレビューします。
カードビルダーを開く次の表に、サポートされているタグとその目的を示します。
| 形式 | 例 | レンダリングされた結果 |
|---|---|---|
| 太字 | "This is <b>bold</b>." |
これは太字で表示されています。 |
| イタリック体 | "This is <i>italics</i>." |
これは斜体です。 |
| Underline | "This is <u>underline</u>." |
こちらは下線です。 |
| 取り消し線 | "This is <s>strikethrough</s>." |
これは |
| フォントの色 | "This is <font color=\"#FF0000\">red font</font>." |
これは赤いフォントです。 |
| Hyperlink | "This is a <a href=\"https://www.google.com\">hyperlink</a>." |
これはハイパーリンクです。 |
| 時間 | "This is a time format: <time>2023-02-16 15:00</time>." |
時刻の形式は です。 |
| 改行 | "This is the first line. <br> This is a new line. インチ |
これが最初の行です。 これは新しい行です。 |
組み込みのアイコンをカードに追加する
DecoratedText ウィジェットと ButtonList ウィジェットは、Chat で使用可能な組み込みアイコンの 1 つを指定するために使用される icon 要素をサポートしています。
次の表に、カード メッセージに使用できる組み込みアイコンを示します。
| 飛行機 | BOOKMARK | ||
| BUS | 車 | ||
| 時計 | CONFIRMATION_NUMBER_ICON | ||
| DESCRIPTION | ドル | ||
| メールアドレス | EVENT_SEAT | ||
| FLIGHT_ARRIVAL | FLIGHT_DEPARTURE | ||
| ホテル | HOTEL_ROOM_TYPE | ||
| 招待 | MAP_PIN | ||
| メンバーシップ | MULTIPLE_PEOPLE | ||
| 人物 | 電話 | ||
| RESTAURANT_ICON | SHOPPING_CART | ||
| スターを付ける | 店舗 | ||
| チケット | TRAIN | ||
| VIDEO_CAMERA | VIDEO_PLAY |
メールアイコンを含むカードの例を次に示します。
Google マテリアル デザインのアイコンをカードに追加する
DecoratedText ウィジェットと ButtonList ウィジェットでは、Google マテリアル アイコンを使用できるため、2,500 以上のアイコン オプションから選択し、アイコンの重量、塗りつぶし、グレードをカスタマイズできます。
Google マテリアル アイコンを含むカードの例を次に示します。
カードにカスタム アイコンを追加する
DecoratedText ウィジェットと ButtonList ウィジェットでは、組み込みのアイコンを使用したり、独自のカスタム アイコンを定義したりできます。カスタム アイコンをカードに追加するには、iconUrl フィールドを含めて、アイコンに対応する URL を指定します。
カスタム アイコンの例を次に示します。