跳过主要内容

Capacitor 应用程序的保密声明指南

了解如何为您的应用程序创建保密声明,以遵守 App Store 的要求并有效保护用户数据。

Martin Donadieu

Martin Donadieu

内容营销人员

Capacitor 应用程序的保密声明指南

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

  • 什么是隐私清单?
    一个结构化的文件,概述了您的应用程序的数据收集实践、API 使用和跟踪域名。

  • 为什么重要:

    • 遵守 App Store 规则,避免被拒绝或移除。
    • 通过透明地处理用户数据来建立信任。
  • 需要包含的关键组成部分:

    • 访问用户数据的 API(例如,位置、照片)。
    • 收集的数据类型的隐私标签。
    • 用于分析或广告的跟踪域名。
  • 如何创建一个:

    • 使用 JSON 定义数据收集细节。
    • PrivacyInfo.xcprivacy 文件放置在您的项目的正确目录中。
    • 使用工具如 Xcode 避免错误。
  • 简化过程的工具:
    使用平台如 Capgo 进行自动化隐私清单验证、实时更新和错误跟踪。

遵循本指南,保持合规、保护用户隐私并避免应用商店延迟。

隐私清单基础

隐私清单定义

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

主要隐私清单元素

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

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

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

    API类别常用用途必填文档
    位置服务用户导航目的和使用说明
    相册个人照片访问级别和意图
    联系人地址簿同步数据最小化声明
  2. 隐私标签
    这些标签通过指定:

    • 正在收集的数据类型
    • 数据收集的原因
    • 数据是否与用户身份相关联
    • 如何使用数据进行跟踪
  3. 跟踪域名
    本节列出了参与跟踪的所有域名,例如用于分析、广告或第三方数据处理的域名。

“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]95%的用户在24小时内遵守更新。通过超过23.5万次的更新

保持您的隐私文档最新对于维持用户信任至关重要。 Capacitor

Capacitor Framework Documentation Website

Setup Requirements

在开始构建清单之前,请确保您已安装:

  • 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"
    ]
}

避免常见错误

To prevent issues, keep these tips in mind:

  • 包含所有必填字段即使某些字段为空,也必须存在。
  • 使用有效的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

For Capacitor plugins, use this structure:

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

一旦文件放置好,请更新您的Xcode构建设置以确保它正确集成:

打开您的项目在Xcode中。

  1. TARGETS 中,选择您的应用程序或插件目标。转到
  2. Go to the "Info" tab and add the following key-value pair: "Privacy - Usage Description" with a value that describes the data your app collects. 设置 选项卡。
  3. 设置 隐私清单开发区域en.
  4. 设置 包含隐私清单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

After making these changes, proceed with implementation checks to verify everything is set up correctly.

实现检查

To ensure the privacy manifest is working as intended, follow these steps:

  1. 构建验证

    • Confirm there are no privacy-related warnings during the build.
    • 确保构建过程中没有隐私相关的警告。
    • Ensure the manifest compiles without issues.
  2. 确保清单编译无误。

    • In debug mode, test for proper privacy prompts and API access behavior.
  3. 确认隐私清单已包含在构建产品中。

    • In debug mode, test for proper privacy prompts and __CAPGO_KEEP_0__ access behavior.
    • 在调试模式下,测试隐私提示和API访问行为是否正常。

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

Apple隐私清单更改

测试和修复

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

一个工具类似于 Capgo 可以帮助。它监控API访问并识别清单问题,避免它们影响用户。一旦潜在问题被标记,您可以将重点转移到彻底验证上。

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

Capgo 隐私工具

Capgo Live Update Dashboard界面

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

Capgo 功能

超过 23.5 万次安全更新 和一个 82% 全球成功率,Capgo 确保 95% 活跃用户在 24 小时内接收更新 [1]。以下是它提供的功能:

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

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

使用Capgo

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

npx @capgo/cli init

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

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

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

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

结论

关键要点

当它来到管理隐私清单、保持合规和维持强大安全措施时,管理隐私清单就变得至关重要。以下是最重要的内容:

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

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

如何开始

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

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

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

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

从隐私清单中继续Privacy Manifest for Capacitor Apps: Guide

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

Capacitor应用的实时更新

当一个 web层 bug 活跃时,通过 Capgo 将修复推送到应用商店,而不是等待几天的审批时间。用户在后台接收更新,而原生变化仍然在正常的审批路径中。

立即开始

最新博客

Capgo 为您提供创建真正专业的移动应用所需的最佳见解。