Para criar um novo complemento do Google Workspace, siga estas instruções procedimento:
- Configurar os projetos do complemento e escolher um proprietário e colaboradores.
- Crie a aparência e o comportamento do 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 seu complemento no Apps Script, crie um projeto do Apps Script e um projeto do Google Cloud. Se você criar seu complemento em um idioma diferente Apps Script, você só precisa 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, já os colaboradores podem ajudar na programação e nos testes.
Projetos do Apps Script
Você pode criar o Apps Script do seu complemento arquivos de projeto em um ambiente compartilhado drive para que conta individual tem propriedade exclusiva. Apresentando seu complemento em um drive compartilhado garante que vários colaboradores tenham acesso a eles o projeto de script.
Quando você publica um complemento, uma única conta de usuário atua como 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 do Script.
Projetos do Google Cloud
Recomendamos que você adicione colaboradores ao complementos projeto do Google Cloud. Isso ajuda a garantir que alguém em sua equipe sempre possa acessar do complemento na nuvem.
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 de complementos do Google Workspace. para orientações sobre como projetar seu usuário do complemento do usuário.
Configurar o manifesto do projeto de 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ê adicionar código e recursos ao complemento, edite as conforme necessário para produzir o complemento necessário aparência e comportamento.
Codificar o complemento
Você precisa implementar uma interface baseada em cards para o . Usar o Apps Script Serviço de cartões ou, se você estiver escrevendo em outro idioma de código, retorne JSON formatado corretamente para que a interface seja renderizada como cartões.
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
Você define uma interface de usuário de complemento criando
Card e preenchê-los com
de 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
também pode criar e exibir novos cards no
em resposta às ações do usuário.
No Apps Script, você cria cards usando o
classe CardBuilder. Cada
O cartão requer uma CardHeader
e um ou mais
CardSections Você deve
preencher cada seção do cartão com os widgets individuais que compõem o
do complemento. Interação
widgets, são
geralmente vinculados a ações para definir
o comportamento de interação.
Depois de adicionar todas as seções e widgets ao seu cartão por meio de seu
CardBuilder, você precisa chamar
CardBuilder.build()
para criar o objeto Card correspondente.
Você pode usar outros scripts integrados do Apps
serviços, como
CalendarApp para recuperar
informações a serem exibidas nos cards complementares que você criar.
Você pode usar dados buscados em serviços de terceiros.
Caso seus complementos do Google Workspace precisem de acesso a APIs que não são do Google que exigem OAuth, você pode: precisa configurar e se conectar a esse serviço. Consulte a seção Como se conectar ao Guia de serviços que não são do Google para mais detalhes.
Ordem de construção
Ao criar um cartão, você precisa construir a partir 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 após adicioná-lo não são refletidas no cartão final.
Ações universais
Você pode usar ações universais para fornecer funcionalidade independente de contexto. As ações universais são itens de menu disponível na interface do complemento, independentemente do cartão exibidos. Todas as ações universais definidas sempre aparecem no no menu do card do complemento.
Consulte Ações universais para saber mais detalhes.
Verifique 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 deve ter para 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 o complemento usa o complemento manifesto.
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 instalado e autorizado, você poderá usar o complemento na sua conta e testar sua aparência e seu comportamento nos aplicativos hospedeiros se 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
Quando você publica um complemento, ele fica disponível para outras pessoas, seja publicamente ou apenas usuários em seu domínio. Antes de iniciar a publicação consulte a visão geral da publicação. A publicação é um processo complexo que exige preparação e tempo para conclusão.
Os complementos do Google Workspace foram 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 Como publicar complemento do Google Workspace para mais detalhes.