Membuat Add-on Google Workspace

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

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

Siapkan project add-on serta pilih pemilik dan kolaborator

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

Project Apps Script

Anda dapat membuat Apps Script add-on file proyek dalam file bersama {i>drive<i} sehingga tidak ada akun tunggal hanya didapati. 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 skrip tetapi tidak harus merupakan pemilik.

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 seperti apa tampilan add-on yang Anda inginkan dan bagaimana caranya perilakunya sebelum Anda mulai membangunnya. Pertimbangkan kasus penggunaan apa add-on harus mencoba memberikan solusi. Mulai dengan desain sederhana untuk mulai bekerja, kemudian menambahkan beberapa penyempurnaan.

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 JSON khusus . Ini menentukan berbagai detail tentang project, seperti library-nya dependensi. Untuk Add-on Google Workspace, manifes juga menyediakan fitur dasar informasi yang diperlukan aplikasi {i>host<i} untuk menampilkan {i>add-on<i} 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 diperlukan untuk menghasilkan add-on yang diperlukan penampilan dan perilaku pengguna.

Membuat kode add-on

Anda harus mengimplementasikan antarmuka berbasis kartu untuk {i>add-on<i}. 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 terhubung ke layanan non-Google pihak ketiga menggunakan OAuth, Anda harus mengonfigurasi OAuth untuk layanan juga.

Membuat kartu

Anda menentukan antarmuka pengguna {i>add-on<i} dengan membuat Card dan mengisinya dengan widget. Fungsi pemicu yang ditentukan di manifes Anda harus mengembalikan satu Objek Card atau array Objek Card yang mewakili 'halaman' yang berbeda antarmuka add-on. Nama add-on ini juga dapat membuat dan menampilkan kartu baru di terhadap tindakan pengguna.

Di Apps Script, Anda membuat kartu menggunakan Class CardBuilder. Masing-masing kartu memerlukan CardHeader dan satu atau beberapa CardSections. Anda seharusnya mengisi setiap bagian kartu dengan masing-masing widget yang membentuk antarmuka add-on Google. Interaksi widget, adalah biasanya dikaitkan dengan tindakan untuk menentukan perilaku interaksi mereka.

Setelah Anda menambahkan semua bagian dan widget ke kartu melalui CardBuilder, Anda harus memanggil CardBuilder.build() untuk membuat objek Card yang sesuai.

Anda dapat menggunakan Apps Script bawaan yang ada layanan seperti CalendarApp untuk diambil informasi untuk ditampilkan di kartu add-on yang Anda buat. 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 bagian Menghubungkan ke Panduan Layanan Non-Google untuk secara lebih mendetail.

Pesanan konstruksi

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

  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 menambahkan salinan dari widget tersebut. Setiap perubahan yang Anda lakukan pada widget setelah menambahkannya, tidak akan ditampilkan 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 kartunya 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 apa saja diizinkan untuk dilakukan atas nama pengguna. Ini adalah praktik terbaik bagi add-on agar hanya memiliki cakupan untuk tindakan yang harus dimiliki agar fungsi dapat berjalan dan tidak lebih.

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 penggunaan add-on add-on ini manifes.

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 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 secara lebih mendetail.