TN3184: Adding data collection details to your privacy manifest

Overview

When you build an app or third-party SDK that collects any data type, perform these steps in your privacy manifest (PrivacyInfo.xcprivacy):

1. Add the NSPrivacyCollectedDataTypes key.

2. For each data type your app or third-party SDK collects, add a dictionary as a value for the NSPrivacyCollectedDataTypes key. The dictionary includes the data type, the data linked to the user and tracking status, and a list of reasons for collecting this data type. For more information, see Add a collected data type and reasons dictionary.

For more information about the privacy manifest and these keys, see Privacy manifest files and Describing data use in privacy manifests.

This document describes how to add the NSPrivacyCollectedDataType, NSPrivacyCollectedDataTypeLinked, NSPrivacyCollectedDataTypeTracking, and NSPrivacyCollectedDataTypePurposes keys to your privacy manifest in Xcode. If you work outside of Xcode, review this document to learn about the expected structure of each key.

Add a collected data type key

The NSPrivacyCollectedDataType key uses the following format:

<key>NSPrivacyCollectedDataType</key>
<string>NS_PRIVACY_COLLECTED_DATA_TYPE_VALUE</string>

The NS_PRIVACY_COLLECTED_DATA_TYPE_VALUE string specifies the type of data your app or third-party SDK collects. For possible values, see “Report the categories of data your app or third-party SDK collects“ in Describing data use in privacy manifests.

To add the NSPrivacyCollectedDataType key to a privacy collected data type and reasons dictionary in your privacy manifest:

1. Select the dictionary in the property list editor.

2. Click the disclosure triangle to the left of the dictionary to reveal it.

3. Click the Add button (+) beside the dictionary to add a new item.

4. In the pop-up menu, choose NSPrivacyCollectedDataType.

5. In the Type column, confirm that the value is String.

6. Select a data type from the pop-up menu in the Value column. For possible values, see “Report the categories of data your app or third-party SDK collects“ in Describing data use in privacy manifests.

7. Confirm that the value exactly matches the type of data your app or third-party SDK collects.

Add a collected data type linked key

The NSPrivacyCollectedDataTypeLinked key uses the following format:

<key>NSPrivacyCollectedDataTypeLinked</key>
<!-- Use <true/> if your app or third-party SDK links this data type to the user’s identity; otherwise,
     use <false/>. -->
<true/>

To add the NSPrivacyCollectedDataTypeLinked key to a privacy collected data type and reasons dictionary in your privacy manifest:

1. Select the dictionary in the property list editor.

2. Click the disclosure triangle to the left of the dictionary to reveal it.

3. Click the Add button (+) beside the dictionary to add a new item.

4. In the pop-up menu, choose NSPrivacyCollectedDataTypeLinked.

5. In the Type column, confirm that the value is Boolean.

6. Select YES from the pop-up menu in the Value column if your app or third-party SDK links this data type to the user’s identity; otherwise, select NO.

Add a collected data type tracking key

The NSPrivacyCollectedDataTypeTracking key uses the following format:

<key>NSPrivacyCollectedDataTypeTracking</key>
<!-- Use <true/> if your app or third-party SDK uses this data type to track; otherwise, use <false/>. -->
<true/>

To add the NSPrivacyCollectedDataTypeTracking key to a privacy collected data type and reasons dictionary in your privacy manifest:

1. Select the dictionary in the property list editor.

2. Click the disclosure triangle to the left of the dictionary to reveal it.

3. Click the Add button (+) beside the dictionary to add a new item.

4. In the pop-up menu, choose NSPrivacyCollectedDataTypeTracking.

5. In the Type column, confirm that the value is Boolean.

6. Select YES from the pop-up menu in the Value column if your app or third-party SDK uses this data type to track; otherwise, select NO.

Add a collected data type purposes key

The NSPrivacyCollectedDataTypePurposes key uses the following format:

<key>NSPrivacyCollectedDataTypePurposes</key>
<array>
    <string>NS_PRIVACY_COLLECTED_DATA_TYPE_PURPOSE_VALUE</string>
    ...
</array>

Each NS_PRIVACY_COLLECTED_DATA_TYPE_PURPOSE_VALUE string in the array identifies a reason why your app or third-party SDK collects a data type. For possible values, see “Report the reasons your app or third-party SDK collects data” in Describing data use in privacy manifests.

To add the NSPrivacyCollectedDataTypePurposes key to a privacy collected data type and reasons dictionary in your privacy manifest:

1. Select the dictionary in the property list editor.

2. Click the disclosure triangle to the left of the dictionary to reveal it.

3. Confirm the dictionary contains a NSPrivacyCollectedDataType key with a value as described in Add a collected data type key.

4. Click the Add button (+) beside the dictionary to add a new item.

5. In the pop-up menu, choose NSPrivacyCollectedDataTypePurposes.

6. In the Type column, confirm that the value is Array.

7. Click the disclosure triangle to the left of NSPrivacyCollectedDataTypePurposes to reveal it.

8. Click the Add button (+) beside NSPrivacyCollectedDataTypePurposes to add a reason.

