Verificação de escopo sensível

Caso seu app peça permissão para usar as APIs do Google a fim de acessar os serviços dados, você pode ter de concluir o processo de verificação antes de disponibilizar o app publicamente pela primeira tempo de resposta.

A aplicação desse requisito ao seu app depende principalmente de dois fatores:

  1. O tipo de dados do usuário que você acessa: informações públicas do perfil, entradas da agenda, arquivos no Drive, alguns dados de saúde e condicionamento físico, etc.
  2. O grau de acesso que você precisa (somente leitura, leitura e gravação, etc.)

Ao usar o OAuth 2.0 para receber permissão de uma Conta do Google para acessar os dados, você usa strings chamadas scopes para especificar o tipo de dados que você quer acessar em nome deles. Se escopos de solicitações do app categorizados como confidencial ou restrita, provavelmente será necessário concluir o processo de verificação, a menos que sua caso o uso de um app se qualifique para uma exceção.

Exemplos de escopos sensíveis incluem a leitura de eventos armazenados no Google Agenda, o armazenamento de um novo contato no Contatos do Google ou a exclusão de um vídeo do YouTube. Para mais informações sobre escopos disponíveis e suas classificações, consulte a documentação de referência da API endpoints chamados pelo app e qualquer guia de autorização relacionado publicado para a API.

É preciso solicitar escopos que exigem ter o mínimo de acesso necessário aos dados do usuário para fornecer essa funcionalidade. Por exemplo: um aplicativo que só lê dados não deve solicitar acesso para ler, gravar e excluir conteúdo quando um um escopo restrito esteja disponível para a API e os endpoints relacionados. Os dados que você recebe de um A API do Google só deve ser usada em conformidade com as políticas da API e da forma que você representar aos usuários nas ações do aplicativo e na política de privacidade.

Considere o tempo necessário para concluir a verificação no plano de lançamento de seu ou novos recursos que exigem um novo escopo. Processo de verificação do escopo sensível geralmente leva de três a cinco dias úteis para ser concluído. É possível que seu app esteja qualificado para marca verificação como um subconjunto da sua solicitação de verificação de escopo sensível.

Entender os escopos sensíveis

Escopos confidenciais exigem a análise do Google antes que qualquer Conta do Google possa conceder acesso. Google os administradores da organização do Workspace podem restringir o acesso a escopos confidenciais para impedir o acesso por IDs do cliente OAuth que a organização não marcar como confiável.

Entender o uso do escopo

  • Revise os escopos que seu app usa ou que você quer usar. Para encontrar o uso do escopo que já existe, examinar o código-fonte do seu aplicativo em busca de escopos enviados com solicitações de autorização.
  • Determinar se cada escopo solicitado é necessário para as ações pretendidas do recurso do app e usa o mínimo de privilégio necessário para fornecer o recurso. Uma API do Google geralmente tem documentação de referência na página do desenvolvedor do Google do produto para os endpoints que incluem o escopo necessário para chamar o endpoint ou propriedades específicas. Para mais informações sobre os escopos de acesso necessários para os endpoints de API que o app chama, leia a documentação de referência desses endpoints.
  • Os dados recebidos de uma API do Google só podem ser usados em conformidade com as políticas da API e da forma que você representa para os usuários nas ações do app e na sua Política de Privacidade.
  • Consulte a documentação da API para saber mais sobre cada escopo, incluindo os possíveis sensitive or restricted status.
  • Declare todos os escopos usados pelo aplicativo no argumento API Console Tela de permissão OAuth de escopos de configuração. Os escopos especificados são agrupados em informações sensíveis ou restritas para destacar as verificações adicionais necessárias.
  • Encontrar o melhor escopo que corresponda aos dados usados pela sua integração, entender seu uso, reconfirme se tudo ainda funciona em um ambiente de teste e prepare-se para enviar para verificação.
.
Uma tabela exibe o nome de uma API, um dos escopos confidenciais e uma descrição da
            o que o escopo abrange.
Figura 1. Um exemplo de um modelo escopo mostrado na página de escopos de configuração da tela de consentimento do OAuth.

Etapas para se preparar para a verificação

