Tindakan add-on memberikan perilaku interaktif pada widget. Dengan membuat tindakan, Anda menentukan apa yang terjadi saat pengguna memilih atau mengupdate widget.
Pada umumnya, Anda dapat menentukan tindakan add-on menggunakan
objek Action
yang disediakan oleh layanan Kartu Apps Script.
Setiap Action dikaitkan dengan
fungsi callback saat Anda membuatnya. Anda menerapkan fungsi callback
untuk mengambil langkah-langkah yang diinginkan saat pengguna berinteraksi dengan widget. Anda juga harus
menautkan Action ke widget
menggunakan fungsi pengendali widget yang sesuai yang
menentukan jenis interaksi yang memicu callback
Action.
Konfigurasikan widget dengan Action
menggunakan proses umum ini:
- Buat objek
Action, dengan menentukan fungsi callback yang harus dijalankan bersama dengan parameter apa pun yang diperlukan. - Panggil fungsi pengendali widget yang sesuai pada widget menggunakan objek
Action. - Implementasikan fungsi callback untuk menerapkan perilaku yang diperlukan.
Fungsi pengendali widget
Untuk menautkan widget ke Action tertentu atau perilaku lainnya, gunakan fungsi pengendali widget. Fungsi pengendali menentukan jenis interaksi (misalnya, mengklik widget atau mengedit kolom teks) yang memicu perilaku tindakan. Fungsi pengendali juga menentukan langkah yang diambil UI,
jika ada, setelah tindakan selesai.
Tabel berikut berisi daftar berbagai jenis pengendali untuk widget dan widget yang digunakan:
| Fungsi pengendali | Memicu tindakan | Widget yang berlaku | Deskripsi |
|---|---|---|---|
setOnChangeAction() |
Perubahan nilai widget |
DatePickerDateTimePickerSelectionInputSwitchTextInput
TimePicker
|
Menetapkan Action
yang menjalankan fungsi Apps Script saat widget kehilangan fokus, seperti
saat pengguna memasukkan teks dalam input, lalu menekan Enter. Pengendali akan secara otomatis meneruskan objek peristiwa ke fungsi yang dipanggilnya.
Anda dapat menyisipkan informasi parameter tambahan dalam objek peristiwa ini jika diinginkan. |
setOnClickAction() |
Pengguna mengklik widget |
CardActionImageImageButtonDecoratedTextTextButton
|
Menetapkan Action
yang menjalankan fungsi Apps Script saat pengguna mengklik widget. Pengendali akan secara otomatis meneruskan objek peristiwa ke fungsi yang dipanggilnya.
Anda dapat menyisipkan informasi parameter opsional dalam objek peristiwa ini. |
setComposeAction() |
Pengguna mengklik widget |
CardActionImageImageButtonDecoratedTextTextButton
|
Khusus Gmail. Menetapkan Action yang membuat draf email, lalu menampilkan draf tersebut kepada pengguna di jendela tulis UI Gmail. Anda dapat membuat draf sebagai pesan baru atau balasan untuk pesan terbuka di Gmail. Saat pengendali memanggil fungsi callback pembuatan draf, objek peristiwa akan diteruskan ke fungsi callback.
Lihat
Menulis pesan draf
untuk mengetahui detail selengkapnya. |
setOnClickOpenLinkAction() |
Pengguna mengklik widget |
CardActionImageImageButtonDecoratedTextTextButton
|
Menetapkan Action
untuk membuka URL saat pengguna mengklik widget. Gunakan pengendali ini ketika Anda
harus membuat URL atau tindakan lain harus dilakukan sebelum link
terbuka; jika tidak, biasanya akan lebih mudah menggunakan setOpenLink().
Anda hanya dapat membuka URL di jendela baru. Saat ditutup, Anda dapat menyebabkan
UI memuat ulang add-on. |
setOpenLink() |
Pengguna mengklik widget |
CardActionImageImageButtonDecoratedTextTextButton
|
Langsung membuka URL saat pengguna mengklik widget. Gunakan pengendali
ini jika Anda mengetahui URL dan hanya perlu membukanya. Jika tidak, gunakan
setOnClickOpenLinkAction().
Anda dapat membuka URL di jendela baru atau di overlay. Saat ditutup, Anda
dapat menyebabkan UI memuat ulang add-on. |
setSuggestionsAction() |
Pengguna memasukkan teks ke input |
TextInput
|
Menetapkan Action
yang menjalankan fungsi Apps Script saat pengguna memasukkan teks ke
widget input teks. Pengendali akan secara otomatis meneruskan objek peristiwa ke fungsi yang dipanggilnya.
Lihat
Saran pelengkapan otomatis
untuk input teks guna mengetahui detail selengkapnya. |
Fungsi callback
Fungsi callback dijalankan saat Action
terpicu. Karena fungsi callback adalah fungsi Apps Script, Anda dapat memintanya
melakukan hampir semua fungsi skrip lainnya yang dapat dilakukan.
Fungsi callback terkadang menampilkan objek respons tertentu. Jenis respons ini menunjukkan operasi tambahan yang perlu terjadi setelah callback selesai dijalankan, seperti menampilkan kartu baru atau menampilkan saran pelengkapan otomatis. Jika fungsi callback Anda harus menampilkan objek respons tertentu, gunakan class builder di Card service untuk membuat objek tersebut.
Tabel berikut menunjukkan kapan fungsi callback Anda harus menampilkan objek respons spesifik untuk tindakan tertentu. Semua tindakan ini tidak bergantung pada aplikasi host tertentu yang diperluas add-on:
| Tindakan dicoba | Fungsi callback akan menampilkan |
|---|---|
| Menavigasi antarkartu | ActionResponse |
Menampilkan Notification |
ActionResponse |
Membuka link menggunakan setOnClickOpenLinkAction() |
ActionResponse |
| Menampilkan saran pelengkapan otomatis | SuggestionResponse |
| Menggunakan tindakan universal | UniversalActionResponse |
| Tindakan lainnya | Nothing |
Selain tindakan ini, setiap aplikasi host memiliki kumpulan tindakannya sendiri yang hanya dapat dilakukan di host tersebut. Untuk mengetahui detailnya, lihat panduan berikut:
Objek peristiwa tindakan
Saat add-on memicu Action,
UI akan otomatis membuat objek peristiwa JSON dan meneruskannya sebagai
argumen ke fungsi callback Action. Objek peristiwa ini berisi informasi tentang konteks sisi klien
saat ini milik pengguna, seperti nilai saat ini dari semua widget interaktif
dalam kartu yang ditampilkan.
Objek peristiwa Action memiliki struktur JSON tertentu yang mengatur informasi yang dimuatnya. Struktur yang sama digunakan saat pemicu halaman beranda diaktifkan untuk membuat halaman beranda, atau saat pemicu kontekstual diaktifkan untuk mengupdate tampilan add-on.
Lihat Objek peristiwa untuk mengetahui penjelasan lengkap tentang struktur objek peristiwa.