Menginstal dan mengizinkan add-on

Pengguna harus menginstal dan mengizinkan add-on sebelum dapat membuka dan menggunakannya. Karena langkah-langkah ini adalah bagian pertama dari pengalaman pengguna add-on, Anda harus memahaminya sebelum mulai membuat add-on sendiri.

Bagian dokumentasi ini menjelaskan cara pengguna dapat menginstal, memberi otorisasi, dan mulai menggunakan add-on.

Instal add-on

Sebelum dapat menggunakan add-on, Anda harus menginstal add-on tersebut. Setelah diinstal, add-on akan tersedia di aplikasi host Google Workspace yang diperluas.

Anda dapat menginstal add-on yang dipublikasikan dari aplikasi host Google Workspace atau dari Google Workspace Marketplace. Administrator domain juga dapat menginstal add-on atas nama pengguna mereka dari Google Workspace Marketplace. Anda juga dapat menginstal add-on yang tidak dipublikasikan yang Anda kembangkan sehingga Anda dapat mengujinya. Sebelum dapat menggunakan add-on yang diinstal untuk pertama kalinya, Anda harus memberi otorisasi kepadanya.

Untuk mengetahui detail selengkapnya, lihat Memublikasikan add-on.

Mengizinkan add-on

Setelah diinstal, add-on akan tersedia di aplikasi host Google Workspace yang diperluas. Saat pertama kali mencoba menggunakan add-on, aplikasi host akan menampilkan kartu atau dialog otorisasi. Kartu ini menjelaskan apa saja add-on yang memerlukan izin untuk pengguna, seperti mengakses konten Spreadsheet Google saat ini. Kemudian, pengguna dapat memberikan izin tersebut dan mengizinkan add-on untuk dilanjutkan. Jika pengguna menolak otorisasi add-on, mereka tidak dapat menggunakan add-on.

Add-on Editor menggunakan model otorisasi yang berbeda dari Add-on Google Workspace. Karena Add-on Editor beroperasi pada file Google Drive, model otorisasi editor menentukan berbagai mode otorisasi yang dihasilkan saat add-on digunakan dengan file individual. Saat mengembangkan Add-on Editor, penting untuk memahami berbagai mode dan bagaimana add-on berpindah di antara mode tersebut.

Mengizinkan add-on yang dipublikasikan

Setelah Anda menginstal add-on yang telah dipublikasikan, alur otorisasi akan segera dimulai:

  1. Anda akan diminta untuk memilih akun melalui opsi Choose an account untuk menginstal add-on.
  2. Selanjutnya, Anda akan melihat daftar otorisasi yang diperlukan add-on untuk beroperasi, sehingga Anda mengetahui apa saja yang harus dilakukan. Tinjau daftar ini dengan cermat, dan jika Anda masih ingin memberikan otorisasi, klik Allow. Tindakan ini akan mengaktifkan add-on untuk digunakan.
  3. Kini, Anda dapat menjalankannya dari aplikasi host yang diperluas. Jika aplikasi sudah terbuka di tab browser, Anda mungkin perlu memuat ulang tab sebelum add-on tersedia.

Jika add-on yang Anda instal kemudian diupdate dan memerlukan otorisasi tambahan yang belum Anda berikan, Anda akan diminta untuk memberikan izin tersebut saat berikutnya Anda menggunakan add-on.

Mengizinkan Add-on Google Workspace yang tidak dipublikasikan

Kartu otorisasi add-on

Add-on yang tidak dipublikasikan tidak memiliki alur otorisasi yang sama dengan add-on yang dipublikasikan karena add-on tersebut belum tercantum di Google Workspace Marketplace. Setelah menginstal add-on yang tidak dipublikasikan, Anda tidak akan langsung diminta untuk memberi otorisasi. Sebagai gantinya, alur otorisasi dimulai saat Anda pertama kali mencoba menggunakan add-on.

Ketika dijalankan, add-on akan menentukan apakah otorisasi pengguna diperlukan atau tidak. Jika otorisasi diperlukan, add-on akan menunjukkan kartu otorisasi. Otorisasi selalu diperlukan saat pertama kali add-on dieksekusi, dan mungkin juga diperlukan jika versi baru add-on menggunakan layanan yang sebelumnya tidak diizinkan. Tombol Izinkan Akses menyediakan jendela dialog bagi pengguna untuk Mengizinkan atau Menolak otorisasi add-on.

Mengizinkan layanan non-Google untuk Add-on Google Workspace

Add-on Google Workspace dapat terhubung ke layanan pihak ketiga yang memerlukan otorisasi. Add-on Google Workspace yang terhubung ke layanan tersebut memerlukan dua tindakan terpisah dari pengguna:

  • Otorisasi add-on itu sendiri saat add-on diinstal atau pertama kali dimulai.
  • Otorisasi layanan non-Google saat pertama kali diakses.

Jika Add-on Google Workspace yang Anda kembangkan perlu mengakses layanan non-Google menggunakan OAuth, Anda harus mengonfigurasi koneksi untuk layanan tersebut saat membuat add-on.

Untuk informasi selengkapnya, lihat Menghubungkan Add-on Google Workspace ke layanan pihak ketiga.

Sistem konferensi pihak ketiga

Add-on Google Workspace yang memperluas Google Kalender juga dapat menambahkan solusi konferensi tambahan yang memungkinkan pengguna memilih sistem konferensi pihak ketiga saat mengedit acara Google Kalender. Jika add-on Anda menyediakan opsi konferensi yang mengharuskan pengguna untuk login, add-on Anda harus memberi pengguna kemampuan untuk melakukannya.

Jika pengguna mencoba membuat konferensi dengan add-on Anda tanpa login yang diperlukan, metode onCreateFunction solusi konferensi akan menampilkan objek ConferenceData yang berisi ConferenceError dengan URL autentikasi.

Setelah menerima objek ini, Google Kalender akan membuat tombol LOG IN di UI edit acara yang menautkan ke URL autentikasi yang disediakan oleh add-on. Kemudian, pengguna dapat menggunakan tombol ini untuk login ke sistem pihak ketiga sebelum menggunakan add-on lebih lanjut.

Lihat Membuat konferensi pihak ketiga untuk detail selengkapnya tentang cara menangani otorisasi menggunakan ConferenceError.

Mengizinkan Add-on Editor yang tidak dipublikasikan

Ini merupakan praktik terbaik untuk menguji Add-on Editor saat Anda mengembangkannya. Alur otorisasi identik dengan alur otorisasi untuk Add-on Editor yang dipublikasikan, kecuali bahwa alur dimulai saat Anda pertama kali mencoba menguji add-on. Jika nanti Anda menguji ulang add-on yang sama, Anda tidak akan dimintai otorisasi lagi.

Batalkan otorisasi add-on

Saat mengembangkan add-on, sebaiknya batalkan otorisasi sehingga Anda dapat menguji ulang alur otorisasi.

Anda dapat membatalkan otorisasi add-on dengan melakukan hal berikut:

  1. Buka konsol keamanan akun Anda.
  2. Cari dan klik add-on yang ingin Anda batalkan otorisasinya.
  3. Klik Hapus Akses.

Saat Anda menjalankan add-on lagi setelah membatalkan otorisasinya, alur otorisasi akan ditampilkan kembali.