Mem-build Add-on Google Workspace

Jika ingin mem-build Google Workspace Add-on baru, ikuti prosedur umum berikut:

  1. Siapkan project add-on Anda dan pilih pemilik dan kolaborator.
  2. Rancang tampilan dan perilaku add-on Anda.
  3. Konfigurasikan resource 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 Anda dan pilih pemilik serta kolaborator

Jika 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 memutuskan akun lain yang menjadi kolaborator. Pemilik project membuat dan mengelola file project dan setelan terkait, sedangkan kolaborator dapat membantu proses coding dan pengujian.

Project Apps Script

Anda dapat mem-build 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 memungkinkan Anda memastikan dengan mudah bahwa beberapa kolaborator selalu memiliki akses ke project skrip.

Saat Anda memublikasikan add-on, satu akun pengguna akan berfungsi sebagai penayang. Akun publikasi harus memiliki akses edit ke project skrip, tetapi tidak harus pemilik.

Project Google Cloud

Sebaiknya tambahkan kolaborator ke project Cloud add-on. Hal ini membantu memastikan seseorang di tim Anda dapat mengakses setelan Cloud add-on kapan saja.

Mendesain tampilan dan perilaku add-on

Tentukan seperti apa tampilan add-on dan perilakunya sebelum mulai mem-build-nya. Pertimbangkan kasus penggunaan apa yang harus dicoba oleh add-on. Mulailah dengan desain sederhana untuk bekerja terlebih dahulu, lalu tambahkan perbaikan lainnya.

Lihat Google Workspace panduan gaya add-on untuk panduan tentang cara mendesain pengalaman pengguna add-on.

Mengonfigurasi manifes project add-on

Dalam project Apps Script, manifes project adalah file JSON khusus. Kolom ini menentukan berbagai detail tentang project, seperti dependensi library-nya. Untuk Google Workspace Add-on, 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.

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 yang akan dirender sebagai kartu.

Anda juga harus mengimplementasikan fungsi pemicu apa pun 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. Add-on juga dapat membuat dan menampilkan kartu baru sebagai respons terhadap tindakan pengguna.

Dalam Apps Script, Anda membuat kartu menggunakan class CardBuilder. Setiap kartu memerlukan CardHeader dan satu atau beberapa CardSections. Anda harus mengisi setiap bagian kartu dengan widget individual yang membentuk antarmuka add-on. Widget interaksi, biasanya dikaitkan 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.

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 Google Workspace Add-on 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.

Urutan konstruksi

Saat membuat kartu, Anda harus mem-build dari atas ke atas. Artinya, Anda harus menggunakan urutan konstruksi ini:

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

Hal ini diperlukan karena saat Anda 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.

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 saat ini 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 diizinkan oleh add-on atas nama pengguna. Ini adalah praktik terbaik bagi add-on untuk hanya memiliki cakupan untuk tindakan yang harus mereka miliki dalam fungsi urutan dan 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 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 dan menguji kemunculan serta perilakunya di aplikasi host yang diperluas. Anda harus memverifikasi bahwa add-on berperilaku seperti yang diharapkan untuk konteks dan tindakan pengguna.

Lihat Pengujian Google Workspace Add-on untuk detail selengkapnya.

Memublikasikan add-on

Memublikasikan add-on Anda 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 memerlukan persiapan dan waktu untuk menyelesaikannya.

Google Workspace Add-on dipublikasikan ke Google Workspace Marketplace. Add-on yang tersedia untuk publik harus menyelesaikan peninjauan aplikasi sebelum dipublikasikan.

Lihat Add-on Google Workspace Publikasi untuk detail selengkapnya.

Google Workspace Contoh add-on

 l10n-placeholder41=

Untuk membantu Anda memahami cara Google Workspace add-on dibuat, Google Workspace "Cats" panduan memulai add-on menunjukkan cara membuat Google Workspace add-on, termasuk halaman beranda layanan, link layanan, Setelah menyelesaikan quickstart, Anda dapat menginstal add-on dan bereksperimen dengan kode tersebut.