Data Collection
Overview of data collection and controls provided by the Airship SDK.
Privacy Manager
Data collected by the Airship SDK can be controlled using Privacy Manager flags. Each flag enables additional Airship features within the SDK and controls what data is collected. The flags are for individual or groups of functional features within the SDK. Some Airship features, such as contact tags, require multiple feature flags to be enabled.
Privacy Manager Flag | Features |
---|---|
Push | Push notifications |
In-App Automation | In-App Automation, In-App Messages, Scenes, Surveys, and Landing Pages |
Message Center | Message Center |
Tags and Attributes | Tags, Attributes, Subscription Lists, and Preference Center |
Contacts | Contact Tags, Attributes, and Subscription Lists; Named User; and Associated Channels |
Analytics | Associated identifiers, Custom events, Screen tracking, Surveys |
Chat | In-App Chat |
Location | Location Lat/Long gathering for App (Not reported to Airship), Location status reporting |
SDK Data Collection
All SDK features are enabled by default, but the SDK can be configured to disable all or a subset of features on start. If the SDK is initialized without any features enabled, it will not store any data or make any network requests. If the SDK features are disabled after being previously enabled, it may make a few network requests to opt the channel out to prevent notifications.
The data collected automatically by the SDK is not used to track users across apps.
Data | Description | Privacy Manager Features |
---|---|---|
Channel ID | Airship app install identifier. | Any |
Locale | The app’s locale, comprised of language and language country. | Any |
Time zone | The device time zone. | Any |
Platform | The platform the device is running on, e.g., Amazon, Android, iOS. | Any |
Accengage device ID | The device ID on Accengage. Only collected if using the Accengage module for Accengage to Airship migration. | Any |
SDK version | The Airship SDK version. | Any |
Notification opt-In status | Notifications and background opt-in status. | Any |
Contact ID | Internal Airship ID that maps to contact. | Contacts |
App version | The app’s version. | Analytics, In-App Automation |
Message Center credentials | The message center credentials for message list access. | Message Center |
Message Center message status | Message reads and deletes. | Message Center |
Push token | The push address for push notifications. | Push |
Push provider | The push delivery platform, e.g., FCM, HMS. | Push |
Device model | The device model, e.g., Samsung GT-S5830L, iPad Air. | Analytics |
Device manufacturer | The device manufacturer name. | Analytics |
OS version | The device OS version. | Analytics |
Carrier | The device mobile carrier. | Analytics |
Connection Type | The connection type, e.g., Cell, Wifi. | Analytics |
Framework | Airship framework usage: React Native, Unity, Cordova, Flutter, Titanium, and Xamarin. | Analytics |
Lifecycle events | Init, foreground, background, and time in app. | Analytics |
Notification events | Push notification interaction events. | Analytics, Push |
Notification permissions | Authorized notification types and permissions. | Analytics, Push |
In-App Automation events | Events within an In-App display: displays, resolutions, page views, button taps, and survey results. | Analytics, In-App Automation |
Location permission | The location permission status. | Analytics, Location |
App Data Collection
In addition to the data automatically collected by the SDK, the app can provide data to the SDK for collection:
Data | Description | Privacy Manager Features |
---|---|---|
Channel Tags | Tags and tag groups set on the channel. | Tags and Attributes |
Channel Subscription Lists | Subscription Lists set on the channel. | Tags and Attributes |
Channel Attributes | Attributes set on the channel. | Tags and Attributes |
Contact Tags | Tags and tag groups set on the contact. | Tags and Attributes, Contacts |
Contact Subscription Lists | Subscription Lists set on the contact. | Tags and Attributes, Contacts |
Contact Attributes | Attributes set on the contact. | Tags and Attributes, Contacts |
Named User | Contact’s external ID. | Contacts |
Associated Channels | Email and email opt-in data, SMS and SMS opt-in data, etc. | Contacts |
Associated Identifiers | Additional analytics identifiers. | Analytics |
Custom Events | App’s custom events. | Analytics |
Screen Tracking | App’s screen tracking. | Analytics |
Data Privacy
Airship makes HTTPS encryption (also referred to as TLS connection) available for data in transit to or from the Service, for more information see Airship Security Measures. Data collected by the SDK is not transferred to any third parties unless a partner integration is enabled and configured by the application. For information on individual data requests, see Individual Data Privacy Rights.
Using Privacy Manager
The Privacy Manager allows setting default enabled features as well as modifying the enabled features at runtime. This table provides a mapping of the iOS flags:
Privacy Manager Flag | Swift Constant | Objective-C Constant | Plist Value |
---|---|---|---|
Push | Features.push | UAFeaturesPush | push |
In-App Automation | Features.inAppAutomation | UAFeaturesInAppAutomation | in_app_automation |
Message Center | Features.messageCenter | UAFeaturesMessageCenter | message_center |
Tags and Attributes | Features.tagsAndAttributes | UAFeaturesTagsAndAttributes | tags_and_attributes |
Contacts | Features.contacts | UAFeaturesContacts | contacts |
Analytics | Features.analytics | UAFeaturesAnalytics | analytics |
Chat | Features.chat | UAFeaturesChat | chat |
Location | Features.location | UAFeaturesLocation | location |
All | Features.all | UAFeaturesAll | all |
None | [] | UAFeaturesNone | none |
Configuring Default Enabled Features
Default enabled features can be declared in UAConfig
or AirshipConfig.plist
by setting the enabledFeatures
flag. For instance, to default to just push:
let config = Config.default()
config.enabledFeatures = [.push]
UAConfig *config = [UAConfig defaultConfig];
config.enabledFeatures = UAFeaturesPush;
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
...
<key>enabledFeatures</key>
<array/>
<string>push</string>
</array>
...
</dict>
</plist>
To fully disable data collection by default, just set the enabled features in your config to []
in Swift, or UAFeaturesNone
in Objective-C:
let config = Config.default()
config.enabledFeatures = []
UAConfig *config = [UAConfig defaultConfig];
config.enabledFeatures = UAFeaturesNone;
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
...
<key>enabledFeatures</key>
<array/>
<string>none</string>
</array>
...
</dict>
</plist>
Modifying Enabled Features
Features can enabled and disabled at any time after takeOff. Once a feature set is modified from the default, those settings will be persisted in the SDK between app inits.
Airship.shared.privacyManager.enableFeatures([.push, .analytics])
[UAirship.shared.privacyManager enableFeatures:UAFeaturesPush | UAFeaturesAnalytics];
Airship.shared.privacyManager.disableFeatures([.push, .analytics])
[UAirship.shared.privacyManager disableFeatures:UAFeaturesPush | UAFeaturesAnalytics];
Airship.shared.privacyManager.enabledFeatures = .all
UAirship.shared.privacyManager.enabledFeatures =UAFeaturesAll
Categories