Настройка

На этой странице объясняется, как настроить приложение, игру или SDK для использования API Play Integrity. Для интеграции API вам потребуется проект Google Cloud, который необходим для отправки запросов. Затем вы можете подключить свой проект Google Cloud к Google Play Console (для приложений) или Google Play SDK Console (для SDK). Подключение проекта необходимо для доступа к дополнительным параметрам конфигурации, функциям тестирования, отчётности API и запроса на увеличение вашей ежедневной квоты запросов.

Включить API целостности воспроизведения

Каждое приложение или SDK, вызывающее API Play Integrity, должно иметь проект Google Cloud для использования API и мониторинга использования. Это обязательный первый шаг для любой интеграции. Вы можете включить API Play Integrity в консоли Google Cloud или сразу перейти к подключению своего проекта Cloud к Google Play, и API Play Integrity будет включен автоматически.

В консоли Google Cloud Console создайте новый проект Cloud или выберите существующий проект Cloud, который вы хотите использовать с API Play Integrity.

1. Перейдите в раздел API и сервисы .
2. Выберите Включить API и службы .
3. Найдите Play Integrity API .
4. Нажмите «Включить» .

Теперь вы можете интегрировать API Play Integrity в своё приложение. Чтобы получить доступ к расширенным функциям и увеличению квот, необходимо перейти к этапу привязки.

Ссылка на Google Play (рекомендуется)

Свяжите свое приложение или SDK с Google Play, следуя этим инструкциям.

Для приложений и игр в Google Play

Приложения, распространяемые в Google Play, должны связать свой проект Google Cloud в консоли Google Play, чтобы включить дополнительные функции и запросить увеличенную ежедневную квоту API.

1. Откройте Google Play Console и выберите свое приложение.
2. Перейдите в раздел Тестирование и выпуск > Целостность приложения .
3. В разделе Play Integrity API нажмите Связать облачный проект .
4. Выберите проект Google Cloud, который вы планируете использовать с Play Integrity API; если Play Integrity API еще не включен для проекта, он будет включен автоматически при связывании.

Для поставщиков SDK в Play SDK Console

Поставщики SDK, использующие Google Play SDK Console, могут связать свой проект Google Cloud, чтобы приписывать использование API к SDK, а не к отдельным приложениям, использующим его, включать дополнительные функции и запрашивать увеличение ежедневной квоты API. Обратите внимание, что доступ к Google Play SDK Console регулируется критериями соответствия .

1. Откройте Google Play SDK Console и выберите свой SDK.
2. Перейдите к целостности SDK
3. В разделе Play Integrity API нажмите Связать облачный проект .
4. Выберите проект Google Cloud, который вы планируете использовать с Play Integrity API; если Play Integrity API еще не включен для проекта, он будет включен автоматически при связывании.

Понимание ограничений использования API Play Integrity

Для вашего приложения или SDK установлен лимит в 10 000 запросов в день, привязанный к номеру облачного проекта. Если вы ожидаете большего объёма запросов, вы можете запросить увеличение квоты.

Увеличьте максимальное количество ежедневных запросов

Увеличение квоты зависит от критериев соответствия. Увеличение квоты распространяется как на генерацию токенов на стороне клиента, так и на вызовы дешифрования на стороне сервера. Обработка запросов может занять до недели. Мы рекомендуем отслеживать использование Play Integrity API в консоли Google Cloud и настраивать оповещения о превышении квоты, чтобы избежать перебоев в работе сервиса.

Даже при более высокой квоте продолжайте ограничивать классические запросы редкими, но высокоценными действиями, чтобы экономить заряд батареи пользователя и использование данных.

Для приложений и игр в Google Play

Чтобы претендовать на увеличение квоты, ваше приложение должно быть доступно в Google Play, а также в других каналах распространения. Вам необходимо связать свой проект Google Cloud с приложением в Play Console . Запросы на увеличение квоты от несвязанных проектов будут отклонены.

Чтобы запросить увеличение:

1. Подключите соответствующий проект Google Cloud в Play Console .
2. Убедитесь, что вы правильно реализовали логику API, включая правильные стратегии повторных попыток.
3. Подайте форму запроса на квоту .

Для поставщиков SDK в Play SDK Console

Чтобы претендовать на увеличение квоты, ваш SDK должен быть заявлен в Google Play SDK Console, а ваш облачный проект должен быть связан с вашим SDK там же. Доступ к Google Play SDK Console предоставляется при соблюдении критериев соответствия .

Чтобы запросить увеличение:

1. Подключите свой проект Google Cloud к консоли Google Play SDK .
2. Заполните форму поддержки Google Play SDK Console .

В разделе открытых комментариев опишите свой вариант использования, тип запросов к API, которые вы делаете (стандартные, классические или оба), частоту запросов и желаемое максимальное количество запросов в день.

Интегрируйте API Play Integrity в свое приложение

Чтобы интегрировать Play Integrity API в ваше приложение или SDK, выполните одно из следующих действий в зависимости от вашей среды разработки:

Котлин или Java

Последняя версия библиотеки Android для API Play Integrity доступна в репозитории Maven от Google . Добавьте следующую зависимость в файл build.gradle вашего приложения:

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

Единство

В следующих разделах описывается, как интегрировать и настроить API Google Play Integrity для проектов Unity, включая поддерживаемые версии Unity, методы установки и настройку среды.

Поддерживаемые версии Unity

• Поддерживаются все версии 2019.x, 2020.x и новее.
• Если вы используете Unity 2018.x, поддерживается версия 2018.4 и более новая.
• Unity 2017.x и более старые версии не поддерживаются.

Настройте среду разработки

openupm add com.google.play.integrity

Unreal Engine

