Memformat pesan

Halaman ini menjelaskan cara aplikasi Google Chat memformat teks untuk mengirim pesan yang berisi salah satu dari berikut ini:

• Teks kaya yang berisi hyperlink atau @sebutan satu atau semua pengguna di ruang Chat.
• Teks yang muncul di antarmuka kartu, termasuk sebagai teks paragraf atau teks UI yang ditampilkan bersama ikon, seperti tombol.

Memformat pesan teks

Dengan Chat, Anda dapat menambahkan pemformatan dasar ke pesan teks, termasuk huruf tebal, miring, dan coretan. Anda memformat teks secara berbeda dalam pesan teks dan pesan kartu karena pesan teks diformat dengan sintaksis yang sama dengan yang digunakan pengguna Chat.

Untuk pesan yang dikirim menggunakan Chat API, Anda dapat terus menggunakan sintaks Chat asli atau menggunakan sintaks Markdown standar (didukung dengan menentukan markup_syntax di isi permintaan).

Untuk memformat pesan teks, gunakan sintaksis berikut:

Misalnya, pertimbangkan JSON berikut:

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

Pesan teks yang diformat ini menampilkan hal berikut di ruang Chat:

Melihat pemformatan teks yang dikirim dalam pesan

Saat pengguna mengirim pesan, isi pesan teks biasa ada di kolom text. Beberapa pemformatan yang diterapkan ke pesan teks menggunakan sintaksis Markdown, berada di kolom text. Pemformatan tambahan ada di kolom formattedText hanya output, termasuk yang berikut:

• Sintaks Markdown tambahan untuk teks
• Sebutan pengguna
• Hyperlink kustom
• Emoji kustom

Misalnya, pertimbangkan teks berikut yang dikirim oleh pengguna:

Jika pesan diformat menggunakan menu Format di UI Chat, kolom text hanya berisi teks, sedangkan kolom formattedText berisi markup, teks, dan hyperlink. Contoh berikut menunjukkan draf pesan teks dengan satu kata yang diberi hyperlink, item dalam daftar, dan satu kata yang ditebalkan:

Pesan diterima dalam format berikut:

    {
      "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*?",
    }

Memformat link

Jika Anda menyertakan URL link biasa dalam teks pesan, seperti http://www.example.com/, Google Chat akan menggunakan URL ini sebagai teks link dan menautkan teks tersebut secara otomatis ke URL yang ditentukan.

Untuk memberikan teks link alternatif untuk link Anda, gunakan sintaksis berikut:

