O Google usa tecnologia de IA na tradução de conteúdos para seu idioma de preferência. As traduções com IA podem ter erros.

Criar complementos do Google Workspace

Saiba como criar, desenvolver e publicar complementos do Google Workspace:

Determine os aplicativos do Google Workspace em que você quer que seu complemento esteja disponível para os usuários.
Configure os projetos do complemento e escolha um proprietário e colaboradores.
Projete e configure a aparência e o comportamento do complemento.
Crie o complemento.
Verifique os escopos do OAuth do complemento.
Teste o complemento em um ou mais aplicativos do Google Workspace.
Publique o complemento.

Crie um complemento com o Apps Script ou HTTP. Para comparar os dois, assista ao vídeo "Apps Script vs. endpoints HTTP: qual escolher?" 🤔".

Escolher aplicativos hospedados do Google Workspace

É possível configurar os complementos do Google Workspace para aparecer nos seguintes aplicativos host do Google Workspace:

Gmail
Google Agenda
Google Chat
Google Docs
Google Drive
Google Meet
Google Planilhas
Google Slides

Para criar aplicativos do Google Workspace, consulte Estender a interface do Google Workspace.

Configurar os projetos do complemento e escolher um proprietário e colaboradores

Se você criar seu complemento no Apps Script, vai criar um projeto do Apps Script e um projeto do Google Cloud. Se você criar o complemento em uma linguagem diferente do Apps Script, só será necessário criar um projeto do Google Cloud.

Para criar um complemento, é necessário configurar um projeto de script e um projeto na nuvem.

Antes de começar o desenvolvimento de complementos, escolha uma única conta de usuário para possuir os projetos e decidir quais outras contas são colaboradores. O proprietário dos projetos cria e gerencia os arquivos do projeto e as configurações associadas, enquanto os colaboradores podem ajudar na programação e nos testes.

Projetos do Apps Script

Antes de criar o complemento, consulte as cotas e limitações do Apps Script para alinhar o design do projeto a essas diretrizes. O Apps Script é ideal para desenvolvimento leve de complementos pessoais ou internos com uma pequena base de usuários. Se o complemento exigir suporte para muitos usuários, baixa latência ou controle total sobre sua infraestrutura, considere um tempo de execução diferente.

Crie os arquivos do projeto do Google 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 todos os colaboradores tenham acesso ao projeto de script.

Quando você publica um complemento, uma única conta de usuário é o editor. A conta de publicação precisa ter acesso de edição ao projeto de script, mas não precisa ser a proprietária.

Para criar um projeto do Apps Script, consulte Projetos de script.

Projetos do Google Cloud

Adicione colaboradores ao projeto na nuvem do complemento. Isso garante que sua equipe sempre possa acessar as configurações do complemento no Cloud.

Para criar um projeto do Google Cloud, consulte Criar um projeto do Google Cloud.

Projetar e configurar a aparência e o comportamento do complemento

Decida a aparência e o comportamento do complemento antes de criá-lo. Considere quais casos de uso o complemento resolve. Comece com um design básico para começar a trabalhar e depois adicione refinamentos.

Consulte o guia de estilo de complementos do Google Workspace para saber como criar a experiência do usuário do complemento.

Configurar o manifesto do complemento

Implemente o design no manifesto do complemento. Configure a aparência e o comportamento do complemento no manifesto, incluindo os aplicativos host do Google Workspace que ele estende.

Para mais detalhes, consulte Manifestos para complementos do Google Workspace.

À medida que você adiciona código e recursos, atualize o manifesto conforme necessário para definir a aparência e o comportamento obrigatórios do complemento.

Configurar a aparência e o comportamento do app Google Chat

Se você criar um complemento que estenda o Google Chat, use a API Google Chat para configurar a aparência e o comportamento de um app do Chat. Para conferir as etapas, consulte Usar a API Google Chat.

Criar o complemento

Implemente uma interface baseada em cards para o complemento. Use o serviço de card ou, se você usar outra linguagem de programação, retorne JSON formatado para que a interface seja renderizada como cards.

Implemente as funções de acionamento especificadas no manifesto do complemento. Se o complemento se conectar a um serviço de terceiros usando o OAuth, configure o OAuth para esse serviço.

Cards de construção

Defina uma interface do usuário de complemento criando objetos Card e adicionando widgets. As funções de acionamento especificadas no manifesto precisam retornar um único objeto Card ou uma matriz de objetos Card que representam diferentes "páginas" da interface do complemento. O complemento também pode criar e mostrar novos cards em resposta às ações do usuário.

No Apps Script, crie cards usando a classe CardBuilder. Cada card requer um CardHeader e um ou mais CardSections. Preencha cada seção do card com os widgets individuais que compõem a interface. Os widgets de interação geralmente são vinculados a ações para definir o comportamento de interação deles.

Depois de adicionar todas as seções e widgets ao card usando o CardBuilder, chame CardBuilder.build para criar o objeto Card correspondente.

Use os serviços integrados do Apps Script](/apps-script/guides/services/), como CalendarApp, para recuperar informações e mostrar nos cards do complemento. Usar dados de serviços que não são do Google.

Se o complemento precisar de acesso a APIs que não são do Google e que exigem OAuth, configure e conecte-se a esse serviço. Consulte o guia de conexão a serviços que não são do Google.

Ordem de construção

Ao criar um card, comece de cima para baixo. Use esta ordem de construção:

Crie o widget.
Adicione o widget à seção de cards.
Repita até que a seção de cards tenha todos os widgets.
Adicione a seção de card ao card.

Isso acontece porque, ao adicionar um widget a um card ou seção de card, você está adicionando uma cópia desse widget. As mudanças feitas no objeto de widget depois de adicionado não são refletidas no card final.

Ações universais

Use ações universais para oferecer funcionalidade independente de contexto. As ações universais são itens de menu disponíveis na interface do complemento, independente do card. Todas as ações universais definidas aparecem no menu de card do complemento.

Consulte Ações universais para mais detalhes.

Verificar os escopos do OAuth do complemento

Os escopos definem as ações que o complemento pode realizar em nome de um usuário. Os complementos só podem ter os escopos necessários para funcionar.

Em projetos de complementos, defina os escopos do complemento para garantir que ele use o conjunto de escopos menos permissivo possível. Defina os escopos no manifesto do complemento.

Consulte Escopos para mais detalhes.

Testar o complemento

Para testar complementos não publicados, primeiro instale o complemento não publicado. Depois de instalado e autorizado, use o complemento na sua conta para testar a aparência e o comportamento dele nos aplicativos hospedados que ele estende. Verifique se o complemento se comporta conforme o esperado em contextos e ações do usuário.

Para começar a testar seu complemento, consulte os seguintes guias:

Publicar o complemento

A publicação disponibiliza seu complemento para outras pessoas. Antes de publicar, revise a visão geral da publicação. A publicação é um processo complexo que exige preparação.

Os complementos do Google Workspace são publicados no Google Workspace Marketplace. Os complementos disponíveis publicamente precisam passar por uma revisão de app antes de serem publicados.

Consulte Publicar um complemento do Google Workspace para mais detalhes.