Todos os apps que usam APIs do Google para solicitar acesso a dados precisam seguir estas etapas para concluir a verificação de marca:

  1. Confirme se o app não se enquadra em nenhum dos casos de uso da seção Exceções aos requisitos de verificação.
  2. Verifique se o app obedece aos requisitos de branding das APIs ou do produto associado. Por exemplo, consulte as diretrizes da promoção de marca para escopos do Login do Google.
  3. Verifique a propriedade do domínios autorizados na Google Search Console. Usar uma Conta do Google A conta associada ao seu API Console projeto como uma proprietário ou editor.
  4. Verifique se todas as informações de marca na tela de permissão OAuth, como o nome do app, são compatíveis e-mail, URI da página inicial, URI da política de privacidade etc. representa com precisão a identidade do aplicativo.

Requisitos da página inicial do aplicativo

Verifique se a página inicial atende aos seguintes requisitos:

  • A página inicial precisa ser acessível ao público, e não apenas aos usuários conectados usuários.
  • A relevância da sua página inicial para o app em revisão precisa ser clara.
  • Links para a página "Detalhes do app" na Google Play Store ou na página do Facebook não são considerados páginas iniciais de aplicativos válidas.

Requisitos para o link da Política de Privacidade do aplicativo

A Política de Privacidade do seu app precisa atender aos seguintes requisitos:

  • A Política de Privacidade precisa estar visível para os usuários e estar hospedada no mesmo domínio do seu do aplicativo do Google e vinculados à tela de permissão OAuth do Google API Console: A página inicial deve incluir um descrição da funcionalidade do app, bem como links para a Política de Privacidade e os termos de serviço opcionais.
  • A política de privacidade precisa divulgar a maneira como seu aplicativo acessa, usa armazena ou compartilha dados dos usuários do Google. É necessário limitar o uso de dados do usuário do Google às práticas divulgadas na sua Política de Privacidade publicada.

Como enviar seu app para verificação

Um Google API Console projeto organiza todos os seus API Console . Um projeto consiste em um conjunto de Contas do Google associadas que têm permissão para realizar operações de projeto, um conjunto de APIs ativadas e configurações de faturamento, autenticação e monitoramento dessas APIs. Por exemplo, um projeto pode contêm um ou mais clientes OAuth, configura APIs para esses clientes e define uma Tela de consentimento OAuth exibida aos usuários antes que eles autorizem o acesso ao app.

Se algum dos seus clientes OAuth não estiver pronto para produção, sugerimos que você o exclua o projeto que está solicitando a verificação. Você pode fazer isso no Google API Console:

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

  1. Verifique se o app obedece aos Termos de Serviço das APIs do Google e à Política de dados do usuário dos serviços de API do Google.
  2. Mantenha atuais os papéis de proprietário e editor das contas associadas ao projeto, bem como o e-mail de suporte ao usuário da tela de consentimento OAuth e os dados de contato do desenvolvedor na sua API Console: Isso garante que os membros corretos equipe de segurança são notificadas sobre novos requisitos.
  3. Acesse a API Console OAuth Consent Screen page.
  4. Clique no botão Seletor de projetos.
  5. Na caixa de diálogo Selecionar de exibida, selecione seu projeto. Se você não conseguir encontrar projeto, mas souber o ID dele, poderá criar um URL no navegador da seguinte formato:

    https://console.developers.google.com/apis/credentials/consent?project=[PROJECT_ID]

    Substitua [PROJECT_ID] pelo ID do projeto que você quer usar.

  6. Selecione o botão Edit App.
  7. Insira as informações necessárias na página da tela de permissão OAuth e selecione a opção Salvar e continuar.
  8. Use o botão Adicionar ou remover escopos para declarar todos os escopos solicitados pelo app. Um os escopos iniciais necessários para o Login do Google são pré-preenchidos Seção Escopos não confidenciais. Os escopos adicionados são classificados como não confidenciais, sensitive, or restricted:
  9. Forneça até três links para documentos relevantes sobre recursos relacionados no app.
  10. Forneça todas as informações adicionais solicitadas sobre seu app nas próximas etapas.

    1. Prepare a detailed justification for each requested sensitive scope, as well as an explanation for why a narrower scope isn't sufficient. For example: "My app will use https://www.googleapis.com/auth/calendar to show a user's Google calendar data on the scheduling screen of my app. This lets users manage their schedules through my app and sync the changes with their Google calendar."
    2. Prepare a video that fully demonstrates how a user initiates and grants access to the requested scopes and shows, in detail, the usage of the granted sensitive and restricted scopes in the app. Upload the video to YouTube Studio and set its Visibility as Unlisted. You need to provide a link to the demonstration video in the YouTube link field.

      1. Show the OAuth grant process that users will experience, in English. This includes the consent flow and, if you use Google Sign-In, the sign-in flow.
      2. Show that the OAuth consent screen correctly displays the App Name.
      3. Show that the browser address bar of the OAuth consent screen correctly includes your app's OAuth client ID.
      4. To show how the data will be used, demonstrate the functionality that's enabled by each sensitive scope that you request.
  11. Se a configuração do app fornecida exigir verificação, você poderá enviá-la o app para verificação. Preencha os campos obrigatórios e clique em Enviar para iniciar o o processo de verificação.

