Jika Anda ingin membuat Add-on Google Workspace baru, ikuti prosedur umum berikut:
- Siapkan project add-on dan pilih pemilik dan kolaborator.
- Rancang tampilan dan perilaku add-on Anda.
- Konfigurasikan manifes project atau resource deployment add-on.
- Tulis kode untuk menentukan tampilan dan perilaku add-on.
- Verifikasi cakupan OAuth add-on Anda.
- Uji add-on dalam aplikasi host yang diperluas.
- Publikasikan add-on.
Siapkan project add-on dan pilih pemilik dan kolaborator
Jika Anda membuat add-on di Apps Script, Anda akan membuat project Apps Script dan project Google Cloud. Jika Anda membuat add-on dalam bahasa selain Apps Script, Anda hanya perlu membuat project Google Cloud.
Sebelum memulai pengembangan add-on, pilih satu akun pengguna untuk memiliki project dan tentukan akun lain yang merupakan kolaborator. Pemilik project membuat dan mengelola file project serta setelan terkait, sedangkan kolaborator dapat membantu coding dan pengujian.
Project Apps Script
Anda dapat membuat file project Apps Script add-on di drive bersama sehingga tidak ada satu akun yang memiliki kepemilikan tunggal. Menempatkan file skrip add-on di drive bersama akan memastikan bahwa beberapa kolaborator memiliki akses ke project skrip.
Saat Anda memublikasikan add-on, satu akun pengguna akan bertindak sebagai penayang. Akun publikasi harus memiliki akses edit ke project skrip, tetapi tidak harus menjadi pemiliknya.
Untuk membuat project Apps Script, lihat Project skrip.
Project Google Cloud
Sebaiknya tambahkan kolaborator ke project Cloud add-on. Hal ini membantu memastikan seseorang di tim Anda selalu dapat mengakses setelan Cloud add-on.
Untuk membuat project Google Cloud, lihat Membuat project Google Cloud.
Mendesain tampilan dan perilaku add-on
Tentukan tampilan add-on dan perilakunya sebelum mulai mem-build add-on. Pertimbangkan kasus penggunaan yang harus dicoba oleh add-on untuk memberikan solusinya. Mulailah dengan desain sederhana untuk mulai bekerja terlebih dahulu, lalu tambahkan lebih banyak penyempurnaan.
Lihat Panduan gaya Add-on Google Workspace untuk mendapatkan panduan cara mendesain pengalaman pengguna add-on.
Mengonfigurasi manifes project add-on
Dalam project Apps Script, manifes project adalah file JSON khusus. Class ini menentukan berbagai detail tentang project, seperti dependensi library-nya. Untuk Add-on Google Workspace, manifes juga memberikan informasi dasar yang diperlukan aplikasi host untuk menampilkan add-on dengan benar.
Lihat Manifes untuk mengetahui detail tentang cara mengonfigurasi manifes add-on di Apps Script.
Saat Anda menambahkan kode dan fitur ke add-on, edit manifes sesuai kebutuhan untuk menghasilkan tampilan dan perilaku add-on yang diperlukan.
Menulis kode add-on
Anda harus mengimplementasikan antarmuka berbasis kartu untuk add-on. Gunakan Layanan Kartu Apps Script atau jika Anda menulis dalam bahasa kode lain, tampilkan JSON yang diformat dengan benar agar antarmuka dirender sebagai kartu.
Anda juga harus mengimplementasikan fungsi pemicu apa pun yang ditetapkan dalam manifes add-on. Jika add-on Anda terhubung ke layanan pihak ketiga non-Google menggunakan OAuth, Anda juga harus mengonfigurasi OAuth untuk layanan tersebut.
Buat kartu
Anda menentukan antarmuka pengguna add-on dengan membuat
objek Card dan mengisinya dengan
widget. Fungsi pemicu yang ditentukan dalam
manifes Anda harus menampilkan satu
objek Card atau array
objek Card yang mewakili 'halaman' antarmuka add-on yang berbeda. Add-on
juga dapat membuat dan menampilkan kartu baru sebagai
respons terhadap tindakan pengguna.
Di Apps Script, Anda membuat kartu menggunakan
class CardBuilder. Setiap
kartu memerlukan CardHeader
dan satu atau beberapa
CardSections. Anda harus
mengisi setiap bagian kartu dengan masing-masing widget yang membentuk
antarmuka add-on. Widget
interaksi, biasanya
ditautkan ke tindakan untuk menentukan
perilaku interaksinya.
Setelah menambahkan semua bagian dan widget ke kartu melalui
CardBuilder, Anda harus memanggil
CardBuilder.build()
untuk membuat objek Card yang sesuai.
Anda dapat menggunakan layanan Apps Script
bawaan lainnya seperti
CalendarApp untuk mengambil
informasi yang akan ditampilkan dalam kartu add-on yang Anda build.
Anda dapat menggunakan data yang diambil dari layanan non-Google.
Jika Add-on Google Workspace Anda memerlukan akses ke API non-Google yang memerlukan OAuth, Anda harus mengonfigurasi dan terhubung ke layanan tersebut—lihat Panduan Terhubung ke Layanan Non-Google untuk mengetahui detail selengkapnya.
Pesanan konstruksi
Saat membuat kartu, Anda harus mem-build dari atas ke atas. Artinya, Anda harus menggunakan urutan konstruksi ini:
- Buat widget.
- Menambahkan widget ke bagian kartu.
- Ulangi sampai bagian kartu memiliki semua widgetnya.
- Tambahkan bagian kartu ke kartu.
Hal ini diperlukan karena saat Anda menambahkan widget ke bagian kartu atau kartu, Anda sebenarnya menambahkan salinan widget tersebut. Setiap perubahan yang Anda buat pada objek widget setelah menambahkannya tidak akan tercermin dalam kartu akhir.
Tindakan universal
Anda dapat menggunakan tindakan universal untuk menyediakan fungsi yang tidak bergantung pada konteks. Tindakan universal adalah item menu yang tersedia di UI add-on, apa pun kartu yang ditampilkan. Semua tindakan universal yang didefinisikan selalu muncul di menu kartu add-on.
Lihat Tindakan universal untuk detail selengkapnya.
Memverifikasi cakupan OAuth add-on
Cakupan menentukan tindakan yang diizinkan oleh add-on untuk pengguna. Praktik terbaiknya adalah agar add-on hanya memiliki cakupan untuk tindakan yang harus dimiliki agar dapat berfungsi, tidak lebih.
Dalam project add-on, tetapkan cakupan add-on secara eksplisit untuk memastikan add-on menggunakan kumpulan cakupan yang paling tidak permisif. Anda menentukan cakupan yang digunakan add-on dalam manifes add-on.
Lihat Cakupan untuk mengetahui detail selengkapnya.
Menguji add-on
Anda dapat menguji add-on yang tidak dipublikasikan dengan menginstal add-on yang tidak dipublikasikan terlebih dahulu. Setelah diinstal dan diberi otorisasi, Anda dapat menggunakan add-on di akun Anda serta menguji tampilan dan perilakunya di aplikasi host yang diperluas. Anda harus memastikan bahwa add-on berperilaku seperti yang diharapkan untuk konteks dan tindakan pengguna.
Lihat Menguji Add-on Google Workspace untuk mengetahui detail selengkapnya.
Memublikasikan add-on
Memublikasikan add-on akan membuatnya tersedia bagi orang lain, baik secara publik maupun hanya pengguna di domain Anda. Sebelum memulai proses publikasi, pastikan untuk meninjau ringkasan publikasi. Publikasi adalah proses kompleks yang membutuhkan persiapan dan waktu untuk menyelesaikannya.
Add-on Google Workspace dipublikasikan ke Google Workspace Marketplace. Add-on yang tersedia secara publik harus menyelesaikan peninjauan aplikasi sebelum dipublikasikan.
Lihat Memublikasikan Add-on Google Workspace untuk mengetahui detail selengkapnya.