Documentation

Developers

API References
Data Subject Request API

Data Subject Request API Version 1 and 2

Data Subject Request API Version 3

Platform API

Platform API Overview

Accounts

Apps

Audiences

Calculated Attributes

Data Points

Feeds

Field Transformations

Services

Users

Workspaces

Warehouse Sync API

Warehouse Sync API Overview

Warehouse Sync API Tutorial

Warehouse Sync API Reference

Data Mapping

Warehouse Sync SQL Reference

Warehouse Sync Troubleshooting Guide

ComposeID

Warehouse Sync API v2 Migration

Bulk Profile Deletion API Reference

Calculated Attributes Seeding API

Custom Access Roles API

Data Planning API

Group Identity API Reference

Pixel Service

Profile API

Events API

mParticle JSON Schema Reference

IDSync

Client SDKs
AMP

AMP SDK

Android

Initialization

Configuration

Network Security Configuration

Event Tracking

User Attributes

IDSync

Screen Events

Commerce Events

Location Tracking

Media

Kits

Application State and Session Management

Data Privacy Controls

Error Tracking

Opt Out

Push Notifications

WebView Integration

Logger

Preventing Blocked HTTP Traffic with CNAME

Linting Data Plans

Troubleshooting the Android SDK

API Reference

Upgrade to Version 5

Direct Url Routing

Direct URL Routing FAQ

Web

Android

iOS

Cordova

Cordova Plugin

Identity

iOS

Initialization

Configuration

Event Tracking

User Attributes

IDSync

Screen Tracking

Commerce Events

Location Tracking

Media

Kits

Application State and Session Management

Data Privacy Controls

Error Tracking

Opt Out

Push Notifications

Webview Integration

Upload Frequency

App Extensions

Preventing Blocked HTTP Traffic with CNAME

Linting Data Plans

Troubleshooting iOS SDK

Social Networks

iOS 14 Guide

iOS 15 FAQ

iOS 16 FAQ

iOS 17 FAQ

iOS 18 FAQ

API Reference

Upgrade to Version 7

Flutter

Getting Started

Usage

API Reference

React Native

Getting Started

Identity

Roku

Getting Started

Identity

Media

Xbox

Getting Started

Identity

Unity

Upload Frequency

Getting Started

Opt Out

Initialize the SDK

Event Tracking

Commerce Tracking

Error Tracking

Screen Tracking

Identity

Location Tracking

Session Management

Xamarin

Getting Started

Identity

Web

Initialization

Configuration

Content Security Policy

Event Tracking

User Attributes

IDSync

Page View Tracking

Commerce Events

Location Tracking

Media

Kits

Application State and Session Management

Data Privacy Controls

Error Tracking

Opt Out

Custom Logger

Persistence

Native Web Views

Self-Hosting

Multiple Instances

Web SDK via Google Tag Manager

Preventing Blocked HTTP Traffic with CNAME

Facebook Instant Articles

Troubleshooting the Web SDK

Browser Compatibility

Linting Data Plans

API Reference

Upgrade to Version 2 of the SDK

Web

Alexa

Media SDKs

Android

iOS

Web

Quickstart
Android

Overview

Step 1. Create an input

Step 2. Verify your input

Step 3. Set up your output

Step 4. Create a connection

Step 5. Verify your connection

Step 6. Track events

Step 7. Track user data

Step 8. Create a data plan

Step 9. Test your local app

HTTP Quick Start

Step 1. Create an input

Step 2. Create an output

Step 3. Verify output

iOS Quick Start

Overview

Step 1. Create an input

Step 2. Verify your input

Step 3. Set up your output

Step 4. Create a connection

Step 5. Verify your connection

Step 6. Track events

Step 7. Track user data

Step 8. Create a data plan

Java Quick Start

Step 1. Create an input

Step 2. Create an output

Step 3. Verify output

Node Quick Start

Step 1. Create an input

Step 2. Create an output

Step 3. Verify output

Python Quick Start

Step 1. Create an input

