Menguji add-on Editor
Tetap teratur dengan koleksi
Simpan dan kategorikan konten berdasarkan preferensi Anda.
Add-on harus diuji secara menyeluruh sebelum dipublikasikan untuk memastikannya
berfungsi sebagaimana mestinya. Apps Script memungkinkan Anda menguji
add-on Editor
dalam pengembangan pada file Google Dokumen, Spreadsheet, Formulir, atau Slide tertentu. Hal ini
dapat digunakan untuk:
- Pastikan bahwa add-on yang ditulis dalam skrip mandiri berfungsi sebagaimana mestinya
saat diterapkan ke spreadsheet, dokumen, presentasi, atau formulir.
- Pastikan alur penginstalan add-on berfungsi sebagaimana mestinya, terutama untuk
status siklus proses otorisasi awal
yang berbeda
(diinstal, diaktifkan, atau keduanya).
- Pastikan add-on berfungsi sebagaimana mestinya saat menangani dokumen
tertentu dan kontennya.
- Uji dan bandingkan add-on versi saat ini dan sebelumnya.
Membuat deployment pengujian
Deployment pengujian adalah kombinasi add-on dan dokumen pengujian.
Setelah Anda mengembangkan versi skrip dan ingin mengujinya sebagai add-on,
ikuti langkah-langkah berikut:
- Jika Anda belum memilikinya, buat spreadsheet, dokumen,
presentasi, atau formulir untuk menguji add-on.
- Buka project skrip yang berisi add-on Anda.
- Klik Deploy > Test deployments.
- Di samping Pilih jenis, klik Aktifkan jenis deployment settings, lalu pilih Add-on editor.
- Klik Buat pengujian baru atau Tambahkan pengujian.
- Pilih versi kode atau pilih Kode Terbaru.
- Di bagian Config, pilih status otorisasi awal untuk pengujian.
- Di bagian Test document, klik No document selected. Pilih file Spreadsheet, Dokumen,
Slide, atau Formulir yang ingin Anda gunakan untuk menguji add-on, lalu klik Sisipkan.
- Klik Simpan pengujian.
Semua deployment pengujian tersimpan akan muncul di dialog Test deployments. Hal ini memungkinkan
Anda meninjau kembali deployment pengujian yang sama nanti.
Menjalankan deployment pengujian
Jika memiliki satu atau beberapa deployment pengujian tersimpan, Anda dapat menjalankan salah satunya dengan
mengikuti langkah-langkah berikut:
- Buka project skrip yang berisi add-on Anda.
- Klik Deploy > Test deployments.
- Di bagian Pengujian Tersimpan, pilih tombol pilihan di samping deployment pengujian
tersimpan yang ingin Anda jalankan, lalu klik Jalankan.
Dokumen pengujian akan terbuka di tab baru. Add-on berada dalam
status otorisasi
yang ditentukan dalam deployment pengujian. Anda dapat memverifikasi bahwa add-on berfungsi seperti yang dimaksudkan dengan berinteraksi dengan menu dan elemen UI-nya.
Detail pengujian
Ada sejumlah hal yang perlu diingat saat menguji add-on Editor
dengan cara ini:
- Pemicu yang dapat diinstal
tidak didukung saat pengujian. Fungsi yang bergantung pada pemicu
yang dapat diinstal tidak dapat diuji.
- Saat menjalankan deployment pengujian yang ditetapkan untuk diuji dengan kode terbaru, Anda
dapat melihat perubahan yang disimpan ke skrip add-on dengan memuat ulang dokumen pengujian.
- Dokumen pengujian memiliki URL yang dapat Anda bagikan kepada editor dokumen pengujian
asli. Dengan cara ini, Anda dapat berkolaborasi dengan orang lain dengan lebih mudah saat
menguji dan mengembangkan.
- Jika add-on Anda menggunakan
Layanan properti,
properti akan tetap ada dan tetap tersedia saat deployment pengujian
berjalan lagi.
- Selain itu, setiap deployment pengujian yang menggunakan kombinasi add-on dan dokumen pengujian yang sama memiliki akses ke informasi properti yang sama. Misalnya, jika Anda membuat dua deployment pengujian, properti yang disimpan saat menjalankan deployment pertama akan tersedia saat menjalankan deployment kedua dan sebaliknya, tetapi hanya jika deployment menggunakan skrip dan dokumen pengujian yang sama.
- Jika menjalankan deployment pengujian, Anda mungkin dimintai otorisasi jika belum menjalankan skrip sebelumnya. Perhatikan bahwa memberikan otorisasi pada skrip saat
pengujian juga akan memberikan otorisasi pada skrip di luar pengujian.
Kecuali dinyatakan lain, konten di halaman ini dilisensikan berdasarkan Lisensi Creative Commons Attribution 4.0, sedangkan contoh kode dilisensikan berdasarkan Lisensi Apache 2.0. Untuk mengetahui informasi selengkapnya, lihat Kebijakan Situs Google Developers. Java adalah merek dagang terdaftar dari Oracle dan/atau afiliasinya.
Terakhir diperbarui pada 2024-12-22 UTC.
[null,null,["Terakhir diperbarui pada 2024-12-22 UTC."],[[["\u003cp\u003eApps Script allows developers to test editor add-ons directly within Google Docs, Sheets, Slides, or Forms to verify functionality and installation flow.\u003c/p\u003e\n"],["\u003cp\u003eDevelopers can create test deployments to specify add-on versions, authorization states, and associated documents for controlled testing environments.\u003c/p\u003e\n"],["\u003cp\u003eSaved test deployments can be executed repeatedly, enabling developers to iterate on their add-ons and observe changes in real-time within the test document.\u003c/p\u003e\n"],["\u003cp\u003eWhile offering valuable testing capabilities, test deployments have limitations such as not supporting installable triggers and shared property persistence across deployments using the same add-on and document.\u003c/p\u003e\n"],["\u003cp\u003eTest deployments provide a shareable URL for collaborative testing and may require authorization for the script, both within and outside the testing environment.\u003c/p\u003e\n"]]],["To test add-ons in development, create a test deployment linking a script version to a specific Google Docs, Sheets, Forms, or Slides file. Select the add-on's authorization state and save the test. Run saved tests by selecting them in the \"Test deployments\" dialog and clicking \"Execute.\" During testing, changes to the script can be viewed by refreshing the test document; the test document URL is shareable for collaboration. Any properties created are also persisted across multiple test deployments.\n"],null,["# Test an Editor add-on\n\nAdd-ons should be tested thoroughly prior to publishing to ensure they\nbehave as intended. Apps Script lets you test\n[Editor add-ons](/workspace/add-ons/concepts/types#editor_add-ons)\nin development on specific Google Docs Sheets, Forms, or Slides files. This\ncan be used to:\n\n- Verify that an add-on written in a standalone script functions as intended when applied to a sheet, doc, presentation, or form.\n- Verify that the add-on installation flow works as intended, particularly for different initial [authorization lifecycle states](/workspace/add-ons/concepts/editor-auth-lifecycle#the_complete_lifecycle) ([installed, enabled, or both](/workspace/add-ons/concepts/editor-auth-lifecycle#installed_versus_enabled)).\n- Verify that the add-on functions as intended when acting on a particular document and its contents.\n- Test and compare the current and previous versions of the add-on.\n\nCreate a test deployment\n------------------------\n\nA test deployment is the combination of an add-on and a test document.\nOnce you have a script version developed and would like to test it as an add-on,\nfollow these steps:\n\n1. If you don't have one already, create a spreadsheet, document, presentation, or form to test the add-on with.\n2. Open the script project containing your add-on.\n3. Click **Deploy** \\\u003e **Test deployments**.\n4. Next to **Select type** , click Enable deployment types settings and select **Editor add-on**.\n5. Click **Create new test** or **Add test**.\n6. Choose a code version or select **Latest Code**.\n7. In the **Config** section, select the initial [authorization state](/workspace/add-ons/concepts/editor-auth-lifecycle#installed_versus_enabled) for the test.\n8. Under **Test document** , click **No document selected** . Select the Sheets, Docs, Slides, or Forms file you want to use to test the add-on and click **Insert**.\n9. Click **Save test**.\n\nAll saved test deployments appear in the **Test deployments** dialog. This lets\nyou revisit the same test deployment later on.\n\nRun a test deployment\n---------------------\n\nIf you have one or more saved test deployments, you can run one of them by\nfollowing these steps:\n\n1. Open the script project containing your add-on.\n2. Click **Deploy** \\\u003e **Test deployments**.\n3. Under **Saved Tests** , select the radio button next to the saved test deployment you want to run and click **Execute**.\n\nThe test document opens in a new tab. The add-on is in the\n[authorization state](/workspace/add-ons/concepts/editor-auth-lifecycle#installed_versus_enabled)\nspecified in the test deployment. You can verify that the add-on functions as\nintended by interacting with its menu and UI elements.\n\n### Testing details\n\nThere are a number of things to keep in mind while testing Editor add-ons\nthis way:\n\n- [Installable triggers](/workspace/add-ons/concepts/editor-triggers#installable_triggers_in_add-ons) aren't supported when testing. Functionality that depends on installable triggers is not testable.\n- While running a test deployment that's set to test with the latest code, you can see changes saved to the add-on script by refreshing the test document.\n- The test document has a URL that you can share with editors of the original test document. This way, you can more easily collaborate with others while testing and developing.\n- If your add-on uses the [Properties service](/apps-script/reference/properties/properties-service), properties persist and remain available the next time the test deployment is run.\n- In addition, any test deployment that uses the same combination of add-on and test document has access to the same property information. For example, if you create two test deployments, the properties saved while running the first are available while running the second and vice versa, but only if the deployments use the same script and test document.\n- If you run a test deployment, you might be prompted for authorization if you have not run the script before. Be aware that authorizing a script while testing also authorizes the script outside of testing."]]
