Práticas recomendadas

Melhore a experiência de seus usuários experiência geral seguindo esses guias para Design do complemento do Google Meet.

Prévia para desenvolvedores:disponível como parte do Programa de prévia para desenvolvedores do Google Workspace, que concede acesso antecipado a determinados recursos.

Práticas recomendadas de autorização

Recomendamos que você use as práticas recomendadas a seguir Complementos do Google Meet que exigem autenticação ou autorização

Usar o Login do Google

Muitos usuários de complementos do Google Workspace já fizeram login no Google. de participar da reunião. Portanto, ter o Login do Google disponível como opção pode evitar que seus usuários precisem clicar ao acessar fluxo de login.

Abrir a página de login de terceiros em uma nova janela

Além do Login do Google, seu aplicativo pode oferecer recursos de login de segurança. Nesse caso, use uma janela de diálogo em vez de abrir a página de login em uma nova guia. Dessa forma, o usuário ainda poderá ver e retornar ao do Google Meet e vai receber menos cliques.

Observação :as páginas de login de terceiros nos complementos do Google Meet não têm a opção mesma implementação requisitos como complementos do Google Workspace. É possível abrir uma janela de login diretamente dos para o aplicativo. Os complementos do Meet também não são compatíveis Login de complementos do Google Workspace cards. No entanto, você ainda precisa redirecionar os usuários para concluir a de autenticação e autorização na sua infraestrutura.

Solicitar corretamente os escopos das APIs do Google

Se o complemento do Meet chamar as APIs do Google: será preciso fornecer uma lista completa de configurações escopos exigidos pelo complemento. Isso é feito Página de configuração do app Google Workspace Marketplace. Depois de adicionar essas escopos, seus usuários recebem uma solicitação ao instalar seus Complemento do Meet que informa aos usuários o tipo de dados permitindo que seu app acesse.

Antes de publicar seu complemento, você também precisa configurar o consentimento do OAuth tela. Para isso, é preciso adicionar exatamente os mesmos escopos de autorização das Configuração do app do Google Workspace Marketplace. Como configurar o OAuth tela de consentimento também exige a configuração de informações de marca, política de privacidade, e os termos de serviço que são exibidos quando os escopos são solicitados. Para publicar publicamente, todas essas informações devem ser enviadas para de verificação.

Observação :ao contrário dos complementos gerais do Google Workspace, não é necessário Complementos do Meet para incluir o oauthScopes no manifesto.

Ao escrever o código para chamar as APIs do Google Workspace, seguindo o JavaScript Guia de início rápido é a maneira mais fácil de começar. Essa abordagem segue as práticas recomendadas usando o Login do Google e janelas de diálogo. Observe que inicializar o token cliente em JavaScript exige que os escopos sejam solicitados separadamente usa durante a execução. Para a melhor experiência do usuário, estes escopos solicitados precisam corresponder aos da configuração de app do Google Workspace Marketplace página. Essa redundância fornece um substituto para lidar com o caso em que um usuário revogou escopos.

Práticas recomendadas de manutenção

As práticas recomendadas a seguir são para escrever códigos aplicativos da Web, mas são especialmente importantes na criação de qualquer Complementos do Meet.

Usar a versão mais recente do SDK de complementos do Meet

O SDK de complementos do Meet é atualizado regularmente. O SDK adere controle de versões semântico. Para encontrar a versão mais recente:

• Ao usar gstatic: a versão mais recente do SDK está contida no gstatic. O URL está disponível nas instruções de uso do SDK.
• Ao usar o npm: execute npm update @googleworkspace/meet-add-ons de dentro do o diretório que contém o package.json do site que hospeda o complemento do Meet.

Criar um projeto de teste do Google Cloud

Depois que seu complemento do Google Meet for publicado no Google Workspace Marketplace, As novas implantações do seu complemento do Google Meet são instantaneamente para os usuários do Meet. Os usuários verão essas atualizações assim que eles esvaziarem os caches ou eles expirarem. Portanto, não recomendamos enviar as alterações ao site de produção até que elas sejam completamente testadas.

Importante :os usuários podem notar um atraso nas atualizações das suas Complemento do Meet dependendo das políticas de cache do para o aplicativo. Defina o tempo de expiração do cache com um valor apropriado para seu (de preferência, no máximo 24 horas) para garantir consistência as experiências do usuário. Os usuários também verão uma nova versão se esvaziarem o cache manualmente.

Para evitar a implantação diretamente na produção, recomendamos criar uma implantação projeto do Google Cloud publicado de maneira particular à sua organização. Esse projeto do Cloud vai hospedar os ambientes de preparo e ambientes de desenvolvimento para o complemento do Meet. Acesso neste projeto do Cloud devem ser limitadas a uma equipe menor trabalhando diretamente no desenvolvimento do seu complemento.

Para criar esses ambientes alternativos para seu complemento, primeiro você precisa hospedar ambientes alternativos do aplicativo da Web que contém seu complemento em um domínio de sua propriedade. Depois, é possível criar ambientes alternativos Complemento do Meet adicionando implantações ao seu projeto de teste do Google Cloud. Essas novas implantações precisam ter que apontam para ambientes alternativos do aplicativo da Web. Recomendamos que você instale cada complemento da seguinte forma:

• Preparação: publicar a versão de preparo de forma particular para que qualquer pessoa da organização possa ajudar nos testes.
• Desenvolvimento: clique em Instalar na coluna Ações para instalar o a versão de desenvolvimento do complemento do Meet apenas para sua conta.

Programar testes

Antes de implantar o complemento do Meet em um ambiente de desenvolvimento recomendamos programar testes de unidade. Seus testes de unidade precisam incluir:

• Simular o SDK de complementos do Meet e verificar se o O complemento do Meet chama as funções do SDK conforme esperado.
• Com o teste de unidade, você tem todas as funcionalidades não relacionadas ao SDK do seu com a estrutura de teste da Web de sua preferência.

Práticas recomendadas de experiência do usuário

As práticas recomendadas a seguir ajudam a criar um complemento do Meet mais intuitiva e refinada.

Gerenciar todo o estado inicial no painel lateral

Recomendamos que você configure seu complemento com base no ações do usuário realizadas no painel lateral. Para isso, defina a colaboração como estado no JavaScript. Todos os dados enviados CollaborationStartingState devem ser definidos pelo iniciador do complemento (normalmente organizador da reunião) no painel lateral. Pense na primeira visualização painel lateral como uma forma que controla a configuração do .

Fechar o painel lateral quando ele não estiver em uso

Após iniciar a atividade, chame startCollaboration, mantenha apenas o painel lateral aberto se for uma parte essencial da experiência do usuário para seu Complemento do Google Meet. Você pode fechar o painel lateral depois que o papel principal estágio é aberto chamando unloadSidePanel.

Promover seu complemento do Meet usando o compartilhamento de tela

Os complementos do Meet oferecem uma experiência mais avançada do que o compartilhamento de tela. No entanto, muitos usuários costumam usar o compartilhamento de tela do Meet . Se um usuário compartilhar uma guia que exibe o site que hospeda seu Complemento do Meet, que pode ser configurado para exibirá um banner a todos os participantes da chamada solicitando que eles instalem ou usem o o complemento do Meet correspondente. Para mais informações, consulte promovendo seu complemento na tela compartilhamento.

Temas relacionados

• Resolver problemas e corrigir erros no complemento do Meet