Step 2. Create an output

Step 3. Verify output

Web

Overview

Step 1. Create an input

Step 2. Verify your input

Step 3. Set up your output

Step 4. Create a connection

Step 5. Verify your connection

Step 6. Track events

Step 7. Track user data

Step 8. Create a data plan

Server SDKs

Node SDK

Go SDK

Python SDK

Ruby SDK

Java SDK

Tools

Linting Tools

Smartype

mParticle Command Line Interface

Guides
Partners

Introduction

Outbound Integrations

Outbound Integrations

Firehose Java SDK

Inbound Integrations

Kit Integrations

Overview

Android Kit Integration

JavaScript Kit Integration

iOS Kit Integration

Compose ID

Data Hosting Locations

Glossary

Migrate from Segment to mParticle

Migrate from Segment to mParticle

Migrate from Segment to Client-side mParticle

Migrate from Segment to Server-side mParticle

Segment-to-mParticle Migration Reference

Rules Developer Guide

API Credential Management

The Developer's Guided Journey to mParticle

Guides

Getting Started

Create an Input

Start capturing data

Connect an Event Output

Create an Audience

Connect an Audience Output

Transform and Enhance Your Data

Platform Guide
The New mParticle Experience

The new mParticle Experience

The Overview Map

Observability

Observability Overview

Observability User Guide

Observability Span Glossary

Introduction

Data Retention

Connections

Activity

Live Stream

Data Filter

Rules

Tiered Events

mParticle Users and Roles

Analytics Free Trial

Troubleshooting mParticle

Usage metering for value-based pricing (VBP)

Analytics

Introduction

Setup

Sync and Activate Analytics User Segments in mParticle

User Segment Activation

Welcome Page Announcements

Settings

Project Settings

Roles and Teammates

Organization Settings

Global Project Filters

Portfolio Analytics

Analytics Data Manager

Analytics Data Manager Overview

Events

Event Properties

User Properties

Revenue Mapping

Export Data

UTM Guide

Query Builder

Data Dictionary

Query Builder Overview

Modify Filters With And/Or Clauses

Query-time Sampling

Query Notes

Filter Where Clauses

Event vs. User Properties

Group By Clauses

Annotations

Cross-tool Compatibility

Apply All for Filter Where Clauses

Date Range and Time Settings Overview

Understanding the Screen View Event

Analyses

Analyses Introduction

Segmentation: Basics

Getting Started

Visualization Options

For Clauses

Date Range and Time Settings

Calculator

Numerical Settings

Segmentation: Advanced

Assisted Analysis

Properties Explorer

Frequency in Segmentation

Trends in Segmentation

Did [not] Perform Clauses

Cumulative vs. Non-Cumulative Analysis in Segmentation

Total Count of vs. Users Who Performed

Save Your Segmentation Analysis

Export Results in Segmentation

Explore Users from Segmentation

Funnels: Basics

Getting Started with Funnels

Group By Settings

Conversion Window

Tracking Properties

Date Range and Time Settings

Visualization Options

Interpreting a Funnel Analysis

Funnels: Advanced

Group By

Filters

Conversion over Time

Conversion Order

Trends

Funnel Direction

Multi-path Funnels

Analyze as Cohort from Funnel

Save a Funnel Analysis

Explore Users from a Funnel

Export Results from a Funnel

Cohorts

Getting Started with Cohorts

Analysis Modes

Save a Cohort Analysis

Export Results

Explore Users

Saved Analyses

Manage Analyses in Dashboards

Users

Getting Started

User Activity Timelines

Time Settings

Export Results

Save A User Analysis

Journeys

Getting Started

Event Menu

Visualization

Ending Event

Save a Journey Analysis

Dashboards

Dashboards––Getting Started

Manage Dashboards

Organize Dashboards

Dashboard Filters

Scheduled Reports

Favorites

Time and Interval Settings in Dashboards

Query Notes in Dashboards

User Aliasing

Analytics Resources

The Demo Environment

Keyboard Shortcuts

Tutorials

