The Adobe Experience Platform SDK gives 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 (for example, as set out in your agreement with Adobe). As a data controller, you can use the Adobe Cloud 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

Analytics users: If your report suite is not timestamp enabled, hits will be discarded until the privacy status changes to opt in.

To programmatically set the privacy status for the app user:

Android
iOS

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);

Objective-C

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.

Syntax

+ (void) setPrivacyStatus: (ACPMobilePrivacyStatus) status;

Example

[ACPCore setPrivacyStatus: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

Java

getPrivacyStatus

The enum representation of the privacy status that corresponds to the following statuses:

  • MobilePrivacyStatus.OPT_IN

  • MobilePrivacyStatus.OPT_OUT

  • MobilePrivacyStatus.UNKNOWN

Syntax

void getPrivacyStatus(final AdobeCallback callback);

Example

MobileCore.getPrivacyStatus(new AdobeCallback<MobilePrivacyStatus>() {
@Override
public void call(MobilePrivacyStatus value) {
System.out.println("getPrivacyStatus: " + status);
}
});

Objective-C

getPrivacyStatus

The enum representation of the privacy status that corresponds to the following statuses:

  • ACPMobilePrivacyStatusOptIn

  • ACPMobilePrivacyStatusOptOut

  • ACPMobilePrivacyStatusUnknown

Syntax

+ (void) getPrivacyStatus: (nonnull void (^) (ACPMobilePrivacyStatus status)) callback;

Example

[ACPCore
getPrivacyStatus:^(ACPMobilePrivacyStatus status) {
switch (status) {
case ACPMobilePrivacyStatusOptIn: NSLog(@"Privacy Status: Opt-In"); break;
}
}];

Retrieving stored identifiers

The following SDK identities (as applicable) are locally stored:

  • Company Context - IMS Org IDs

  • Experience Cloud ID (MID)

  • User IDs

  • Integration codes (ADID, push IDs)

  • Data source IDs (DPID, DPUUID)

  • Analytics IDs (AVID, AID, VID, and associated RSIDs)

  • Target legacy IDs (TNTID, TNT3rdpartyID)

  • Audience Manager ID (UUID)

To retrieve data as a JSON string from the SDKs, and send this data to your servers, use the following:

You must call the API below and retrieve identities stored in the SDK, before the user opts-out.

Android
iOS

Java

Syntax

MobileCore.getSdkIdentities()

Example

MobileCore.getSdkIdentities(new AdobeCallback<String>() {
@Override
public void call(String value) {
// handle the json string
}
});

Objective-C

Syntax

[ACPCore getSdkIdentities:]

Example

[ACPCore getSdkIdentities:^(NSString * _Nullable content){
NSLog(content);
}];

Configuration keys

To update the SDK configuration, programmatically, use the following information to change your privacy configuration values. For more information, Configuration Methods Reference.

Key

Description

global.privacy

Setting to control privacy opt status; values may include optedid, optedout, optunknown

Further Reading