Capacitor 应用程序的隐私清单指南

想发布您的 Capacitor app 在 App Store 不需要延迟? 首先创建一个隐私清单。苹果现在要求开发者包含此文档，以确保应用程序符合严格的隐私标准。以下是您需要了解的内容：

什么是隐私清单?
一个结构化的文件，概述了您的应用程序的数据收集实践、API 使用和跟踪域名。
为什么它很重要：
- 遵守 App Store 规则，以避免拒绝或移除。
- 通过透明地处理用户数据来建立信任。
需要包含的关键组件：
- 访问用户数据的 API（例如，位置、照片）。
- 收集的数据类型的隐私标签。
- 用于分析或广告的跟踪域名。
如何创建一个:
- 使用 JSON 定义数据收集详细信息。
- 将 PrivacyInfo.xcprivacy 文件放在您的项目的正确目录中。
- 使用工具进行验证以避免错误。简化过程的工具:
使用平台
__CAPGO_KEEP_0__ Capgo Xcode

遵守相关规定，保护用户隐私，避免应用商店延迟，按照以下指南进行操作。

隐私清单基础

隐私清单定义

隐私清单是一种结构化的文件，概述了您的应用程序的数据处理实践。它详细说明了像API访问用户数据、跟踪域名、收集的数据类型以及第三方SDK集成等元素。这份文件不仅有助于建立信任，还确保了与应用商店指南的遵守。让我们分解一下您清单中应该包含的关键组件。

主要隐私清单元素

以下是您需要在隐私清单中包含的主要元素，以符合苹果的要求:

必填原因API
此部分列出了您的应用程序使用的隐私敏感API，并解释了它们为什么是必要的。

以下是常见API要求的表格摘要:

API类别常用用途必填文档
位置服务用户导航目的和使用说明
相册个人照片访问级别和意图
联系人地址簿同步数据最小化声明
隐私标签
这些标签通过指定:
- 正在收集的数据类型
- 数据收集的原因
- 数据是否与用户身份相关
- 数据如何用于跟踪
跟踪域名
本节列出了所有参与跟踪的域名，例如用于分析、广告或第三方数据处理的域名。

API类别	常用用途	必填文档
位置服务	用户导航	目的和使用说明
相册	个人照片	访问级别和意图
联系人	地址簿同步	数据最小化声明

“App Store compliant” - Capgo [1]

According to Capgo, 95% of users comply with updates within 24 hours. With over 23.5 million updates delivered [1]根据

为 Capacitor

Capacitor Framework Documentation Website

Setup Requirements

在开始构建清单之前，请确保您已经:

已安装 Xcode 15 或更高版本
已设置 Capacitor 8.0+ 项目
访问您的应用程序的 Info.plist 文件
了解 JSON 结构的基本知识
概述了您的应用程序的数据收集实践

创建步骤

从开始创建一个 PrivacyInfo.xcprivacy 文件在您的 iOS 项目目录中。该文件必须遵循特定的格式指南：

设置基本信息

{
    "NSPrivacyTracking": false,
    "NSPrivacyTrackingDomains": [],
    "NSPrivacyCollectedDataTypes": []
}

定义数据收集详细信息

{
    "NSPrivacyAccessedAPITypes": [
        {
            "NSPrivacyAccessedAPIType": "NSLocationWhenInUseUsageDescription",
            "NSPrivacyAccessedAPITypeReasons": ["1.1"]
        },
        {
            "NSPrivacyAccessedAPIType": "NSCameraUsageDescription",
            "NSPrivacyAccessedAPITypeReasons": ["2.1"]
        }
    ]
}

添加跟踪域名

{
    "NSPrivacyTrackingDomains": [
        "analytics.yourdomain.com",
        "metrics.yourdomain.com"
    ]
}

避免常见错误

为了防止问题，记住以下提示：

包含所有必填字段: 即使某些字段为空，也必须存在。
使用有效的API类型: 检查API标识符与苹果官方文档的对应关系。
检查JSON格式: 将文件通过JSON校验器运行以捕捉语法错误。
提供完整的原因: 确保每个API访问都包含一个相应的原因code。
保持信息最新: 在添加新功能时更新清单。

另外，请确保清单文件保持在512KB以下，以避免构建错误。定期在Xcode的构建过程中验证该文件，以早期捕捉错误。完成清单后，请按照文件放置指南将其整合到您的Capacitor项目中。

为Capacitor添加隐私清单

文件放置指南

要将隐私清单包含在您的Capacitor项目中，请将 PrivacyInfo.xcprivacy 文件放置在以下目录结构中：

your-app/
├── ios/
│   ├── App/
│   │   ├── PrivacyInfo.xcprivacy
│   │   └── Info.plist
│   └── App.xcworkspace

