Melhore a experiência geral dos usuários seguindo estes guias de design de complementos.
Práticas recomendadas gerais
Recomendamos que você use as práticas recomendadas a seguir para todos os complementos que desenvolver.
Determinar a propriedade do complemento antes de começar
Os complementos são definidos por projetos do Apps Script, que precisam ser de uma conta específica ou colocados em um drive compartilhado. Antes de programar um complemento, determine qual conta será proprietária do projeto e qual conta atua como editor. Determine também quais contas vão atuar como colaboradoras e verifique se elas têm acesso ao projeto do script e ao projeto do Google Cloud associado.
Amplie o Google Workspace, não o replique
Os complementos fornecem novos recursos aos aplicativos do Google Workspace que eles estendem ou automatizam tarefas complexas. Os complementos que apenas replicam a funcionalidade já existente no aplicativo ou que não fazem melhorias significativas em um fluxo de trabalho provavelmente não serão aprovados na revisão de complementos para publicação.
Manter os escopos restritos
Ao definir seus escopos
explicitamente, sempre escolha o
conjunto de escopos menos permissivo possível. Por exemplo, não peça
acesso total ao complemento do
Google Agenda do usuário com o escopo https://www.googleapis.com/auth/calendar
se ele precisar apenas de acesso de leitura. Para acesso somente leitura, use o
escopo https://www.googleapis.com/auth/calendar.readonly.
Evite depender muito das bibliotecas
O uso de bibliotecas do Apps Script pode fazer com que o complemento seja executado mais lentamente do que se todo o código do Apps Script estivesse contido em um único projeto de script. Embora as bibliotecas do Apps Script funcionem em complementos, você pode ter uma redução no desempenho se usá-las. Evite incluir bibliotecas desnecessárias no seu projeto e considere maneiras de reduzir a dependência do complemento delas.
A latência descrita acima se aplica apenas a projetos do Apps Script que são usados como bibliotecas do lado do servidor. É possível usar bibliotecas JavaScript do lado do cliente, como o jQuery, sem encontrar essa latência.
Práticas recomendadas para complementos de editor
As práticas recomendadas a seguir se aplicam apenas ao complemento do Editor.
Colocar o HTML da interface e o JavaScript do lado do cliente nos próprios arquivos de script
É possível criar vários arquivos de script em um projeto do Apps Script. É mais fácil gerenciar um complemento complexo se você colocar o HTML e o JavaScript que define as barras laterais e as caixas de diálogo do complemento em arquivos de script dedicados a eles.
Teste completamente em diferentes modos de autorização
Ao testar o complemento, tente configurações com arquivos e estados de autorização diferentes.