Melhore a experiência de seus usuários experiência geral seguindo estes guias de complementos do projeto.
Práticas recomendadas gerais
Recomendamos que você siga as práticas recomendadas a seguir para todos os complementos desenvolver.
Determinar a propriedade do complemento antes de começar
são definidos por projetos do Apps Script, que precisam pertencer a uma ou adicionado a um drive compartilhado. Antes de programar um complemento, determine qual conta será a proprietária do projeto. qual conta age como seu editor. Além disso, determine quais contas devem agir como colaboradores e certifique-se de que essas contas tenham acesso ao script do projeto e dos recursos associados Projeto do Cloud Platform.
Amplie o Google Workspace, não replique
que os complementos oferecem novas funcionalidades para os aplicativos do Google Workspace estendidos ou automatizar tarefas complexas. que apenas replicam a funcionalidade já existente aplicativo ou que não fazem replicações de melhorias significativas para um o fluxo de trabalho provavelmente não será aprovado na revisão do complemento para publicação.
Manter os escopos estreitos
Ao definir os escopos explicitamente,
escolha sempre o conjunto de escopos menos permissivo possível. Por exemplo, não
solicitar acesso total à Agenda do usuário com a
Escopo https://www.googleapis.com/auth/calendar se ele precisar apenas de leitura.
acesso. Para acesso somente leitura, use o
escopo https://www.googleapis.com/auth/calendar.readonly.
Evite depender demais das bibliotecas
O uso das bibliotecas do Apps Script pode fazer com que que seja executado mais lentamente do que faria se todo o código do Apps Script estivesse em um único projeto de script. Embora as bibliotecas do Apps Script funcionem em complementos, você pode ter problemas de desempenho e descontos se você usá-los. Evite incluir bibliotecas desnecessárias no projeto e considere maneiras de reduzir a dependência do seu complemento neles.
A latência descrita acima só se aplica aos projetos do Apps Script em uso como bibliotecas do lado do servidor. É possível usar bibliotecas JavaScript do lado do cliente, como o jQuery livremente, sem encontrar essa latência.
Práticas recomendadas para complementos do Google Workspace
As práticas recomendadas a seguir só se aplicam a Complementos do Google Workspace e o uso do Serviço de cartão.
Usar apenas alguns cards
Se o complemento usar muitos cards, a configuração de navegação será aplicada. se torna complexo e difícil de gerenciar.
Evitar o impulso de criar mais cards do que o necessário.
Usar funções de criação de widgets
Ao escrever o código que cria Card
ou outros objetos complexos de IU, considere colocar esse código em uma função própria.
Essa função de criação deve apenas construir o objeto e retorná-lo. Isso permite
você rapidamente regenera esse objeto sempre que a IU precisa ser atualizada. Lembrar
para chamar build() depois de usar as classes builder na
Serviço de cartão.
Simplifique os cartões
Se um determinado card tiver muitos widgets, ele poderá preencher muito da tela e se tornar menos úteis. Enquanto seções grandes de cartão são renderizadas como elementos da interface recolhíveis, isso oculta as informações do usuário. Procure simplificar o complemento e oferecer exatamente o que o usuário precisa e nada mais.
Usar cards de erro
Crie cards para condições de erro. Se o complemento causar um erro, ele deverá exibir um cartão com as informações do erro e instruções sobre como corrigi-lo se possível. Por exemplo, se não foi possível conectar seu complemento a um provedor porque a autorização falhou, exiba um cartão com essa informação e pergunte o usuário para verificar as informações da conta que estão sendo usadas.
Criar testes e mensagens de teste
Teste todos os complementos criados. Crie funções de teste que criar cartões e widgets usando dados de teste e, em seguida, verificar se os objetos estão criados conforme o esperado.
Ao usar funções de callback de ação, geralmente é necessário criar um objeto de resposta. Você pode usar declarações como a seguir para verificar se as respostas estão sendo construídas corretamente:
Logger.log(response.printJson());
Executar funções de teste criadas diretamente no Apps Script usando o menu Executar. Quando um complemento viável estiver funcionando, instale a versão não publicada para que você possa testá-lo.
Use dados de teste adequados para cada aplicativo host estendido pelo complemento. Para exemplo, se o complemento estender o Gmail, é provável que você precise de alguns e-mails de teste e seus IDs de mensagem para que você possa garantir que o complemento funcione como esperado quando o conteúdo da mensagem é diferente. Você pode conferir o ID da mensagem determinada mensagem listando-as usando o API Gmail Users.messages.list ou usando a API Serviço do Gmail.
Práticas recomendadas para videoconferências no Google Agenda
Caso seu complemento integre recursos videoconferência da agenda opções no Google Agenda, siga estas práticas recomendadas adicionais:
Mantenha o dispositivo onCreateFunction leve
Cada onCreateFunction
definido no manifesto é chamado de forma síncrona quando um usuário tenta
criar uma solução de conferência desse tipo. Certifique-se de que essas funções
mínimo de trabalho necessário para criar a conferência. Fazer muitas coisas
pode causar uma experiência do usuário lenta para seu complemento.
Usar campos ConferenceData apropriados para dados de videoconferência
Quando você cria
ConferenceData
objetos, preencha-os com detalhes sobre a videoconferência (acesso
códigos, números de telefone, PINs, URIs etc.). Use o modelo
Campo EntryPoint
para obter essas informações. Não coloque esses detalhes no ConferenceData
notas.
Não anexar detalhes da videoconferência ao evento do Google Agenda
Seu complemento não precisa adicionar informações sobre o serviço de terceiros criado videoconferências à descrição do evento do Google Agenda. O Google Agenda faz automaticamente quando necessário.