Google Chat メッセージの概要

このページでは、テキスト メッセージとカード メッセージの違いについて説明します。

Chat アプリから基本的な情報を伝えるテキスト メッセージを送信すると、Google Chat のユーザーがメッセージを記述するのと同じように、そのメッセージがインラインで表示されます。テキスト以外の内容を含むメッセージを作成したり、ユーザーが操作できるメッセージを作成したりするために、チャットアプリでカードを使用できます。Chat アプリでは、カードにテキスト メッセージを追加することもできます。フォームの入力など、複数のステップからなるプロセスを完了するようユーザーに促すために、チャットアプリでは、新しいウィンドウで開くダイアログ カードを作成することもできます。

テキスト メッセージの構造

Google Chat API では、メッセージは JSON オブジェクトとして表現されます。メッセージ内では、テキスト メッセージは text オブジェクトとして表されます。

次の例では、Chat アプリが、コードフリーズが近づいているソフトウェア開発者チーム向けのスペースにテキスト メッセージを作成しています。

{
  "text": "Attention <users/all>: Code freeze starts at `11:59 am` Pacific Standard Time! If you need a little more time, type `/moreTime` and I'll push the code freeze back one hour."
}

JSON は次のメッセージを返します。

コードフリーズを通知する Google Chat のテキスト メッセージの例。

カード メッセージの構造

Google Chat API では、メッセージは JSON オブジェクトとして表現されます。メッセージ内では、カードは cardsV2 配列として表され、次のもので構成されています。

  • 1 つ以上の CardWithId オブジェクト。
  • cardId: カードを識別し、特定のメッセージ内のスコープを指定するために使用されます。（異なるメール内のカードは同じ ID を持つことができます）。

  • card オブジェクト。以下で構成されます。

    • タイトル、サブタイトル、アバタースタイルの画像などを指定する header オブジェクト。
    • 1 つ以上の section オブジェクト。それぞれに 1 つ以上のウィジェットが含まれています。
    • 1 つ以上の widget オブジェクト。各ウィジェットは、テキスト、画像、ボタン、その他のオブジェクト タイプを表す複合オブジェクトです。

たとえば、次のカード メッセージには、header、section、widget オブジェクトが含まれています。

カード メッセージを使用して Chat スペースでアンケートを実行する Chat アプリ

次のコードは、カード メッセージの JSON を表します。

JSON

{
  "cardsV2": [
    {
      "cardId": "unique-card-id",
      "card": {
        "header": {
          "title": "Sasha",
          "subtitle": "Software Engineer",
          "imageUrl": "https://developers.google.com/chat/images/quickstart-app-avatar.png",
          "imageType": "CIRCLE",
          "imageAltText": "Avatar for Sasha"
        },
        "sections": [
          {
            "header": "Contact Info",
            "collapsible": true,
            "uncollapsibleWidgetsCount": 1,
            "widgets": [
              {
                "decoratedText": {
                  "startIcon": {
                    "knownIcon": "EMAIL"
                  },
                  "text": "sasha@example.com"
                }
              },
              {
                "decoratedText": {
                  "startIcon": {
                    "knownIcon": "PERSON"
                  },
                  "text": "<font color=\"#80e27e\">Online</font>"
                }
              },
              {
                "decoratedText": {
                  "startIcon": {
                    "knownIcon": "PHONE"
                  },
                  "text": "+1 (555) 555-1234"
                }
              },
              {
                "buttonList": {
                  "buttons": [
                    {
                      "text": "Share",
                      "onClick": {
                        "openLink": {
                          "url": "https://example.com/share"
                        }
                      }
                    },
                    {
                      "text": "Edit",
                      "onClick": {
                        "action": {
                          "function": "goToView",
                          "parameters": [
                            {
                              "key": "viewType",
                              "value": "EDIT"
                            }
                          ]
                        }
                      }
                    }
                  ]
                }
              }
            ]
          }
        ]
      }
    }
  ]
}