Quando você quiser criar um novo complemento do Google Workspace, siga este procedimento geral:
- Configure os projetos do complemento e escolha um proprietário e colaboradores.
- Projete a aparência e o comportamento do seu complemento.
- Configure o manifesto do projeto do complemento ou recurso de implantação.
- Escreva o código para definir a aparência do complemento e do seu modelo.
- Verifique os escopos do OAuth do complemento.
- Teste o complemento no hospedar aplicativos ela se estende.
- Publique o complemento.
Configurar os projetos do complemento e escolher um proprietário e colaboradores
Se você criar o complemento no Apps Script, vai criar um projeto do Apps Script e um do Google Cloud. Se você criar o complemento em uma linguagem diferente do Apps Script, só vai precisar criar um projeto do Google Cloud.
Antes de iniciar o desenvolvimento de complementos, escolha um único conta de usuário seja proprietária dos projetos e decida quais outras contas serão colaboradores. O proprietário dos projetos cria e gerencia os arquivos do projeto e as configurações associadas, enquanto os colaboradores podem ajudar com a programação e os testes.
Projetos do Apps Script
É possível criar os arquivos de projeto do Apps Script do seu complemento em um drive compartilhado para que nenhuma conta tenha propriedade exclusiva. Colocar o arquivo de script do complemento em um drive compartilhado garante que vários colaboradores tenham acesso ao projeto do script.
Quando você publica um complemento, uma conta de usuário único atua como o editor. A conta de publicação precisa ter acesso para editar o script. projeto, mas não precisa ser o proprietário.
Para criar um projeto do Apps Script, consulte Projetos de script.
Projetos do Google Cloud
Recomendamos que você adicione colaboradores ao projeto do Cloud do complemento. Isso ajuda a garantir que alguém da sua equipe possa sempre acessar as configurações do complemento no Cloud.
Para criar um projeto do Google Cloud, consulte Criar um projeto do Google Cloud.
Projetar a aparência e o comportamento do complemento
Escolha a aparência e o visual do complemento ela deve se comportar antes de você começar a construí-la. Considere quais casos de uso de destino deve tentar fornecer soluções. Iniciar com um design simples para começar a funcionar primeiro e depois adicionar mais refinamentos.
Consulte o guia de estilo do complemento do Google Workspace para conferir diretrizes sobre como projetar a experiência do usuário do complemento.
Configurar o manifesto do projeto do complemento
Em projetos do Apps Script, o manifesto do projeto é um JSON especial. . Ele especifica uma variedade de detalhes sobre o projeto, como a biblioteca dependências. Para complementos do Google Workspace, o manifesto também fornece os recursos básicos informações que o aplicativo host precisa para exibir o o complemento correto.
Consulte Manifestos para ver detalhes sobre como configurar seu do complemento no Apps Script.
À medida que você adiciona códigos e recursos ao seu complemento, edite o manifesto conforme necessário para produzir a aparência e o comportamento necessários.
Programar o complemento
É necessário implementar uma interface baseada em cards para o complemento. Use o serviço de cards do Apps Script ou, se estiver escrevendo em outro idioma de código, retorne um JSON formatado corretamente para que a interface seja renderizada como cards.
Você também deve implementar qualquer acionador funções especificadas no o manifesto do complemento. Se as o complemento se conecta a um serviço de terceiros que não é do Google usando o OAuth, você precisa configurar o OAuth para essa com o serviço do Google Cloud.
Criar cards
Para definir uma interface do usuário de complemento, crie objetos
Card e os preencha com
widgets. Acionar funções especificadas em
seu manifesto deve retornar uma única
objeto Card ou uma matriz de
Objetos Card que representam
"páginas" diferentes da interface de complementos. Seu
complemento também pode criar e mostrar novos cards em
resposta a ações do usuário.
No Apps Script, você cria cards usando a classe CardBuilder. Cada
card exige um CardHeader
e um ou mais
CardSections. É necessário
preencher cada seção de card com os widgets individuais que compõem a
interface do complemento. Os widgets
de interação geralmente
são vinculados a ações para definir
o comportamento de interação.
Depois de adicionar todas as seções e widgets ao cartão pelo
CardBuilder, chame
CardBuilder.build()
para criar o objeto Card correspondente.
Você pode usar outros serviços integrados do Apps Script, como o CalendarApp, para recuperar informações a serem exibidas nos cards complementares criados.
É possível usar dados buscados de serviços de terceiros.
Caso seu complemento precise acessar APIs que não são do Google que requerem OAuth, você deve configurar e conectar-se a esse serviço. Consulte as Guia de conexão com serviços que não são do Google para mais detalhes.
Ordem de construção
Ao criar um card, você precisa começar do topo. Ou seja, você deve usar este ordem de construção:
- Crie o widget.
- Adicione o widget à seção do card.
- Repita até que a seção do cartão tenha todos os widgets.
- Adicione a seção do cartão ao card.
Isso é necessário porque, ao adicionar um widget a uma seção ou card, estão adicionando uma cópia desse widget. Todas as alterações feitas no widget depois de adicioná-lo não são refletidas no cartão final.
Ações universais
É possível usar ações universais para fornecer funcionalidades independentes do contexto. As ações universais são itens de menu disponíveis na interface do complemento, independentemente do card exibido. Todas as ações universais definidas aparecem sempre no menu do card do complemento.
Consulte Ações universais para mais detalhes.
Verificar os escopos do OAuth do complemento
Os escopos definem quais ações do complemento pode assumir em nome de um usuário. É um prática recomendada para os complementos terem escopos apenas para as ações precisa funcionar e nada mais.
Em projetos complementares, defina explicitamente o complemento escopos para garantir o complemento usa o conjunto de escopos menos permissivo sempre que possível. Você define quais escopos seu complemento usa no manifesto do complemento.
Consulte Escopos para mais detalhes.
Testar o complemento
Para testar complementos não publicados, primeiro instale o não publicado do App Engine. Depois de instalar e autorizar o complemento, você poderá usá-lo na sua conta e testar a aparência e o comportamento dele nos aplicativos host que ele estende. Você deve verificar se o complemento se comporta como para contextos e ações do usuário.
Consulte Como testar complementos do Google Workspace para mais detalhes.
Publicar o complemento
A publicação do complemento o disponibiliza para outras pessoas, seja publicamente ou apenas para usuários no seu domínio. Antes de iniciar o processo de publicação, leia a visão geral da publicação. A publicação é um processo complexo que requer preparação e tempo para ser concluído.
Os complementos do Google Workspace são publicados no Google Workspace Marketplace. Disponível publicamente os complementos precisam concluir a revisão do app antes de após a publicação.
Consulte Publicar um complemento do Google Workspace para mais detalhes.