Privacy and GDPR

The Experience Platform SDKs give you controls to manage consent and privacy obligations under the European Union's General Data Protection Regulation (GDPR). Developers can retrieve locally stored identities and set opt status flags for data collection and transmission.
Before implementing these controls, read Adobe's GDPR documentation.
When Adobe provides software and services to an enterprise, Adobe acts as a data processor for any personal data it processes and stores as part of providing these services. As a data processor, Adobe processes personal data in accordance with your company’s permission and instructions, as set out in your agreement with Adobe. As a data controller, you can use the Experience Platform SDKs to support GDPR retrieve and delete requests from your mobile apps.
Set and get privacy status
You can set a privacy status to ensure collection of data suits your user's preferences.
Expected Behavior
Opt In
Opt Out
Opt Unknown
Analytics
Hits are sent
Hits not sent
Hits queued
Audience Manager
Signals, ID syncs are sent
Signals, ID syncs not sent
Syncs queued
Campaign Classic
User data stored, calls are sent
User data cleared, calls not sent
User data stored, calls not sent
Target
Mbox requests are sent
Mbox requests not sent
Mbox requests queued
Campaign Standard
User data stored, calls are sent
User data cleared, calls not sent
User data stored, calls are queued
Analytics users: If your report suite is not timestamp enabled, hits are discarded until the privacy status changes to opt in.
To programmatically set the privacy status for the app user:
Android
iOS
Android
Java
setPrivacyStatus
You can set the privacy status to one of the following values:
MobilePrivacyStatus.OPT_IN
MobilePrivacyStatus.OPT_OUT
MobilePrivacyStatus.UNKNOWN
To understand the expected behavior, see the Set and get privacy status table above.
Syntax
public static void setPrivacyStatus(final MobilePrivacyStatus privacyStatus);
Example
MobileCore.setPrivacyStatus(MobilePrivacyStatus.OPT_OUT);
iOS
setPrivacyStatus
You can set privacy status to one of the following values:
ACPMobilePrivacyStatusOptIn
ACPMobilePrivacyStatusOptOut 
ACPMobilePrivacyStatusUnknown
To understand the expected behavior, see the Set and get privacy status table above.
Objective-C
Syntax
+ (void) setPrivacyStatus: (ACPMobilePrivacyStatus) status;
Example
[ACPCore setPrivacyStatus:ACPMobilePrivacyStatusOptIn];
Swift
Syntax
class func setPrivacyStatus(_ status: ACPMobilePrivacyStatus) {
}
Example
ACPCore.privacyStatus = ACPMobilePrivacyStatusOptIn
You can also programmatically view the current privacy status by using the following:
The following API returns an enum representation of the privacy status for the user.
Android
iOS
Android
getPrivacyStatus
The enum representation of the privacy status that corresponds to the following statuses:
MobilePrivacyStatus.OPT_IN
MobilePrivacyStatus.OPT_OUT
MobilePrivacyStatus.UNKNOWN
Java
Syntax
void getPrivacyStatus(AdobeCallback<MobilePrivacyStatus> callback);
callback is invoked after the privacy status is available.
If an instance of  AdobeCallbackWithError is provided, and you are fetching the attributes from the Mobile SDK, the timeout value is 5000ms. If the operation times out or an unexpected error occurs, the fail method is called with the appropriate AdobeError.
Example
MobileCore.getPrivacyStatus(new AdobeCallback<MobilePrivacyStatus>() {
    @Override
    public void call(MobilePrivacyStatus value) {
          System.out.println("getPrivacyStatus: " + status);
    }
});
iOS
getPrivacyStatus
The enum representation of the privacy status that corresponds to the following statuses:
ACPMobilePrivacyStatusOptIn 
ACPMobilePrivacyStatusOptOut
ACPMobilePrivacyStatusUnknown
Objective-C
Syntax
+ (void) getPrivacyStatus: (nonnull void (^) (ACPMobilePrivacyStatus status)) callback;
+ (void) getPrivacyStatusWithCompletionHandler: (nonnull void (^) (ACPMobilePrivacyStatus status, NSError* _Nullable error)) completionHandler;
callback is invoked after the privacy status is available.
completionHandler is invoked with the current privacy status, or error if an unexpected error occurs or the request times out. The default timeout is 5000ms.
Example
[ACPCore 
getPrivacyStatus:^(ACPMobilePrivacyStatus status) { 
     switch (status) { 
          case ACPMobilePrivacyStatusOptIn: NSLog(@"Privacy Status: Opt-In");               break; 
          } 
}];
​
​
[ACPCore getPrivacyStatusWithCompletionHandler:^(ACPMobilePrivacyStatus status, NSError * _Nullable error) {
        if (error) {
            // handle error here
        } else {
            // handle the retrieved privacy status
        }
    }];
Swift
Syntax
class func getPrivacyStatus(_ callback: @escaping (_ status: ACPMobilePrivacyStatus) -> Void) {//}
​
class func getPrivacyStatus(withCompletionHandler completionHandler: @escaping (_ status: ACPMobilePrivacyStatus, _ error: Error?) -> Void) {//}
callback is invoked after the privacy status is available.
completionHandler is invoked with the current privacy status, or error if an unexpected error occurs or the request times out. The default timeout is 5000ms.
Example
ACPCore.getPrivacyStatus(
    { status in
        switch status {
            case ACPMobilePrivacyStatusOptIn:
                print("Privacy Status: Opt-In")
            default:
                break
        }
    })
​
​
ACPCore.getPrivacyStatus(withCompletionHandler: { status, error in
    if error != nil {
        // handle error here
    } else {
        // handle the retrieved privacy status
    }
})
Retrieving stored identifiers
To retrieve all the identifier data stored locally by the SDK as a JSON string, and send this data to your servers, use the getSdkIdentities API from the Mobile Core extension.
Configuration keys
To update the SDK configuration, programmatically, use the following information to change your privacy configuration values. For more information, Configuration API reference.
Key
Description
global.privacy
Setting to control privacy opt status; values may include optedid, optedout, optunknown
Video
Using Mobile SDK Privacy APIs
Additional information
For more information about GDPR, see GDPR and Your Business​
To see the GDPR API documentation, go to General Data Protection Regulation API​

Resources - Previous

Frequently asked questions

Next - Resources

WeChat Mini Programs

Last updated 5 months ago

Expected Behavior	Opt In	Opt Out	Opt Unknown
Analytics	Hits are sent	Hits not sent	Hits queued
Audience Manager	Signals, ID syncs are sent	Signals, ID syncs not sent	Syncs queued
Campaign Classic	User data stored, calls are sent	User data cleared, calls not sent	User data stored, calls not sent
Target	Mbox requests are sent	Mbox requests not sent	Mbox requests queued
Campaign Standard	User data stored, calls are sent	User data cleared, calls not sent	User data stored, calls are queued

Key	Description
`global.privacy`	Setting to control privacy opt status; values may include `optedid`, `optedout`, `optunknown`