Analytics for Marketers

Analytics for Product Managers

Compare Conversion Across Acquisition Sources

Analyze Product Feature Usage

Identify Points of User Friction

Time-based Subscription Analysis

Dashboard Tips and Tricks

Understand Product Stickiness

Optimize User Flow with A/B Testing

User Segments

APIs

User Segments Export API

Dashboard Filter API

IDSync

IDSync Overview

Use Cases for IDSync

Components of IDSync

Store and Organize User Data

Identify Users

Default IDSync Configuration

Profile Conversion Strategy

Profile Link Strategy

Profile Isolation Strategy

Best Match Strategy

Aliasing

Data Master
Group Identity

Overview

Create and Manage Group Definitions

Introduction

Catalog

Live Stream

Data Plans

Data Plans

Blocked Data Backfill Guide

Personalization
Predictive Audiences

Predictive Audiences Overview

Using Predictive Audiences

Predictive Attributes

Predictive Attributes Overview

Create Predictive Attributes

Assess and Troubleshoot Predictions

Use Predictive Attributes in Campaigns

Introduction

Profiles

Calculated Attributes

Calculated Attributes Overview

Using Calculated Attributes

Create with AI Assistance

Calculated Attributes Reference

Audiences

Audiences Overview

Real-time Audiences

Standard Audiences

Journeys

Journeys Overview

Manage Journeys

Download an audience from a journey

Audience A/B testing from a journey

Journeys 2.0

Warehouse Sync

Data Privacy Controls

Data Subject Requests

Default Service Limits

Feeds

Cross-Account Audience Sharing

Approved Sub-Processors

Import Data with CSV Files

Import Data with CSV Files

CSV File Reference

Glossary

Video Index

Analytics (Deprecated)
Settings

Debug Console

Data Warehouse Delay Alerting

Identity Providers

Single Sign-On (SSO)

Setup Examples

Introduction

Developer Docs

Introduction

Integrations

Introduction

Rudderstack

Google Tag Manager

Segment

Data Warehouses and Data Lakes

Advanced Data Warehouse Settings

AWS Kinesis (Snowplow)

AWS Redshift (Define Your Own Schema)

AWS S3 Integration (Define Your Own Schema)

AWS S3 (Snowplow Schema)

BigQuery (Snowplow Schema)

BigQuery Firebase Schema

BigQuery (Define Your Own Schema)

GCP BigQuery Export

Snowplow Schema Overview

Snowflake (Snowplow Schema)

Snowflake (Define Your Own Schema)

APIs

Dashboard Filter API (Deprecated)

REST API

User Segments Export API (Deprecated)

SDKs

SDKs Introduction

React Native

iOS

Android

Java

JavaScript

Python

Object API

Developer Basics

Aliasing

Integrations

24i

Event

ABTasty

Audience

Abakus

Event

Aarki

Audience

Actable

Feed

AdChemix

Event

Adjust

Event

Feed

AdMedia

Audience

Adikteev

Audience

Event

Adobe Marketing Cloud

Cookie Sync

Event

Adobe Audience Manager

Audience

Adobe Campaign Manager

Audience

Adobe Target

Audience

AdPredictive

Feed

AgilOne

Event

Algolia

Event

Airship

Audience

Event

Feed

AlgoLift

Feed

Event

Alooma

Event

Amazon Kinesis

Event

Amazon Advertising

Audience

Amazon Kinesis Firehose

Audience

Event

Amazon S3

Event

Amazon Redshift

Data Warehouse

Amazon SNS

Event

Adobe Marketing Cloud

Event

Amazon SQS

Event

Amobee

Audience

Amplitude

Forwarding Data Subject Requests

Event

Ampush

Audience

Event

Analytics

Audience

Event

Forwarding Data Subject Requests

AppsFlyer

Event

Feed

Forwarding Data Subject Requests

Anodot

Event

Antavo

Feed

Apptentive

Event

AppLovin

Audience

Event

Apptimize

Event

Apteligent

Event