В следующих разделах описывается, как интегрировать и настроить Google Play Integrity API для проектов Unreal Engine.

Поддерживаемые версии Unreal Engine

Плагин поддерживает Unreal Engine 5.0 и все последующие версии.

Настройте среду разработки

1. Загрузите плагин Play Unreal Engine из репозитория GitHub.

2. Скопируйте папку GooglePlay в папку Plugins вашего проекта Unreal Engine.

3. Откройте проект Unreal Engine и нажмите Редактировать → Плагины .

4. Найдите Google Play и установите флажок «Включено» .

5. Перезапустите игровой проект и запустите сборку.

6. Откройте файл Build.cs вашего проекта и добавьте модуль PlayIntegrity в PublicDependencyModuleNames :

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

Родной

Следуйте руководству по настройке . Подробнее см. в справочной документации по API Play Integrity.

Настроить ответы API (необязательно)

Ответ API включает вердикты по умолчанию, возвращаемые в каждом запросе. Если вы связали свой проект Cloud с Play Console или Play SDK Console, вы можете настроить ответ API, включив в него дополнительную информацию.

Вердикты о целостности по умолчанию

По умолчанию в ответе API Play Integrity возвращаются следующие вердикты целостности:

Google Play Игры для ПК

Если вы распространяете игру в Google Play Games для ПК , вы автоматически соглашаетесь на получение дополнительной метки в вердикте о целостности устройства:

Дополнительные вердикты о целостности

Если вы связали свой облачный проект в Play Console или Play SDK Console, вы можете подписаться на получение дополнительной информации.

Чтобы внести изменения, откройте Play Console и выберите «Тестирование и выпуск» > «Целостность приложения» . Рядом с пунктом «Play Integrity API» нажмите «Настройки» . Нажмите «Изменить ответы» , отредактируйте и сохраните изменения.

Информация об устройстве

Дополнительные метки устройств в вердикте deviceIntegrity предоставляют дополнительную информацию о среде устройства, в которой работает приложение. Одно устройство возвращает несколько меток, если оно соответствует критериям каждой из них. Эти метки можно использовать для создания многоуровневой стратегии контроля. Например, вы можете доверять устройству, возвращающему три метки ( MEETS_STRONG_INTEGRITY , MEETS_DEVICE_INTEGRITY и MEETS_BASIC_INTEGRITY ), больше, чем устройству, возвращающему только одну метку ( MEETS_BASIC_INTEGRITY ).

Атрибуты устройства содержат информацию о версии Android SDK ОС Android, установленной на устройстве. В будущем этот список может быть расширен другими атрибутами устройства.

Недавняя активность устройства отображается в диапазоне от LEVEL_1 (низкое количество запросов) до LEVEL_4 (высокое количество запросов). Высокий уровень активности может указывать на то, что устройство используется для генерации избыточного количества токенов для незаконной рассылки на ненадежные устройства.

Функция отзыва устройств позволяет вам сохранять некоторые индивидуальные данные для каждого устройства, которые вы сможете надежно извлечь при повторной установке приложения на том же устройстве.

После того, как вы согласитесь на предоставление дополнительной информации, ваш ответ API будет включать новые поля и ответы в вердикте:

Подробности об окружающей среде

Риск доступа к приложениям показывает, запущены ли другие приложения, которые могут использоваться для захвата экрана, отображения оверлеев или управления устройством. Проверенные службы специальных возможностей, известные Google Play, автоматически исключаются из этого вердикта.

Вердикт Play Protect сообщает, включена ли функция Google Play Protect на устройстве и обнаружено ли известное вредоносное ПО.

После того, как вы согласитесь на предоставление дополнительной информации, ваш ответ API будет включать новые поля и ответы в вердикте:

Настройте параметры классического запроса (необязательно)

Пропустите этот раздел, если вы планируете делать только стандартные запросы API .

По умолчанию шифрованием ответов управляет Google Play, то есть ваш бэкенд обращается к серверу Google для расшифровки вердиктов. Кроме того, вы можете самостоятельно управлять ключами для расшифровки локально в защищённой серверной среде.

Позвольте Google управлять шифрованием вашего ответа (рекомендуется)

Мы рекомендуем разрешить Google генерировать и управлять ключами для защиты безопасности вашего приложения. Ваш бэкенд будет обращаться к серверу Google Play для расшифровки и проверки ответов.

Управляйте собственными ключами шифрования

Для локальной расшифровки в вашей защищенной серверной среде вы можете загрузить ключи шифрования из Play Console или Play SDK Console. Для использования этой функции ваше приложение должно быть доступно в Google Play.

Прежде чем изменять стратегию управления шифрованием ответов в Play Console, убедитесь, что ваш сервер правильно настроен для расшифровки и проверки токенов целостности на серверах Google Play, чтобы избежать сбоев.

Переключение между ключами шифрования, управляемыми Google, и ключами шифрования, управляемыми самостоятельно

1. Откройте Play Console и выберите свое приложение.
2. Перейдите в раздел Тестирование и выпуск > Целостность приложения .
3. Рядом с Play Integrity API нажмите Настройки .
4. В разделе Классические запросы , рядом с пунктом Шифрование ответов , нажмите Изменить .

Чтобы перейти на самостоятельное управление ключами:

1. Выберите «Управление» и загрузите мои ключи шифрования ответов , а затем загрузите свой открытый ключ.
2. Нажмите «Сохранить» , чтобы автоматически загрузить зашифрованные ключи.
3. Обновите защищенный внутренний сервер для локальной расшифровки с помощью этих ключей.

Чтобы перейти на ключи, управляемые Google:

1. Выберите Разрешить Google управлять шифрованием моих ответов (рекомендуется) .
2. Нажмите Сохранить изменения .