9. Choose a reason from the pop-up menu in the Value column. For possible values, see “Report the reasons your app or third-party SDK collects data” in Describing data use in privacy manifests.

Repeat the last two steps for each reason your app or third-party SDK collects this data type.

Add a collected data type and reasons dictionary

A privacy collected data type and reasons dictionary includes a data type, a data linked to the user status, a tracking status, and a list of reasons for collecting this data type. The dictionary contains exactly four keys: NSPrivacyCollectedDataType, NSPrivacyCollectedDataTypeLinked, NSPrivacyCollectedDataTypeTracking, and NSPrivacyCollectedDataTypePurposes. It uses the following format:

<dict>
    <!-- Add a privacy collected data type key. -->
    <key>NSPrivacyCollectedDataType</key>
    <string>NS_PRIVACY_COLLECTED_DATA_TYPE_VALUE</string>

    <!-- Add a privacy collected data type linked key. -->
    <key>NSPrivacyCollectedDataTypeLinked</key>
    <false/>

    <!-- Add a privacy collected data type tracking key. -->
    <key>NSPrivacyCollectedDataTypeTracking</key>
    <false/>

    <!-- Add a privacy collected data type purposes key. -->
    <key>NSPrivacyCollectedDataTypePurposes</key>
    <array>
        <string>NS_PRIVACY_COLLECTED_DATA_TYPE_PURPOSE_VALUE</string>
        ...
    </array>
</dict>

To add a privacy collected data type and reasons dictionary to the NSPrivacyCollectedDataTypes key in your privacy manifest:

1. Select PrivacyInfo.xcprivacy in the Project navigator in Xcode.

2. Find the NSPrivacyCollectedDataTypes key in the property list editor.

3. Click the disclosure triangle to the left of NSPrivacyCollectedDataTypes to reveal it.

4. Click the Add button (+) beside NSPrivacyCollectedDataTypes to insert a new item.

5. Confirm the value is Dictionary in the Type column.

6. Click the disclosure triangle to the left of the dictionary to reveal it.

7. To add the NSPrivacyCollectedDataType key to the dictionary, see Add a collected data type key.

8. To add the NSPrivacyCollectedDataTypeLinked key to the dictionary, see Add a collected data type linked key.

9. To add the NSPrivacyCollectedDataTypeTracking key to the dictionary, see Add a collected data type tracking key.

10. To add the NSPrivacyCollectedDataTypePurposes key to the dictionary, see Add a collected data type purposes key.

Add the collected data types key

The NSPrivacyCollectedDataTypes key is an array of privacy collected data type and reasons dictionaries. For more information, see Add a collected data type and reasons dictionary. The key uses the following format:

<key>NSPrivacyCollectedDataTypes</key>
<array>
    <dict>
        <!-- Add a privacy collected data type key. -->
        <key>NSPrivacyCollectedDataType</key>
        <string>NS_PRIVACY_COLLECTED_DATA_TYPE_VALUE</string>

        <!-- Add a privacy collected data type linked key. -->
        <key>NSPrivacyCollectedDataTypeLinked</key>
        <false/>

        <!-- Add a privacy collected data type tracking key. -->
        <key>NSPrivacyCollectedDataTypeTracking</key>
        <false/>

        <!-- Add a privacy collected data type purposes key. -->
        <key>NSPrivacyCollectedDataTypePurposes</key>
        <array>
            <string>NS_PRIVACY_COLLECTED_DATA_TYPE_PURPOSE_VALUE</string>
            ...
        </array>
    </dict>
    ...
</array>

To add the NSPrivacyCollectedDataTypes key to your privacy manifest:

1. Select PrivacyInfo.xcprivacy in the Project navigator.

2. Click the Add button (+) beside the App Privacy Configuration key in the property list editor.

3. In the pop-up menu that appears, choose NSPrivacyCollectedDataTypes.

4. Confirm the value is Array in the Type column.

5. To add a privacy collected data type and reasons dictionary, see Add a collected data type and reasons dictionary.

The following example declares the contacts information collected from the user in an app named Sample:

Repeat step 5 for each additional data type your app or third-party SDK collects. In the following example, Sample additionally collects user ID information from the user:

Revision History

• 2024-12-17 First published.

See Also

Latest

• TN3205: Low-latency communication with RDMA over Thunderbolt
• TN3206: Updating Apple Pay certificates
• TN3179: Understanding local network privacy
• TN3190: USB audio device design considerations
• TN3194: Handling account deletions and revoking tokens for Sign in with Apple
• TN3193: Managing the on-device foundation model’s context window
• TN3115: Bluetooth State Restoration app relaunch rules
• TN3192: Migrating your iPad app from the deprecated UIRequiresFullScreen key
• TN3151: Choosing the right networking API
• TN3111: iOS Wi-Fi API overview
• TN3191: IMAP extensions supported by Mail for iOS, iPadOS, and visionOS
• TN3134: Network Extension provider deployment
• TN3189: Managing Mail background traffic load
• TN3187: Migrating to the UIKit scene-based life cycle
• TN3188: Troubleshooting In-App Purchases availability in the App Store