Meningkatkan pengalaman secara keseluruhan dengan mengikuti panduan add-on ini desain.
Praktik terbaik umum
Sebaiknya ikuti praktik terbaik berikut untuk semua add-on yang Anda dikembangkan.
Tentukan kepemilikan add-on sebelum memulai
ditentukan oleh project Apps Script, yang harus dimiliki oleh akun atau yang lain yang ditempatkan di drive bersama. Sebelum membuat kode add-on, tentukan akun mana yang harus menjadi pemilik proyek, dan akun mana yang bertindak sebagai penerbit. Juga tentukan akun mana yang akan bertindak sebagai kolaborator, dan pastikan akun tersebut memiliki akses ke skrip proyek dan hal-hal terkait Project platform cloud.
Memperluas Google Workspace, jangan mereplikasinya
{i>add-on<i} dimaksudkan untuk memberikan kemampuan baru pada aplikasi Google Workspace yang mereka perluas, atau yang lainnya mengotomatiskan tugas-tugas yang kompleks. add-on yang hanya mereplikasi fungsi yang sudah ada dalam aplikasi atau aplikasi yang tidak membuat replika perbaikan yang signifikan terhadap alur kerja tersebut kemungkinan tidak lulus peninjauan add-on untuk publikasi.
Menjaga cakupan tetap sempit
Saat menentukan cakupan secara eksplisit,
selalu pilih cakupan ruang
lingkup yang paling tidak permisif. Misalnya, jangan
meminta add-on agar meminta akses penuh ke Kalender pengguna dengan
https://www.googleapis.com/auth/calendar cakupan jika hanya perlu dibaca
akses. Untuk akses hanya baca, gunakan
https://www.googleapis.com/auth/calendar.readonly cakupan.
Menghindari terlalu mengandalkan library
Menggunakan library Apps Script dapat menyebabkan add-on untuk berjalan lebih lambat daripada jika semua kode Apps Script dimuat dalam satu project skrip. Meskipun library Apps Script berfungsi di add-on, Anda dapat mengalami performa pengurangan jika Anda menggunakannya. Hindari menyertakan library yang tidak diperlukan di proyek Anda, dan mempertimbangkan cara untuk mengurangi ketergantungan pada {i>add-on<i} pada program tersebut.
Latensi yang dijelaskan di atas hanya berlaku untuk project Apps Script yang sedang digunakan sebagai library sisi server. Anda dapat menggunakan library JavaScript sisi klien seperti jQuery dengan bebas tanpa menemui latensi ini.
Praktik terbaik Add-on Google Workspace
Praktik terbaik berikut hanya berlaku untuk Add-on Google Workspace dan penggunaannya dari layanan Kartu.
Menggunakan beberapa kartu saja
Jika add-on menggunakan terlalu banyak kartu, konfigurasi navigasi menjadi kompleks dan sulit dikelola.
Hindari dorongan untuk membuat kartu lebih banyak daripada yang diperlukan.
Menggunakan fungsi pembuatan widget
Saat menulis kode yang membuat Card
atau objek UI kompleks lainnya, pertimbangkan untuk menempatkan kode tersebut dalam fungsinya sendiri.
Fungsi pembuatan ini hanya perlu membangun objek dan menampilkannya. Hal ini memungkinkan
Anda membuat ulang objek tersebut dengan cepat setiap kali UI harus di-refresh. Ingat
memanggil build() setelah menggunakan class builder di
Layanan kartu.
Jaga agar kartu tetap sederhana
Jika kartu tertentu memiliki terlalu banyak widget, kartu akan memenuhi terlalu banyak layar dan menjadi kurang berguna. Sementara bagian kartu besar dirender sebagai elemen UI yang bisa diciutkan, ini menyembunyikan informasi dari pengguna. Targetkan untuk menyederhanakan add-on Anda dan memberikan persis apa yang dibutuhkan pengguna dan tidak lebih dari itu.
Menggunakan kartu error
Buat kartu untuk kondisi error. Jika add-on Anda menghasilkan error, seharusnya add-on tersebut menampilkan kartu dengan informasi error dan petunjuk cara memperbaikinya jika memungkinkan. Misalnya, jika add-on Anda tidak dapat terhubung ke add-on non-Google layanan karena otorisasi gagal, tampilkan kartu yang menyatakan hal ini dan tanyakan pengguna untuk memverifikasi informasi akun yang digunakan.
Menulis pengujian dan menguji pesan
Anda harus menguji semua add-on yang dibuat secara menyeluruh. Membangun fungsi pengujian yang membuat kartu dan widget menggunakan data pengujian, lalu memverifikasi bahwa objek dibuat seperti yang diharapkan.
Saat menggunakan fungsi callback tindakan, Anda biasanya harus membuat objek respons. Anda dapat menggunakan pernyataan seperti hal berikut ini untuk memverifikasi bahwa respons dibuat dengan benar:
Logger.log(response.printJson());
Menjalankan fungsi pengujian yang Anda buat langsung dari Apps Script menggunakan menu Run. Ketika Anda memiliki {i>add-on<i} yang layak, pastikan Anda menginstal versi yang tidak dipublikasikan sehingga Anda dapat mengujinya.
Gunakan data pengujian yang sesuai untuk setiap aplikasi host yang diperluas add-on. Sebagai misalnya, jika add-on memperluas Gmail, Anda mungkin memerlukan beberapa email percobaan dan ID pesannya sehingga Anda dapat memastikan bahwa add-on berfungsi sebagai seperti yang diharapkan ketika diberikan isi pesan yang berbeda. Anda bisa mendapatkan ID pesan untuk tertentu dengan membuat daftar pesan menggunakan Users.messages.list Gmail API atau dengan menggunakan skrip Layanan Gmail.
Praktik terbaik konferensi kalender
Jika add-on Anda mengintegrasikan layanan konferensi kalender ke Google Kalender, ikuti praktik terbaik tambahan berikut:
Pertahankan lampu onCreateFunction
Setiap onCreateFunction
yang Anda definisikan dalam manifes akan dipanggil
secara sinkron bila pengguna mencoba
membuat solusi konferensi
jenis itu. Pastikan fungsi tersebut hanya melakukan
upaya minimum yang diperlukan
untuk membuat konferensi. Terlalu banyak melakukan
dapat memperlambat pengalaman pengguna di add-on Anda.
Gunakan kolom ConferenceData yang sesuai untuk data konferensi
Saat Anda membangun
ConferenceData
Anda dapat mengisinya dengan detail tentang konferensi (akses
kode, nomor telepon, pin, URI, dll.). Pastikan untuk menggunakan
Kolom EntryPoint
untuk informasi ini. Jangan tempatkan detail ini di ConferenceData
kolom catatan.
Jangan tambahkan detail konferensi ke acara Google Kalender
Add-on Anda tidak perlu menambahkan informasi tentang aplikasi pihak ketiga yang dibuat konferensi hingga deskripsi acara Google Kalender. Google Kalender melakukan hal ini secara otomatis jika diperlukan.