Membuat kartu interaktif

Sebagian besar add-on, selain menampilkan data, mengharuskan pengguna memasukkan informasi. Saat membuat add-on berbasis kartu, Anda dapat menggunakan widget interaktif seperti tombol, item menu toolbar, atau kotak centang untuk menanyakan data yang diperlukan pengguna atau memberikan kontrol interaksi lainnya.

Menambahkan tindakan ke widget

Biasanya, Anda membuat widget menjadi interaktif dengan menautkannya ke tindakan tertentu dan menerapkan perilaku yang diperlukan dalam fungsi callback. Lihat tindakan add-on untuk mengetahui detailnya.

Pada umumnya, Anda dapat mengikuti prosedur umum berikut untuk mengonfigurasi widget agar melakukan tindakan tertentu saat dipilih atau diupdate:

1. Buat objek Action, yang menentukan fungsi callback yang harus dieksekusi, bersama dengan parameter yang diperlukan.
2. Tautkan widget ke Action dengan memanggil fungsi pengendali widget yang sesuai.
3. Implementasikan fungsi callback untuk memberlakukan perilaku yang diperlukan.

Contoh

Contoh berikut menetapkan tombol yang menampilkan notifikasi pengguna setelah diklik. Klik memicu fungsi callback notifyUser() dengan argumen yang menentukan teks notifikasi. Menampilkan ActionResponse akan menghasilkan notifikasi yang ditampilkan.

  /**
   * Build a simple card with a button that sends a notification.
   * @return {Card}
   */
  function buildSimpleCard() {
    var buttonAction = CardService.newAction()
        .setFunctionName('notifyUser')
        .setParameters({'notifyText': 'Button clicked!'});
    var button = CardService.newTextButton()
        .setText('Notify')
        .setOnClickAction(buttonAction);

    // ...continue creating widgets, then create a Card object
    // to add them to. Return the built Card object.
  }

  /**
   * Callback function for a button action. Constructs a
   * notification action response and returns it.
   * @param {Object} e the action event object
   * @return {ActionResponse}
   */
  function notifyUser(e) {
    var parameters = e.parameters;
    var notificationText = parameters['notifyText'];
    return CardService.newActionResponseBuilder()
        .setNotification(CardService.newNotification()
            .setText(notificationText)
        .build();      // Don't forget to build the response!
  }

Mendesain interaksi yang efektif

Saat mendesain kartu interaktif, perhatikan hal-hal berikut:

• Widget interaktif biasanya memerlukan setidaknya satu metode pengendali untuk menentukan perilakunya.

• Gunakan fungsi pengendali widget setOpenLink() jika Anda memiliki URL dan hanya ingin membukanya di tab. Dengan demikian, Anda tidak perlu menentukan objek Action dan fungsi callback. Jika Anda perlu mem-build URL terlebih dahulu, atau melakukan langkah tambahan lainnya sebelum membuka URL, tentukan Action dan gunakan setOnClickOpenLinkAction() sebagai gantinya.

• Saat menggunakan fungsi pengendali widget setOpenLink() atau setOnClickOpenLinkAction(), Anda harus menyediakan objek OpenLink untuk menentukan URL mana yang akan dibuka. Anda juga dapat menggunakan objek ini untuk menentukan perilaku buka dan tutup menggunakan enum OpenAs dan OnClose.

• Lebih dari satu widget dapat menggunakan objek Action yang sama. Namun, Anda harus menentukan objek Action yang berbeda jika ingin memberikan parameter yang berbeda untuk fungsi callback.

• Buat fungsi callback Anda tetap sederhana. Agar add-on tetap responsif, Layanan Kartu membatasi fungsi callback hingga maksimum 30 detik waktu eksekusi. Jika eksekusi membutuhkan waktu lebih lama dari itu, UI add-on Anda mungkin tidak mengupdate tampilan kartunya dengan benar sebagai respons terhadap Action .

• Jika status data pada backend pihak ketiga berubah karena interaksi pengguna dengan UI add-on, sebaiknya add-on menetapkan bit 'status berubah' ke true agar cache sisi klien yang ada dihapus. Lihat deskripsi metode ActionResponseBuilder.setStateChanged() untuk detail tambahan.