Membangun antarmuka Google Kalender

Add-on Google Workspace dapat menyediakan antarmuka yang disesuaikan saat pengguna melihat atau mengedit kalender dan acara Kalender. Dengan demikian, Anda dapat memberikan informasi tambahan yang relevan kepada pengguna, mengotomatiskan tugas, dan menghubungkan sistem pihak ketiga ke Kalender.

Saat membuat antarmuka add-on Google Workspace untuk Kalender, Anda dapat menyediakan halaman beranda. Anda dapat menggunakan halaman beranda yang sama untuk beberapa host, atau mendesain halaman beranda tertentu untuk Kalender.

Add-on Anda juga dapat menentukan antarmuka yang muncul saat pengguna membuka acara Kalender.

Mengakses UI add-on

UI Anda dapat muncul dalam beberapa cara, bergantung pada konteksnya. Misalnya, add-on dapat menentukan antarmuka halaman beranda, antarmuka acara Kalender, antarmuka pemilihan lampiran, atau ketiganya:

Jika pengguna mengklik ikon add-on saat berada di tampilan kalender, add-on akan menjalankan fungsi calendar.homepageTrigger yang sesuai (jika ada). Fungsi ini membuat dan menampilkan kartu halaman beranda ke Kalender untuk ditampilkan. Jika tidak ada fungsi calendar.homepageTrigger yang ditentukan, kartu halaman beranda generik akan ditampilkan.
Jika pengguna membuka acara Kalender, lalu mengklik ikon add-on, atau add-on terbuka saat pengguna membuka acara, add-on akan menjalankan fungsi eventOpenTrigger yang sesuai (jika ada). Fungsi ini membuat antarmuka acara Kalender add-on dan kembali ke Kalender untuk ditampilkan.
Jika add-on menentukan fungsi eventAttachmentTrigger, add-on akan muncul sebagai penyedia lampiran saat pengguna mengklik Tambahkan lampiran saat mengedit acara Kalender. Saat add-on dipilih, fungsi eventAttachmentTrigger akan membuat antarmuka pemilihan lampiran add-on dan menampilkannya ke Kalender.

Membangun antarmuka Kalender add-on

Ikuti langkah-langkah berikut untuk membuat UI Anda. Anda dapat memperluas fungsi Kalender dengan add-on Google Workspace dengan mengikuti langkah-langkah berikut:

Tentukan apakah Anda ingin add-on memiliki halaman beranda khusus Kalender. Tentukan juga apakah Anda ingin menyediakan antarmuka kustom saat pengguna mengedit acara Kalender.
Tambahkan kolom addOns.common dan addOns.calendar yang sesuai ke manifes project skrip add-on, termasuk cakupan yang diperlukan.
Jika Anda menyediakan halaman beranda khusus Kalender, terapkan fungsi calendar.homepageTrigger untuk membuat antarmuka ini. Anda juga dapat memilih untuk menggunakan antarmuka common.homepageTrigger untuk beberapa aplikasi host.
Jika Anda menyediakan antarmuka acara Kalender, terapkan fungsi calendar.eventOpenTrigger untuk membangun antarmuka ini. Lihat Memperluas antarmuka acara Kalender untuk mengetahui detailnya.
Terapkan fungsi callback terkait yang diperlukan untuk merespons interaksi UI pengguna, seperti klik tombol.

Halaman beranda kalender

add-on mendukung tampilan halaman beranda add-on Google Workspace. Untuk menampilkan halaman beranda umum add-on Anda di Kalender, pastikan ada kolom addOns.calendar di manifes add-on.

Atau, tambahkan calendar.homepageTrigger ke manifes add-on untuk menyediakan halaman beranda khusus Kalender.

Apa pun yang Anda pilih, Anda harus memberikan nama fungsi pemicu halaman beranda di project skrip add-on Anda. Fungsi ini dipanggil secara otomatis untuk membuat halaman beranda Kalender saat diperlukan. Terapkan fungsi ini untuk membuat dan menampilkan satu Card atau array objek Card yang membentuk halaman beranda. Fungsi pemicu beranda menerima objek peristiwa sebagai parameter yang berisi beberapa informasi umum seperti platform klien. Gunakan data objek peristiwa untuk menyesuaikan pembuatan halaman beranda.