Microsoft Azure Blob Storage

Event

Attentive

Event

Feed

Bidease

Audience

Batch

Audience

Event

Attractor

Event

Bing Ads

Event

Bluecore

Event

Bluedot

Feed

Blueshift

Event

Feed

Forwarding Data Subject Requests

Branch S2S Event

Event

Branch

Feed

Event

Forwarding Data Subject Requests

Bugsnag

Event

Cadent

Audience

Braze

Audience

Feed

Forwarding Data Subject Requests

Event

Button

Audience

Event

ciValue

Event

Feed

Census

Feed

CleverTap

Event

Feed

Audience

comScore

Event

Conversant

Event

Cordial

Audience

Feed

Cortex

Event

Feed

Forwarding Data Subject Requests

Criteo

Audience

Event

Custom Feed

Custom Feed

Crossing Minds

Event

CustomerGlu

Event

Feed

Customer.io

Audience

Event

Feed

Databricks

Data Warehouse

Datadog

Event

Didomi

Event

Dynalyst

Audience

Dynamic Yield

Audience

Event

Edge226

Audience

Emarsys

Audience

Epsilon

Event

Everflow

Audience

Facebook

Audience

Event

Fiksu

Audience

Event

Facebook Offline Conversions

Event

Google Analytics for Firebase

Event

Flybits

Event

Flurry

Event

ForeSee

Event

Formation

Event

Feed

Foursquare

Audience

Feed

FreeWheel Data Suite

Audience

Google Ad Manager

Audience

Google Ads

Audience

Event

Google Analytics

Event

Google Analytics 4

Event

Google BigQuery

Audience

Data Warehouse

Google Cloud Storage

Event

Audience

Google Enhanced Conversions

Event

Google Marketing Platform

Cookie Sync

Audience

Event

Google Marketing Platform Offline Conversions

Event

Google Pub/Sub

Event

Google Tag Manager

Event

Heap

Event

Hightouch

Feed

Herow

Feed

Hyperlocology

Event

Ibotta

Event

Impact

Event

Indicative

Audience

Event

InMarket

Audience

Insider

Audience

Event

Feed

InMobi

Audience

Event

Inspectlet

Event

Intercom

Event

iPost

Audience

Feed

ironSource

Audience

Iterable

Event

Audience

Feed

Jampp

Audience

Event

Kafka

Event

Kayzen

Event

Audience

Kochava

Feed

Forwarding Data Subject Requests

Event

Kissmetrics

Event

Klaviyo

Event

Audience

Kubit

Event

LaunchDarkly

Feed

Leanplum

Audience

Feed

Event

LifeStreet

Audience

LiveLike

Event

Liveramp

Audience

Liftoff

Audience

Event

Localytics

Event

MadHive

Audience

mAdme Technologies

Event

Mailchimp

Audience

Feed

Event

Marigold

Audience

Mautic

Audience

Event

MediaMath

Audience

Mediasmart

Audience

Mintegral

Audience

Microsoft Azure Event Hubs

Event

Mixpanel

Audience

Forwarding Data Subject Requests

Event

MoEngage

Event

Audience

Feed

Moloco

Event

Audience

Monetate

Event

Movable Ink - V2

Event

Movable Ink

Event

Multiplied

Event

myTarget

Event

Audience

Nami ML

Feed

Nanigans

Event

Narrative

Audience

Event

Feed

Neura

Event

NCR Aloha

Event

OneTrust

Event

Optimizely

Audience

Event

Oracle Responsys

Audience

Event

Oracle BlueKai

Event

Paytronix

Feed

Persona.ly

Audience

Personify XP

Event

PieEye

Inbound Data Subject Requests

Pilgrim

Feed

Event

Pinterest

Audience

Event

Plarin

Event

Postie

Audience

Event

Punchh

Audience

Event

Feed

Primer

Event

Quantcast

Event

Radar

Event

Feed

Regal

Event

Reddit

Audience

Event

Remerge

Audience

Event

Qualtrics

Event

RevenueCat

