このページでは、Google Chat アプリでテキストをフォーマットして、次のいずれかを含むメッセージを送信する方法について説明します。
- ハイパーリンクを含むリッチテキスト、または Chat Space 内の 1 人以上のユーザーを @メンションするリッチテキスト。
- カード インターフェースに表示されるテキスト（段落テキストや、ボタンなどのアイコンの横に表示される UI テキストなど）。
テキスト メッセージの書式を設定する
Chat では、Markdown 構文のサブセットを使用して、太字、斜体、取り消し線などの基本的な書式をテキスト メッセージに追加できます。テキスト メッセージは Chat ユーザーが使用する構文で書式設定されるため、テキスト メッセージとカード メッセージではテキストの書式設定が異なります。
テキスト メッセージをフォーマットするには、次の構文を使用します。
| 形式 | 記号 | 構文の例 | Google Chat に表示されるテキスト |
|---|---|---|---|
| 太字 | * | *hello* | hello |
| 斜体 | _（アンダースコア） | _hello_ | hello |
| 取り消し線 | ~ | ~hello~ | |
| 等幅 | ` （バッククォート） | 「hello」 | hello |
| 等幅ブロック | ` ` ` （3 つのバッククォート） | ``` Hello World ``` |
Hello |
| 箇条書き | * または -（ハイフン）とスペース 1 つ | * リストの最初の項目です * リスト内の 2 つ目の項目 |
|
たとえば、次の JSON について考えてみましょう。
{
"text": "Your pizza delivery *has arrived*!\nThank you for using _Cymbal Pizza!_"
}
このフォーマットされたテキスト メッセージは、チャット スペースに次のように表示されます。
メッセージで送信されたテキストの書式設定を表示する
ユーザーがメッセージを送信すると、メッセージの本文がプレーンテキストで text フィールドに格納されます。Markdown 構文を使用してテキスト メッセージに適用される書式の一部は、text フィールドにあります。その他のフォーマットは、出力専用の formattedText フィールドにあります。次に例を示します。
- テキストの追加のマークダウン構文
- ユーザーによる言及
- カスタム ハイパーリンク
- カスタム絵文字
たとえば、ユーザーから送信された次のテキストについて考えてみましょう。
チャット UI の [書式] メニューを使用してメッセージの書式設定を行った場合、text フィールドにはテキストのみが含まれ、formattedText フィールドにはマークアップ、テキスト、ハイパーリンクが含まれます。次の例は、単語にハイパーリンクが設定され、リストにアイテムが含まれ、1 つの単語が太字になっているテキスト メッセージの下書きを示しています。
メッセージは次の形式で受信されます。
{
"text": "I can meet there at:\nNoon\n3 pm\n5 pm\nWhat time works for you?",
"formattedText": "I can meet at:\n* Noon\n* 3 pm\n* 5 pm\nWhat time works for *you*?" ,
}
リンクをフォーマットする
メッセージのテキストにプレーンなリンク URL（http://www.example.com/ など）を含めると、Google Chat はこれをリンクテキストとして使用し、そのテキストを指定された URL に自動的にハイパーリンクします。
リンクの代替テキストを指定するには、次の構文を使用します。
| 構文の例 | Google Chat に表示されるテキスト |
|---|---|
|
パイプとリンク テキストは省略可能であるため、https://www.example.com/ は同等です。
テキスト メッセージでカスタム絵文字を使用する
チャットアプリは、カスタム絵文字を含むテキスト メッセージを送信して、メッセージをカスタマイズできます。カスタム絵文字は Google Workspace 組織でのみ使用できます。また、組織でカスタム絵文字を有効にする必要があります。詳しくは、Google Chat のカスタム絵文字についてとカスタム絵文字の権限を管理するをご覧ください。
カスタム絵文字を含むメッセージを作成するには、アプリでユーザー認証を使用する必要があります。カスタム絵文字は、Webhook として作成されたメッセージや、アプリ認証で作成されたメッセージではサポートされていません。
メッセージのテキストにカスタム絵文字を追加するには、customEmoji リソースの name または emoji_name を指定します。
{
"text": "Hello CUSTOM_EMOJI_ID>."
}
このサンプルを使用するには、CUSTOM_EMOJI_ID をカスタム絵文字の ID に置き換えます。この ID は、customEmoji リソースの name フィールドまたは emoji_name フィールドで確認できます。
テキスト メッセージでユーザーの名前リンクを追加する
Chat 用アプリは、Chat スペース内の 1 人またはすべてのユーザーを @メンションするテキスト メッセージを送信できます。スペースに参加していないユーザーやインポート モードのスペースをメンションするには、Chat アプリがユーザー認証でメッセージを送信する必要があります。
特定のユーザーの名前リンクを追加する
特定のユーザーに @メンションするには、テキスト メッセージに {user} はユーザーの ID です。たとえば、次のテキスト メッセージを考えてみましょう。ここで、123456789012345678901 はユーザー Mahan S. の ID を表します。
{
"text": "A customer has reported an issue. Assigning ticket #942 to ."
}
テキスト メッセージは次のように表示されます。
users/{user} 値は次の方法で指定できます。
- Google Chat アプリがユーザーから送信されたメッセージに応答する場合は、
MESSAGEインタラクション イベントのmessage.sender.nameフィールドを使用できます。 Google Chat アプリが非同期テキスト メッセージを作成している場合は、次の方法で
users/{user}の値を指定できます。- Google Chat の
Userリソースのnameフィールド（users/123456789012345678901など）を使用します。 {user}値のエイリアスとしてユーザーのメールアドレスを使用します。たとえば、メールアドレスが[email protected]の場合、ユーザーをusers/[email protected]として指定できます。メール エイリアスを使用するには、Google Chat アプリがユーザーとして認証されている必要があります。
- Google Chat の
People API を使用している場合は、
people.getメソッドを使用してユーザー ID を特定することもできます。
すべてのユーザーに名前リンクを追加する
スペース内の全員に @メンションするテキスト メッセージを作成するには、{user} を all に置き換えます。次の JSON の例では、メッセージ内のすべてのユーザーに言及しています。
{
"text": "Important message for : Code freeze starts at midnight tonight!"
}
カードに表示されるテキストの書式を設定する
カード内のほとんどのテキスト フィールドは、HTML タグの一部を使用して基本的なテキストの書式設定をサポートしています。テキスト メッセージは Chat ユーザーが使用する構文で書式設定されるため、カード メッセージとテキスト メッセージではテキストの書式設定が異なります。
カード作成ツールを使用して、Chat アプリのメッセージとユーザー インターフェースを設計し、プレビューできます。
カードビルダーを開く段落テキストの書式を設定する
サポートされているタグとその目的を次の表に示します。
| 形式 | 例 | レンダリングされた結果 |
|---|---|---|
| 太字 | "This is bold." |
これは太字です。 |
| イタリック体 | "This is italics." |
これは斜体です。 |
| 下線 | "This is underline." |
これは下線です。 |
| 取り消し線 | "This is |
これは |
| フォントの色 | "This is red font." |
これは赤いフォントです。 |
| Hyperlink | "This is a hyperlink." |
これはハイパーリンクです。 |
| 時間 | "This is a time format: ." |
時刻の形式は です。 |
| 改行 | "This is the first line. " |
これが最初の行です。 これは新しい行です。 |
テキストにアイコンを追加する
カード内のテキストの横にアイコンを表示するには、DecoratedText ウィジェットと ButtonList ウィジェットを使用します。
以降のセクションでは、装飾されたテキストやボタンで組み込みアイコン、Google マテリアル アイコン、カスタム アイコンを使用する方法について説明します。
Chat のアイコンを使用する
Chat で利用可能な組み込みアイコンを使用するには、次のいずれかを指定します。
次の表に、カード メッセージで使用できる組み込みアイコンを示します。
| AIRPLANE | ブックマーク | ||
| BUS | CAR | ||
| 時計 | CONFIRMATION_NUMBER_ICON | ||
| 説明 | ドル | ||
| メールアドレス | EVENT_SEAT | ||
| FLIGHT_ARRIVAL | FLIGHT_DEPARTURE | ||
| ホテル | HOTEL_ROOM_TYPE | ||
| INVITE | MAP_PIN | ||
| メンバーシップ | MULTIPLE_PEOPLE | ||
| PERSON | PHONE | ||
| RESTAURANT_ICON | SHOPPING_CART | ||
| STAR | ストア | ||
| TICKET | トレイン | ||
| VIDEO_CAMERA | VIDEO_PLAY |
メールアイコン付きのカードは次のとおりです。
Google マテリアル アイコンを使用する
Google マテリアル アイコンを使用すると、2,500 を超えるアイコン オプションから選択し、アイコンの太さ、塗りつぶし、グレードをカスタマイズできます。
Google マテリアル アイコンを使用したカードの例を次に示します。
カスタム アイコンを使用する
カスタム アイコンを追加するには、iconUrl フィールドを含めて、アイコンに対応する URL を指定します。
カスタム アイコンの例を次に示します。