Configurar OAuth

Ao publicar seu app, há três 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. Envie seu app para verificação do OAuth.

Entender os escopos do OAuth

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.

Forneça a lista completa de escopos do OAuth necessários para o app. Os escopos adicionados a cada local 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 desse complemento. No seu projeto do Google Cloud, a tela de consentimento do OAuth e o SDK do Marketplace incluem os escopos dos dois complementos.

Corrigir escopos do OAuth não verificados

Se você tiver um app novo, um rascunho salvo ou um app público publicado com escopos sensíveis ou restritos não verificados, a seguinte mensagem de erro vai aparecer ao editar o app no SDK do Marketplace:

OAuth verification is required for sensitive or restricted scopes. You can still save your app as a draft, but you're not able to publish your draft app listing.

Para mais informações, consulte Especificar o nível de acesso necessário para o app.

Para contornar esse erro, faça o seguinte:

  • Faça mudanças em uma página de detalhes do app com escopos sensíveis ou restritos não verificados e salve a página como rascunho.

  • Publique o app quando nenhum novo escopo restrito ou sensível não verificado for adicionado.

  • Publique o app quando apenas os escopos restritos ou sensíveis não verificados forem removidos.

Em algumas soluções alternativas, a tela "App não verificado" pode aparecer para os usuários. Para mais informações, consulte Apps não verificados.

Para corrigir esse erro, envie seu app para verificação OAuth.

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 > > Branding.

    Acessar "Branding"

  2. Se você já tiver configurado o , poderá configurar as seguintes configurações da tela de consentimento do OAuth em Marca, Público-alvo e Acesso a dados. Se você receber a mensagem ainda não configurado, clique em Começar:
    1. Em Informações do app, em Nome do app, insira um Nome do app.
    2. Em E-mail para suporte do usuário, escolha um endereço de e-mail de suporte para que os usuários entrem em contato com você se tiverem dúvidas sobre o consentimento.
    3. Clique em Próxima.
    4. Em Público, selecione o tipo de usuário do app.
    5. Clique em Próxima.
    6. Em Dados de contato, insira um endereço de e-mail para receber notificações sobre as mudanças no projeto.
    7. Clique em Próxima.
    8. Em Concluir, analise a Política de dados do usuário dos serviços de API do Google e, se concordar, selecione Concordo com a política de dados do usuário dos serviços de API do Google.
    9. Clique em Continuar.
    10. Clique em Criar.
    11. Se você selecionou Externo como tipo de usuário, adicione usuários de teste:
      1. Clique em Público-alvo.
      2. Em Test users, clique em Add users.
      3. Insira seu endereço de e-mail e os outros usuários de teste autorizados. Depois, clique em Salvar.

  3. Se você estiver criando um app para uso fora da sua organização do Google Workspace, clique em Acesso a dados > 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 exige mais análises do Google. Para mais informações, consulte Categorias de escopo.
  4. Depois de selecionar os escopos necessários para o app, clique em Salvar.

Para mais informações sobre como configurar o consentimento OAuth, consulte Começar a usar o .

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 Cloud para o novo projeto padrão. Para mais informações, consulte Mudar para um projeto padrão do Cloud.

Depois de associar seu projeto do Apps Script ao projeto do 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 OAuth.

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

Se o app usa APIs do Google para acessar dados do usuário do Google, ele pode estar sujeito ao processo de verificação antes da publicação.

Antes do envio

Embora você possa concluir as etapas 1 e 2 nesta página, talvez não seja possível enviar o app para verificação OAuth até que você conclua algumas etapas de publicação do Marketplace que ocorrem simultaneamente a esse processo.

Por exemplo, para criar um complemento do Google Sala de Aula, você precisa criar uma listagem de rascunho do app no SDK do Marketplace usando as etapas em Configurar seu app no SDK do Google Workspace Marketplace . Em seguida, use a listagem de rascunho do app para criar o vídeo de demonstração necessário para a verificação do OAuth. Depois que a verificação for concluída, você poderá enviar o rascunho da página de detalhes do app para análise.

Para uma visão geral das etapas de envio, consulte Publicar seu app.

Revisão da verificação do OAuth

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

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 o OAuth.

A análise de apps se concentra nas informações que você fornece no SDK do Google Workspace Marketplace e nos recursos e na usabilidade do app. Para saber mais sobre os critérios de análise de apps, consulte Processo de análise e requisitos de apps para o Google Workspace Marketplace.