Memperluas antarmuka acara Kalender

Kalender mengandalkan pemicu kontekstual untuk menentukan antarmuka (jika ada) yang akan ditampilkan saat pengguna mengedit acara Kalender. Saat pemicu diaktifkan, pemicu akan menjalankan fungsi pemicu kontekstual yang ditentukan oleh kolom calendar.eventOpenTrigger dalam manifes add-on.

Terapkan fungsi yang dinamai di kolom calendar.eventOpenTrigger. Fungsi ini menerima objek peristiwa sebagai argumen dan harus menampilkan satu objek Card atau array objek Card agar Kalender dapat menampilkannya saat pengguna membuka acara.

Objek peristiwa

Objek peristiwa dibuat dan diteruskan ke fungsi pemicu kontekstual calendar.eventOpenTrigger saat pengguna membuka acara Kalender. Fungsi pemicu dapat menggunakan informasi dalam objek peristiwa ini untuk menentukan cara membuat kartu add-on atau mengontrol perilaku add-on. Objek peristiwa juga dibuat dan diteruskan ke fungsi homepageTrigger saat add-on pertama kali dibuka, dan saat pengguna mengklik atau memilih widget interaktif.

Struktur lengkap objek peristiwa dijelaskan di Objek peristiwa. Jika Kalender adalah aplikasi host add-on yang bertindak, objek peristiwa pemicu kontekstual dan interaksi widget mencakup kolom objek acara Kalender yang membawa informasi klien khusus Kalender.

Memperbarui acara Kalender

Selain peristiwa kontekstual calendar.eventOpenTrigger yang diaktifkan saat pengguna membuka acara Kalender untuk diedit, Anda juga dapat menentukan calendar.eventUpdateTrigger yang diaktifkan saat pengguna memperbarui dan menyimpan acara Kalender. Pemicu ini hanya diaktifkan jika pengguna melakukan satu atau beberapa pengeditan berikut:

Menambahkan satu atau beberapa tamu.
Menghapus satu atau beberapa tamu.
Menambahkan atau beralih ke solusi konferensi lain.

Saat pemicu ini diaktifkan, pemicu akan menjalankan fungsi pemicu yang ditentukan oleh kolom manifes calendar.eventUpdateTrigger. Fungsi ini dijalankan sebelum pengeditan acara Kalender disimpan.

calendar.eventUpdateTrigger biasanya digunakan untuk melakukan satu atau beberapa hal berikut:

Perbarui antarmuka acara Kalender add-on sebagai respons terhadap perubahan acara Kalender yang dilakukan pengguna.
Menyinkronkan data acara Kalender dengan sistem pihak ketiga, seperti sistem konferensi yang terhubung ke Kalender.

Jika add-on Anda perlu melakukan penyesuaian pada data acara Kalender (seperti daftar tamu), tetapkan kolom manifes add-on calendar.currentEventAccess ke WRITE atau READ_WRITE. Hal ini juga mengharuskan add-on memiliki cakupan https://www.googleapis.com/auth/calendar.addons.current.event.write .

Menambahkan solusi konferensi

Jika mengelola sistem konferensi pihak ketiga, Anda dapat mengintegrasikannya dengan Kalender dengan menambahkan solusi konferensi. Fitur ini sebelumnya dalam versi beta sebagai add-on konferensi Kalender.

Solusi konferensi mewakili opsi konferensi pihak ketiga yang dapat dilampirkan pengguna ke acara Kalender. Dokumentasi Ringkasan konferensi pihak ketiga memberikan detail tentang cara membuat add-on yang menambahkan solusi konferensi baru. Anda tidak perlu membuat UI untuk jenis ekstensi ini; solusi yang ditambahkan akan muncul sebagai opsi di menu drop-down UI acara Kalender.