diff --git a/src/content/docs/zh/sdk/unity/v5/integrations/signature-library.mdx b/src/content/docs/zh/sdk/unity/v5/integrations/signature-library.mdx index c4c5ac022..ea672edc4 100644 --- a/src/content/docs/zh/sdk/unity/v5/integrations/signature-library.mdx +++ b/src/content/docs/zh/sdk/unity/v5/integrations/signature-library.mdx @@ -1,60 +1,60 @@ --- -title: SDK 签名库集成 -description: 将签名库添加到您的 Unity 应用，确保 Adjust SDK 和 Adjust 服务器之间通讯的安全。 -slug: zh/sdk/unity/integrations/signature-library -versions: - - label: v5 - value: v5 - default: true - - label: v4 - value: v4 -redirects: - v4: /zh/sdk/unity/v4/integrations/signature-library +title: "SDK 签名库集成" +description: "将签名库添加到您的 Unity 应用，确保 Adjust SDK 和 Adjust 服务器之间通讯的安全。" +slug: "en/sdk/unity/integrations/signature-library" +versions: + - + label: "v5" + value: "v5" + default: true + - + label: "v4" + value: "v4" +redirects: + v4: "/en/sdk/unity/v4/integrations/signature-library" --- - Adjust 的 SDK 签名库是 Adjust SDK 的一款独立插件，也就是说，您无需变更代码或改变在应用中使用 Adjust SDK 的方式，即可使用 SDK 签名库。安装插件后，Adjust SDK 发出的所有请求都将继续如常运行。 -## 操作前须知 {#before-you-begin} +操作前须知 \{\#before\-you\-begin\} +----------------------------------- - + 在 [3\.32\.0 或更高版本](https://github.com/adjust/adjust_signature_sdk/releases/tag/v3.32.0)中，SDK 签名库被配置为使用 [16KB 的页面大小](https://developer.android.com/guide/practices/page-sizes)。 - - + 要将签名库集成到您的 Unity 应用，请确保满足下列条件： -- 正在使用的安卓API 为 **21 或更高版本** 。 -- 正在使用的 Adjust SDK 为 **4\.37\.2 或更高版本** 。即使是间接使用 Adjust SDK 的情况，此要求也同样适用。 -- 如果您使用了 ProGuard，那么签名库和 Adjust SDK 须使用完全相同的 ProGuard 配置。 +* 正在使用的安卓API 为 **21 或更高版本** 。 +* 正在使用的 Adjust SDK 为 **4\.37\.2 或更高版本** 。即使是间接使用 Adjust SDK 的情况，此要求也同样适用。 +* 如果您使用了 ProGuard，那么签名库和 Adjust SDK 须使用完全相同的 ProGuard 配置。 - + 在 Adjust SDK 或签名库中使用外部模糊处理工具可能会影响签名库的功能。如果您不确定是否要使用外部工具，请联系您的 Adjust 代表或发送电子邮件至[support@adjust.com](mailto:support@adjust.com)，确认相关功能是否受到影响。 + - - -### 从 Signature V1 或 V2 库过渡{#migrating-from-signature-v1-or-v2-library} +### 从 Signature V1 或 V2 库过渡\{\#migrating\-from\-signature\-v1\-or\-v2\-library\} 如果您之前使用的是 Signature v1 或 Signature v2，请先移除旧版本，然后再集成签名库。 为此请进行下列操作： -- 如果您之前已经集成了 Signature V1，请移除项目中所有会调用签名功能的代码。 -- 如果您之前已经集成了 Signature V2，请从您的项目中移除 Signature V2 库。 +* 如果您之前已经集成了 Signature V1，请移除项目中所有会调用签名功能的代码。 +* 如果您之前已经集成了 Signature V2，请从您的项目中移除 Signature V2 库。 -### 更新签名库{#updating-the-signature-library} +### 更新签名库\{\#updating\-the\-signature\-library\} -要更新 Adjust 签名库，请用新版本替换现有的签名库，然后重新运行测试。只要您的[证书已配置且未被更改](https://help.adjust.com/zh/article/sdk-signature#manage-your-certificate-fingerprints)，就无需立即在 Adjust 中对应用逻辑或设置进行任何更改。[如果密钥 ID 满足以下条件，请务必停用](https://help.adjust.com/zh/article/sdk-signature#manage-your-secret-ids)： +要更新 Adjust 签名库，请用新版本替换现有的签名库，然后重新运行测试。只要您的[证书已配置且未被更改](https://help.adjust.com/en/article/sdk-signature#manage-your-certificate-fingerprints)，就无需立即在 Adjust 中对应用逻辑或设置进行任何更改。[如果密钥 ID 满足以下条件，请务必停用](https://help.adjust.com/en/article/sdk-signature#manage-your-secret-ids)： -- 应用密钥已不再适用于安装报告。 -- 您已经在所有应用平台和商店中全面发布了应用的新版本。 +* 应用密钥已不再适用于安装报告。 +* 您已经在所有应用平台和商店中全面发布了应用的新版本。 -## 集成签名库 \(仅限 SDK v4\){#integrate-the-signature-library} +集成签名库 \(仅限 SDK v4\)\{\#integrate\-the\-signature\-library\} +------------------------------------------------------------------- - + Adjust SDK v5 原生支持 SDK 签名验证。如果您之前集成了 SDK 签名库，请将其卸载并移除所有相关代码。 - - + 请按照下列步骤操作，将签名库集成入您的 Unity 项目中。 @@ -64,27 +64,25 @@ Adjust SDK v5 原生支持 SDK 签名验证。如果您之前集成了 SDK 签 一切就绪！签名库现已集成到您的项目中。请按照下一节说明的步骤操作，配置您的数字证书。 -## 在 Adjust 套件中设置证书{#set-up-your-certificates-in-the-adjust-suite} +在 Adjust 套件中设置证书\{\#set\-up\-your\-certificates\-in\-the\-adjust\-suite\} +----------------------------------------------------------------------------------- - + 只有针对 **安卓** 的应用才需要进行这一步操作。 - - + 将签名库集成到应用中后，Adjust SDK 向 Adjust 发送的所有请求都会带有签名。Adjust SDK 还会向 Adjust 服务器发送相关信息，包括您的签名证书指纹。 证书指纹是证书中公开信息的加密哈希值，可以用来验证应用的真实性。 签名库无法验证证书指纹的真实性。请在 Adjust suite 中将指纹加入许可名单，这样，Adjust 才会认定包含指纹的请求真实，并接受这些请求。为此，您需要调取证书指纹，将其发送给 Adjust。 - - + 您必须将签名证书的指纹添加至许可名单。如果未将任何指纹添加至许可名单，则来自应用的流量可能会被伪造。 + - - -#### 从密钥库获取证书指纹{#from-a-keystore} +#### 从密钥库获取证书指纹\{\#from\-a\-keystore\} 如果您使用了自己的密钥库，或 Android Studio 为您生成了密钥库，则可以按下列步骤操作，提取证书指纹。 @@ -93,7 +91,7 @@ Adjust SDK v5 原生支持 SDK 签名验证。如果您之前集成了 SDK 签 2. 运行以下指令，以列出密钥。请用您的信息替换尖括号中的内容。 ```console - $ keytool -list -v -keystore -alias + $ keytool -list -v -keystore -alias ``` 该命令会提示您输入密钥库密码。这是您在生成密钥库时定义的密码。 @@ -125,7 +123,7 @@ Adjust SDK v5 原生支持 SDK 签名验证。如果您之前集成了 SDK 签 3. 保存 SHA\-1 指纹，[添加到 Adjust suite 中的许可名单中](#add-your-digital-certificate-fingerprints-to-adjusts-allowlist)。 -#### 从 Google 内部应用分享获取证书指纹{#from-google-play-internal-app-sharing} +#### 从 Google 内部应用分享获取证书指纹\{\#from\-google\-play\-internal\-app\-sharing\} 如果您使用的是 [Google Play 内部应用分享](https://support.google.com/googleplay/android-developer/answer/9303479?hl=en)，则需要将您所在机构的 SHA\-1 证书指纹和内部测试证书指纹发送给 Adjust ，以将其加入许可名单。 @@ -133,12 +131,12 @@ Adjust SDK v5 原生支持 SDK 签名验证。如果您之前集成了 SDK 签 1. 登录 Google Play Console 2. 选择您的应用。 -3. 进入 **版本管理 \(Release management\) \-\-> 应用发布 \(App Releases\) \-> 管理内部应用分享 \(Manage internal app sharing\) > 应用证书 \(App certificates\)** +3. 进入 **版本管理 \(Release management\) \-\-> 应用发布 \(App Releases\) \-> 管理内部应用分享 \(Manage internal app sharing\) > 应用证书 \(App certificates\)** 4. 保存 **内部测试证书** 和您所在机构密钥库的 **SHA\-1 证书指纹** ，[将其添加入 Adjust suite 许可名单中](#add-your-digital-certificate-fingerprints-to-adjusts-allowlist)。 ![A screenshot of the certficate page in Google Play Console](@images/sig-v3/google-play-internal-sharing.png) -#### 从 Google Play 应用签名获取证书指纹{#from-google-play-app-signing} +#### 从 Google Play 应用签名获取证书指纹\{\#from\-google\-play\-app\-signing\} 如果您使用的是 [Google Play 应用签名](https://support.google.com/googleplay/android-developer/answer/7384423?hl=en)，则需要将所在机构的 SHA\-1 证书指纹和内部测试证书指纹发送给 Adjust ，以将其加入许可名单。 @@ -151,15 +149,13 @@ Adjust SDK v5 原生支持 SDK 签名验证。如果您之前集成了 SDK 签 ![A screenshot of the App signing page in the Google Play Console](@images/sig-v3/google-play-signing.png) -#### 从 Huawei AppGallery 应用签名获取证书指纹{#from-huawei-appgallery-app-signing} +#### 从 Huawei AppGallery 应用签名获取证书指纹\{\#from\-huawei\-appgallery\-app\-signing\} 如果您使用的是 Huawei AppGallery 应用签名，则需要将所在机构的 SHA\-1 证书指纹和内部测试证书指纹发送给 Adjust ，以将其加入许可名单。 - - + 如果您在 Huawei AppGallery 中使用自己的签名证书，请按照[从密钥库提取证书指纹的步骤](#from-a-keystore)操作。 - - + 要提取指纹，请按照下列步骤操作： @@ -181,13 +177,12 @@ Adjust SDK v5 原生支持 SDK 签名验证。如果您之前集成了 SDK 签 3. 保存指纹，[添加到 Adjust suite 中的许可名单中](#add-your-digital-certificate-fingerprints-to-adjusts-allowlist)。 -### 将您的数字证书指纹加入 Adjust 许可名单{#add-your-digital-certificate-fingerprints-to-adjust-s-allowlist} +### 将您的数字证书指纹加入 Adjust 许可名单\{\#add\-your\-digital\-certificate\-fingerprints\-to\-adjust\-s\-allowlist\} - + 请务必将要使用的所有证书指纹添加进 Adjust suite，包括调试版本和针对不同商店的版本。 - - + 获得证书指纹后，请按照下列步骤操作，将证书指纹加入许可名单： @@ -200,21 +195,20 @@ Adjust SDK v5 原生支持 SDK 签名验证。如果您之前集成了 SDK 签 一切就绪！您的指纹现已加入应用许可名单。 -## 测试应用{#test-your-app} +测试应用\{\#test\-your\-app\} +------------------------------ -您可以使用 [Adjust 测试控制台](https://help.adjust.com/zh/article/testing-console)验证签名库是否已正确集成进应用。 - - +您可以使用 [Adjust 测试控制台](https://help.adjust.com/en/article/testing-console)验证签名库是否已正确集成进应用。 + 请务必确保 Adjust SDK 处于 **sandbox 模式** 。 - - + 要测试您的签名库集成情况，请按照下列步骤操作。 1. 从测试设备中完全删除应用，确保安装信息能被正确发送。 -2. 使用测试控制台遗忘设备，清除与该设备相关的所有信息。您还可以发送从 Adjust InSights 应用 \(已推出 [iOS](https://apps.apple.com/us/app/adjust-insights/id1125517808) 和 [安卓](https://play.google.com/store/apps/details?id=com.adjust.insights) 版\) 中获得的应用识别码和广告 ID，以此使用 forget_device 终端。您可以使用以下任何广告 ID：`adid`、`android_id`、`gps_adid`、`idfa`、`idfv`、`imei`、`oaid`。 +2. 使用测试控制台遗忘设备，清除与该设备相关的所有信息。您还可以发送从 Adjust InSights 应用 \(已推出 [iOS](https://apps.apple.com/us/app/adjust-insights/id1125517808) 和 [安卓](https://play.google.com/store/apps/details?id=com.adjust.insights) 版\) 中获得的应用识别码和广告 ID，以此使用 forget\_device 终端。您可以使用以下任何广告 ID：`adid`、`android_id`、`gps_adid`、`idfa`、`idfv`、`imei`、`oaid`。 调用看上去应该是这样的： @@ -231,16 +225,18 @@ Adjust SDK v5 原生支持 SDK 签名验证。如果您之前集成了 SDK 签 如果这些字段没有缺失，且包含正确的信息，就说明签名库已经成功集成。如果字段中出现了不同的值，请再次检查集成步骤，或发送邮件到 [support@adjust.com](mailto:support@adjust.com) 获取支持。 -一切就绪！签名库已成功集成到您的应用。[等待两个归因窗口结束](https://help.adjust.com/zh/article/attribution-windows)，即可[执行 SDK 签名验证](https://help.adjust.com/zh/article/sdk-signature#enforce-signature-validation)，确保 Adjust 只接受带有签名的请求。 +一切就绪！签名库已成功集成到您的应用。[等待两个归因窗口结束](https://help.adjust.com/en/article/attribution-windows)，即可[执行 SDK 签名验证](https://help.adjust.com/en/article/sdk-signature#enforce-signature-validation)，确保 Adjust 只接受带有签名的请求。 -## 故障排查{#troubleshooting} +故障排查\{\#troubleshooting\} +---------------------------- ### Upload symbols failed 在验证或提交使用 Xcode 16 构建的应用时,您可能会遇到与签名库相关的`Upload symbols failed`警告。此缺失符号的情况是有意的，不会影响功能，因此可以忽略。 -### Unknown CPU Architecture in AdjustSigSdk.a {#unknown-cpu-architecture-in-adjustsigsdk-a} +### Unknown CPU Architecture in AdjustSigSdk.a \{\#unknown\-cpu\-architecture\-in\-adjustsigsdk\-a\} 在 Unity Editor 2018 和更新版本中，您可能会遇到 " **Unknown CPU Architecture** " 的错误信息。当 Unity Editor 试图针对非 iOS 平台应用 iOS 静态框架 \(`.a`\) 时，就会出现该报错。要解决该问题，请选择 `AdjustSigSdk.a` 文件，然后找到 **Import Settings** \(导入设置\) 菜单，取消勾选 **iOS** 以外的所有平台。 ![A screenshot of the AdjustSdk Import Settings in Unity Editor](@images/sig-v3/unity-import-settings.png) +