Merespons perintah cepat sebagai aplikasi Google Chat

Halaman ini menjelaskan cara menyiapkan dan merespons perintah cepat untuk aplikasi Google Chat Anda.

Perintah cepat adalah cara pengguna dapat memanggil dan berinteraksi dengan aplikasi Chat. Untuk menggunakan perintah cepat, buka menu integrasi dengan mengklik Alat Google Workspace di ruang Chat atau percakapan, lalu pilih perintah aplikasi dengan nama yang tidak diawali dengan garis miring (/). Dengan memilih perintah cepat, aplikasi Chat akan langsung dipanggil tanpa input lebih lanjut dari pengguna, sehingga memungkinkan interaksi pengguna yang cepat.

Pengguna juga dapat memanggil aplikasi Chat melalui perintah garis miring. Untuk mengetahui langkah-langkahnya, lihat Merespons perintah garis miring. Dibandingkan dengan perintah garis miring, perintah cepat diformat dengan nama yang lebih mudah digunakan di UI Chat, perintah ini langsung dipanggil setelah dipilih, dan pengguna tidak perlu mengingat atau mengetik nama perintah garis miring.

Menu integrasi dengan perintah cepat
Gambar 1: Menu integrasi yang berisi perintah cepat untuk aplikasi Chat.

Menyiapkan perintah cepat di Google Chat API

Untuk membuat perintah cepat atau memperbarui perintah garis miring yang ada menjadi perintah cepat, Anda harus menentukan informasi tentang perintah tersebut dalam konfigurasi aplikasi Chat untuk Google Chat API.

Untuk mengonfigurasi perintah cepat di Google Chat API, selesaikan langkah-langkah berikut:

  1. Di konsol Google Cloud, klik Menu > APIs & Services > Enabled APIs & Services > Google Chat API

    Buka halaman Google Chat API

  2. Klik Konfigurasi.

  3. Di bagian Commands, klik Add a command.

  4. Masukkan ID perintah, nama, deskripsi, dan jenis perintah untuk perintah:

    • ID Perintah: angka dari 1 hingga 1.000 yang digunakan aplikasi Chat Anda untuk mengenali perintah dan menampilkan respons.
    • Name: nama tampilan untuk perintah. Nama dapat berisi maksimal 50 karakter dan dapat menyertakan karakter khusus.
      • Gunakan kata atau frasa yang singkat, deskriptif, dan dapat ditindaklanjuti untuk membuat perintah lebih jelas bagi pengguna. Misalnya, gunakan Update contact untuk perintah yang mengubah data kontak.
    • Deskripsi: teks yang menjelaskan fungsi perintah. Deskripsi dapat berisi hingga 50 karakter dan dapat menyertakan karakter khusus.
      • Buat deskripsi singkat dan jelas sehingga pengguna tahu apa yang akan terjadi saat mereka memanggil perintah.
      • Beri tahu pengguna apakah aplikasi Chat membalas semua orang di ruang, atau secara pribadi kepada pengguna yang memanggil perintah. Misalnya, untuk perintah cepat Tentang, Anda dapat menjelaskannya sebagai Pelajari aplikasi ini (Hanya terlihat oleh Anda).
    • Jenis perintah: pilih Perintah cepat.

  5. Opsional: Jika Anda ingin aplikasi Chat merespons perintah dengan dialog, centang kotak Buka dialog.

  6. Klik Simpan.

Perintah cepat kini dikonfigurasi untuk aplikasi Chat.

Merespons perintah cepat

Saat pengguna memanggil perintah cepat, aplikasi Chat Anda akan menerima peristiwa interaksi APP_COMMAND. Payload peristiwa berisi objek appCommandMetadata dengan detail tentang perintah yang dipanggil (termasuk ID perintah dan jenis perintah), sehingga Anda dapat menampilkan respons yang sesuai.

Kode berikut menunjukkan contoh aplikasi Chat yang membalas perintah Bantuan dengan menangani peristiwa interaksi APP_COMMAND dan mendeteksi apakah payload peristiwa berisi ID perintah yang cocok. Jika payload peristiwa berisi ID perintah, aplikasi Chat akan menampilkan pesan pribadi:

Apps Script 

// Handle the APP_COMMAND event type.
function onAppCommand(event) {
  // Executes the command logic based on its ID.
  // Command IDs are set in the Google Chat API configuration.
  switch (event.appCommandMetadata.appCommandId) {
    case HELP_COMMAND_ID:
      return {
        privateMessageViewer: event.user,
        text: 'The Avatar app replies to Google Chat messages.'
      };
  }
}

Tetapkan HELP_COMMAND_ID dengan ID perintah yang Anda tentukan saat mengonfigurasi perintah cepat di Chat API. Untuk menguji kode ini, lihat Menguji fitur interaktif untuk aplikasi Google Chat. Untuk menguji perintah cepat di Chat, buka menu integrasi dengan mengklik Alat Google Workspace , lalu memilih perintah cepat Anda.

Mengubah perintah garis miring yang ada menjadi perintah cepat

Untuk mengubah perintah garis miring yang ada menjadi perintah cepat, edit perintah garis miring di Google Chat API dengan mengubah Jenis perintah dari Perintah garis miring menjadi Perintah cepat.

Saat pengguna memanggil perintah cepat, aplikasi Chat Anda akan menerima peristiwa interaksi APP_COMMAND, bukan peristiwa interaksi MESSAGE yang dikirim untuk perintah garis miring. Perbarui aplikasi Chat Anda untuk menangani jenis peristiwa interaksi ini dengan membaca payload peristiwa yang berisi objek appCommandMetadata dengan detail tentang perintah cepat yang dipanggil. Lihat Merespons perintah cepat.