Instalar e autorizar complementos

Os usuários precisam instalar e autorizar um complemento antes de abrir e usá-lo. Como essas etapas são a primeira parte da experiência do usuário com o complemento, é importante que você as entenda antes de começar a criar seus próprios complementos.

Esta seção da documentação descreve como os usuários podem instalar, autorizar e começar a usar os complementos.

Instalar complementos

Antes de usar um complemento, é necessário instalá-lo. Depois de instalado, o complemento fica disponível no aplicativo host do Google Workspace que ele estende.

É possível instalar complementos publicados no aplicativo host do Google Workspace ou no Google Workspace Marketplace. Os administradores de domínio também podem instalar complementos em nome dos usuários no Google Workspace Marketplace. Também é possível instalar complementos não publicados que você está desenvolvendo para testá-los. Antes de poder usar um pela primeira vez, será preciso autorizar reimplantá-lo.

Para mais detalhes, consulte Publicar complementos.

Autorizar complementos

Depois de instalar um complemento, ele fica disponível no aplicativo host do Google Workspace que ele estende. Na primeira vez que um usuário tentar usar o do aplicativo hospedeiro apresenta-lhes um cartão de autorização ou caixa de diálogo. Este card explica o que precisa de permissão para o usuário, como acessar o conteúdo da planilha atual do Google. O usuário pode conceder essas permissões e permitir que o complemento continue. Se o o usuário nega o complemento autorização, não poderão usar o complemento.

Os complementos do editor usam um modelo de autorização diferente Complementos do Google Workspace. Como os Complementos do Editor funcionam nos arquivos do Google Drive, O modelo de autorização do editor define vários modos de autorização que resultam quando são usados com arquivos individuais. Ao desenvolver complementos do editor, é importante entender os diferentes modos e como um complemento se move entre eles.

Autorizar complementos publicados

Depois de instalar um complemento publicado, o fluxo de autorização começa imediatamente:

1. Você vai precisar escolher uma conta para instalar o complemento.
2. Você verá a lista de autorizações que o complemento precisa para funcionar, para que você saiba o que ele tenta fazer. Avaliar lista com atenção e, se ainda quiser conceder autorização, Clique em Allow. Isso ativa o complemento para uso.
3. Agora você pode executá-lo do aplicativo host ela se estende. Se o aplicativo já estiver aberto em uma guia do navegador, talvez seja necessário atualizar a guia antes que o complemento fique disponível.

Se o complemento instalado for atualizado posteriormente e precisar autorizações que ainda não foram concedidas, você precisa fornecer essas permissões na próxima vez em que você usar o complemento.

Autorizar complementos não publicados do Google Workspace

Complementos não publicados não têm o mesmo fluxo de autorização que os publicados porque ainda não estão listados no Google Workspace Marketplace. Depois de instalar um complemento não publicado, você não precisa dar autorização imediatamente. Em vez disso, o fluxo de autorização começa quando você tenta usar o complemento pela primeira vez.

Quando um complemento é executado, ele determina se é necessária alguma autorização do usuário. Se autorização é necessária, o complemento apresenta um cartão de autorização. A autorização é sempre necessária na primeira execução de um complemento e também pode ser obrigatório se uma nova versão do complemento usar um serviço que não foi incluído anteriormente autorizado. O botão Authorize Access (autorizar acesso) oferece uma janela de diálogo para que o usuário permita ou negue a autorização do complemento.

Observação: se o complemento ainda não tiver sido verificado, o aplicativo host pode apresentar caixas de diálogo adicionais com informações sobre isso e solicitar uma confirmação para continuar.

Autorizar serviços de terceiros para um complemento do Google Workspace

É possível que um complemento do Google Workspace se conecte a um serviço de terceiros que exija autorização. Complementos do Google Workspace que se conectam a esses serviços exigem duas ações separadas do usuário:

• Autorização do complemento quando ele é instalado ou pela primeira vez começar.
• Autorização do serviço que não é do Google quando é acessado pela primeira vez.

Se um complemento do Google Workspace que você está desenvolvendo precisar acessar um serviço que não seja do Google usando o OAuth, será necessário configurar a conexão para esse serviço ao criar o complemento.

Para mais informações, consulte Conectar o complemento do Google Workspace a um serviço de terceiros.

Sistemas de conferência de terceiros

Observação: esta seção descreve a autorização de soluções de videoconferência adicionadas ao Google Agenda com um complemento do Google Workspace.

Se você não tiver um sistema de conferências de terceiros baseado na Web, seu complemento não precisará autorizar nenhuma solução de conferência. Isso foi criada especificamente para provedores de videoconferência.

Complementos do Google Workspace que ampliam o Google Agenda também podem acrescentar soluções de conferência que permitem que os usuários selecionem um sistema de videoconferência de terceiros ao editar Eventos do Google Agenda. Se o complemento oferece opções de conferência que exigem que o usuário faça login, ele precisa dar ao usuário a capacidade de fazer isso.

Se um usuário tentar criar uma conferência com seu complemento sem fazer o login necessário, o método onCreateFunction das soluções de conferência vai retornar um objeto ConferenceData que contém um ConferenceError com um URL de autenticação.

Ao receber esse objeto, o Google Agenda cria um botão FAZER LOGIN no a interface de edição do evento que está vinculada ao URL de autenticação fornecido pelo complemento. Os usuários podem usar esse botão para fazer login no sistema de terceiros antes de usar o complemento.

Consulte Como criar videoconferências de terceiros. para mais detalhes sobre como gerenciar a autorização usando ConferenceError.

Autorizar complementos não publicados do editor

É recomendável testar os complementos do editor durante o desenvolvimento. O fluxo de autorização é idêntico ao para Complementos do Editor publicados, exceto que o fluxo é iniciado quando você tenta testar o complemento pela primeira vez. Se você testar o mesmo modelo novamente não vai receber outra solicitação de autorização.

Cancelar a autorização de complementos

Ao desenvolver complementos, pode ser útil desautorizá-los para que você possa testar o fluxo de autorização novamente.

Para cancelar a autorização de um complemento, faça o seguinte:

1. Abra o console de segurança da conta.
2. Localize e clique no complemento que você quer desautorizar.
3. Clique em Remover acesso.

Quando você executa o complemento novamente após desautorizá-lo, o fluxo de autorização é apresentado novamente.

Desinstalar complementos

Para desinstalar um complemento instalado no Google Workspace Marketplace, consulte Desinstalar um app ou complemento do Marketplace.

Para desinstalar um complemento não publicado integrado ao Apps Script, consulte Desinstalar um complemento não publicado.

Temas relacionados

• Abrir e usar os complementos instalados
• Conectar o complemento do Google Workspace a um serviço de terceiros