Privacy Manifest for Capacitor Apps: Guide

想在 Capacitor App Store App Store without delays? Start by creating a Privacy Manifest. Apple now requires developers to include this document to ensure apps meet strict privacy standards. Here’s what you need to know:

What is a Privacy Manifest?
A structured file outlining your app’s data collection practices, API usage, and tracking domains.
Why it matters:
- Complies with App Store rules to avoid rejections or removal.
- Builds trust by being transparent about user data handling.
Key components to include:
- API访问用户数据（例如位置、照片）。
- 收集数据类型的隐私标签。
- 用于分析或广告的跟踪域名。
如何创建一个：
- 使用JSON定义数据收集详细信息。
- 将文件放置在项目的正确目录中。 PrivacyInfo.xcprivacy 使用工具如
- Xcode 以避免错误。简化过程的工具：
使用平台如
file in the correct directory of your project. Capgo 为了自动化隐私清单验证、实时更新和错误跟踪。您的清单声明跟踪或分析SDK时 @capgo/capacitor-app-tracking-transparency 处理iOS ATT提示 @capgo/capacitor-firebase-analytics 记录Firebase数据收集以便App Store审查

遵守指南、保护用户隐私并避免应用商店延迟，按照本指南进行

隐私清单基础

隐私清单定义

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

主要隐私清单元素

以下是您需要在隐私清单中包含的主要元素，以便与苹果的要求保持一致：

Required Reason APIs
本节列出了您的应用程序使用的敏感API以及它们为什么必要。

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

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

隐私标签
这些标签提供透明度，通过指定:
- 收集的数据类型
- 数据收集的原因
- 数据是否与用户身份相关
- 数据用于跟踪的方式
跟踪域名
本节列出了参与跟踪的所有域名，例如用于分析、广告或第三方数据处理的域名。

“App Store 合规” - Capgo [1]

根据 Capgo, 95% 的用户在 24 小时内遵守更新。通过超过 23.5 万次更新 [1]保持最新的隐私文档对于维持用户信任至关重要。

为 Capacitor

Capacitor 框架文档网站

设置要求

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

Xcode 15 或更高版本已安装
一个 Capacitor 8.0+ 项目已设置
对您的应用程序的 Info.plist 文件
对 JSON 结构的基本了解
关于Capacitor应用的隐私声明指南

创建步骤

首先在您的iOS项目目录中创建一个 PrivacyInfo.xcprivacy 文件。该文件必须遵循特定的格式规范:

设置基本信息

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

定义数据收集细节

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

添加跟踪域名

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

避免常见错误

为了防止问题，记住以下几点:

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

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

将隐私清单添加到 Capacitor 中

文件放置指南

将隐私清单添加到 Capacitor 项目中，需要将文件放置在以下目录结构中： PrivacyInfo.xcprivacy Check JSON Formatting

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

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

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

构建设置

一旦文件放置在正确位置，请更新您的 Xcode 构建设置以确保它正确集成：

打开您的项目在 Xcode 中。
在 TARGETS中选择您的应用或插件目标。
转到 Build Settings 选项卡。
设置 Privacy Manifest Development Region 到 en.
设置 包含隐私清单 到 YES.

如果您的项目使用 CocoaPods, 在您的 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

完成这些更改后，请按照以下步骤进行实施检查，以验证一切设置正确。

实施检查

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

构建验证
- 确认在构建过程中没有任何与隐私相关的警告。
- 确保清单编译无误。
- 验证隐私清单已包含在构建产品中。
运行时验证
- 在调试模式下，测试隐私提示和API访问行为是否正常。
App Store Connect验证
- 上传您的构建并在App Store Connect中查看隐私报告。
- 检查API声明是否完整，并确保跟踪域名格式正确。

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

苹果隐私清单更新

测试和修复

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

一个工具，如 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.

Capacitor

Capgo 在做出更新后，测试您的清单在开发环境中。使用错误跟踪的见解来指导您的审查。这一方法有助于确保您的应用与苹果的隐私标准保持一致。

Capgo Live Update Dashboard Interface

Capgo simplifies managing privacy manifests and app updates, ensuring your privacy standards stay intact without delaying deployments.

Capgo Features

实时更新控制台界面 Capacitor 和一个 全球成功率达82%Capgo确保 95%的活跃用户在24小时内接收更新 [1]。以下是它的优势:

端到端加密 以确保更新安全
频道系统 用于控制更新分发
错误跟踪 快速识别和解决问题
一键回滚 立即恢复到之前的版本

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

使用Capgo

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

npx @capgo/cli init

Capgo可以与CI/CD管道无缝整合，通过平台如Capgo Actions GitHub Actions, ，或Jenkins 无论您选择云端还是自主托管的选项，__CAPGO_KEEP_0__都支持750个生产应用程序，同时确保每次更新都符合隐私标准。Capgo

“我们实践敏捷开发，@Capgo 是使我们能够持续为用户提供服务的 mission-critical!” – Rodrigo Mantica

“Capgo 是一种聪明的方式来进行热 code 推送 🙂” – NASA 的 OSIRIS-REx

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

结论

关键点

当它涉及管理隐私清单时，保持兼容性并维持强大的安全措施至关重要。以下是最重要的内容:

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

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

如何开始

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

设置环境: 运行 npx @capgo/cli init 开始
启用隐私功能: 使用端到端加密进行安全更新。
部署监控工具: 使用分析跟踪更新。
为回滚做好准备:确保在需要时可以快速切换回较早的版本。

“Capgo 是开发人员提高生产力所必需的工具。避免由于 bug 修复而引起的审查延迟是一个重大变化。” - Bessie Cooper

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

从Privacy Manifest for Capacitor Apps: Guide继续前进

如果您正在使用 Privacy Manifest for Capacitor Apps: Guide 来规划安全性和合规性，连接它到加密加密的实现细节合规性 Capgo 安全扫描器为 Capgo 安全扫描器的产品工作流程 Capgo 安全为 Capgo 安全的产品工作流程 Capgo 信任中心为 Capgo 信任中心的产品工作流程