Configuração

Esta página explica como configurar seu app, jogo ou SDK para usar a API Play Integrity. Para integrar a API, você precisa ter um projeto do Google Cloud, que é necessário para começar a fazer solicitações. Em seguida, vincule seu projeto do Google Cloud ao Google Play Console (para apps) ou ao Google Play SDK Console (para SDKs). É necessário vincular seu projeto para acessar outras opções de configuração, recursos de teste, relatórios da API e solicitar um aumento na cota diária de solicitações.

Ativar a API Play Integrity

Todo app ou SDK que chama a API Play Integrity precisa ter um projeto do Google Cloud para usar a API e monitorar o uso. Essa é a primeira etapa obrigatória para todas as integrações. É possível ativar a API Play Integrity no console do Google Cloud ou pular diretamente para a vinculação do projeto do Cloud ao Google Play e a API Play Integrity será ativada para você.

No Console do Google Cloud, crie um projeto do Cloud ou escolha um projeto atual que você queira usar com a API Play Integrity.

1. Navegue até APIs e serviços.
2. Selecione Ativar APIs e serviços.
3. Pesquise API Play Integrity.
4. Clique em Ativar.

Agora você pode integrar a API Play Integrity ao app. Para acessar recursos avançados e aumentos de cota, siga para a etapa de vinculação.

Vincular ao Google Play (recomendado)

Vincule seu app ou SDK ao Google Play seguindo estas instruções.

Para apps e jogos no Google Play

Os apps distribuídos no Google Play precisam vincular o projeto do Google Cloud no Google Play Console para ativar recursos extras e solicitar um aumento na cota diária de API.

1. Abra o Google Play Console e selecione seu app.
2. Navegue até Testar e lançar > Integridade do app.
3. Em API Play Integrity, clique em Vincular um projeto do Cloud.
4. Escolha o projeto do Google Cloud que você planeja usar com a API Play Integrity. Se ela ainda não estiver ativada para o projeto, será ativada automaticamente após a vinculação.

Para provedores de SDK no Google Play SDK Console

Os provedores de SDK que usam o Google Play SDK Console podem vincular o projeto do Google Cloud para atribuir o uso da API ao SDK, em vez dos apps individuais que o usam, ativar recursos extras e solicitar um aumento na cota diária da API. O acesso ao Google Play SDK Console está sujeito a critérios de qualificação.

1. Abra o Google Play SDK Console e selecione seu SDK.
2. Navegue até Integridade do SDK.
3. Em API Play Integrity, clique em Vincular um projeto do Cloud.
4. Escolha o projeto do Google Cloud que você planeja usar com a API Play Integrity. Se ela ainda não estiver ativada, isso vai acontecer automaticamente ao vincular.

Entender os limites de uso da API Play Integrity

Seu app ou SDK tem um limite diário padrão de 10.000 solicitações totais, vinculadas ao número do projeto do Cloud associado. Se você prevê um volume maior, peça um aumento de cota.

Aumentar o número diário máximo de solicitações

O aumento da cota está sujeito a critérios de qualificação. Os aumentos de cota se aplicam à geração de tokens do lado do cliente e às chamadas de descriptografia do lado do servidor. O processamento de solicitações pode levar até uma semana. Recomendamos monitorar o uso da API Play Integrity no console do Google Cloud e definir alertas de cota para evitar interrupções no serviço.

Mesmo com uma cota maior, continue limitando as solicitações clássicas a ações pouco frequentes e de alto valor para preservar a bateria do usuário e o uso de dados.

Para apps e jogos no Google Play

Para se qualificar para um aumento de cota, o app precisa estar disponível no Google Play além de outros canais de distribuição. Vincule seu projeto do Google Cloud ao app no Play Console. As solicitações de cota de projetos desvinculados serão rejeitadas.

Para solicitar um aumento:

1. Vincule o projeto relevante do Google Cloud no Play Console.
2. Verifique se você implementou corretamente a lógica da API, incluindo estratégias de repetição adequadas.
3. Envie o formulário de solicitação de cota.