• Untuk pesan API yang dikonfigurasi dengan Markdown, gunakan sintaks link Markdown standar:

  Contoh sintaksis	Teks yang ditampilkan di Google Chat
  [Example website](https://example.com)	Example website

• Untuk pesan teks biasa standar, gunakan sintaksis pipe:

  Contoh sintaksis	Teks yang ditampilkan di Google Chat
  <https://example.com|Example website>	Example website

  Teks pipa dan link bersifat opsional, sehingga <https://example.com> dan https://example.com setara.

Menggunakan emoji kustom dalam pesan teks

Aplikasi chat dapat mengirim pesan teks dengan emoji kustom untuk mempersonalisasi pesan. Emoji kustom hanya tersedia untuk organisasi Google Workspace, dan administrator harus mengaktifkan emoji kustom untuk organisasi. Untuk mengetahui informasi selengkapnya, lihat Mempelajari emoji kustom di Google Chat dan Mengelola izin emoji kustom.

Untuk membuat pesan dengan emoji kustom, aplikasi Anda harus menggunakan autentikasi pengguna. Emoji kustom tidak didukung dalam pesan yang dibuat sebagai webhook atau dalam pesan yang dibuat dengan autentikasi aplikasi.

Untuk menambahkan emoji kustom ke teks pesan, tentukan name atau emoji_name resource customEmoji:

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

Untuk menggunakan contoh ini, ganti CUSTOM_EMOJI_ID dengan ID untuk emoji kustom. Anda dapat menemukan ID ini di kolom name atau emoji_name resource customEmoji.

Jika aplikasi Anda mengirim pesan menggunakan sintaks Markdown, Anda dapat menentukan emoji kustom dalam format tag HTML menggunakan ID emoji kustom:

{
  "text": "Hello <chat-emoji data-custom-emoji=\"customEmojis/CUSTOM_EMOJI_ID\">."
}

Atau, Anda dapat menentukan nama emoji kustom:

{
  "text": "Hello <chat-emoji data-emoji-name=\"CUSTOM_EMOJI_NAME\">."
}

Untuk menggunakan contoh ini, ganti CUSTOM_EMOJI_ID dengan ID emoji kustom, dan CUSTOM_EMOJI_NAME dengan nama kode pendek emoji kustom.

Menyebut pengguna dalam pesan teks

Aplikasi Chat dapat mengirim pesan teks yang @menyebut satu atau semua pengguna dalam ruang Chat. Aplikasi Chat juga dapat menyebut pengguna yang belum bergabung ke ruang atau merupakan anggota ruang yang dalam mode impor.

Pesan senyap tidak mendukung penyebutan pengguna. Menyertakan sebutan dalam pesan senyap akan menampilkan error.

@sebutkan pengguna tertentu

Untuk @menyebut pengguna tertentu, tambahkan <users/{user}> ke pesan teks dengan {user} adalah ID pengguna. Misalnya, pertimbangkan pesan teks berikut dengan 123456789012345678901 mewakili ID untuk pengguna Mahan S.:

{
    "text": "A customer has reported an issue. Assigning ticket #942 to <users/123456789012345678901>."
}

Jika aplikasi Anda mengirim pesan menggunakan sintaks Markdown, gunakan format tag HTML chat-user untuk menentukan ID pengguna:

{
  "text": "Assigning ticket #942 to <chat-user data-user=\"users/123456789012345678901\">."
}

Atau tentukan melalui email:

{
  "text": "Assigning ticket #942 to <chat-user data-email=\"mahan@example.com\">."
}

Pesan teks ditampilkan sebagai berikut:

Anda dapat menentukan nilai users/{user} dengan cara berikut:

• Jika aplikasi Google Chat Anda merespons pesan yang dikirim oleh pengguna, Anda dapat menggunakan kolom message.sender.name dari peristiwa interaksi MESSAGE.

• Jika aplikasi Google Chat Anda membuat pesan teks asinkron, Anda dapat menentukan nilai untuk users/{user} dengan cara berikut:

  • Gunakan kolom name dari resource User Google Chat, seperti users/123456789012345678901.
  • Gunakan alamat email pengguna sebagai alias untuk nilai {user}. Misalnya, jika alamat emailnya adalah mahan@example.com, Anda dapat menentukan pengguna sebagai users/mahan@example.com. Untuk menggunakan alias email, aplikasi Google Chat Anda harus mengautentikasi sebagai pengguna.

• Jika menggunakan People API, Anda juga dapat menggunakan metode people.get untuk mengidentifikasi ID pengguna.

@sebutkan semua pengguna

Untuk membuat pesan teks yang @menyebut semua orang dalam ruang, ganti {user} dengan all. Contoh JSON berikut menyebut semua pengguna dalam pesan:

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

Jika aplikasi Anda mengirim pesan menggunakan sintaksis Markdown, tentukan sebutan menggunakan format tag HTML chat-user:

{
  "text": "Important message for <chat-user data-user=\"users/all\">: Code freeze starts at midnight tonight!"
}

Menambahkan kutipan ke pesan teks

Aplikasi chat dapat menyertakan kutipan dalam pesan teks untuk memberikan informasi sumber yang mendetail kepada pengguna. Anda dapat memberikan sumber dengan dua cara:

• Kutipan inline: Tambahkan kartu interaktif yang muncul saat pengguna menahan kursor di bagian tertentu dari teks pesan Anda.
• Sumber footer: Menampilkan daftar sumber di bagian bawah pesan sebagai link footer.

Kutipan hanya didukung jika markupSyntax pesan disetel ke MARKUP_SYNTAX_MARKDOWN. Fitur ini hanya didukung melalui pembuatan pesan asinkron menggunakan Chat API.

Untuk menambahkan kutipan inline ke pesan:

1. Berikan sumber dalam daftar citations dari elements pesan, dengan menetapkan id unik ke setiap objek Citation.
2. Dalam teks pesan, sertakan teks yang ingin Anda kutip menggunakan format tag HTML chat-citation: <chat-citation data-id="{id}">{text}</chat-citation>. Pastikan {id} cocok dengan ID yang Anda tentukan di elements. Kutipan yang tidak dirujuk (yang tidak memiliki tag yang cocok) akan diabaikan.

{
  "text": "This is a <chat-citation data-id=\"cite_1\">cited</chat-citation> text.",
  "markupSyntax": "MARKUP_SYNTAX_MARKDOWN",
  "elements": {
    "citations": [
      {
        "id": "cite_1",
        "citedSources": [
          {
            "title": "Example Source",
            "uri": "https://example.com"
          }
        ]
      }
    ]
  }
}

Untuk menambahkan sumber footer ke pesan, berikan sumber dalam daftar citedSources pesan elements. Setiap sumber yang diberikan di sini akan otomatis muncul di bawah pesan sebagai link footer, dan tidak memerlukan tag inline apa pun dalam teks pesan.

{
  "text": "This is a message with a footer source.",
  "markupSyntax": "MARKUP_SYNTAX_MARKDOWN",
  "elements": {
    "citedSources": [
      {
        "title": "Example Source",
        "uri": "https://example.com"
      }
    ]
  }
}

Memformat teks yang muncul di kartu

Di dalam kartu, sebagian besar kolom teks mendukung pemformatan teks dasar dengan menggunakan subkumpulan kecil tag HTML. Anda memformat teks secara berbeda dalam pesan kartu daripada dalam pesan teks karena pesan teks diformat dengan sintaksis yang sama yang digunakan pengguna Chat.

Gunakan Pembuat Kartu untuk mendesain dan melihat pratinjau pesan dan antarmuka pengguna untuk aplikasi Chat:

Memformat teks paragraf

Tag yang didukung dan tujuannya ditampilkan dalam tabel berikut:

Untuk menentukan daftar dan blok kode, gunakan tag berikut:

This is a code block.

Markdown

Jika sintaks Markdown diaktifkan, Anda dapat menggunakan sintaks berikut:

Menambahkan ikon ke teks

Untuk menampilkan ikon bersama teks dalam kartu, Anda dapat menggunakan widget DecoratedText dan ButtonList.

Bagian berikut menjelaskan cara menggunakan ikon bawaan, ikon Material Google, atau ikon kustom dalam teks atau tombol yang dihias.

Menggunakan ikon dari Chat

Untuk menggunakan ikon bawaan yang tersedia di Chat, tentukan salah satu opsi berikut:

Tabel berikut mencantumkan ikon bawaan yang tersedia untuk pesan kartu:

Berikut adalah contoh kartu dengan ikon email:

Menggunakan ikon Material Google

Anda dapat menggunakan ikon Material Google untuk memilih dari lebih dari 2.500 opsi ikon dan menyesuaikan ketebalan, pengisian, dan tingkat ikon.

Berikut adalah contoh kartu dengan ikon Material Google:

Menggunakan ikon kustom

Untuk menambahkan ikon kustom, sertakan kolom iconUrl dan tentukan URL yang sesuai untuk ikon.

Berikut adalah contoh ikon kustom: