Testar e depurar complementos do Google Workspace para o Apps Script
Mantenha tudo organizado com as coleções
Salve e categorize o conteúdo com base nas suas preferências.
Quando você publica um complemento, os usuários podem instalá-lo
pelo aplicativo host
ou pelo Google Workspace Marketplace. Antes de publicar, teste os
complementos que você desenvolve nos aplicativos host que
eles estendem.
Esta página descreve como instalar um complemento que está
em desenvolvimento (chamado de não publicado ou do desenvolvedor
(link em inglês) para uso pessoal ou
de teste. Também é possível depurar complementos usando o
depuração e os pontos de interrupção do ambiente de desenvolvimento integrado do Apps Script.
Pré-requisitos
É necessário ter acesso de editor ao projeto do script do complemento.
Para permitir que outras pessoas na sua organização testem o complemento, conceda a elas acesso de editor
ao projeto do script. Para saber mais sobre como conceder acesso, consulte
Como colaborar com outros desenvolvedores.
Instalar um complemento não publicado
É possível instalar complementos não publicados na caixa de diálogo Deployments do Apps Script.
Siga estas etapas para instalar um complemento não publicado
do Google Workspace para testes:
Abra o projeto do script no editor do Apps Script.
Clique em Implantar > Testar implantações.
Clique em Instalar.
Na parte de baixo, clique em Concluído.
Para permitir que outros usuários testem o complemento, compartilhe o projeto do Apps Script com a conta deles (é necessário ter acesso de edição). Em seguida, peça para os usuários
seguirem as etapas acima.
Depois de instalado, o complemento fica imediatamente disponível nos aplicativos host que ele
estende. Talvez seja necessário atualizar a guia do aplicativo host antes que o complemento
apareça. Você também precisa
autorizar
o complemento antes de usá-lo.
Desinstalar um complemento não publicado
Para desinstalar uma implantação de complemento não publicada, siga estas etapas:
Abra o projeto do script no editor do Apps Script.
Clique em Implantar > Testar implantações.
Clique em Desinstalar.
Na parte de baixo, clique em Concluído.
Essas etapas removem imediatamente a implantação, e o complemento não aparece mais
em nenhum aplicativo host. É possível reinstalar a implantação a qualquer momento
repetindo o procedimento de instalação.
Práticas recomendadas para testes
Ao testar o complemento do Google Workspace, siga
as
práticas recomendadas
para desenvolvimento de complementos. Além disso, faça o seguinte:
A navegação do card de teste flui completamente em todos os aplicativos host que o
complemento estende. Verifique se o comportamento do complemento está correto conforme o usuário muda
de contexto e entre cards não contextuais e contextuais.
Se o complemento se conectar a uma API de terceiros ou a outro serviço, verifique
se o serviço pode ser acessado e se ele se comporta como esperado. Confira se
o complemento está processando os
detalhes de autorização e login
corretamente.
Verifique se todas as condições de erro são tratadas corretamente. Use cards de erro
quando necessário.
Preste atenção no desempenho do complemento. Se você fizer uma mudança no
código e o complemento começar a ficar lento, talvez seja necessário remover ou refazer
esse recurso.
[[["Fácil de entender","easyToUnderstand","thumb-up"],["Meu problema foi resolvido","solvedMyProblem","thumb-up"],["Outro","otherUp","thumb-up"]],[["Não contém as informações de que eu preciso","missingTheInformationINeed","thumb-down"],["Muito complicado / etapas demais","tooComplicatedTooManySteps","thumb-down"],["Desatualizado","outOfDate","thumb-down"],["Problema na tradução","translationIssue","thumb-down"],["Problema com as amostras / o código","samplesCodeIssue","thumb-down"],["Outro","otherDown","thumb-down"]],["Última atualização 2024-12-22 UTC."],[[["\u003cp\u003eUnpublished Google Workspace add-ons can be installed for testing and personal use directly from the Apps Script project.\u003c/p\u003e\n"],["\u003cp\u003eUsers need editor access to the script project to install and test the unpublished add-on.\u003c/p\u003e\n"],["\u003cp\u003eUninstalling an unpublished add-on removes it from all host applications and requires reinstallation for further use.\u003c/p\u003e\n"],["\u003cp\u003eThorough testing is crucial, including card navigation, data handling, external service integrations, error management, and performance evaluation.\u003c/p\u003e\n"]]],["To test an unpublished add-on, open its script project in the Apps Script editor and navigate to **Deploy \u003e Test deployments**. Click **Install**, then **Done** to make it available in host applications. Share the project for others to test. Uninstall by repeating the process and selecting **Uninstall**. Testing should include card navigation, example data evaluation, third-party service verification, error handling, and performance monitoring.\n"],null,["# Test and debug Apps Script Google Workspace add-ons\n\nWhen you publish an add-on, users can install it\nthrough the host application\nor the [Google Workspace Marketplace](https://workspace.google.com/marketplace/). Before you publish, test the\nadd-ons that you develop within the host applications that\nthey extend.\n\nThis page describes how to install an add-on that is\nunder development (called an *unpublished* or *developer*\nadd-on) for testing or\npersonal use. You can also debug add-ons using the\nApps Script\nIDE's [debugger and breakpoints](/apps-script/guides/support/troubleshooting#use-debugger).\n\nPrerequisites\n-------------\n\n- You must have editor access to the add-on's script project.\n- To let other people in your organization test the add-on, grant them editor access to the script project. For details about granting access, see [Collaborating with Other Developers](/apps-script/guides/collaborating).\n\nInstall an unpublished add-on\n-----------------------------\n\nYou can install unpublished add-ons from Apps Script's **Deployments**\ndialog.\n\nFollow these steps to install an unpublished\nGoogle Workspace add-on for testing:\n\n1. Open the script project in the Apps Script editor.\n2. Click **Deploy \\\u003e Test deployments**.\n3. Click **Install**.\n4. At the bottom, click **Done**.\n\nYou can let other users test the add-on by sharing the Apps Script project\nwith their account (edit access is required). Then prompt the users to\nfollow the above steps.\n\nOnce installed, the add-on is immediately available in host applications it\nextends. You may need to refresh the host application tab before the add-on\nappears. You must also\n[authorize](/workspace/add-ons/how-tos/authorizing-addons#authorizing_unpublished_g_suite_add-ons)\nthe add-on before using it.\n\nUninstall an unpublished add-on\n-------------------------------\n\nTo uninstall an unpublished add-on deployment, follow these steps:\n\n1. Open the script project in the Apps Script editor.\n2. Click **Deploy \\\u003e Test deployments**.\n3. Click **Uninstall**.\n4. At the bottom, click **Done**.\n\nThese steps immediately remove the deployment and the add-on no longer appears\nin any host application. You can reinstall the deployment at any time by\nrepeating the [install procedure](#install_an_unpublished_add-on).\n\nTesting best practices\n----------------------\n\nWhile testing your Google Workspace add-on, be sure\nto follow the\n[Best practices](/workspace/add-ons/guides/workspace-best-practices)\nfor add-on development. In addition, be sure to do the following:\n\n1. Test card navigation flows thoroughly in all the host applications the\n add-on extends. Make sure the add-on behavior is correct as the user moves\n from context to context, and between non-contextual and contextual cards.\n\n2. [Use example test data](/workspace/add-ons/guides/workspace-best-practices#_write_tests_and_test_messages)\n to evaluate your add-on's behavior.\n\n3. If your add-on connects to a third-party API or other service, verify\n that the service can be accessed and behaves as expected. Make sure\n your add-on is handling the\n [authorization and log-in details](/workspace/add-ons/how-tos/non-google-services)\n correctly.\n\n4. Make sure any error conditions are handled gracefully. [Use error cards](/workspace/add-ons/guides/workspace-best-practices#_use_error_cards)\n where needed.\n\n5. Pay attention to how performant the add-on is. If you make a change to the\n code and the add-on starts slowing down, you may need to remove or rework\n that feature."]]