Configurar OAuth

Quando você publica seu app, há quatro tarefas principais a serem concluídas para autenticação e autorização:

  1. Preencha a tela de permissão OAuth.
  2. Crie sua credencial do OAuth 2.0.
  3. Configurar todos os escopos que o app precisa executar no SDK do Google Workspace Marketplace
  4. Envie seu app para a verificação do OAuth.

Os escopos adicionados a cada local precisam corresponder e são usados das seguintes maneiras:

  • Os escopos adicionados à tela de permissão OAuth são usados na verificação do OAuth.
  • Os escopos adicionados ao SDK do Google Workspace Marketplace são usados em instalações individuais e em todo o domínio para autorizar seu app quando ele for instalado do 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 Planilhas Google e um complemento do Documentos Google, o manifesto do Apps Script de cada complemento incluirá apenas os escopos específicos do complemento. No projeto do Google Cloud, a tela de permissão 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 permissão OAuth.

    Acessar a tela de permissão OAuth

  2. Selecione o tipo de usuário para seu 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 ao selecionar escopos:

    • Selecione os escopos que fornecem o nível mínimo de acesso exigido pelo app. Para acessar 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 confidenciais, confidenciais e restritos. Para os escopos listados nas seções "Seus escopos confidenciais" ou "Seus escopos restritos", tente identificar escopos não confidenciais alternativos para evitar revisões desnecessárias.
    • Alguns escopos exigem outras análises do Google. No caso de apps usados somente 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 confidenciais não requer análise adicional do Google. Para mais informações, consulte Categorias de escopo.
  5. Depois de selecionar os escopos exigidos pelo app, clique em Save and Continue.
  6. Se você tiver selecionado Externo como tipo de usuário, adicione usuários de teste:
    1. Em Usuários de teste, clique em Adicionar usuários.
    2. Insira seu endereço de e-mail e outros usuários de teste autorizados e clique em Salvar e continuar.
  7. Analise o resumo de registro do seu app. Para fazer mudanças, clique em Editar. Se o registro do app estiver correto, clique em Voltar para o painel.

2. Criar sua credencial do OAuth 2.0

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

Se você tiver criado seu app no Apps Script

Troque o projeto padrão do Google Cloud no seu projeto do Apps Script para o novo projeto padrão. Consulte Como alternar para um projeto padrão diferente.

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

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

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

3. Configurar escopos

Forneça uma lista completa dos escopos do OAuth exigidos pelo seu app. Use sempre os escopos mais restritos possíveis.

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

Quando o app é instalado, o usuário precisa validar os escopos usados pelo app. Em geral, escolha o escopo mais restrito possível e evite solicitar escopos que não são necessários para o app. Os usuários concedem acesso mais rápido a escopos limitados e claramente descritos.

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

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

  • Para a verificação do OAuth, envie um vídeo de demonstração que demonstre a jornada ou o fluxo que explique o uso dos escopos ou dados solicitados aos usuários.
  • Se o app usar escopos restritos, talvez ele também precise passar por uma avaliação de segurança. Consulte Por que a avaliação de segurança é necessária?.

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

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

    Acessar a tela de permissão OAuth

  2. Clique em Seletor de projetos e escolha seu 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 obrigatória, insira as justificativas apropriadas e clique em Enviar para iniciar o processo de verificação.

Se você atualizar seu aplicativo para usar escopos diferentes sensíveis ou restritivos, será necessário enviá-lo para a verificação do OAuth novamente. Não é necessário enviá-lo novamente para a revisão do app.

Qual é a diferença entre a verificação OAuth e a revisão do app

A verificação OAuth é um processo separado da revisão do app. O foco dele é garantir que a tela de consentimento represente com precisão a identidade e a intent do app e garantir que ele não use dados do usuário indevidamente. A página "Detalhes do app" não pode ser aprovada até que a verificação do OAuth do app seja concluída. Para mais informações sobre a verificação do OAuth, consulte Perguntas frequentes sobre a verificação da API OAuth.

A revisão 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 avaliação, consulte Sobre a revisão de apps.