Feed

Retina AI

Event

Feed

Reveal Mobile

Event

RTB House

Event

Audience

Rokt

Audience

Salesforce Email

Audience

Event

Feed

Sailthru

Audience

Event

Salesforce Mobile Push

Event

Samba TV

Audience

Event

SendGrid

Audience

Feed

Scalarr

Event

ShareThis

Audience

Feed

SessionM

Event

Feed

Signal

Event

Shopify

Custom Pixel

Feed

SimpleReach

Event

Singular

Event

Feed

Singular-DEPRECATED

Event

Skyhook

Event

Smadex

Audience

Slack

Event

SmarterHQ

Event

Snapchat Conversions

Event

Snapchat

Audience

Event

Snowflake

Data Warehouse

Snowplow

Event

Splunk MINT

Event

Split

Event

Feed

StartApp

Audience

Sprig

Audience

Event

Statsig

Event

Feed

Stormly

Audience

Event

Swrve

Event

Feed

Talon.One

Audience

Feed

Event

Tapad

Audience

Tapjoy

Audience

Taplytics

Event

Taptica

Audience

Teak

Audience

The Trade Desk

Audience

Cookie Sync

Event

Ticketure

Feed

TikTok Event

Audience (Deprecated)

Audience

Event

Audience Migration

Treasure Data

Audience

Event

Triton Digital

Audience

Twitter

Audience

Event

TUNE

Event

Valid

Event

Vkontakte

Audience

Voucherify

Audience

Event

Vungle

Audience

Webhook

Event

Webtrends

Event

White Label Loyalty

Event

Wootric

Event

Xandr

Audience

Cookie Sync

Yahoo (formerly Verizon Media)

Audience

Cookie Sync

Yotpo

Feed

YouAppi

Audience

Z2A Digital

Audience

Event

Pushwoosh

Audience

Event

Zendesk

Feed

Event

Quadratic Labs

Event

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, and more.

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. This kit-only integration solely supports client-side data forwarding.

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.

Before enabling the integration, include your customized script for OneTrust in the <head> of your page before the mParticle snippet. You can get this from your OneTrust dashboard under Preference & Consent Management > Cookie Compliance > Integrations > Scripts.

Add the OneTrust SDK script tag to your html

// 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

Add Cookie Settings Button and Policy Information (optional)

OneTrust recommends that you add a Cookie Settings button or div in your site/application’s footer

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

Optionally, you can also add a cookie policy list

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

Web Implementation Details

When a user browses your web site, the OneTrust Web SDK sets a OnetrustActiveGroups variable on the window. This variable is a comma-separated list of Cookie Groups the current user is part of. The value might look like "group 2, group 4".

When the OneTrust integration is enabled, the mParticle SDK checks the value of OnetrustActiveGroups and sets consent state for each mapped purpose. If the mapped Cookie Group ID is listed in OnetrustActiveGroups, mParticle will set the value of consented to true for the corresponding purpose. If the ID is not listed, mParticle sets consented to false.

For example, if your Cookie Groups are mapped as below, and the value of OnetrustActiveGroups is "group 2", mParticle will set consented to true for the “Performance” purpose and false for the “Marketing” purpose.

The mParticle SDK will automatically update consent state if the user changes, or if the value of OnetrustActiveGroups changes.

The mParticle SDK also waits for the OneTrust SDK to fire the OptanonWrapper callback, signaling that OneTrust has loaded and is able to send events. Please make sure this is included in your implementation as OneTrust also requires this.

Before enabling the integration, you must install the OneTrust SDK. This can either be installed via CocoaPods (recommended) or via your OneTrust dashboard under Preference & Consent Management > Cookie Compliance > Integrations > SDKs.

Further instructions can be found at https://developer.onetrust.com/sdk/mobile-apps/ios/getting-started

Note: If you install the SDK manually using artifacts downloaded from OneTrust, you will also need to manually drag the MPKitOneTrust.h and MPKitOneTrust.m files from the kit into your project.

