形式メッセージ

このページでは、Google Chat アプリでテキストの書式を設定して、次のいずれかを含むメッセージを送信する方法について説明します。

• ハイパーリンクを含むリッチテキスト、または Chat スペース内の 1 人またはすべてのユーザーを @メンションするリッチテキスト。
• カード インターフェースに表示されるテキスト（段落テキストや、ボタンなどのアイコンの横に表示される UI テキストなど）。

テキスト メッセージの書式を設定する

Chat では、マークダウン構文の小さなサブセットを使用して、テキスト メッセージに太字、斜体、取り消し線などの基本的な書式を追加できます。テキスト メッセージは Chat ユーザーが使用するのと同じ構文で書式設定されるため、カード メッセージとは異なる方法で書式設定します。

テキスト メッセージの書式を設定するには、次の構文を使用します。

たとえば、次の JSON を考えてみましょう。

    {
      "text": "Your pizza delivery *has arrived*!\nThank you for using _Cymbal Pizza!_"
    }

この書式設定されたテキスト メッセージは、Chat スペースに次のように表示されます。

メッセージで送信されたテキストの書式設定を表示する

ユーザーがメッセージを送信すると、メッセージの書式なしテキストの本文が text フィールドに表示されます。マークダウン構文を使用してテキスト メッセージに適用される書式設定の一部は、text フィールドに表示されます。その他の書式設定は、出力専用の formattedText フィールドに表示されます。たとえば、次のようなものがあります。

• テキストの追加のマークダウン構文
• ユーザーのメンション
• カスタム ハイパーリンク
• カスタム絵文字

たとえば、ユーザーが送信した次のテキストを考えてみましょう。

メッセージが Chat UI の [書式] メニューを使用して書式設定されている場合、text フィールドにはテキストのみが含まれ、formattedText フィールドにはマークアップ、テキスト、ハイパーリンクが含まれます。次の例は、単語がハイパーリンクされたテキスト メッセージの下書き、リスト内の項目、太字の単語を示しています。

メッセージは次の形式で受信されます。

    {
      "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 に自動的にハイパーリンクします。

リンクの代替リンクテキストを指定するには、次の構文を使用します。

パイプとリンクテキストは省略可能であるため、<https://www.example.com/> と https://www.example.com/ は同等です。

テキスト メッセージでカスタム絵文字を使用する

Chat アプリは、カスタム絵文字を含むテキスト メッセージを送信して、メッセージをカスタマイズできます。カスタム絵文字は Google Workspace 組織でのみ使用できます。管理者は、組織でカスタム絵文字を有効にする必要があります。詳細については、 Google Chat のカスタム絵文字について とカスタム絵文字の権限を管理するをご覧ください。

カスタム絵文字を含むメッセージを作成するには、アプリで ユーザー認証を使用する必要があります。 Webhook として作成された メッセージ や、アプリ認証で作成されたメッセージでは、カスタム絵文字はサポートされていません。

メッセージのテキストにカスタム絵文字を追加するには、name または emoji_name の customEmoji リソースを指定します。

{
    "text": "Hello <customEmojis/CUSTOM_EMOJI_ID>."
}

このサンプルを使用するには、CUSTOM_EMOJI_ID をカスタム絵文字の ID に置き換えます。この ID は、 name または emoji_name リソースの customEmoji フィールドにあります。

テキスト メッセージでユーザーをメンションする

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.sender.name フィールドの MESSAGE インタラクション イベントを使用できます。

• Google Chat アプリが非同期テキスト メッセージを作成している場合は、users/{user} の値を次の方法で指定できます。

  • Google Chat User リソースの name フィールド（ users/123456789012345678901 など）を使用します。
  • ユーザーのメールアドレスを {user} 値のエイリアスとして使用します。たとえば、メールアドレスが mahan@example.com の場合、ユーザーを users/mahan@example.com として指定できます。メールエイリアスを使用するには、お使いの Google Chat アプリが ユーザーとして認証されている必要があります。

• People API を使用する場合は、 people.get メソッド を使用してユーザー ID を特定することもできます。

すべてのユーザーを @メンションする

スペース内のすべてのユーザーを @メンションするテキスト メッセージを作成するには、{user} を all に置き換えます。次の JSON の例では、メッセージ内のすべてのユーザーをメンションしています。

{
    "text": "Important message for <users/all>: Code freeze starts at midnight tonight!"
}

カードに表示されるテキストの書式を設定する

カード内では、ほとんどのテキスト フィールドで、HTML タグの小さなサブセットを使用して基本的なテキストの書式設定がサポートされています。テキスト メッセージは Chat ユーザーが使用するのと同じ構文で書式設定されるため、カード メッセージとは異なる方法で書式設定します。

カード作成ツールを使用して、Chat アプリのメッセージングとユーザー インターフェースを設計してプレビューします。

段落テキストの書式を設定する

サポートされているタグとその目的を次の表に示します。

リストとコードブロックを定義するには、次のタグを使用します。

This is a code block.

マークダウン

マークダウン構文が有効になっている場合は、次の構文を使用できます。

テキストにアイコンを追加する

カード内のテキストの横にアイコンを表示するには、 DecoratedText と ButtonList ウィジェットを使用します。

以降のセクションでは、装飾テキストまたはボタンで組み込みアイコン、Google マテリアル アイコン、カスタム アイコンを使用する方法について説明します。

Chat のアイコンを使用する

Chat で使用できる組み込みアイコンを使用するには、次のいずれかを指定します。

次の表に、カード メッセージで使用できる組み込みアイコンを示します。

メールアイコンを含むカードの例を次に示します。

Google マテリアル アイコンを使用する

Google マテリアル アイコンを使用すると、2,500 以上のアイコン オプションから選択し、アイコンの太さ、塗りつぶし、グレードをカスタマイズできます。

Google マテリアル アイコンを含むカードの例を次に示します。

カスタム アイコンを使用する

カスタム アイコンを追加するには、iconUrl フィールドを含めて、アイコンに対応する URL を指定します。

カスタム アイコンの例を次に示します。