Para provedores de SDK no Google Play SDK Console

Para se qualificar para um aumento de cota, seu SDK precisa ser reivindicado no Google Play SDK Console, e seu projeto do Cloud precisa estar vinculado a ele. O acesso ao Google Play SDK Console está sujeito a critérios de qualificação.

Para solicitar um aumento:

1. Vincule seu projeto do Google Cloud ao Google Play SDK Console.
2. Preencha o formulário de suporte do Google Play SDK Console.

Na seção de comentários abertos, descreva seu caso de uso, o tipo de solicitações de API que você está fazendo (padrão, clássica ou ambas), a frequência com que você faz solicitações e o número máximo diário de solicitações que você quer.

Integrar a API Play Integrity ao app

Para integrar a API Play Integrity ao app ou SDK, siga um dos procedimentos abaixo, dependendo do ambiente de desenvolvimento usado:

Kotlin ou Java

A biblioteca Android mais recente da API Play Integrity está disponível no repositório Maven do Google. Adicione a seguinte dependência ao arquivo build.gradle do app:

implementation 'com.google.android.play:integrity:1.6.0'

Unity

As seções a seguir descrevem como integrar e configurar a API Google Play Integrity para projetos do Unity, abordando versões compatíveis do Unity, métodos de instalação e configuração do ambiente.

Versões compatíveis do Unity

• Todas as versões 2019.x, 2020.x e mais recentes têm suporte.
• Se você usar o Unity 2018.x, há suporte para a versão 2018.4 ou mais recente.
• O Unity 2017.x e versões anteriores não têm suporte.

Configurar seu ambiente de desenvolvimento

openupm add com.google.play.integrity

Unreal Engine

As seções a seguir descrevem como integrar e configurar a API Google Play Integrity para projetos do Unreal Engine.

Versões compatíveis do Unreal Engine

O plug-in é compatível com o Unreal Engine 5.0 e todas as versões subsequentes.

Configurar seu ambiente de desenvolvimento

1. Faça o download do plug-in do Google Play para Unreal Engine no repositório do GitHub.

2. Copie a pasta GooglePlay dentro da pasta Plugins no seu projeto do Unreal Engine.

3. Abra seu projeto do Unreal Engine e clique em Editar → Plug-ins.

4. Pesquise Google Play e marque a caixa de seleção Ativado.

5. Reinicie o projeto do jogo e acione um build.

6. Abra o arquivo Build.cs do projeto e adicione o módulo PlayIntegrity a PublicDependencyModuleNames:

   using UnrealBuildTool;
   
   public class MyGame : ModuleRules
   {
     public MyGame(ReadOnlyTargetRules Target) : base(Target)
     {
       // ...
   
       PublicDependencyModuleNames.Add("PlayIntegrity");
   
       // ...
     }
   }
   

Nativo

Siga o guia de configuração nativa. Para mais detalhes, consulte a documentação de referência da API nativa da Play Integrity.

Configurar respostas da API (opcional)

A resposta da API inclui vereditos padrão retornados em cada solicitação. Se você vinculou seu projeto do Cloud ao Play Console ou ao Play SDK Console, é possível personalizar a resposta da API para incluir mais informações.

Vereditos de integridade padrão

Os vereditos de integridade abaixo são retornados na resposta da API Play Integrity por padrão:

Google Play Games para PC

Se você distribuir o app para o Google Play Games para PC, o recebimento de um identificador extra no veredito de integridade do dispositivo será ativado automaticamente:

Vereditos de integridade opcionais

Se você tiver vinculado seu projeto do Cloud no Play Console ou no Play SDK Console, poderá ativar o recebimento de informações adicionais.

Para fazer mudanças, acesse o Play Console e navegue até Teste e lançamento > Integridade do app. Ao lado de API Play Integrity, clique em Configurações. Clique em Mudar respostas, edite e salve as mudanças.