Depois de enviar seu app, a equipe de confiança A equipe de segurança faz o acompanhamento por e-mail outras informações de que precisam ou etapas que você precisa concluir. Verifique seus endereços de e-mail na seção Informações de contato do desenvolvedor e no e-mail de suporte da tela de consentimento do OAuth para ver se há solicitações de informações adicionais. Também é possível conferir o consentimento de OAuth do seu projeto página da tela para confirmar o status de revisão atual do projeto, incluindo se o processo de revisão está pausado enquanto aguardamos sua resposta.

Exceções aos requisitos de verificação

Caso seu app seja usado em qualquer um dos cenários descritos nas seções a seguir, não precisará enviá-lo para análise.

Uso pessoal

Um caso de uso é se você for o único usuário do seu app ou se ele for usado por apenas alguns usuários, todos conhecidos pessoalmente por você. Você e seu número limitado de usuários podem se sentir confortáveis ao avançar pela tela do app não verificado e conceder acesso às suas contas pessoais ao app.

Projetos usados em desenvolvimento, teste ou preparo camadas

Para cumprir as Políticas do OAuth 2.0 do Google, é recomendável ter projetos diferentes para ambientes de teste e produção. Recomendamos que você envie seu app somente para verificação se quiser disponibilizar o app para qualquer usuário com uma Conta do Google. Portanto, se o seu app está nas fases de desenvolvimento, teste ou preparo, a verificação não é necessária.

Se o app estiver nas fases de desenvolvimento ou teste, deixe o Status de publicação na configuração padrão de Teste. Essa configuração significa que seu app ainda está em desenvolvimento disponível para os usuários que você adicionar à lista de usuários de teste. Você precisa gerenciar a lista de Contas do Google envolvidas no desenvolvimento ou teste do app.

Mensagem de aviso de que o Google não verificou um app que está em teste.
Figura 2. Tela de aviso do testador

Somente dados do serviço

Se o app usar uma conta de serviço para acessar apenas os próprios dados e não acessar dados do usuário (vinculados a uma Conta do Google), não será necessário enviar para verificação.

Para entender o que são contas de serviço, consulte Contas de serviço no na documentação do Google Cloud. Para instruções sobre como usar uma conta de serviço, consulte Como usar o OAuth 2.0 para aplicativos de servidor para servidor.

Somente para uso interno

Isso significa que o app é usado apenas por pessoas na sua organização do Google Workspace ou do Cloud Identity. O projeto precisa ser de propriedade da organização e da tela de permissão OAuth precisa ser configurado Usuário interno tipo. Nesse caso, talvez o app precise da aprovação de um administrador da organização. Para mais informações, consulte Outros considerações sobre o Google Workspace.

Instalação em todo o domínio

Se você planeja que o app segmente apenas usuários de uma conta do Google Workspace ou do Cloud Identity organização e sempre usam todo o domínio instalação, ele não exigirá a verificação de apps. Isso ocorre porque uma conta de serviço permite que um administrador de domínio conceda a apps internos e de terceiros acesso aos dos seus usuários dados. Os administradores da organização são as únicas contas que podem adicionar o app a um lista de permissões para uso nos próprios domínios.

Saiba como tornar seu app uma instalação em todo o domínio nas Perguntas frequentes Meu aplicativo tem usuários com contas empresariais de outro domínio do Google Workspace.