Jika Anda telah membuat dan memublikasikan add-on untuk memperluas Gmail atau Kalender, Anda dapat mengupgradenya menjadi add-on Google Workspace. Petunjuk di halaman ini menjelaskan cara menambahkan fungsi Google Workspace ke add-on Gmail atau Kalender yang sudah ada, lalu memublikasikan add-on yang diupgrade agar dapat ditemukan dan diinstal.
Anda dapat mentransfer fungsi baru ke add-on asli untuk mempertahankan listingan, penginstalan, dan pengguna Google Workspace Marketplace. Dengan mengupgrade, Anda juga dapat memanfaatkan fitur add-on Google Workspace baru seperti halaman beranda.
Langkah 1: Buat salinan project Apps Script add-on Anda
Add-on yang diupgrade menggunakan project Google Cloud yang sama dengan add-on yang dipublikasikan, tetapi Anda harus membuat dan menggunakan salinan project Apps Script yang mendasarinya agar pengguna lama tidak terpengaruh saat Anda menguji versi yang diupgrade. Mengupgrade salinan project skrip asli juga berarti Anda selalu dapat mengakses kode asli, dan dapat men-deploy ulang kode tersebut nanti jika diperlukan.
- Buka project Apps Script add-on Gmail atau add-on konferensi Kalender yang sudah ada.
- Di sebelah kiri, klik Ringkasan .
- Di sebelah kanan, klik Buat salinan .
- Di sebelah kiri, klik Setelan Project > Ubah project.
- Klik GCP Project Number.
- Masukkan nomor project yang sama yang terkait dengan project Apps Script add-on yang sudah ada dan dipublikasikan.
- Klik Set project.
Langkah 2: Mengintegrasikan add-on Google Workspace
Anda harus mendesain dan menerapkan fitur add-on Google Workspace yang ingin ditambahkan ke add-on Anda.
- Rencanakan konten yang akan ditampilkan di kartu beranda add-on Anda dan apakah konten tersebut harus muncul di Gmail, Kalender, Drive, atau kombinasi dari ketiga host tersebut. Jika Anda menginginkan halaman beranda di lebih dari satu host, putuskan apakah halaman beranda tersebut dapat sama atau apakah Anda menginginkan kartu halaman beranda kustom untuk setiap host.
- Di project Apps Script add-on yang disalin, buat kartu beranda dengan fungsi
homepageTrigger. Pastikan untuk menyertakan fungsi atau logika pendukung yang diperlukan untuk mengontrol antarmuka halaman beranda baru Anda. Pertimbangkan untuk menambahkan kartu kontekstual yang dipicu oleh tindakan pengguna, seperti membuka rangkaian pesan Gmail atau acara Kalender.
Perbarui setiap akses ke objek peristiwa di add-on Anda (dalam fungsi callback widget atau dalam fungsi pemicu kontekstual) untuk menggunakan struktur objek peristiwa yang diperbarui. Struktur baru masih berisi kolom objek acara yang sama yang digunakan oleh add-on konferensi Gmail dan Kalender, tetapi kolom asli tersebut tidak digunakan lagi dan pada akhirnya akan dihapus.
Langkah 3: Perbarui manifes add-on
Cara informasi konfigurasi disimpan dalam
struktur manifes add-on
Google Workspace telah berubah secara signifikan dari struktur yang digunakan add-on Gmail
dan add-on konferensi Kalender. Saat mengupgrade add-on, Anda harus memperbarui kolom manifes project Apps Script add-on sesuai dengan tabel di bawah. Anda harus memperbarui semua sub-properti yang relevan ke properti
addOns yang baru.
Pastikan juga untuk memperbarui kolom
oauthScopes manifes Anda sesuai
kebutuhan untuk mencerminkan izin yang diperlukan add-on yang diperbarui.
Untuk mempelajari lebih lanjut manifes add-on Google Workspace, lihat Manifes.
Add-on Gmail
| Kolom manifes asli | Tindakan diperlukan |
|---|---|
gmail.composeTrigger |
Pindahkan ke addOns.gmail.composeTrigger. |
gmail.contextualTriggers[] |
Pindahkan daftar ke addOns.gmail.contextualTriggers[]. |
gmail.logoUrl |
Pindahkan ke addOns.common.logoUrl. |
gmail.name |
Pindahkan ke addOns.common.name. |
gmail.openLinkUrlPrefixes[] |
Pindahkan daftar ke addOns.common.openLinkUrlPrefixes[].
|
gmail.primaryColor |
Pindahkan ke addOns.common.layoutProperties.primaryColor. |
gmail.secondaryColor |
Pindahkan ke addOns.common.layoutProperties.secondaryColor.
|
gmail.universalActions[] |
Pindahkan daftar ke addOns.common.universalActions[]. |
gmail.universalActions[].text |
Pindahkan setiap kolom gmail.universalActions[].text ke kolom addOns.common.universalActions[].label yang sesuai. |
gmail.useLocalFromApp |
Pindahkan ke addOns.common.useLocaleFromApp. |
Add-on konferensi Kalender
| Kolom manifes asli | Tindakan diperlukan |
|---|---|
calendar.createSettingsUrlFunction |
Pindahkan ke addOns.calendar.createSettingsUrlFunction. |
calendar.conferenceSolution[] |
Pindahkan ke addOns.calendar.conferenceSolution[]. |
calendar.logoUrl |
Pindahkan ke addOns.common.logoUrl. |
calendar.name |
Pindahkan ke addOns.common.name. |
Langkah 4: Uji add-on yang diupgrade
Untuk menguji add-on yang diupgrade sebelum dipublikasikan, lihat Menguji add-on Google Workspace.
Langkah 5: Minta ulasan untuk add-on yang diupgrade
Semua add-on Google Workspace, baik add-on yang diupgrade maupun yang dibuat dari awal, harus disetujui sebelum dapat dicantumkan di Google Workspace Marketplace.
Ikuti langkah-langkah berikut untuk mengirimkan add-on Anda agar ditinjau:
Pastikan add-on Anda memenuhi semua persyaratan publikasi add-on.
Buat deployment berversi add-on Google Workspace Anda (di project Apps Script baru) menggunakan versi kode yang ingin Anda publikasikan. Jangan mencoba memublikasikan menggunakan head deployment.
Jika menambahkan cakupan baru saat mengupgrade add-on, Anda harus meminta verifikasi OAuth. Misalnya, jika add-on Gmail Anda menggunakan cakupan Drive atau Kalender baru dalam versi add-on Google Workspace, Anda harus mengirimkan cakupan baru tersebut untuk verifikasi. Verifikasi sering kali memerlukan waktu beberapa hari untuk diselesaikan, jadi mulai prosesnya sesegera mungkin. Pastikan add-on Anda diverifikasi sebelum melanjutkan ke Langkah 6.
Langkah 6: Sediakan add-on yang diupgrade
Buka Google Workspace Marketplace SDK.
Di sebelah kiri, klik Konfigurasi. Panel ini berisi formulir tempat Anda memberikan informasi tentang add-on.
Perbarui deskripsi singkat, deskripsi mendetail, dan screenshot listingan Anda untuk mencerminkan fungsi baru add-on Google Workspace.
Di bagian Ekstensi, klik tombol Upgrade ke add-on Google Workspace. Di kotak teks yang muncul, masukkan ID deployment baru yang Anda buat untuk add-on Google Workspace di langkah sebelumnya. Jika ID deployment Anda valid, daftar host yang didukung akan muncul.
Jika Anda menambahkan cakupan baru ke add-on Google Workspace, pastikan Anda menambahkannya ke bagian cakupan OAuth 2.0 di halaman Konfigurasi. Cakupan yang tercantum di bagian tersebut harus sama persis dengan cakupan yang tercantum dalam manifes add-on Anda.
Pastikan informasi yang Anda masukkan dalam formulir sudah benar. Kemudian, klik Simpan perubahan.
Jika ada pertanyaan atau Anda mengalami masalah selama proses upgrade add-on Google Workspace ini, hubungi kami.
FAQ
Berikut adalah pertanyaan umum (FAQ) terkait upgrade add-on:
Dapatkah saya mengupgrade add-on Editor saya?
Sebagian besar add-on Editor dapat dipindahkan ke add-on Google Workspace. Namun, add-on tersebut tidak dapat diupgrade ke add-on Google Workspace semudah add-on untuk Gmail dan Kalender.
Jika ingin memigrasikan add-on Editor ke add-on Google Workspace, Anda harus menulis ulang UI add-on dari HTML ke antarmuka berbasis Kartu, dan memperbarui penanganan JavaScript ke Card Service.
Beberapa layanan di add-on Editor yang ada mungkin tidak tersedia di Layanan Kartu. Misalnya, jika add-on Editor Anda menyertakan pemilih file, tidak ada pemilih file yang setara yang tersedia dari Layanan Kartu untuk add-on Google Workspace.
Dapatkah saya membuat add-on Google Workspace terpisah dan mempertahankan add-on yang sudah ada?
Anda dapat membuat add-on Google Workspace tambahan dengan nama merek yang berbeda, tetapi kami tidak mengizinkan add-on konferensi Gmail atau Kalender terpisah dengan nama merek yang sama dengan add-on Google Workspace Anda. Jika ada pertanyaan atau ingin meminta pengecualian, hubungi kami.
Apakah pengguna saya perlu memberikan kembali otorisasi add-on setelah diupgrade?
Selama add-on Google Workspace Anda menggunakan project Cloud Platform (GCP) yang sama, dengan ID klien OAuth terkait, pengguna Anda tidak perlu mengotorisasi ulang izin yang sebelumnya mereka otorisasi untuk add-on asli Anda. Namun, jika Anda menambahkan cakupan baru selama proses upgrade, pengguna Anda harus mengizinkan cakupan baru tersebut saat pertama kali mereka menggunakan add-on versi Google Workspace.
Dapatkah saya mengupgrade ekstensi Chrome saya ke add-on Google Workspace dan mentransfer pengguna?
Tidak. Anda tidak dapat mentransfer pengguna, penginstalan, dan ulasan listingan ekstensi Chrome. Anda harus membuat add-on Google Workspace baru dan mengarahkan pengguna ekstensi Chrome Anda ke Google Workspace Marketplace.
Dapatkah saya memaketkan beberapa add-on dengan add-on Google Workspace saya?
Lihat Mencantumkan integrasi aplikasi dalam satu listingan.