Testare un componente aggiuntivo Editor
Mantieni tutto organizzato con le raccolte
Salva e classifica i contenuti in base alle tue preferenze.
I componenti aggiuntivi devono essere testati accuratamente prima della pubblicazione per assicurarsi che si comportino come previsto. Apps Script ti consente di testare
componenti aggiuntivi di Editor
in fase di sviluppo in file di Documenti, Fogli, Moduli o Presentazioni Google specifici. Questo
può essere utilizzato per:
- Verifica che un componente aggiuntivo scritto in uno script autonomo funzioni come previsto
quando viene applicato a un foglio, un documento, una presentazione o un modulo.
- Verifica che il flusso di installazione del componente aggiuntivo funzioni come previsto, in particolare per diversi stati del ciclo di vita dell'autorizzazione iniziali (installato, abilitato o entrambi).
- Verifica che il componente aggiuntivo funzioni come previsto quando agisce su un determinato
documento e sui relativi contenuti.
- Testa e confronta le versioni attuale e precedente del componente aggiuntivo.
Creare un deployment di test
Un deployment di test è la combinazione di un componente aggiuntivo e di un documento di test.
Una volta sviluppata una versione dello script e volendo testarla come componente aggiuntivo, segui questi passaggi:
- Se non ne hai già uno, crea un foglio di lavoro, un documento,
una presentazione o un modulo per testare il componente aggiuntivo.
- Apri il progetto di script contenente il componente aggiuntivo.
- Fai clic su Esegui il deployment > Testa i deployment.
- Accanto a Seleziona tipo, fai clic su Attiva i tipi di implementazione settings
e seleziona Componente aggiuntivo Editor.
- Fai clic su Crea nuovo test o Aggiungi test.
- Scegli una versione del codice o seleziona Codice più recente.
- Nella sezione Config, seleziona lo stato di autorizzazione iniziale per il test.
- In Documento di test, fai clic su Nessun documento selezionato. Seleziona il file di Fogli, Documenti, Presentazioni o Moduli che vuoi utilizzare per testare il componente aggiuntivo e fai clic su Inserisci.
- Fai clic su Salva test.
Tutti i deployment di test salvati vengono visualizzati nella finestra di dialogo Deployment di test. In questo modo, potrai esaminare di nuovo lo stesso deployment di test in un secondo momento.
Esegui un deployment di prova
Se hai uno o più implementazioni di test salvate, puoi eseguirne una seguendo questi passaggi:
- Apri il progetto di script contenente il componente aggiuntivo.
- Fai clic su Esegui il deployment > Testa i deployment.
- In Test salvati, seleziona il pulsante di opzione accanto al deployment del test salvato che vuoi eseguire e fai clic su Esegui.
Il documento di test si apre in una nuova scheda. Il componente aggiuntivo si trova nello
stato di autorizzazione
specificato nel deployment di test. Puoi verificare che il componente aggiuntivo funzioni come previsto interagendo con il menu e gli elementi dell'interfaccia utente.
Dettagli dei test
Esistono diversi aspetti da tenere presenti durante il test dei componenti aggiuntivi di Editor in questo modo:
- Gli attivatori installabili
non sono supportati durante i test. La funzionalità che dipende da attivatori installabili non è testabile.
- Durante l'esecuzione di un deployment di test impostato per il test con il codice più recente, puoi vedere le modifiche salvate nello script del componente aggiuntivo aggiornando il documento di test.
- Il documento di test ha un URL che puoi condividere con gli editor del documento di test originale. In questo modo, puoi collaborare più facilmente con altre persone durante il test e lo sviluppo.
- Se il tuo componente aggiuntivo utilizza il
servizio Proprietà,
le proprietà rimangono e rimangono disponibili alla successiva esecuzione dell'implementazione di test.
- Inoltre, qualsiasi implementazione di test che utilizza la stessa combinazione di componente aggiuntivo e
documento di test ha accesso alle stesse informazioni sulla proprietà. Ad esempio, se crei due implementazioni di test, le proprietà salvate durante l'esecuzione della prima sono disponibili durante l'esecuzione della seconda e viceversa, ma solo se le implementazioni utilizzano lo stesso script e lo stesso documento di test.
- Se esegui un deployment di prova, ti potrebbe essere richiesta l'autorizzazione se non hai mai eseguito lo script. Tieni presente che l'autorizzazione di uno script durante il test lo autorizza anche al di fuori del test.
Salvo quando diversamente specificato, i contenuti di questa pagina sono concessi in base alla licenza Creative Commons Attribution 4.0, mentre gli esempi di codice sono concessi in base alla licenza Apache 2.0. Per ulteriori dettagli, consulta le norme del sito di Google Developers. Java è un marchio registrato di Oracle e/o delle sue consociate.
Ultimo aggiornamento 2024-12-22 UTC.
[null,null,["Ultimo aggiornamento 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."]]