Mem-build add-on Google Workspace

Halaman ini memberikan ringkasan tentang cara mendesain, mem-build, dan memublikasikan add-on Google Workspace. Ringkasan ini menjelaskan langkah-langkah berikut:

1. Tentukan aplikasi Google Workspace tempat Anda ingin add-on tersedia untuk pengguna.
2. Siapkan project add-on Anda, lalu pilih pemilik dan kolaborator.
3. Desain dan konfigurasikan tampilan dan perilaku add-on Anda.
4. Build add-on.
5. Verifikasi cakupan OAuth add-on Anda.
6. Uji add-on dalam satu atau beberapa aplikasi Google Workspace.
7. Publikasikan add-on.

Memilih aplikasi host Google Workspace

Anda dapat mengonfigurasi add-on Google Workspace agar muncul di aplikasi host Google Workspace berikut:

• Gmail
• Google Kalender
• Google Chat (Pratinjau Developer)
• Google Dokumen
• Google Drive
• Google Spreadsheet
• Google Slide

Untuk mempelajari cara mem-build aplikasi Google Workspace, lihat Memperluas UI Google Workspace.

Menyiapkan project add-on dan memilih pemilik serta kolaborator

Jika mem-build add-on di Apps Script, Anda akan membuat project Apps Script dan project Google Cloud. Jika mem-build 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 dan setelan add-on sepenuhnya.

Project Apps Script

Anda dapat mem-build file project Apps Script add-on di drive bersama sehingga tidak ada satu akun pun yang memiliki kepemilikan tunggal. Menempatkan file skrip add-on di drive bersama 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. Tindakan 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 dan mengonfigurasi tampilan dan perilaku add-on

Tentukan tampilan add-on yang Anda inginkan dan perilakunya sebelum Anda mulai mem-build-nya. Pertimbangkan kasus penggunaan yang harus dicoba dipecahkan oleh add-on. Mulai dengan desain sederhana untuk mulai bekerja terlebih dahulu, lalu tambahkan lebih banyak peningkatan.

Tips: Mulai dengan kartu halaman beranda 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 add-on

Setelah mendesain add-on, Anda dapat mulai menerapkan desain dalam manifes add-on. Manifes adalah tempat Anda mengonfigurasi sebagian besar tampilan dan perilaku add-on, termasuk aplikasi host Google Workspace yang diperluas oleh add-on.

Untuk mengetahui detailnya, lihat Manifes untuk add-on Google Workspace.

Saat menambahkan kode dan fitur ke add-on, edit manifes sesuai kebutuhan untuk menghasilkan tampilan dan perilaku add-on yang diperlukan.

Mengonfigurasi tampilan dan perilaku aplikasi Google Chat

Pratinjau Developer: Tersedia sebagai bagian dari Program Pratinjau Developer Google Workspace, yang memberikan akses awal ke fitur tertentu.

Jika telah mendesain add-on yang memperluas Google Chat, Anda harus menggunakan Google Chat API untuk mengonfigurasi tampilan dan perilaku aplikasi Chat. Untuk mengetahui langkah-langkahnya, lihat Mengonfigurasi aplikasi Google Chat.

Mem-build 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 menerapkan fungsi pemicu yang ditentukan 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.

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' antarmuka add-on yang berbeda. 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 setiap 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.

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 buat. Anda dapat menggunakan data yang diambil dari layanan non-Google.

Jika add-on Anda memerlukan akses ke API non-Google yang memerlukan OAuth, Anda harus mengonfigurasi dan terhubung ke layanan tersebut. Lihat panduan Menghubungkan ke Layanan Non-Google untuk mengetahui detail selengkapnya.

Perintah konstruksi

Saat membuat kartu, Anda harus membuat dari penambahan saldo. Artinya, Anda harus menggunakan urutan konstruksi ini:

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

Hal ini diperlukan karena saat menambahkan widget ke kartu atau bagian kartu, Anda sebenarnya menambahkan salinan widget tersebut. Setiap perubahan yang Anda buat pada objek widget setelah menambahkannya tidak akan ditampilkan di kartu akhir.

Peringatan: Hanya tambahkan widget ke kartu atau bagian kartu setelah Anda selesai mem-build-nya. Hanya tambahkan bagian kartu ke kartu setelah diisi sepenuhnya 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 menyediakan fungsi yang tidak bergantung pada konteks. Tindakan universal adalah item menu yang tersedia di UI add-on, terlepas dari kartu apa yang ditampilkan. Semua tindakan universal yang ditentukan selalu muncul di menu kartu add-on.

Lihat Tindakan universal untuk mengetahui detail selengkapnya.

Memverifikasi cakupan OAuth add-on

Cakupan menentukan tindakan yang diizinkan untuk dilakukan add-on atas nama pengguna. Praktik terbaiknya adalah add-on hanya memiliki cakupan untuk tindakan yang harus dimiliki agar dapat berfungsi dan tidak lebih dari itu.

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 manifest 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 dan menguji tampilan serta perilakunya di aplikasi host yang diperluas. Anda harus memverifikasi bahwa add-on berperilaku seperti yang diharapkan untuk konteks dan tindakan pengguna.

Untuk mulai menguji add-on, lihat panduan berikut:

• Menguji dan men-debug add-on Google Workspace Apps Script
• Menguji dan men-debug add-on Google Workspace HTTP
• Menguji fitur interaktif untuk aplikasi Google Chat

Memublikasikan add-on

Dengan memublikasikan add-on, add-on tersebut akan tersedia untuk orang lain, baik secara publik maupun hanya untuk pengguna di domain Anda. Sebelum memulai proses publikasi, pastikan untuk meninjau ringkasan publikasi. Publikasi adalah proses kompleks yang memerlukan persiapan dan waktu untuk diselesaikan.

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.