Add the OneTrust SDK to your Podspec file

Add the OneTrust podspec repositories as sources to your application’s Podfile, then add the necessary pods:

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

Run pod install in the root of your application directory

$> 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 and initialize the OneTrust SDK:

#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

    }];

iOS Implementation Details

When building your app, OneTrust requires that you implement their OTPublisherHeadlessSDK and either their Banner or Preference Center UI via OTPublishersHeadlessSDK.shared.setupUI and either showPreferenceCenterUI or showBannerUI. This will render the OneTrust UI upon your application’s first load. You may also need to configure a button in your UI to manually trigger these UI function separately. Please consult the OneTrust: Displaying User Interfaces documentation for details.

Upon loading your mobile app, the mParticle SDK will fetch the Consent Mapping defined in your mParticle OneTrust Connection and map these GDPR Consent Purposes with OneTrust Cookie Categories. The SDK will then define NSNotificationCenter Observers for each OneTrust Cookie Category and fetch the current consent state from OneTrust’s servers using OTPublishersHeadlessSDK.shared getConsentStatusForCategory, initializing a user’s session with their current consent state.

When a user interacts with the OneTrust UI, the OTPublishersHeadlessSDK will dispatch an event to the NSNotificationCenter which will then be picked up by the mParticle SDK’s listeners. This will continue to update the consent state any time the user interacts with the OneTrust UI.

Before enabling the integration, you must install the OneTrust SDK. This can either be installed via Maven (recommended) or via your OneTrust dashboard under Preference & Consent Management > Cookie Compliance > Integrations > SDKs.

Add the OneTrust SDK to your settings.gradle file

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

Import and initialize the OneTrust SDK

// 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());
        }
    })

Android Implementation Details

When building your app, OneTrust requires that you implement their OTPublishersHeadlessSDK and either their Banner or Preference Center UI via OTPublishersHeadlessSDK.setupUI and either showPreferenceCenterUI or showBannerUI. This will render the OneTrust modal upon your application’s first load. You may also need to configure a button in your UI to manually trigger these UI function separately. Please consult the OneTrust: Displaying User Interfaces documentation for details.

Upon loading your mobile app, the mParticle SDK will fetch the Consent Mapping defined in your mParticle OneTrust Connection and map these Consent Purposes with OneTrust Cookie Categories. The SDK will then define BroadcastReceiver() Observers for each OneTrust Cookie Category and fetch the current consent state from OneTrust’s servers using OTPublishersHeadlessSDK.getConsentStatusForGroupId, initializing a user’s session with their current consent state.

When a user interracts with the OneTrust modal, the OTPublishersHeadlessSDK will dispatch an event that the mParticle SDK’s BroadcastReceiver() will pick up and update the mParticle Consent State. This will continue to update the consent state any time the user interacts with the OneTrust UI.

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 and your OneTrust Vendor IDs for each type of Vendor (IAB, Google, and General) 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. To retrieve your vendor Ids, visit https://app.onetrust.com/cookies/vendors/list. The initial page will show the ID for your General Vendors on the main page (these are user editable). Click on IAB Vendor and filter the list there for both IAB and Google Vendors.

In this example, you can see the 4 sections for mapping your mParticle consent purposes to the corresponding consent mapping in OneTrust. Purpose Consent Mapping is for your category or cookie consent groups while the other three sections refer to the three different types of vendor consent groups in OneTrust.

Connection Settings

Setting Name Data Type Description
Purpose Consent Mapping string Mapping of your mParticle GDPR consent purposes to OneTrust consent groups.
IAB Vendor Consent Mapping string Mapping of your mParticle consent purposes to OneTrust IAB vendor consent groups.
Google Vendor Consent Mapping string Mapping of your mParticle consent purposes to OneTrust Google consent groups.
General Vendor Consent Mapping string Mapping of your mParticle consent purposes to OneTrust general vendor consent groups.

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.

To learn more about GDPR and CCPA consent purposes, see Data Privacy Controls.

    Last Updated: November 27, 2024