Como fazer upgrade dos complementos publicados

Mantenha tudo organizado com as coleções Salve e categorize o conteúdo com base nas suas preferências.

Se você já tiver criado e publicado um complemento para estender o Gmail ou o Agenda, poderá fazer upgrade dele para um complemento Google Workspace . As instruções desta página detalham como adicionar funcionalidades Google Workspace aos complementos atuais do Gmail ou do Agenda e publicar o complemento atualizado para que ele possa ser descoberto e instalado.

Você pode transferir a nova funcionalidade para o complemento original para manter a Google Workspace listagem do Marketplace, instalações e usuários. O upgrade também permite que você aproveite os novos Google Workspace recursos complementares, como as páginas iniciais.

Etapa 1: fazer uma cópia do projeto do Apps Script do complemento

O complemento com upgrade usa o mesmo projeto do Google Cloud que o complemento publicado, mas é importante criar e usar uma cópia do projeto 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ê sempre poderá acessar o código original e reimplantá-lo mais tarde, se necessário.

  1. Abra seu projeto dos complementos do Gmail ou dos complementos do Agenda para o Google Apps Script.
  2. À esquerda, clique em Overview .
  3. À direita, clique em Fazer uma cópia .
  4. À esquerda, clique em Configurações do projeto > Alterar projeto.
  5. Clique em Número do projeto do GCP.
  6. Digite o mesmo número do projeto associado ao seu projeto atual do complemento do Apps Script.
  7. Clique em Definir projeto.

Etapa 2: integrar Google Workspace os recursos complementares

Você precisa projetar e implementar qualquer Google Workspace recurso de complemento que queira adicionar ao seu complemento.

  1. Planeje o conteúdo a ser exibido nos cards da página inicial do complemento e se eles aparecerão 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 ela pode ser a mesma página inicial ou se quer cards personalizados para cada host.
  2. No projeto do complemento do Apps Script copiado, 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.
  3. Considere adicionar cards contextuais acionados pela ação de um usuário, como abrir uma conversa de mensagens do Gmail ou um evento do Agenda.

  4. Atualize o acesso de objetos de evento no complemento (em funções de callback do widget ou em funções de acionador contextuais) para usar a estrutura de objeto de evento atualizada. A nova estrutura ainda contém os mesmos campos de objetos de eventos 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 do manifesto de Google Workspace Complementos mudou consideravelmente em relação à estrutura usada pelos complementos do Gmail e dos 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 e # de acordo com as tabelas abaixo. Você precisa 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 necessárias para o complemento atualizado.

Para saber mais sobre os Google Workspace manifestos de complementos, consulte Manifestos.

Complementos do Gmail

Campo do manifesto original Ação necessária
gmail.composeTrigger Move para addOns.gmail.composeTrigger.
gmail.contextualTriggers[] Mova a lista para addOns.gmail.contextualTriggers[].
gmail.logoUrl Move para addOns.common.logoUrl.
gmail.name Move para addOns.common.name.
gmail.openLinkUrlPrefixes[] Mova a lista para addOns.common.openLinkUrlPrefixes[].
gmail.primaryColor Move para addOns.common.layoutProperties.primaryColor.
gmail.secondaryColor Move 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 Move para addOns.common.useLocaleFromApp.

Complementos de videoconferência do Agenda

Campo do manifesto original Ação necessária
calendar.createSettingsUrlFunction Move para addOns.calendar.createSettingsUrlFunction.
calendar.conferenceSolution[] Move para addOns.calendar.conferenceSolution[].
calendar.logoUrl Move para addOns.common.logoUrl.
calendar.name Move para addOns.common.name.

Etapa 4: testar o complemento atualizado

Para testar o complemento atualizado antes de publicar, consulte Testar Google Workspace complementos.

Etapa 5: solicitar avaliações do seu complemento atualizado

Todos os complementos Google Workspace , sejam eles atualizados ou desenvolvidos do zero, precisam ser aprovados antes de serem listados no Google Workspace Marketplace.

Siga estas etapas para enviar seu complemento para análise:

  1. Verifique se o complemento atende a todos os requisitos de publicação de complementos.

  2. Crie uma implantação com versão do Google Workspace complemento (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.

  3. Se você adicionou novos escopos ao fazer upgrade do complemento, é necessário solicitar a verificação do OAuth. Por exemplo, se os complementos do Gmail usarem novos escopos do Drive ou do Agenda na Google Workspace versão de complementos, você precisará enviar esses novos escopos para verificação. Geralmente, a verificação leva alguns dias para ser concluída. Portanto, inicie o processo o quanto antes. Verifique se o complemento foi verificado antes de prosseguir para a Etapa 6.

Etapa 6: disponibilizar o complemento atualizado

  1. Abra o Google Workspace SDK do Marketplace.

  2. À esquerda, clique em Configuração. Esse painel contém um formulário em que você fornece informações sobre o complemento.

  3. Atualize a descrição breve, a descrição detalhada e as capturas de tela da sua lista para refletir a nova funcionalidade do complemento Google Workspace .

  4. Em Extensões, clique no botão Fazer upgrade para Google Workspace complemento. Na caixa de texto exibida, insira o novo ID de implantação que você criou para o complemento Google Workspace na etapa anterior. Se o ID de implantação for válido, uma lista de hosts compatíveis será exibida.

  5. Se você adicionou novos escopos ao Google Workspace Complemento, adicione-os à seção Escopos do OAuth 2.0 na página Configuração. Os escopos listados nessa seção precisam corresponder exatamente aos escopos listados no manifesto dos complementos.

  6. 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 Google Workspace de upgrade dos complementos, entre em contato conosco.

Perguntas frequentes

Veja a seguir perguntas frequentes sobre upgrades de complementos:

Posso fazer upgrade do meu complemento Editor?

A maioria dos complementos do editor pode ser movida para Google Workspace Complementos. No entanto, eles não podem ser atualizados para Google Workspace Complementos com a mesma facilidade que os complementos do Gmail e do Agenda.

Se quiser migrar o complemento do editor para um Google Workspace complemento Google Workspace , você precisará reescrever a IU dos complementos do HTML para uma interface baseada em cartões e atualizar o processamento de JavaScript para o serviço de cartões.

Alguns serviços do complemento atual 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 arquivo, não haverá um equivalente disponível do serviço de cartões para Google Workspace complementos.

Posso criar outro complemento Google Workspace e manter meus complementos atuais?

Você pode criar outros Google Workspace Complementos de nomes de marca diferentes, mas não permitimos complementos de videoconferência do Gmail ou do Agenda separados com o mesmo nome de marca que seu Complemento Google Workspace . Se tiver dúvidas ou quiser solicitar uma exceção, entre em contato com a nossa equipe.

Meus usuários precisarão autorizar novamente o complemento após o upgrade?

Desde que seu Google Workspace Complemento use o mesmo projeto subjacente do Cloud Platform (GCP), com um ID do cliente OAuth associado, seus usuários não precisarão reautorizar as permissões que já tinham autorizado 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 Google Workspace do complemento.

Posso fazer upgrade da minha extensão do Chrome para um Google Workspace Complemento e transferir usuários?

Não. Não é possível transferir avaliações, instalações e usuários de uma extensão do Chrome. Você precisa criar um novo Google Workspace Complemento e direcionar os usuários da extensão do Chrome para o Google Workspace Marketplace.

Posso agrupar vários complementos com meu Google Workspace Complemento?

Consulte Listar integrações de apps.