Se você já criou e publicou um complemento para estender o Gmail ou o Google Agenda, você pode para um complemento do Google Workspace. As instruções nesta página detalham como para adicionar a funcionalidade do Google Workspace aos complementos do Gmail ou Agenda e em seguida, publique o complemento atualizado para que ele possa ser descoberto e instalado.
Você pode transferir a nova funcionalidade para seu para reter a ficha, as instalações e os usuários do Google Workspace Marketplace. Com o upgrade, você também pode aproveitar os novos recursos do complemento do Google Workspace como páginas iniciais.
Etapa 1: fazer uma cópia do projeto do Apps Script do seu complemento
O complemento atualizado usa o mesmo projeto do Google Cloud que o publicado do Google, mas é importante criar e usar uma cópia do aplicativo Projeto de script para que os usuários atuais não sejam afetados durante o teste 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 pode reimplantá-lo depois se necessários.
- Abra o complemento do Gmail ou de videoconferência do Google Agenda que você já tem usando o Apps Script. projeto.
- À 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 do projeto associados ao seu projeto de complemento publicado que já está no Google 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 quiser incluir seu complemento.
- Planeje o conteúdo a ser exibido nos complementos cards da página inicial e se eles devem aparecer no Gmail, Agenda, Drive ou em qualquer combinação dos três host. 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ê quiser cards personalizados para cada página inicial.
- No projeto de complemento copiado do Apps Script, crie sua página inicial
cards com
homepageTrigger. Inclua todas as funções de suporte ou lógicas necessárias para controlar as novas interfaces da página inicial. Considere adicionar cards de contexto acionados pela ação de um usuário, como abrir uma Agrupamento de mensagens do Gmail ou Evento da agenda.
Atualizar qualquer acesso de objetos de evento no complemento (nas funções de callback do widget ou no gatilho contextual ) para usar a função estrutura de objetos de evento. A nova estrutura ainda contém os mesmos campos de objeto de evento usados pelo do Gmail e do Google Agenda, mas os campos originais descontinuada e será removida.
Etapa 3: atualizar o manifesto do complemento
A forma como as informações de configuração são armazenadas no
estrutura do manifesto de
Os complementos do Google Workspace mudaram muito em relação à estrutura dos complementos do Gmail
e complementos de videoconferência do Google Agenda. Ao fazer upgrade do complemento, você precisa atualizar os campos do manifesto do projeto do Apps Script de acordo com
nas tabelas abaixo. É necessário atualizar todas as subpropriedades relevantes para a nova
propriedade addOns.
Atualize também o arquivo
oauthScopes como
necessárias 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 uma
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 da publicação, faça o seguinte: consulte Testar complementos do Google Workspace.
Etapa 5: solicitar 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 o complemento para análise:
Verifique se o complemento atende a todos os requisitos requisitos de publicação de complementos.
Criar uma implantação com controle de versão do complemento do Google Workspace (no novo projeto do Apps Script) usando a versão do o código que você quer publicar. Não tente publicar usando um cabeçalho implantação do Google Workspace.
Se você adicionou novos escopos ao fazer upgrade do complemento, será necessário solicite a verificação do OAuth. Por exemplo, se o complemento do Gmail usar os novos escopos do Drive ou Agenda na do complemento do Google Workspace, será preciso enviar esses novos escopos para verificação. A verificação geralmente leva alguns dias para ser concluída, então inicie o processo o o mais cedo possível. Verifique se o complemento foi verificado antes de continuar à 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 que você fornecer informações sobre o complemento.
Atualize a descrição breve, a detalhada e as capturas de tela do listagem para refletir a nova funcionalidade do complemento do Google Workspace.
Em Extensões, clique no botão Fazer upgrade para Botão "Complemento do Google Workspace". Na caixa de texto exibida, digite o novo ID de implantação criado para o complemento do Google Workspace na etapa anterior. Se o ID de implantação for válido, uma uma lista de hosts compatíveis será exibida.
Se você adicionou novos escopos ao Complemento do Google Workspace, adicione-os ao seção de escopos OAuth 2.0 na página Configuração. Os escopos listados nessa seção devem corresponder exatamente aos escopos listados manifesto do aplicativo.
Verifique se as informações inseridas no formulário estão corretas. Depois, Clique em Salvar alterações.
Se você tiver dúvidas ou encontrar um problema durante o upgrade do complemento do Google Workspace desse processo, 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 podem ser fez upgrade para os Complementos do Google Workspace tão facilmente quanto para os complementos do Gmail e Agenda.
Se você quiser migrar seu Complemento do Editor para um Complemento do Google Workspace, será necessário: reescrever a interface do complemento do HTML para um tipo de cartão interface e atualize a versão para o Serviço de cartão.
Alguns serviços no seu Complemento atual do Editor podem não estar disponíveis no Serviço de cartão. Por exemplo, se o Complemento do Editor inclui um seletor de arquivos, não é um equivalente disponível nos complementos do serviço do cartão para Google Workspace.
Posso criar outro complemento do Google Workspace e manter meu atual?
Você pode criar outros complementos do Google Workspace com várias marcas, mas não são permitidos complementos de videoconferência do Gmail ou do Google Agenda separados na mesmo nome da marca do seu complemento do Google Workspace. Se você tiver dúvidas ou quiser solicitar uma exceção, entre em contato.
Meus usuários precisarão autorizar o complemento novamente após o upgrade?
Contanto que seu Complemento do Google Workspace use a mesma Projeto do Cloud Platform (GCP), com um ID do cliente OAuth associado, os usuários não precisarão autorizar novamente permissões concedidas anteriormente para o complemento original. No entanto, se adicionar novos escopos durante o processo de upgrade, seus usuários deverão autorizá-los novos escopos na primeira vez que usam do seu complemento.
Posso fazer upgrade da minha extensão do Chrome para um complemento do Google Workspace e transferir usuários?
Não é possível transferir usuários, instalações e informações de uma extensão do Chrome avaliações. Você precisa criar um novo complemento do Google Workspace e direcionar os usuários do seu Chrome extensão ao Google Workspace Marketplace.
Posso agrupar vários complementos com meu complemento do Google Workspace?
Consulte Listar integrações de apps.