Práticas recomendadas

Melhore a experiência geral dos usuários seguindo estes guias de design de complementos.

Práticas recomendadas gerais

Siga as práticas recomendadas abaixo para todos os complementos desenvolvidos.

Determinar a propriedade do complemento antes de começar

Os complementos são definidos por projetos do Apps Script, que precisam pertencer a uma conta específica ou ser colocados em um drive compartilhado. Antes de codificar um complemento, determine qual conta será proprietária do projeto e qual conta atuará como a de editora. Determine também quais contas vão atuar como colaboradores e verifique se essas contas têm acesso ao projeto de script e ao projeto do Cloud Platform associado.

Estender o Google Workspace, não replicá-lo

os complementos oferecem novos recursos aos aplicativos do Google Workspace que eles estendem ou automatizam tarefas complexas. Os complementos que simplesmente replicam a funcionalidade que já está no aplicativo ou aqueles que não fazem melhorias significativas no fluxo de trabalho provavelmente não serão aprovados na avaliação de complementos para publicação.

Manter os escopos restritos

Ao definir seus escopos explicitamente, sempre escolha o conjunto menos permissivo possível. Por exemplo, não tenha a solicitação do complemento de acesso total à agenda do usuário com o escopo https://www.googleapis.com/auth/calendar se ela precisar apenas de acesso de leitura. Para acesso somente leitura, use o escopo https://www.googleapis.com/auth/calendar.readonly.

Evitar depender demais das bibliotecas

Com o uso das bibliotecas do Apps Script, seu complemento pode ser executado mais lentamente do que seria 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, elas podem ser reduzidas no desempenho. Evite incluir bibliotecas desnecessárias no projeto e considere maneiras de reduzir a dependência delas pelo complemento.

A latência descrita acima só se aplica a projetos do Apps Script usados como bibliotecas do lado do servidor. É possível usar bibliotecas JavaScript do lado do cliente, como o jQuery, de maneira livre, sem essa latência.

Práticas recomendadas para complementos do Editor

as práticas recomendadas a seguir só se aplicam 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 definem as barras laterais e as caixas de diálogo do complemento em arquivos de script dedicados a eles.

Fazer testes completos em diferentes modos de autorização

Ao testar seu complemento, teste as configurações com arquivos e estados de autorização distintos.