Membuat Add-on Google Workspace

Jika Anda ingin membuat Add-on Google Workspace baru, ikuti prosedur umum berikut:

1. Siapkan project add-on Anda, lalu pilih pemilik dan kolaborator.
2. Rancang tampilan dan perilaku add-on Anda.
3. Konfigurasi manifes project atau resource deployment add-on.
4. Tulis kode untuk menentukan tampilan dan perilaku add-on.
5. Verifikasi cakupan OAuth add-on Anda.
6. Uji add-on dalam aplikasi host yang diperluas.
7. Publikasikan add-on.

Siapkan project add-on serta pilih pemilik dan kolaborator

Jika Anda membangun add-on di Apps Script, Anda akan membuat project Apps Script dan project Google Cloud. Jika 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 dan setelan terkait, sedangkan kolaborator dapat membantu coding dan pengujian.

Peringatan: Jika Anda tidak menambahkan kolaborator ke project add-on, Anda harus mentransfer kepemilikannya sebelum akun pemilik dinonaktifkan atau dihapus. Jika tidak, Anda dapat kehilangan akses ke kode add-on dan setelan sepenuhnya.

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 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 Anda menambahkan 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.

Desain tampilan dan perilaku add-on Anda

Tentukan tampilan add-on yang diinginkan dan perilakunya sebelum mulai membangun add-on. Pertimbangkan kasus penggunaan apa yang perlu diberikan solusi oleh add-on. Mulai dengan desain sederhana untuk memulai pekerjaan terlebih dahulu, lalu tambahkan lebih banyak peningkatan.

Tips: Mulai dengan kartu halaman beranda yang sederhana, lalu tambahkan lebih banyak widget, kartu, navigasi, dan perilaku lainnya. Anda juga dapat mempertimbangkan kartu kontekstual yang dipicu oleh tindakan pengguna di aplikasi host, seperti membuka rangkaian pesan Gmail atau Acara Kalender.

Lihat panduan gaya Add-on Google Workspace untuk mendapatkan panduan tentang 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 menyediakan informasi dasar yang diperlukan aplikasi host untuk menampilkan add-on dengan benar.

Lihat Manifes untuk mengetahui detail tentang cara mengonfigurasi manifes add-on Anda 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.

Membuat 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 untuk antarmuka agar dirender sebagai kartu.

Anda juga harus mengimplementasikan fungsi pemicu apa pun yang ditentukan dalam manifes add-on. Jika add-on Anda terhubung ke layanan non-Google pihak ketiga menggunakan OAuth, Anda juga harus mengonfigurasi OAuth untuk layanan tersebut.

Membuat 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' yang berbeda dari antarmuka add-on. Add-on Anda 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 dengan 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.

Catatan: Gagal memanggil build() setelah menggunakan class builder di layanan Kartu akan menyebabkan error jenis. Fungsi pemicu, misalnya, harus menampilkan objek Card. Menampilkan objek CardBuilder akan menghasilkan error.

Anda dapat menggunakan layanan Apps Script bawaan lainnya seperti CalendarApp untuk mengambil informasi yang akan ditampilkan di kartu add-on yang Anda build. Anda dapat menggunakan data yang diambil dari layanan non-Google.

Jika Add-on Google Workspace 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 membuatnya dari awal. Artinya, Anda harus menggunakan urutan konstruksi ini:

1. Bangun widget.
2. Tambahkan widget ke bagian kartu.
3. Ulangi hingga bagian kartu memiliki semua widgetnya.
4. Tambahkan bagian kartu ke kartu tersebut.

Tindakan ini diperlukan karena saat 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 ditampilkan pada kartu akhir.

Peringatan: Hanya tambahkan widget ke bagian kartu atau kartu setelah Anda selesai membangunnya. Hanya tambahkan bagian kartu ke kartu setelah terisi penuh dengan widgetnya. Jangan mengubah widget atau bagian setelah ditambahkan. Jika ingin membuat perubahan pada widget yang ditambahkan, Anda harus membuat ulang bagian atau kartu tempat widget tersebut ditambahkan.

Tindakan universal

Anda dapat menggunakan tindakan universal untuk memberikan 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 ditentukan selalu muncul di menu kartu add-on.

Lihat Tindakan universal untuk detail selengkapnya.

Memverifikasi cakupan OAuth add-on

Cakupan menentukan tindakan yang boleh dilakukan add-on atas nama pengguna. Praktik terbaik bagi add-on adalah agar hanya memiliki cakupan tindakan yang harus dimiliki agar dapat berfungsi secara berurutan, 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 memverifikasi bahwa add-on berperilaku seperti yang diharapkan untuk konteks dan tindakan pengguna.

Lihat Menguji Add-on Google Workspace untuk mengetahui detail selengkapnya.

Publikasikan add-on

Memublikasikan add-on akan membuatnya tersedia untuk 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 penyelesaian.

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.