设置

本页介绍了如何设置应用、游戏或 SDK 以使用 Play Integrity API。如需集成该 API，您必须拥有一个 Google Cloud 项目，这是开始发出请求的必要条件。然后，您可以在 Google Play 管理中心（针对应用）或 Google Play SDK 管理中心（针对 SDK）内关联您的 Google Cloud 项目。您必须关联项目，才能使用其他配置选项、测试功能、API 报告，以及申请提高每日请求配额。

启用 Play Integrity API

每个调用 Play Integrity API 的应用或 SDK 都必须拥有一个 Google Cloud 项目，才能使用该 API 并监控使用情况。这是所有集成都必须执行的第一步。您可以在 Google Cloud 控制台中启用 Play Integrity API，也可以直接跳过此步骤，将 Cloud 项目关联到 Google Play，系统会自动为您启用 Play Integrity API。

在 Google Cloud 控制台中，新建一个 Cloud 项目，或者选择一个要与 Play Integrity API 搭配使用的现有 Cloud 项目。

1. 前往 API 和服务。
2. 选择启用 API 和服务。
3. 搜索 Play Integrity API。
4. 点击启用。

现在，您即可将 Play Integrity API 集成到您的应用中。如需使用高级功能并获得配额增加，您必须继续执行关联步骤。

关联到 Google Play（推荐）

按照这些说明将您的应用或 SDK 关联到 Google Play。

适用于 Google Play 上的应用和游戏

在 Google Play 上分发的应用应在 Google Play 管理中心内关联其 Google Cloud 项目，以启用其他功能并申请提高每日 API 配额。

1. 打开 Google Play 管理中心，然后选择您的应用。
2. 依次前往测试和发布 > 应用完整性。
3. 在 Play Integrity API 下，点击关联 Cloud 项目。
4. 选择您计划与 Play Integrity API 搭配使用的 Google Cloud 项目；如果该项目尚未启用 Play Integrity API，则在关联后会自动启用。

面向 Play SDK 管理中心内的 SDK 提供方

使用 Google Play SDK 管理中心的 SDK 提供方可以关联其 Google Cloud 项目，以便将 API 使用情况归因于 SDK，而不是归因于使用该 SDK 的各个应用；此外，还可以启用其他功能并申请提高每日 API 配额。请注意，访问 Google Play SDK 管理中心需满足资格条件。

1. 打开 Google Play SDK 管理中心，然后选择您的 SDK。
2. 前往 SDK 完整性
3. 在 Play Integrity API 下，点击关联 Cloud 项目。
4. 选择您计划与 Play Integrity API 搭配使用的 Google Cloud 项目；如果该项目尚未启用 Play Integrity API，则在关联后会自动启用。

了解 Play Integrity API 使用量限制

您的应用或 SDK 的默认每日总请求数上限为 10,000 次，与关联的 Cloud 项目编号相关联。如果您预计用量会增加，可以申请提高配额。

提高您的每日请求次数上限

配额增加须符合资格条件。配额增加同时适用于客户端令牌生成和服务器端解密调用。处理请求最多可能需要一周时间。我们建议您在 Google Cloud 控制台中监控 Play Integrity API 的使用情况，并设置配额提醒，以免服务中断。

即使配额更高，也应继续将传统请求限制为不频繁的高价值操作，从而节省用户电量和数据流量。

适用于 Google Play 上的应用和游戏

若要符合提高配额的条件，您的应用除了要能通过任何其他渠道分发外，还必须在 Google Play 上架。您必须在 Play 管理中心内将 Google Cloud 项目与应用相关联。来自未关联项目的配额请求将被拒绝。

如需申请增加配额，请执行以下操作：

1. 在 Play 管理中心内关联相关的 Google Cloud 项目。
2. 验证您是否已正确实现 API 逻辑（包括适当的重试策略）。
3. 提交配额申请表单。

面向 Play SDK 管理中心内的 SDK 提供方

如需申请增加配额，您必须在 Google Play SDK 管理中心内声明您的 SDK，并且您的 Cloud 项目必须与该 SDK 相关联。 您必须符合资格条件，才能访问 Google Play SDK 管理中心。

如需申请增加配额，请执行以下操作：

1. 在 Google Play SDK 管理中心内关联您的 Google Cloud 项目。
2. 填写 Google Play SDK 管理中心支持表单。

在公开评论部分，请描述您的使用情形、您发出的 API 请求类型（标准或经典或两者兼有）、您发出请求的频率以及您希望获得的每日请求次数上限。

将 Play Integrity API 集成到您的应用中

如需将 Play Integrity API 集成到您的应用或 SDK 中，请根据您的开发环境执行以下其中一项操作：

Kotlin 或 Java

Google 的 Maven 制品库提供了适用于 Play Integrity API 的最新 Android 库。将以下依赖项添加到应用的 build.gradle 文件中：

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

Unity

以下部分介绍了如何为 Unity 项目集成和设置 Google Play Integrity API，包括支持的 Unity 版本、安装方法和环境设置。

