Configurar OAuth

Ao publicar o app, há quatro tarefas principais a serem concluídas para autenticação e autorização:

  1. Preencha a tela de consentimento do OAuth.
  2. Crie sua credencial OAuth 2.0.
  3. Configurar todos os escopos necessários para a execução do app no SDK do Google Workspace Marketplace
  4. Envie seu app para verificação do OAuth.

Os escopos adicionados a cada lugar precisam ser correspondentes e são usados da seguinte maneira:

  • Os escopos adicionados à tela de consentimento do OAuth são usados para a verificação do OAuth.
  • Os escopos adicionados ao SDK do Google Workspace Marketplace são usados para instalações individuais e em todo o domínio para autorizar seu app quando ele é instalado no Google Workspace Marketplace.
  • Os escopos adicionados ao manifesto são necessários para que o app funcione corretamente.

Por exemplo, se você publicar um app que inclui um complemento do Google Planilhas e um complemento do Google Docs, o manifesto do Apps Script de cada complemento vai incluir apenas os escopos específicos do complemento. No seu projeto do Google Cloud, a tela de consentimento do OAuth e o SDK do Google Workspace Marketplace incluem os escopos dos dois complementos.

Pré-requisitos

A tela de consentimento OAuth é um prompt que informa aos usuários quem está solicitando acesso aos dados e quais tipos de dados eles estão permitindo que seu app acesse.

  1. No console do Google Cloud, acesse Menu > APIs e serviços > Tela de consentimento do OAuth.

    Acessar a tela de permissão OAuth

  2. Selecione o tipo de usuário do app e clique em Criar.
  3. Preencha o formulário de registro do app e clique em Salvar e continuar.

  4. Se você estiver criando um app para uso fora da sua organização do Google Workspace, clique em Adicionar ou remover escopos. Recomendamos as seguintes práticas recomendadas ao selecionar escopos:

    • Selecione os escopos que fornecem o nível mínimo de acesso exigido pelo app. Para uma lista de escopos disponíveis, consulte Escopos do OAuth 2.0 para APIs do Google.
    • Analise os escopos listados em cada uma das três seções: escopos não sensíveis, sensíveis e restritos. Para todos os escopos listados nas seções "Seus escopos sensíveis" ou "Seus escopos restritos", tente identificar escopos alternativos não sensíveis para evitar revisões adicionais desnecessárias.
    • Alguns escopos exigem análises adicionais do Google. Para apps usados apenas internamente pela sua organização do Google Workspace, os escopos não são listados na tela de consentimento, e o uso de escopos restritos ou sensíveis não requer mais análises do Google. Para mais informações, consulte Categorias de escopo.
  5. Depois de selecionar os escopos necessários pelo app, clique em Salvar e continuar.
  6. Se você selecionou Externo como tipo de usuário, adicione usuários de teste:
    1. Em Test Users, clique em Add users.
    2. Insira seu endereço de e-mail e os outros usuários de teste autorizados. Depois, clique em Salvar e continuar.
  7. Analise o resumo do registro do app. Para fazer alterações, clique em Editar. Se o registro do app estiver correto, clique em Voltar ao painel.

2. Criar a credencial OAuth 2.0

Dependendo de como você criou o app, há duas maneiras diferentes de criar as credenciais do OAuth 2.0.

Se você criou o app no Apps Script

Mude o projeto do Apps Script do projeto padrão do Google Cloud para o novo projeto padrão. Consulte Como mudar para um projeto padrão diferente.

Depois de associar seu projeto do Apps Script ao projeto do Google Cloud, sua credencial OAuth 2.0 será criada automaticamente.

Se você não usou o Apps Script para criar seu app

Para criar sua credencial OAuth 2.0, consulte Credenciais de ID do cliente do OAuth.

3. Configurar escopos

Forneça uma lista completa dos escopos do OAuth necessários para o app. Sempre use os escopos mais estreitos possíveis.

Para definir o nível de acesso concedido ao app, é necessário identificar e declarar os escopos de autorização. Um escopo de autorização é uma string de URI OAuth 2.0 que contém o nome do app do Google Workspace, o tipo de dados acessado e o nível de acesso. Os escopos são as solicitações do app para trabalhar com dados do Google Workspace, incluindo dados da Conta do Google dos usuários.

Quando o app é instalado, o usuário precisa validar os escopos usados por ele. Geralmente, escolha o escopo mais focado possível e evite solicitar escopos que o app não exige. Os usuários concedem acesso mais fácil a escopos limitados e claramente descritos.

4. Enviar para verificação do OAuth (somente apps públicos)

Se um app público usa escopos sensíveis ou restritos, ele precisa passar por um processo de análise de verificação do OAuth.

  • Para a verificação do OAuth, você precisa enviar um vídeo de demonstração que mostre a jornada ou o fluxo que explica o uso dos escopos ou dados solicitados aos usuários.
  • Se o app usa escopos restritos, ele também pode precisar passar por uma avaliação de segurança. Consulte Por que a avaliação de segurança é necessária.

Para enviar a verificação, siga estas etapas:

  1. No console do Google Cloud, acesse Menu > APIs e serviços > Tela de consentimento do OAuth.

    Acessar a tela de permissão OAuth

  2. Clique em Seletor de projetos e escolha o projeto.
  3. Clique em Editar app.
  4. Insira as informações necessárias e clique em Enviar para verificação.
  5. Na caixa de diálogo Verificação necessária, digite as justificativas adequadas e clique em Enviar para iniciar o processo de verificação.

Se você atualizar o app para usar escopos diferentes que sejam sensíveis ou restritos, será necessário enviar o app para verificação do OAuth novamente. Não é preciso enviar o app para análise novamente.

Qual é a diferença entre a verificação OAuth e a análise de apps

A verificação OAuth é um processo separado da análise do app. O foco é garantir que a tela de consentimento represente com precisão a identidade e a intenção do app, além de garantir que ele não use indevidamente os dados do usuário. A ficha do app não pode ser aprovada até que a verificação OAuth seja concluída. Para mais informações sobre a verificação do OAuth, consulte as Perguntas frequentes sobre a verificação da API OAuth.

A análise de apps se concentra nas informações que você fornece na API Google Workspace Marketplace e na funcionalidade e usabilidade do app. Para saber mais sobre os critérios de análise, consulte Sobre a análise de apps.