对于Capacitor插件，请使用以下结构：

your-plugin/
├── ios/
│   ├── Plugin/
│   │   └── PrivacyInfo.xcprivacy
│   └── Plugin.xcodeproj

构建设置配置

将文件放置后，请更新您的Xcode构建设置，以确保它正确整合：

打开您的项目在Xcode中。
在 TARGETS选择您的应用程序或插件目标。
前往 构建设置 选项卡。
设置 隐私清单开发区域 到 en.
设置 包含隐私清单 如果您的项目使用 YES.

CocoaPods select your app or plugin target.包括以下内容以启用隐私清单： Podfile 为了使隐私清单正常工作，请遵循以下步骤：

post_install do |installer|
  installer.pods_project.targets.each do |target|
    target.build_configurations.each do |config|
      config.build_settings['INCLUDE_PRIVACY_MANIFEST'] = 'YES'
    end
  end
end

实现检查

为了确保隐私清单正常工作，请遵循以下步骤：

构建验证

在构建过程中确认没有隐私相关的警告。
- 确保清单编译无问题。
- 验证隐私清单已包含在构建产品中。
- 运行时验证
在调试模式下，测试正确的隐私提示和__CAPGO_KEEP_0__访问行为。
- In debug mode, test for proper privacy prompts and API access behavior.
为了确保隐私清单在 App Store Connect 中正常工作，请遵循以下步骤：
- 在 App Store Connect 中上传您的构建并查看隐私报告。
- 检查 API 声明是否完整，并确保跟踪域名格式正确。

如果您遇到“隐私清单验证失败”的错误，请检查您的清单以确保它符合最新的 App Store 要求。特别注意 API 类型和跟踪域名配置。

Apple 隐私清单更改

测试和修复

创建符合 Apple 指引的隐私清单至关重要。为了保持进度，集成可靠的错误跟踪工具到您的开发过程中。这有助于将开发努力与遵守要求联系起来。

像这样的工具可以帮助。它监控 Capgo 访问并识别清单问题之前就能影响用户。一次潜在问题被标记后，您可以将重点转移到彻底验证上。 can help. It monitors API access and identifies manifest issues before they affect users. Once potential problems are flagged, you can shift your focus to thorough validation.

__CAPGO_KEEP_0__

Capgo 隐私工具

Capgo 实时更新控制台界面

Capgo 简化了隐私清单和应用程序更新的管理，确保您的隐私标准保持完整，而不会延迟部署。

Capgo 功能

超过 23.5 万次安全更新 和一个 全球成功率 82% , __CAPGO_KEEP_0__ 确保了, Capgo ensures that 以下是它提供的内容： [1]端到端加密

隐私清单和应用程序更新的管理 为了保持更新安全
频道系统 用于控制更新分发
错误跟踪 快速识别和解决问题
一键回滚 立即回滚到上一个版本

这些工具使得将Capgo添加到您的工作流程变得顺畅和高效。

使用Capgo

开始之前，请安装Capgo插件使用以下命令：

npx @capgo/cli init

Capgo 与 CI/CD pipeline 无缝整合，通过平台如 GitHub Actions, GitLab CI, 或 Jenkins，自动验证隐私清单。无论您选择云或自主托管选项，Capgo 支持 750 个生产应用程序，同时确保每次更新都符合隐私标准。

“我们实行敏捷开发，@Capgo 在为用户持续交付中扮演着mission-critical角色！” – Rodrigo Mantica

“Capgo is a smart way to make hot code pushes 🙂” – NASA’s OSIRIS-REx

Capgo 还包括内置分析功能，实时监测更新成功率和用户参与度。这确保了隐私更新能够覆盖整个用户群，同时保持与 Apple 指南的兼容性。

结论

关键点

在管理隐私清单、保持兼容性和维持强大安全措施方面，非常关键。以下是最重要的内容：

端到端加密: 从开始到结束都保持更新的安全性。
实时监控: 高效地跟踪更新的分布。
即时回滚能力: 提供快速修复的安全网。
自动验证: 确保您的更新符合合规标准。

建立可靠的更新系统有助于您跟上苹果和谷歌的不断演进的隐私要求。这一方法已被证明可以提高应用商店的通过率和增强用户信心 [1].

如何开始

您可以通过遵循以下步骤开始实施这些原则:

设置您的环境: 运行 npx @capgo/cli init 为了开始使用。
启用隐私功能: 使用端到端加密进行安全更新。
部署监控工具: 使用分析跟踪更新。
计划回滚: 确保您可以快速恢复到早期版本。

“Capgo 是开发人员提高生产力所必需的工具。避免 bug 修复的审查延迟是一场游戏改变。” - Bessie Cooper

定期更新和适当工具是保持合规和不断改进的关键。

关于Capacitor应用的隐私声明指南