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 nesta página detalham como adicionar a funcionalidade do Google Workspace aos seus complementos atuais do Gmail ou da Agenda e publicar o complemento atualizado para que ele possa ser descoberto e instalado.
Você pode transferir a nova funcionalidade para seu complemento original e manter a listagem, as instalações e os usuários do Google Workspace Marketplace. Ao fazer upgrade, você também pode aproveitar os novos recursos de complementos 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 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 enquanto você testa a versão atualizada. Ao fazer upgrade de uma cópia do projeto de script original, você sempre pode acessar o código original e reimplantá-lo depois, se necessário.
- Abra seu projeto do Apps Script de um complemento do Gmail ou do complemento para videoconferências do Google 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 do projeto associado ao projeto do Apps Script do complemento publicado.
- Clique em Configurar projeto.
Etapa 2: integrar o complemento do Google Workspace
Você precisa projetar e implementar todos 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 complemento e se eles vão aparecer no Gmail, na 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 copiado do complemento do Apps Script, 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 conversa 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 acionamento 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 conferência do Gmail e do Google Agenda, mas esses campos originais estão 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 usada pelos complementos do Gmail
e de videoconferência do Google Agenda. Ao fazer upgrade do complemento, é necessário atualizar os campos de manifesto do projeto do Apps Script de acordo com as tabelas abaixo. Atualize todas as subpropriedades relevantes para a nova propriedade addOns.
Não se esqueça de atualizar o campo oauthScopes do manifesto conforme necessário para refletir as permissões exigidas pelo complemento atualizado.
Para saber mais sobre manifestos de complementos do Google Workspace, consulte Manifestos.
Complementos do Gmail
| Campo do manifesto original | Ação necessária |
|---|---|
gmail.composeTrigger |
Mova para addOns.gmail.composeTrigger. |
gmail.contextualTriggers[] |
Mova a lista para addOns.gmail.contextualTriggers[]. |
gmail.logoUrl |
Mova para addOns.common.logoUrl. |
gmail.name |
Mova para addOns.common.name. |
gmail.openLinkUrlPrefixes[] |
Mova a lista para addOns.common.openLinkUrlPrefixes[].
|
gmail.primaryColor |
Mova para addOns.common.layoutProperties.primaryColor. |
gmail.secondaryColor |
Mova 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 |
Mova para addOns.common.useLocaleFromApp. |
Complementos de conferência da Agenda
| Campo do manifesto original | Ação necessária |
|---|---|
calendar.createSettingsUrlFunction |
Mova para addOns.calendar.createSettingsUrlFunction. |
calendar.conferenceSolution[] |
Mova para addOns.calendar.conferenceSolution[]. |
calendar.logoUrl |
Mova para addOns.common.logoUrl. |
calendar.name |
Mova 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: pedir 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 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) 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, é 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, você precisará enviar esses novos escopos para verificação. A verificação geralmente leva alguns dias para ser concluída. Por isso, comece o processo o mais rápido possível. 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 em que você fornece informações sobre seu complemento.
Atualize a descrição curta, a descrição detalhada e as capturas de tela da página "Detalhes do app" 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 criado para seu complemento do Google Workspace na etapa anterior. Se o ID de implantação for válido, uma lista de hosts compatíveis 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 nessa 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, entre em contato.
Perguntas frequentes
Confira a seguir algumas perguntas frequentes sobre upgrades de complementos:
Posso fazer upgrade do complemento Editor?
A maioria dos complementos do Editor pode ser transferida para os complementos do 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 cards e atualizar o processamento do JavaScript para o Card Service.
Alguns serviços do seu complemento do Editor talvez não estejam 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 serviço de card para complementos do Google Workspace.
Posso criar um complemento separado do Google Workspace e manter meu complemento atual?
Você pode criar outros complementos do Google Workspace com nomes de marcas diferentes, mas não é permitido ter complementos separados de conferência do Gmail ou da Agenda com o mesmo nome de marca do seu complemento do Google Workspace. Se você tiver dúvidas ou quiser pedir uma exceção, entre em contato.
Meus usuários vão precisar autorizar o complemento de novo depois que ele for atualizado?
Desde que seu complemento do Google Workspace use o mesmo projeto do Cloud Platform (GCP) com um ID de cliente OAuth associado, os usuários não precisarão autorizar novamente as permissões que já tinham concedido ao 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 usuários?
Não. Não é possível transferir usuários, instalações e avaliações da página de detalhes 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.