Informações do dispositivo

Os identificadores adicionais do dispositivo no veredito deviceIntegrity informam mais sobre o ambiente do dispositivo em que o app está sendo executado. Um único dispositivo retorna vários identificadores se atender aos critérios de cada um deles. É possível usar esses rótulos para criar uma estratégia de aplicação por níveis. Por exemplo, você pode confiar mais em um dispositivo que retorna três rótulos (MEETS_STRONG_INTEGRITY, MEETS_DEVICE_INTEGRITY e MEETS_BASIC_INTEGRITY) do que em um que retorna apenas um (MEETS_BASIC_INTEGRITY).

Os atributos do dispositivo informam a versão do SDK do Android do SO Android no dispositivo. No futuro, ele poderá ser estendido com outros atributos de dispositivo.

A atividade recente do dispositivo retorna um nível que varia de LEVEL_1 (baixo número de solicitações) a LEVEL_4 (alto número de solicitações). Níveis altos de atividade podem indicar que um dispositivo está sendo usado para gerar tokens em excesso para distribuição abusiva a dispositivos não confiáveis.

Com a recuperação de dispositivo, é possível armazenar alguns dados personalizados por dispositivo com aparelhos específicos, que podem ser recuperados de forma confiável quando o app for instalado novamente no mesmo dispositivo.

Depois de ativar as informações opcionais, a resposta da API vai incluir novos campos e respostas no veredito:

Detalhes do ambiente

O risco de acesso a apps informa se outros apps estão em execução e podem ser usados para capturar a tela, mostrar sobreposições ou controlar o dispositivo. Os serviços de acessibilidade verificados conhecidos pelo Google Play são excluídos automaticamente desse veredito.

O veredito do Play Protect informa se o Google Play Protect está ativado no dispositivo e se ele encontrou malware conhecido.

Depois de ativar as informações opcionais, a resposta da API vai incluir novos campos e respostas no veredito:

Definir as configurações de solicitações clássicas (opcional)

Pule esta seção se você quiser fazer apenas solicitações de API padrão.

Por padrão, o Google Play gerencia a criptografia de respostas, ou seja, seu back-end chama o servidor do Google para descriptografar veredictos. Se preferir, gerencie as chaves por conta própria para descriptografar localmente no seu ambiente de servidor seguro.

Permitir que o Google gerencie sua criptografia de resposta (recomendado)

Recomendamos permitir que o Google gere e gerencie chaves para proteger a segurança do app. O back-end vai chamar o servidor do Google Play para descriptografar e verificar as respostas.

Gerenciar suas próprias chaves de criptografia

Para descriptografar localmente no seu próprio ambiente de servidor seguro, faça o download das chaves de criptografia no Play Console ou no Play SDK Console. Seu app precisa estar disponível no Google Play para usar esse recurso.

Antes de mudar sua estratégia de gerenciamento de criptografia de resposta no Play Console, verifique se o servidor está configurado corretamente para descriptografar e verificar os tokens de integridade nos servidores do Google Play para evitar interrupções.

Alternar entre chaves de criptografia gerenciadas pelo Google e autogerenciadas

1. Abra o Play Console e selecione seu app .
2. Acesse Testar e lançar > Integridade do app.
3. Ao lado de API Play Integrity, clique em Configurações.
4. Em Solicitações clássicas, ao lado de Criptografia de resposta, clique em Editar.

Para mudar para chaves gerenciadas por você:

1. Selecione Gerenciar e fazer o download das minhas próprias chaves de criptografia de resposta e faça upload da sua chave pública.
2. Clique em Salvar para baixar automaticamente as chaves criptografadas.
3. Atualize seu servidor de back-end seguro para descriptografar localmente usando essas chaves.

Para mudar para chaves gerenciadas pelo Google:

1. Selecione Permitir que o Google gerencie minhas chaves de criptografia de resposta (recomendado).
2. Clique em Salvar alterações.