Se você já criou e publicou um complemento para estender o Gmail ou a Agenda, pode fazer upgrade para um complemento do Google Workspace. As instruções nesta página detalham como adicionar a funcionalidade do Google Workspace aos complementos do Gmail ou Agenda e publicar o complemento atualizado para que ele possa ser descoberto e instalado.
Você pode transferir a nova funcionalidade para o complemento original se quiser manter a ficha, as instalações e os usuários do Google Workspace Marketplace. O upgrade também permite que você aproveite os novos recursos do complemento do Google Workspace, como as páginas iniciais.
Etapa 1: fazer uma cópia do projeto do Apps Script do seu complemento
O complemento atualizado usa o mesmo projeto do Google Cloud que o complemento publicado, mas é importante criar e usar uma cópia do projeto subjacente do Apps Script para que os usuários atuais não sejam afetados durante o teste da versão atualizada. Fazer upgrade de uma cópia do projeto de script original também significa que você sempre poderá acessar o código original e reimplantá-lo mais tarde, se necessário.
- Abra o complemento do Gmail ou o projeto de complemento de videoconferência do Google Agenda que você já criou no Apps Script.
- À esquerda, clique em Visão geral .
- À direita, clique em Fazer uma cópia .
- À esquerda, clique em Configurações do projeto > Alterar projeto.
- Clique em Número do projeto do GCP.
- Insira o mesmo número de projeto associado ao seu projeto de complemento publicado no Apps Script.
- Clique em Configurar projeto.
Etapa 2: integrar o complemento do Google Workspace
É necessário projetar e implementar os recursos do Complemento do Google Workspace que você quer incluir no complemento.
- Planeje qual conteúdo será exibido nos cards da página inicial do complemento e se eles devem aparecer no Gmail, Agenda, Drive ou em qualquer combinação dos três hosts. Caso queira uma página inicial em mais de um host, decida se ela pode ser a mesma página inicial ou se você quer cards personalizados para cada host.
- No projeto de complemento copiado do Apps Script, crie os cards da página inicial com as funções
homepageTrigger. Inclua todas as funções de suporte ou lógicas necessárias para controlar as novas interfaces da página inicial. Adicione cards de contexto acionados pela ação de um usuário, como abrir uma conversa de mensagens do Gmail ou evento da agenda.
Atualize todos os acessos a objetos de evento no seu complemento (em funções de callback de widget ou em funções de acionador contextual) para usar a estrutura de objetos de evento atualizada. A nova estrutura ainda contém os mesmos campos de objeto de evento usados pelos complementos de videoconferência do Gmail e do Agenda, mas os campos originais foram descontinuados e serão removidos.
Etapa 3: atualizar o manifesto do complemento
A forma como as informações de configuração são armazenadas na
estrutura do manifesto dos
complementos do Google Workspace mudou consideravelmente em relação à estrutura dos complementos do Gmail
e de videoconferência do Agenda. Ao fazer upgrade do complemento, você precisa atualizar os campos do manifesto do projeto do Apps Script de acordo com as tabelas abaixo. É necessário atualizar todas as subpropriedades relevantes para a nova propriedade addOns.
Atualize também o campo
oauthScopes do manifesto conforme
necessário para refletir as permissões exigidas pelo complemento atualizado.
Para saber mais sobre os manifestos de complementos do Google Workspace, consulte Manifestos.
Complementos do Gmail
| Campo do manifesto original | Ação necessária |
|---|---|
gmail.composeTrigger |
Mover para addOns.gmail.composeTrigger. |
gmail.contextualTriggers[] |
Mova a lista para addOns.gmail.contextualTriggers[]. |
gmail.logoUrl |
Mover para addOns.common.logoUrl. |
gmail.name |
Mover para addOns.common.name. |
gmail.openLinkUrlPrefixes[] |
Mova a lista para addOns.common.openLinkUrlPrefixes[].
|
gmail.primaryColor |
Mover para addOns.common.layoutProperties.primaryColor. |
gmail.secondaryColor |
Mover para addOns.common.layoutProperties.secondaryColor.
|
gmail.universalActions[] |
Mova a lista para addOns.common.universalActions[]. |
gmail.universalActions[].text |
Mova cada campo gmail.universalActions[].text para um campo addOns.common.universalActions[].label correspondente. |
gmail.useLocalFromApp |
Mover para addOns.common.useLocaleFromApp. |
Complementos de videoconferência do Agenda
| Campo do manifesto original | Ação necessária |
|---|---|
calendar.createSettingsUrlFunction |
Mover para addOns.calendar.createSettingsUrlFunction. |
calendar.conferenceSolution[] |
Mover para addOns.calendar.conferenceSolution[]. |
calendar.logoUrl |
Mover para addOns.common.logoUrl. |
calendar.name |
Mover para addOns.common.name. |
Etapa 4: testar o complemento atualizado
Para testar o complemento atualizado antes da publicação, consulte Como testar complementos do Google Workspace.
Etapa 5: solicitar análises do complemento atualizado
Todos os complementos do Google Workspace, sejam eles atualizados ou criados do zero, precisam ser aprovados antes de serem listados no Google Workspace Marketplace.
Siga estas etapas para enviar o complemento para análise:
Verifique se o complemento atende a todos os requisitos de publicação de complementos.
Crie uma implantação com controle de versão do seu complemento do Google Workspace (no novo projeto do Apps Script) usando a versão do código que você quer publicar. Não tente publicar usando uma implantação principal.
Se você adicionou novos escopos ao fazer upgrade do complemento, solicite a verificação do OAuth. Por exemplo, se o complemento do Gmail usar novos escopos do Drive ou Agenda na versão do complemento do Google Workspace, você precisará enviar esses novos escopos para verificação. A verificação geralmente leva alguns dias para ser concluída, portanto, inicie o processo o mais cedo possível. Confirme se o complemento foi verificado antes de prosseguir para a Etapa 6.
Etapa 6: disponibilizar o complemento atualizado
Abra o SDK do Google Workspace Marketplace.
À esquerda, clique em Configuração. Esse painel contém um formulário em que você fornece informações sobre o complemento.
Atualize a descrição breve, a detalhada e as capturas de tela da sua ficha para refletir a nova funcionalidade do complemento do Google Workspace.
Em Extensões, clique no botão Fazer upgrade para o complemento do Google Workspace. Na caixa de texto exibida, insira o novo ID de implantação que você criou para o complemento do Google Workspace na etapa anterior. Se o ID de implantação for válido, uma lista de hosts compatíveis será exibida.
Se você adicionou novos escopos ao complemento do Google Workspace, faça isso na seção Escopos do OAuth 2.0 na página Configuração. Os escopos listados nessa seção precisam corresponder exatamente àqueles listados no manifesto do complemento.
Verifique se as informações inseridas no formulário estão corretas. Em seguida, clique em Salvar alterações.
Se você tiver dúvidas ou encontrar um problema durante o processo de upgrade de complementos do Google Workspace, entre em contato com nossa equipe.
Perguntas frequentes
Confira a seguir perguntas frequentes sobre upgrades de complementos:
Posso fazer upgrade do meu Complemento do Editor?
A maioria dos complementos do Editor pode ser migrada para os complementos do Google Workspace. No entanto, não é possível fazer upgrade deles para complementos do Google Workspace tão facilmente quanto os complementos do Gmail e Agenda.
Se você quiser migrar seu complemento do editor para um complemento do Google Workspace, reescreva a interface do complemento de HTML para uma interface baseada em cards e atualize o processamento do JavaScript para o Serviço de card.
Alguns serviços no seu complemento Editor atual podem não estar disponíveis no Card Service. Por exemplo, se o complemento do editor incluir um seletor de arquivos, não haverá um equivalente disponível no Card Service para complementos do Google Workspace.
Posso criar outro complemento do Google Workspace e manter meu atual?
Você pode criar complementos do Google Workspace com outras marcas, mas não são permitidos complementos de videoconferência do Gmail ou do Agenda separados com a mesma marca do Complemento do Google Workspace. Se você tiver dúvidas ou quiser solicitar uma exceção, entre em contato conosco.
Meus usuários precisarão autorizar o complemento novamente após o upgrade?
Contanto que seu complemento do Google Workspace use o mesmo projeto subjacente do Cloud Platform (GCP) com um ID do cliente OAuth associado, seus usuários não precisarão autorizar novamente as permissões autorizadas para o complemento original. No entanto, se você adicionar novos escopos durante o processo de upgrade, seus usuários precisarão autorizar esses novos escopos na primeira vez que usarem a versão do Google Workspace do seu complemento.
Posso fazer upgrade da minha extensão do Chrome para um complemento do Google Workspace e transferir usuários?
Não é possível transferir usuários, instalações e avaliações das fichas de empresas do Chrome. É necessário criar um novo complemento do Google Workspace e direcionar os usuários da extensão do Chrome para o Google Workspace Marketplace.
Posso agrupar vários complementos com meu complemento do Google Workspace?
Consulte Listar integrações de apps.