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. 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.
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:
Di konsol Google Cloud, klik Menu > APIs & Services > Enabled APIs & Services > Google Chat API
Klik Konfigurasi.
Di bagian Setelan lanjutan, buka Pemicu dan pastikan kolom Perintah aplikasi berisi pemicu, seperti endpoint HTTP atau fungsi Apps Script. Anda harus menggunakan pemicu ini di bagian berikut untuk merespons perintah cepat.
Di bagian Commands, klik Add a command.
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.
Opsional: Jika Anda ingin aplikasi Chat merespons perintah dengan dialog, centang kotak Buka dialog.
Klik Simpan.
Perintah cepat kini dikonfigurasi untuk aplikasi Chat.
Merespons perintah cepat
Saat pengguna memanggil perintah cepat, aplikasi Chat Anda
akan menerima objek peristiwa yang berisi informasi tentang perintah cepat.
Objek peristiwa berisi payload AppCommand
dengan detail tentang perintah yang dipanggil (termasuk ID perintah), sehingga Anda
dapat menampilkan respons yang sesuai.
Untuk merespons perintah cepat, Anda harus menerapkan pemicu Perintah aplikasi sehingga aplikasi Chat dapat menangani objek peristiwa yang berisi metadata perintah aplikasi.
Kode berikut menunjukkan contoh aplikasi Chat yang
membalas perintah Bantuan. Untuk merespons perintah cepat, aplikasi Chat menangani objek peristiwa dari pemicu
Perintah aplikasi. Jika payload objek peristiwa berisi ID perintah cepat,
aplikasi Chat akan menampilkan tindakan DataActions dengan
objek createMessageAction:
Apps Script
// The ID of the slash command "/about".
// It's not enabled by default, set to the actual ID to enable it. You must
// use the same ID as set in the Google Chat API configuration.
const HELP_COMMAND_ID = 0;
/**
* Responds to an APP_COMMAND event in Google Chat.
*
* @param {Object} event the event object from Google Chat
*/
function onAppCommand(event) {
// Stores the Google Chat app command metadata as a variable.
const appCommandMetadata = event.chat.appCommandPayload.appCommandMetadata;
if (appCommandMetadata.appCommandType == "QUICK_COMMAND") {
// Executes the quick command logic based on its ID.
// Quick command IDs are set in the Google Chat API configuration.
switch (appCommandMetadata.appCommandId) {
case HELP_COMMAND_ID:
return { hostAppDataAction: { chatDataAction: { createMessageAction: { message: {
text: 'The Avatar app replies to Google Chat messages.'
}}}}};
}
}
}
Untuk menggunakan contoh kode ini, ganti HELP_COMMAND_ID dengan
ID perintah yang Anda tentukan saat
mengonfigurasi perintah cepat di Chat API.
Untuk menguji perintah cepat di Chat, buka menu integrasi dengan mengklik
Alat Google Workspace , lalu
memilih perintah cepat Anda.