Ringkasan pesan Google Chat

Halaman ini menjelaskan perbedaan antara pesan teks dan kartu.

Saat aplikasi Chat mengirim pesan teks untuk menyampaikan informasi dasar, pesan muncul secara inline, sama seperti cara orang di Google Chat menulis membuat pesan teks. Untuk membuat pesan yang berisi lebih dari teks, atau untuk membuat pesan yang dapat berinteraksi dengan pengguna, aplikasi Chat dapat digunakan kartu. Aplikasi chat juga dapat menambahkan pesan teks dengan kartu. Kepada meminta pengguna untuk menyelesaikan proses multi-langkah seperti mengisi formulir, Aplikasi Chat juga dapat membuat kartu yang terbuka di jendela baru saat dialog.

Anatomi pesan teks

Di Google Chat API, pesan direpresentasikan sebagai objek JSON. Di dalam pesan, sebuah pesan teks direpresentasikan sebagai text .

Dalam misalnya, aplikasi Chat membuat pesan teks di ruang untuk tim developer software yang hampir mengalami pembekuan kode:

{
  "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 akan menampilkan pesan berikut:

Contoh pesan teks di Google Chat yang mengumumkan code freeze (tidak ada lagi perubahan kode).

Anatomi pesan kartu

Di Google Chat API, pesan direpresentasikan sebagai objek JSON. Di dalam pesan kartu direpresentasikan sebagai cardsV2 array dan terdiri dari hal berikut:

  • Satu atau lebih Objek CardWithId.
  • cardId, digunakan untuk mengidentifikasi kartu dan dicakup dalam pesan tertentu. (Kartu di pesan yang berbeda dapat memiliki ID yang sama.)

  • Objek card, yang terdiri dari hal berikut:

    • Objek header yang menentukan hal-hal seperti judul, subjudul, dan gambar bergaya avatar.
    • Satu atau lebih Objek section yang masing-masing berisi setidaknya satu widget.
    • Satu atau lebih Objek widget. Setiap widget adalah objek gabungan yang dapat merepresentasikan teks, gambar, tombol, dan jenis objek lainnya.

Misalnya, pesan kartu berikut berisi header, section, dan Objek widget:

Aplikasi Chat yang menjalankan polling di Chat ruang menggunakan kartu pesan

Kode berikut mewakili JSON pesan kartu:

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"
                            }
                          ]
                        }
                      }
                    }
                  ]
                }
              }
            ]
          }
        ]
      }
    }
  ]
}

Gunakan Card Builder untuk mendesain dan melihat pratinjau pesan kartu JSON untuk aplikasi Chat:

Membuka Card Builder