支持的 Unity 版本

• 所有 2019.x、2020.x 版本和更高版本均受支持。
• 如果您使用的是 Unity 2018.x，则支持 2018.4 或更高版本。
• 不支持 Unity 2017.x 及更低版本。

设置您的开发环境

openupm add com.google.play.integrity

Unreal Engine

以下部分介绍了如何为 Unreal Engine 项目集成和设置 Google Play Integrity API。

支持的 Unreal Engine 版本

该插件支持 Unreal Engine 5.0 及所有后续版本。

设置您的开发环境

1. 从 GitHub 代码库下载 Play Unreal Engine 插件。

2. 将 GooglePlay 文件夹复制到 Unreal Engine 项目中的 Plugins 文件夹内。

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");
   
       // ...
     }
   }
   

原生

按照原生设置指南操作。如需了解详情，请参阅 Play Integrity 的原生 API 参考文档。

配置 API 响应（可选）

API 响应包含每个请求中返回的默认判定结果。如果您已在 Play 管理中心或 Play SDK 管理中心内关联 Cloud 项目，则可以自定义 API 响应以包含其他信息。

默认完整性判定

默认情况下，Play Integrity API 响应中会返回以下完整性判定结果：

Google Play 游戏电脑版

如果您的应用分发到 Google Play Games 电脑版，则会自动选择在设备完整性判定结果中接收其他标签：

可选完整性判定

如果您已在 Play 管理中心或 Play SDK 管理中心内关联 Cloud 项目，则可以选择接收其他信息。

如需进行更改，请访问 Play 管理中心，然后依次前往测试和发布 > 应用完整性。点击 Play Integrity API 旁边的设置。点击更改响应，修改并保存更改。

设备信息

deviceIntegrity 判定结果中的其他设备标签可让您详细了解应用所运行的设备环境。如果一部设备满足多个标签的条件，则会返回多个标签。 您可以使用这些标签来制定分级违规处置策略。例如，与仅返回一个标签 (MEETS_BASIC_INTEGRITY) 的设备相比，您可以选择更信任返回三个标签（MEETS_STRONG_INTEGRITY、MEETS_DEVICE_INTEGRITY 和 MEETS_BASIC_INTEGRITY）的设备。

设备属性会告知您设备上 Android 操作系统的 Android SDK 版本。未来，可能会添加其他设备属性。

近期设备活动记录会返回一个介于 LEVEL_1（请求数量较少）到 LEVEL_4（请求数量较多）之间的级别。高活动水平可能表明设备正被用于生成过多的令牌，以滥用方式分发给非可信设备。

借助设备回想，您可以将一些自定义的每台设备数据与特定设备相关联，以便在日后于同一设备上重新安装应用时可靠地检索这些数据。

选择启用可选信息后，您的 API 响应将在判定结果中包含以下新字段和响应：

环境详情

应用访问风险信号会告知您是否有其他正在运行的应用可能会用于截屏、显示叠加层或控制设备。Google Play 已知的经过验证的无障碍服务会自动从这一判定结果中排除。

Play 保护机制判定旨在向您告知 Google Play 保护机制是否已在设备上启用，以及该机制是否发现了已知的恶意软件。

选择启用可选信息后，您的 API 响应将在判定结果中包含以下新字段和响应：

配置传统请求设置（可选）

如果您只计划发出标准 API 请求，请跳过此部分。

默认情况下，Google Play 会管理响应加密，这意味着您的后端会调用 Google 的服务器来解密判定结果。或者，您也可以自行管理密钥，以便在安全服务器环境中进行本地解密。

让 Google 管理您的响应加密（推荐）

为保证应用的安全性，建议您允许 Google 生成和管理密钥。您的后端将调用 Google Play 的服务器来解密和验证响应。

管理您自己的加密密钥

如需在自己的安全服务器环境中以本地方式解密，您可以从 Play 管理中心或 Play SDK 管理中心下载加密密钥。您的应用必须在 Google Play 上发布，才能使用此功能。

在 Play 管理中心内更改响应加密管理策略之前，请确保您的服务器已正确配置为在 Google Play 服务器上解密并验证完整性令牌，以免服务中断。

在 Google 管理的加密密钥和自行管理的加密密钥之间切换

1. 打开 Play 管理中心，然后选择您的应用。
2. 依次前往测试和发布 > 应用完整性。
3. 点击 Play Integrity API 旁边的设置。
4. 在传统请求下，点击响应加密旁边的修改。

如需切换到自行管理的密钥，请执行以下操作：

1. 选择管理和下载我的响应加密密钥，然后上传您的公钥。
2. 点击保存，系统会自动下载加密的密钥。
3. 更新安全后端服务器，以便使用这些密钥在本地解密。

如需改用 Google 管理的密钥，请执行以下操作：

1. 选择让 Google 管理我的响应加密事宜（推荐）。
2. 点击保存更改。