Se você já criou e publicou um complemento para estender o Gmail ou o Google Agenda, é possível fazer upgrade para um complemento do Google Workspace. As instruções nesta página detalham como adicionar a funcionalidade do Google Workspace aos seus complementos do Gmail ou da Agenda e publicar o complemento atualizado para que ele possa ser descoberto e instalado.
É possível transferir a nova funcionalidade para o complemento original e manter a página de detalhes, as instalações e os usuários do Google Workspace Marketplace. O upgrade também permite aproveitar 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 complemento
O complemento atualizado usa o mesmo projeto do Google Cloud que o publicado, mas é importante criar e usar uma cópia do projeto do Apps Script para que os usuários atuais não sejam afetados enquanto você testa a versão atualizada. O upgrade de uma cópia do projeto do script original também significa que você sempre pode acessar o código original e reimplantá-lo mais tarde, se necessário.
- Abra o projeto do Apps Script do complemento do Gmail ou do complemento de videoconferências do app Agenda.
- À esquerda, clique em Visão geral .
- À direita, clique em Fazer uma cópia .
- À esquerda, clique em Configurações do projeto > Mudar projeto.
- Clique em Número do projeto do GCP.
- Insira o mesmo número de projeto associado ao projeto do Apps Script publicado.
- Clique em Configurar projeto.
Etapa 2: integrar o complemento do Google Workspace
Você precisa projetar e implementar os recursos do complemento do Google Workspace que quer adicionar ao seu complemento.
- Planeje o conteúdo que será mostrado nos cards da página inicial do seu complemento e se eles vão aparecer no Gmail, no Google Agenda, no Drive ou em qualquer combinação dos três hosts. Se você quiser uma página inicial em mais de um host, decida se ela pode ser a mesma ou se você quer cards personalizados para cada host.
- No projeto do Apps Script copiado, crie os cards da página inicial com funções
homepageTrigger. Inclua todas as funções ou lógicas de suporte necessárias para controlar as novas interfaces da página inicial. Considere adicionar cards contextuais acionados por uma ação do usuário, como abrir uma linha de mensagens do Gmail ou um evento da Agenda.
Atualize qualquer acesso a objetos de evento no seu complemento (em funções de callback de widget ou em funções de gatilho contextual) para usar a estrutura de objeto 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 esses 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 de manifesto dos
complementos do Google Workspace mudou consideravelmente em relação à estrutura dos complementos do Gmail
e das conferências da Agenda. Ao fazer upgrade do complemento, atualize os campos do manifesto do projeto do Apps Script de acordo
com as tabelas abaixo. Atualize 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 de 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 conferências da Agenda
| Campo de 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 Testar complementos do Google Workspace.
Etapa 5: solicitar avaliações 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:
Confira se o complemento atende a todos os requisitos de publicação.
Crie uma implantação com 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 durante a atualização do complemento, é necessário solicitar a verificação do OAuth. Por exemplo, se o complemento do Gmail usar novos escopos do Drive ou do Google Agenda na versão do complemento do Google Workspace, será necessário 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. Confira 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ê informa detalhes sobre o complemento.
Atualize a descrição curta, a descrição detalhada e as capturas de tela da sua página 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 que aparece, 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 com suporte vai aparecer.
Se você adicionou novos escopos ao complemento do Google Workspace, adicione-os à seção Escopos do OAuth 2.0 na página Configuração. Os escopos listados nesta seção precisam corresponder exatamente aos escopos listados no manifesto do seu 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 do complemento do Google Workspace, entre em contato com nossa equipe.
Perguntas frequentes
Confira a seguir algumas perguntas frequentes sobre upgrades de complementos:
Posso fazer upgrade do meu complemento do Editor?
A maioria dos complementos do Editor pode ser transferida para o Google Workspace. No entanto, não é possível fazer upgrade para complementos do Google Workspace com a mesma facilidade que os complementos do Gmail e da Agenda.
Se você quiser migrar seu complemento do Editor para um complemento do Google Workspace, será necessário reescrever a interface do complemento de HTML para uma interface baseada em cartão e atualizar o processamento de JavaScript para o serviço de cartão.
Alguns serviços no seu complemento do Editor podem não estar disponíveis no serviço de cartão. Por exemplo, se o complemento do Editor incluir um seletor de arquivos, não haverá um equivalente disponível no serviço de cartão para complementos do Google Workspace.
Posso criar um complemento separado do Google Workspace e manter o complemento atual?
Você pode criar outros complementos do Google Workspace com nomes de marca diferentes, mas não permitimos complementos de videoconferência do Gmail ou da Agenda com o mesmo nome de marca que o complemento do Google Workspace. Se você tiver dúvidas ou quiser solicitar uma exceção, entre em contato.
Os usuários vão precisar autorizar o complemento novamente após o upgrade?
Se o complemento do Google Workspace usar o mesmo projeto do Google Cloud Platform (GCP), com um ID do cliente OAuth associado, os usuários não precisarão renovar as permissões que já foram autorizadas para o complemento original. No entanto, se você adicionar novos escopos durante o processo de upgrade, os usuários precisarão autorizar esses novos escopos na primeira vez que usarem a versão do Google Workspace do seu complemento.
Posso atualizar minha extensão do Chrome para um complemento do Google Workspace e transferir usuários?
Não. Não é possível transferir os usuários, as instalações e as avaliações da listagem de uma extensão do Chrome. Você precisa criar um novo complemento do Google Workspace e direcionar os usuários da sua 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 em conjunto.