Event

OneTrust is a global leader for GDPR and privacy management.

mParticle’s OneTrust integration operates in a unique way. While it is enabled as an event integration, no event data is passed from mParticle to OneTrust. The purpose of the integration is to allow you to map OneTrust cookie/consent groups to mParticle’s consent “purposes”.

mParticle can, in turn, use this consent information to enable and disable other integrations, power consent forwarding rules, etc. Read our documentation on Consent Management to understand more about GDPR consent purposes.

For specifics on GDPR and CCPA implementation within the One Trust integration, please review Mapping Consent States below.

How it Works

Whenever a user browses your site or uses your mobile app, OneTrust provides a collection of cookie groups IDs representing the GDPR consent purposes a user has consented to, or declined.

When the OneTrust integration is enabled, the mParticle SDK connects with our servers and OneTrust to create a mapping of OneTrust cookie groups to the GDPR consent purposes defined in the mParticle UI.

The mParticle SDK then registers event listeners that act when OneTrust dispatches consent events via the OneTrust modal. The mParticle SDK will then update consent state every time the user confirms their changes.

Implementation

mParticle’s OneTrust integration requires that you add the OneTrust SDK to your Web, iOS, or Android app. When initialized, the mParticle OneTrust kit will map OneTrust’s consent group cookie IDs to your mParticle GDPR consent purposes according to the mapping you have defined in the Connection Settings.

The basic requirements to enable the OneTrust integration are:

• Add the OneTrust SDK to your app (this requires a manual download or private credentials)

  • (iOS/Android) You will need to verify that the version of your installed OneTrust SDK matches the version in your dashboard on app.onetrust.com.
• Add the separate mParticle-OneTrust kit to your app
• Enable the integration in mParticle

There may also be additional configuration required to implement the OneTrust UI for your application. Please consult the OneTrust SDK Dev Portal for instructions

See the Apple SDK and Android SDK guides to read more about kits.

Enabling the Integration

The OneTrust integration works by syncing consent state between the current mParticle user and OneTrust SDK. You must separately initialize the OneTrust SDK and the mParticle SDK, and the integration simply works as a bridge between the two.

The flow is as follows:

1. Both SDKs are separately initialized.
2. The mParticle SDK will detect and initialize the OneTrust kit if present.
3. Whenever (a) consent state of the current user is mutated, or (b) the current user changes based on an mParticle IDSync API result, the mParticle kit will send the latest OneTrust-gathered consent state to the mParticle SDK.

// OneTrust script from your admin dashboard

<!-- OneTrust Cookies Consent Notice start for YOURWEBSITENAME.COM -->
<script
    src="https://cdn.cookielaw.org/scripttemplates/otSDKStub.js"
    type="text/javascript"
    charset="UTF-8"
    data-domain-script="xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" >
</script>
<script type="text/javascript">
    // Required OneTrust Callback
    function OptanonWrapper() { }
</script>
<!-- OneTrust Cookies Consent Notice end for YOURWEBSITENAME.COM -->
</script>


// Add mParticle SDK snippet below

<!-- OneTrust Cookies Settings button start -->
<button id="ot-sdk-btn" class="ot-sdk-show-settings">Cookie Settings</button>
<!-- OneTrust Cookies Settings button end -->

<!-- OneTrust Cookies List start -->
<div id="ot-sdk-cookie-policy"></div>
<!-- OneTrust Cookies List end -->

target 'Your-App' do
    # Required pods

    # Specify exact version used in app.onetrust.com
    pod 'OneTrust-CMP-XCFramework', 'X.XX.X'

    pod 'mParticle-Apple-SDK', '~>8.4.0'
    pod 'mParticle-OneTrust', '~>8.0.2'
end

$> pod install

Downloading dependencies
Installing mParticle-OneTrust 8.0.2 (was 8.0.1)
Generating Pods project
Integrating client project
Pod installation complete! There are 6 dependencies from the Podfile and 5 total pods installed.

#import <mParticle_Apple_SDK/mParticle.h>
#import <OTPublishersHeadlessSDK/OTPublishersHeadlessSDK-Swift.h>

[[OTPublishersHeadlessSDK shared]
    startSDKWithStorageLocation: @"cdn.cookielaw.org"
    domainIdentifier: @"XXXXXXXXXXXXXXXXXXXXXXXXX"
    languageCode:@"en"
    params: sdkParams
    completionHandler:^(OTResponse *response) {

        // Take any next action

    }];

include ':app', ':OTPublishersHeadlessSDK-release'
include ':mparticle-android-integration-onetrust'

// import OneTrust SDK
import com.onetrust.otpublishers.headless.Public.OTPublishersHeadlessSDK;

// Use OneTrust
OTPublishersHeadlessSDK otPublishersHeadlessSDK = new OTPublishersHeadlessSDK(this);

otPublishersHeadlessSDK.startSDK(domainURL, domainId, languageCode, sdkParams, new OTCallback() {
	@Override
	public void onSuccess(@NonNull OTResponse otSuccessResponse) {
        // Success logging and actions
	}

	@Override
	public void onFailure(@NonNull OTResponse otErrorResponse) {
		// Use below method to get errorCode and errorMessage.
		int errorCode = otErrorResponse.getResponseCode();
		String errorDetails = otErrorResponse.getResponseMessage();
		// Use toString() to log complete OT response
		Log.i(LOG_TAG, otErrorResponse.toString());
	}
});

// import OneTrust SDK
import com.onetrust.otpublishers.headless.Public.OTPublishersHeadlessSDK;

// Use OneTrust
val otPublishersHeadlessSDK = OTPublishersHeadlessSDK(this)

otPublishersHeadlessSDK.startSDK(
    "cdn.cookielaw.org",                           // domainURL
    "XXXXXXXX-XXXXXXXXXXX-XXXXXXXXX-XXXXXXXXXX",   // domainId
    "en",                                          // languageCode
    null,                                          // sdkParams
    object : OTCallback {
        override fun onSuccess(otSuccessResponse: OTResponse) {
            // Success logging and actions
        }

        override fun onFailure(otErrorResponse: OTResponse) {
            // Use below method to get errorCode and errorMessage.
            val errorCode = otErrorResponse.responseCode
            val errorDetails = otErrorResponse.responseMessage
		    Log.i(LOG_TAG, otErrorResponse.toString());
        }
    })

Configuring OneTrust in the mParticle Dashboard

To enable the OneTrust integration, configure OneTrust from mParticle’s integrations directory and connect it to your input. In the Connection Settings, you need to map your OneTrust Cookie Group IDs to your mParticle GDPR consent purposes.

The ID of each of your Cookie Groups can be found in the OneTrust dashboard under Preference & Consent Management > Cookie Compliance > Categorizations > Categories.

In this example, OneTrust Cookie Group “group 2” (Performance Cookies) are mapped to the “Performance” purpose, and OneTrust Cookie Group “group 4” (Targeting Cookies) are mapped to the “Marketing” purpose:

Connection Settings

Mapping Consent States

The mParticle OneTrust integration supports both GDPR and CCPA consent states transparently. Currently, any OneTrust Cookie Group that is mapped to a consent purpose of data_sale_opt_in will be automatically assigned a CCPA consent state. All other consent purposes are mapped as GDPR.

Read our documentation on Consent Management to understand more about GDPR and CCPA consent purposes.