Se você já criou e publicou um complemento para estender o Gmail ou o Google Agenda, é possível fazer upgrade dele 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 Agenda e publicar seu complemento atualizado para que ele possa ser descoberto e instalado.
É possível transferir a nova funcionalidade para o complemento original para manter a ficha da empresa, as instalações e os usuários do Google Workspace Marketplace. O upgrade também permite que você aproveite os novos recursos de complemento do Google Workspace, como as páginas iniciais.
Etapa 1: fazer uma cópia do projeto do Apps Script do seu complemento
Seu 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 enquanto você estiver testando a versão atualizada. Fazer upgrade de uma cópia do projeto de 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ência do Google Agenda.
- À esquerda, clique em Visão geral .
- À direita, clique em Fazer uma cópia .
- À esquerda, clique em Project Settings > Change project.
- Clique em Número do projeto do GCP.
- Insira o mesmo número de projeto associado ao seu projeto de complemento publicado do Apps Script.
- Clique em Configurar projeto.
Etapa 2: integrar o complemento do Google Workspace
Projete e implemente os recursos do complemento do Google Workspace que você quiser adicionar a ele.
- Planeje o conteúdo que será exibido nos cards da página inicial do complemento e se ele aparecerá no Gmail, Agenda, 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 página inicial ou se você quer cards de página inicial personalizados para cada host.
- No projeto copiado do Apps Script, crie os 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 página inicial. Considere adicionar cards contextuais acionados por uma ação do usuário, como abrir uma conversa de mensagens do Gmail ou evento da agenda.
Atualize qualquer acesso de objetos de evento no seu complemento (em funções de callback do widget ou em funções de acionador contexto) para usar a estrutura do 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 Google 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 usada pelos complementos do Gmail
e pelos complementos de videoconferência do Agenda. Ao fazer upgrade do complemento, você precisa atualizar os campos do manifesto do projeto do Apps Script do complemento, de acordo com as tabelas abaixo. É preciso 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 Google 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 seu 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 seu 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 complemento do Google Workspace (no novo projeto do Apps Script) com 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, será necessário solicitar a verificação do OAuth. Por exemplo, se o complemento do Gmail usar novos escopos do Drive ou do 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. 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ê 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 seu complemento do Google Workspace, adicione-os à seção Escopos do OAuth 2.0 na página Configuração. Os escopos listados nessa seção precisam corresponder exatamente aos 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 do complemento do Google Workspace, entre em contato.
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 os complementos do Google Workspace tão facilmente quanto os complementos do Gmail e do Agenda.
Se você quiser migrar seu complemento do Editor para um do Google Workspace, reescreva a IU do complemento de HTML para uma interface baseada em cards e atualize o processamento do JavaScript para o Serviço de cartões.
Alguns serviços no seu complemento do 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 há um equivalente disponível no serviço de cartão para complementos do Google Workspace.
Posso criar um complemento do Google Workspace separado e manter meu complemento atual?
É possível criar outros complementos do Google Workspace com diferentes nomes de marca, mas não são permitidos complementos para videoconferências do Gmail ou do Google Agenda com o mesmo nome do complemento do Google Workspace. Se você tiver dúvidas ou quiser solicitar uma exceção, entre em contato.
Meus usuários precisarão autorizar novamente o complemento após o upgrade?
Se o complemento do Google Workspace usar o mesmo projeto do Cloud Platform (GCP) com um ID do cliente OAuth associado, os usuários não vão precisar autorizar novamente as permissões já autorizadas para o complemento original. No entanto, se você adicionar novos escopos durante o processo de upgrade, seus usuários precisarão autorizá-los 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 usuários?
Não. Não é possível transferir usuários, instalações e avaliações de detalhes 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 do Google Workspace?
Consulte Listar integrações de apps em conjunto.