Privacy Manifest for Capacitor Apps: Guide

想在App Store上发布您的 Capacitor 不再延迟? App Store 什么是隐私清单? context

context
应用数据收集实践、API 使用和跟踪域名的结构化文件。
为什么它很重要:
- 遵守 App Store 规则，避免被拒绝或移除。
- 通过透明地处理用户数据来建立信任。
需要包含的关键组件:
- 访问用户数据的 API（例如，位置、照片）。
- 收集数据类型的隐私标签。
- 用于分析或广告的跟踪域名。
如何创建一个:
- 使用 JSON 定义数据收集细节。
- 将文件放置在项目的正确目录中。 PrivacyInfo.xcprivacy 文件在项目的正确目录中。
- 使用工具类似于 Xcode 以避免错误
简化流程的工具:
使用平台类似于 Capgo context @capgo/capacitor-应用跟踪透明度为自动化隐私清单验证、实时更新和错误跟踪提供工具。当您的清单声明跟踪或分析 SDK 时， @capgo/capacitor-app-tracking-transparency 处理 iOS ATT 提示并

@__CAPGO_KEEP_0__/__CAPGO_KEEP_1__-firebase-analytics

Privacy Manifest 基础

Privacy Manifest 定义

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

主要 Privacy Manifest 元素

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

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

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

API 类别常见用途必需的文档

位置服务用户导航目的和使用说明

相册头像访问级别和意图

联系人地址簿同步数据最小化声明
隐私标签
这些标签通过指定以下内容来提供透明度:
- 正在收集的数据类型
- 数据收集的原因
- 是否将数据与用户身份关联
- 数据如何用于跟踪
跟踪域名
本节列出了所有参与跟踪的域名，例如用于分析、广告或第三方数据处理的域名。

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

“App Store 兼容” - Capgo [1]

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

为 Capacitor 应用程序构建隐私清单 Capacitor

Capacitor 框架文档网站

Page/area: Live updates product page. Role: Section or page heading. Seen in: page live-update.astro. Preserve Capgo product/brand and developer terms exactly. Message key `live_update_platform_capacitor_title` (Live Update Platform Capacitor Title).

__CAPGO_KEEP_0__ 框架文档网站

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

创建步骤

在 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标识符进行交叉检查。
检查JSON格式:使用JSON校验器来捕捉语法错误。
提供完整的原因:确保每个API访问都包含一个相应的原因code。
保持信息最新:在添加新功能时更新清单。

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

将隐私清单添加到Capacitor

文件放置指南

要将隐私清单添加到您的Capacitor项目中，请将文件放置在以下目录结构中: PrivacyInfo.xcprivacy 对于__CAPGO_KEEP_0__插件，请使用以下结构:

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

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

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

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

打开您的项目在Xcode中。

在
TARGETS TARGETS选择您的应用或插件目标。
前往 构建设置 选项卡。
设置 context to en.
设置 Include Privacy Manifest to YES.

If your project uses 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 声明是否完整，并确保跟踪域名格式正确。

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

Apple Privacy Manifest 变更

测试和修复

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

一个像这样的工具 Capgo 可以帮助。它监控 API 访问并识别清单问题，确保这些问题不会影响用户。一次标记潜在问题后，您可以将重点转移到彻底验证上。

在进行更新后，测试您的清单在开发环境中。使用错误跟踪的见解来指导您的审查。这有助于确保您的应用始终符合 Apple 的隐私标准。

Capgo 隐私工具

Capgo Live Update 控制台界面

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

Capgo 功能

__CAPGO_KEEP_0__ 已成功完成超过 23.5万个安全更新 和一个 82%Capgo 确保了 95% 的活跃用户在 24 小时内接收到更新。 [1]__CAPGO_KEEP_0__ 提供了以下功能：

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

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

使用Capgo

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

npx @capgo/cli init

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

“我们实行敏捷开发，@Capgo 在交付持续更新给用户方面是 mission-critical 的！” – Rodrigo Mantica

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

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

结论

关键点

当它来到管理隐私清单时，保持兼容性和强大的安全措施至关重要。以下是最重要的内容：

端到端加密: 保证从开始到结束的更新安全性。
实时监控: 高效地跟踪更新的分布。
: 提供快速修复的安全网。: 确保您的更新符合标准。
建立可靠的更新系统有助于您跟上苹果和谷歌不断演进的隐私要求。这种方法已被证明可以提高应用商店的通过率和增强用户信心。如何开始

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

设置环境

: 运行

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

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

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

继续阅读 Capacitor 应用程序隐私声明指南

如果您正在使用 Capacitor 应用程序隐私声明指南 为了规划安全性和合规性，连接它加密加密的实施细节合规合规的实施细节 Capgo 安全扫描器 Capgo 安全扫描器的产品工作流程 Capgo 安全 Capgo 安全的产品工作流程 Capgo 信任中心 Capgo 信任中心的产品工作流程