Instalar e autorizar complementos

Os usuários precisam instalar e autorizar um complemento antes de pode abri-lo e usá-lo. Como essas etapas são a primeira parte experiência do usuário complementar, você deve entendê-los antes de começar a criar seus próprios complementos.

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

Instalar complementos

Antes de usar um complemento, é preciso instalá-lo. Depois de instalado, o complemento é disponibilizado no Google Workspace. aplicativo host ela se estende.

É possível instalar os complementos publicados no aplicativo host do Google Workspace ou no Google Workspace Marketplace. Os administradores do domínio também podem instalar complementos em nome dos usuários do Google Workspace Marketplace. Você também pode instalar complementos não publicados que está desenvolvendo para poder 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 é disponibilizado no Google Workspace. aplicativo host ela se estende. Na primeira vez que um usuário tentar usar o e o aplicativo hospedeiro apresenta a eles 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 e permitir que o complemento continue. Se o o usuário nega o complemento autorização, eles não podem 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 ocorrem quando são usados com arquivos individuais. Ao desenvolver Complementos do Editor, é importante entender os diferentes modos e como um complemento se alterna entre eles.

Autorizar complementos publicados

Depois que você instala um complemento publicado, o fluxo de autorização começa imediatamente:

  1. Será preciso 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 Permitir. Isso ativa o uso do complemento.
  3. Agora você pode executá-lo do aplicativo host ela se estende. Se o aplicativo já estava aberto em uma guia do navegador, recomendamos será necessário atualizar a guia para que o complemento seja disponibilizado.

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

Cartão de autorização de complemento

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 instalar um complemento não publicado sua autorização não será solicitada imediatamente. Em vez disso, o fluxo de autorização é iniciado quando você tenta usar o complemento pela primeira vez.

Quando um complemento é executado, ele determina se alguma autorização do usuário é necessária. Se autorização é necessária, o complemento apresenta um cartão de autorização. A autorização é sempre exigida 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 Autorizar acesso abre uma janela de diálogo para o para permitir ou negar a autorização do complemento.

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

É possível que um complemento do Google Workspace se conecte para um serviço de terceiros que requer 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 você tiver um complemento do Google Workspace para acessar um serviço que não é do Google usando o OAuth, é 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

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. Caso seu complemento ofereça opções de videoconferência exigir que o usuário faça login neles, seu complemento deve oferecer ao usuário a capacidade de para fazer isso.

Se um usuário tentar criar uma videoconferência com seu complemento sem a fazer login, o método onCreateFunction das soluções de conferência deve retornar um ConferenceData que contém um objeto 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 a continuar usando o complemento.

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

Autorizar complementos do editor não publicados

É uma prática recomendada testar os complementos do Editor. à medida que você os desenvolve. 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 autorização de complementos

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

Para desautorizar 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.