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 FlagFeatures
PushPush notifications
In-App AutomationIn-App Automation, In-App Messages, Scenes, Surveys, and Landing Pages
Message CenterMessage Center
Tags and AttributesTags, Attributes, Subscription Lists, and Preference Center
ContactsContact Tags, Attributes, and Subscription Lists; Named User; and Associated Channels
AnalyticsAssociated identifiers, Custom events, Screen tracking, Surveys
ChatIn-App Chat
LocationLocation 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.

 Note

The data collected automatically by the SDK is not used to track users across apps.

DataDescriptionPrivacy Manager Features
Channel IDAirship app install identifier.Any
LocaleThe app’s locale, comprised of language and language country.Any
Time zoneThe device time zone.Any
PlatformThe platform the device is running on, e.g., Amazon, Android, iOS.Any
Accengage device IDThe device ID on Accengage. Only collected if using the Accengage module for Accengage to Airship migration.Any
SDK versionThe Airship SDK version.Any
Notification opt-In statusNotifications and background opt-in status.Any
Contact IDInternal Airship ID that maps to contact.Contacts
App versionThe app’s version.Analytics, In-App Automation
Message Center credentialsThe message center credentials for message list access.Message Center
Message Center message statusMessage reads and deletes.Message Center
Push tokenThe push address for push notifications.Push
Push providerThe push delivery platform, e.g., FCM, HMS.Push
Device modelThe device model, e.g., Samsung GT-S5830L, iPad Air.Analytics
Device manufacturerThe device manufacturer name.Analytics
OS versionThe device OS version.Analytics
CarrierThe device mobile carrier.Analytics
Connection TypeThe connection type, e.g., Cell, Wifi.Analytics
FrameworkAirship framework usage: React Native, Unity, Cordova, Flutter, Titanium, and Xamarin.Analytics
Lifecycle eventsInit, foreground, background, and time in app.Analytics
Notification eventsPush notification interaction events.Analytics, Push
Notification permissionsAuthorized notification types and permissions.Analytics, Push
In-App Automation eventsEvents within an In-App display: displays, resolutions, page views, button taps, and survey results.Analytics, In-App Automation
Location permissionThe 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:

DataDescriptionPrivacy Manager Features
Channel TagsTags and tag groups set on the channel.Tags and Attributes
Channel Subscription ListsSubscription Lists set on the channel.Tags and Attributes
Channel AttributesAttributes set on the channel.Tags and Attributes
Contact TagsTags and tag groups set on the contact.Tags and Attributes, Contacts
Contact Subscription ListsSubscription Lists set on the contact.Tags and Attributes, Contacts
Contact AttributesAttributes set on the contact.Tags and Attributes, Contacts
Named UserContact’s external ID.Contacts
Associated ChannelsEmail and email opt-in data, SMS and SMS opt-in data, etc.Contacts
Associated IdentifiersAdditional analytics identifiers.Analytics
Custom EventsApp’s custom events.Analytics
Screen TrackingApp’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 FlagSwift ConstantObjective-C ConstantPlist Value
PushFeatures.pushUAFeaturesPushpush
In-App AutomationFeatures.inAppAutomationUAFeaturesInAppAutomationin_app_automation
Message CenterFeatures.messageCenterUAFeaturesMessageCentermessage_center
Tags and AttributesFeatures.tagsAndAttributesUAFeaturesTagsAndAttributestags_and_attributes
ContactsFeatures.contactsUAFeaturesContactscontacts
AnalyticsFeatures.analyticsUAFeaturesAnalyticsanalytics
ChatFeatures.chatUAFeaturesChatchat
LocationFeatures.locationUAFeaturesLocationlocation
AllFeatures.allUAFeaturesAllall
None[]UAFeaturesNonenone

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:

UAConfig
let config = Config.default()
config.enabledFeatures = [.push]
UAConfig *config = [UAConfig defaultConfig];
config.enabledFeatures = UAFeaturesPush;
AirshipConfig.plist
<?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:

Config
let config = Config.default()
config.enabledFeatures = []
UAConfig *config = [UAConfig defaultConfig];
config.enabledFeatures = UAFeaturesNone;
AirshipConfig.plist
<?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.

Enabling features
Airship.shared.privacyManager.enableFeatures([.push, .analytics])
[UAirship.shared.privacyManager enableFeatures:UAFeaturesPush | UAFeaturesAnalytics];
Disabling features
Airship.shared.privacyManager.disableFeatures([.push, .analytics])
[UAirship.shared.privacyManager disableFeatures:UAFeaturesPush | UAFeaturesAnalytics];
Setting the current set of features
  Airship.shared.privacyManager.enabledFeatures = .all
  UAirship.shared.privacyManager.enabledFeatures =UAFeaturesAll