Membuat Add-on Google Workspace

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

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

Menyiapkan project add-on dan memilih pemilik serta kolaborator

Jika Anda membuat add-on di Apps Script, Anda 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 memutuskan akun lain mana para kolaborator. Pemilik project membuat dan mengelola file project dan setelan terkait, sedangkan kolaborator dapat membantu coding dan pengujian.

Project Apps Script

Anda dapat mem-build file project Apps Script add-on di drive bersama sehingga tidak ada akun tunggal yang memiliki kepemilikan tunggal. Menempatkan add-on file skrip di drive bersama memastikan bahwa beberapa kolaborator memiliki akses ke proyek 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 Anda menambahkan kolaborator ke add-on project Google Cloud. Hal ini membantu memastikan seseorang di tim Anda selalu dapat mengakses di 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 Anda inginkan dan caranya perilakunya sebelum Anda mulai membangunnya. Pertimbangkan kasus penggunaan yang harus dicoba dipecahkan oleh add-on. Mulai dengan desain sederhana untuk mulai bekerja terlebih dahulu, lalu tambahkan lebih banyak peningkatan.

Lihat panduan gaya Add-on Google Workspace untuk panduan cara mendesain add-on pengalaman yang lancar bagi developer.

Mengonfigurasi manifes project add-on

Dalam project Apps Script, manifes project adalah file JSON khusus. Ini menentukan berbagai detail tentang project, seperti library-nya dependensi. 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 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 skrip Apps Script Layanan kartu atau jika Anda menulis dalam bahasa kode lain, kembali JSON yang diformat dengan benar agar antarmuka dapat dirender sebagai kartu.

Anda juga harus menerapkan pemicu fungsi 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. Nama add-on juga dapat membuat dan menampilkan kartu baru di 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 widget individual yang membentuk antarmuka add-on. Interaksi widget tersebut adalah biasanya dikaitkan dengan tindakan untuk menentukan perilaku interaksi mereka.

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

Pesanan konstruksi

Saat membuat kartu, Anda harus membuatnya dari awal. Artinya, Anda harus menggunakan pesanan konstruksi:

  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.

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 didefinisikan selalu muncul di di menu kartu add-on.

Lihat Tindakan universal untuk mengetahui informasi selengkapnya spesifikasi pendukung.

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, setel secara eksplisit atau Gemini Enterprise cakupan untuk memastikan add-on menggunakan kumpulan cakupan yang paling tidak permisif sebaik mungkin. 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 terlebih dahulu tidak dipublikasikan add-on Anda. Setelah diinstal dan diberi otorisasi, Anda dapat menggunakan add-on di akun Anda dan menguji tampilan serta perilakunya di aplikasi host. akan meluas. Anda harus memastikan bahwa add-on berfungsi sebagai yang diharapkan untuk konteks dan tindakan pengguna.

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

Publikasikan add-on

Memublikasikan add-on Anda akan membuatnya tersedia untuk orang lain, baik secara publik maupun hanya pengguna di domain Anda. Sebelum memulai publikasi pastikan untuk meninjau ringkasan publikasi. Publikasi adalah proses kompleks yang membutuhkan persiapan dan waktu penyelesaiannya.

Add-on Google Workspace dipublikasikan ke Google Workspace Marketplace. Tersedia untuk umum add-on harus menyelesaikan peninjauan aplikasi sebelum publikasinya.

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