AMP SDK
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 FAQ
Web
Android
iOS
Cordova Plugin
Identity
Workspace Switching
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
Getting Started
Identity
Upload Frequency
Getting Started
Opt Out
Initialize the SDK
Event Tracking
Commerce Tracking
Error Tracking
Screen Tracking
Identity
Location Tracking
Session Management
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
Getting Started
Identity
Alexa
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
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 1. Create an input
Step 2. Create an output
Step 3. Verify output
Key Management
Platform API Overview
Accounts
Apps
Audiences
Calculated Attributes
Data Points
Feeds
Field Transformations
Services
Users
Workspaces
Data Subject Request API Version 1 and 2
Data Subject Request API Version 3
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
Group Identity API Reference
Data Planning API
Pixel Service
Profile API
Events API
mParticle JSON Schema Reference
IDSync
Node SDK
Go SDK
Python SDK
Ruby SDK
Java SDK
Introduction
Outbound Integrations
Firehose Java SDK
Inbound Integrations
Compose ID
Data Hosting Locations
Glossary
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
Overview
Overview
User Profiles
Overview
Create and Manage Group Definitions
Calculated Attributes Overview
Using Calculated Attributes
Create with AI Assistance
Calculated Attributes Reference
What are predictive attributes?
Create an Input
Start capturing data
Connect an Event Output
Create an Audience
Connect an Audience Output
Transform and Enhance Your Data
Usage and Billing Report
The new mParticle Experience
The Overview Map
Observability Overview
Observability User Guide
Observability Troubleshooting Examples
Observability Span Glossary
Key Management
Event Forwarding
Notification Center (Early Access)
System Alerts
Trends
Introduction
Data Retention
Data Catalog
Connections
Activity
Data Plans
Live Stream
Filters
Rules
Blocked Data Backfill Guide
Tiered Events
mParticle Users and Roles
Analytics Free Trial
Troubleshooting mParticle
Usage metering for value-based pricing (VBP)
Audiences Overview
Create an Audience
Connect an Audience
Manage Audiences
FAQ
Real-time Audiences (Legacy)
Standard Audiences (Legacy)
New vs. Classic Experience Comparison
Predictive Audiences Overview
Using Predictive Audiences
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
Introduction
Core Analytics (Beta)
Sync and Activate Analytics User Segments in mParticle
User Segment Activation
Welcome Page Announcements
Project Settings
Roles and Teammates
Organization Settings
Global Project Filters
Portfolio Analytics
Analytics Data Manager Overview
Events
Event Properties
User Properties
Revenue Mapping
Export Data
UTM Guide
Analyses Introduction
Getting Started
Visualization Options
For Clauses
Date Range and Time Settings
Calculator
Numerical Settings
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
Getting Started with Funnels
Group By Settings
Conversion Window
Tracking Properties
Date Range and Time Settings
Visualization Options
Interpreting a Funnel Analysis
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
Saved Analyses
Manage Analyses in Dashboards
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
User Attributes at Event Time
Understanding the Screen View Event
User Aliasing
Dashboards––Getting Started
Manage Dashboards
Dashboard Filters
Organize Dashboards
Scheduled Reports
Favorites
Time and Interval Settings in Dashboards
Query Notes in Dashboards
The Demo Environment
Keyboard Shortcuts
User Segments
Warehouse Sync
Data Privacy Controls
Data Subject Requests
Default Service Limits
Feeds
Cross-Account Audience Sharing
Approved Sub-Processors
Import Data with CSV Files
CSV File Reference
Glossary
Video Index
Single Sign-On (SSO)
Setup Examples
Introduction
Introduction
Introduction
Rudderstack
Google Tag Manager
Segment
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
Snowflake (Snowplow Schema)
Snowplow Schema Overview
Snowflake (Define Your Own Schema)
Aliasing
Event
Audience
Event
Audience
Feed
Event
Audience
Cookie Sync
Server-to-Server Events
Platform SDK Events
Audience
Audience
Audience
Feed
Event
Event
Event
Audience
Event
Data Warehouse
Event
Event
Event
Audience
Event
Event
Feed
Event
Event
Event
Event
Event
Event
Audience
Event
Feed
Event
Event
Audience
Feed
Event
Event
Event
Custom Feed
Data Warehouse
Event
Event
Audience
Audience
Event
Audience
Audience
Event
Event
Event
Event
Event
Audience
Audience
Event
Event
Event
Audience
Data Warehouse
Event
Audience
Cookie Sync
Event
Event
Event
Event
Event
Feed
Feed
Event
Event
Kit
Audience
Event
Event
Event
Audience
Event
Event
Event
Feed
Audience
Event
Event
Audience
Audience
Event
Audience
Audience
Audience
Event
Audience
Event
Event
Event
Event
Feed
Event
Event
Event
Event
Event
Feed
Audience
Event
Event
Event
Event
Event
Event
Event
Event
Feed
Event
Event
Event
Custom Pixel
Feed
Event
Event
Event
Event
Audience
Event
Event
Event
Data Warehouse
Event
Event
Audience
Audience
Audience
Event
Feed
Loyalty Feed
Audience
Event
Audience
Audience
Audience
Cookie Sync
Event
Feed
Audience
Event
Event
Audience
Audience
Event
Event
Event
Event
Audience
Cookie Sync
Audience
Cookie Sync
Feed
Audience
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.
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.
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)
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.
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:
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 belowAdd 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'
endRun 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.
To enable the OneTrust integration in mParticle:
Toggle Connection Status to Active and map your OneTrust Cookie Group IDs and your OneTrust Vendor IDs for each vendor (IAB, Google, and General) to your mParticle GDPR consent purposes.
| 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.