Se você já tiver criado e publicado um complemento para estender o Gmail ou o Google Agenda, poderá fazer upgrade para um complemento do Google Workspace. As instruções desta página detalham como adicionar a funcionalidade do Google Workspace aos seus complementos atuais do Gmail ou do Google Agenda e publicar o complemento atualizado para que ele possa ser encontrado e instalado.
É possível transferir a nova funcionalidade para o complemento original para manter as informações do produto, 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: copiar o projeto do Apps Script do complemento
Seu complemento atualizado usa o mesmo projeto do Google Cloud que seu 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. O upgrade de uma cópia do projeto de script original também significa que você pode acessar o código original e implantá-lo mais tarde se necessário.
- Abra o projeto do complemento do Gmail ou de videoconferência do Google Agenda no projeto do 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 projeto do complemento do Apps Script publicado.
- Clique em Definir projeto.
Etapa 2: integrar os recursos dos complementos do Google Workspace
Você precisa criar e implementar os recursos do complemento do Google Workspace que quer adicionar ao complemento.
- Planeje o conteúdo que será exibido nos cards da página inicial do complemento e se ele vai aparecer no Gmail, no 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 pode ser a mesma página inicial ou se quer cards personalizados para cada host.
- No projeto copiado do Apps Script, crie seus cards da página inicial com as funções
homepageTrigger. Inclua todas as funções ou lógicas de suporte necessárias para controlar as novas interfaces da sua página inicial. Considere adicionar cards contextuais acionados pela ação de um usuário, como abrir uma conversa de mensagens do Gmail ou um evento da agenda.
Atualize qualquer acesso de objetos de evento no seu complemento (em funções de callback de widget ou em funções de acionamento contextuais) para usar a estrutura de objeto de evento atualizada. A nova estrutura ainda contém os mesmos campos de objeto de eventos usados pelos complementos de videoconferência do Gmail e do Agenda, mas esses campos originais estão obsoletos e serão removidos.
Etapa 3: atualizar o manifesto do complemento
A maneira 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 usada pelos complementos do Gmail
e de videoconferência do Agenda. Conforme você atualiza o complemento, precisa atualizar os campos do manifesto do projeto do Apps Script de acordo com as tabelas abaixo. Você precisa atualizar todas as subpropriedades relevantes para a nova propriedade
addOns.
Também atualize 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 de publicar, consulte Como testar complementos do Google Workspace.
Etapa 5: solicitar avaliações do complemento atualizado
Todos os complementos do Google Workspace, sejam eles um upgrade ou uma versão criada do zero, precisam ser aprovados antes de serem listados no Google Workspace Marketplace.
Siga estas etapas para enviar seu complemento para revisão:
Verifique se o complemento atende a todos os requisitos de publicação de complementos.
Crie uma implantação com controle de versões do 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 do Agenda na versão dos complementos do Google Workspace, vai ser preciso enviar esses novos escopos para verificação. Geralmente, a verificação leva alguns dias para ser concluída. Portanto, comece o processo o quanto antes. Verifique 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 para você fornecer informações sobre o complemento.
Atualize a descrição breve, a descrição 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, digite 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, 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 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 esse processo de upgrade do complemento do Google Workspace, fale conosco.
Perguntas frequentes
Veja a seguir perguntas frequentes sobre upgrades de complementos:
Posso fazer upgrade do meu complemento do Editor?
A maioria dos complementos do editor pode ser movida para os complementos do Google Workspace. No entanto, não é possível fazer upgrade para os complementos do Google Workspace com a mesma facilidade que eles usam no Gmail e no Agenda.
Se você quiser migrar o complemento do editor para um complemento do Google Workspace, vai precisar reescrever a IU do complemento em HTML para uma interface baseada em cartão e atualizar o processamento do JavaScript para o serviço de cartão.
Alguns serviços do seu Complemento de editor pode não estar disponível no serviço de cartão. Por exemplo, se o complemento Editor incluir um seletor de arquivos, não haverá um equivalente disponível do serviço de cards para os complementos do Google Workspace.
Posso criar um complemento separado do Google Workspace e manter o atual?
Você pode criar outros complementos do Google Workspace com nomes de marcas diferentes, mas não permitimos complementos de videoconferência do Gmail ou do Google Agenda com o mesmo nome da marca dos complementos do Google Workspace. Se você tiver dúvidas ou quiser solicitar uma exceção, entre em contato.
Meus usuários vão precisar autorizar novamente o complemento depois que ele for atualizado?
Desde que seu complemento do Google Workspace use o mesmo projeto subjacente do Cloud Platform (GCP), com um ID do cliente OAuth associado, os 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, os usuários precisarão autorizar esses novos escopos na primeira vez que usarem a versão do Google Workspace do complemento.
Posso fazer upgrade da minha extensão do Chrome para um complemento do Google Workspace e transferir os usuários?
Não é possível transferir as avaliações de usuários, instalações e listagens de uma extensão do Chrome. Você precisa 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.