Data Subject Request API Version 1 and 2
Data Subject Request API Version 3
Platform API Overview
Accounts
Apps
Audiences
Calculated Attributes
Data Points
Feeds
Field Transformations
Services
Users
Workspaces
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
Custom Access Roles API
Bulk Profile Deletion API Reference
Data Planning API
Group Identity API Reference
Calculated Attributes Seeding API
Pixel Service
Profile API
Events API
mParticle JSON Schema Reference
IDSync
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
Cordova Plugin
Identity
Direct URL Routing FAQ
Web
Android
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
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
Web
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
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
Create an Input
Start capturing data
Connect an Event Output
Create an Audience
Connect an Audience Output
Transform and Enhance Your Data
The new mParticle Experience
The Overview Map
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)
Introduction
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
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 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
Dashboards––Getting Started
Manage Dashboards
Dashboard Filters
Organize Dashboards
Scheduled Reports
Favorites
Time and Interval Settings in Dashboards
Query Notes in Dashboards
User Aliasing
The Demo Environment
Keyboard Shortcuts
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
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
Overview
Create and Manage Group Definitions
Introduction
Catalog
Live Stream
Data Plans
Blocked Data Backfill Guide
Predictive Attributes Overview
Create Predictive Attributes
Assess and Troubleshoot Predictions
Use Predictive Attributes in Campaigns
Predictive Audiences Overview
Using Predictive Audiences
Introduction
Profiles
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
Event
Audience
Audience
Event
Feed
Event
Cookie Sync
Audience
Audience
Audience
Audience
Event
Feed
Event
Event
Audience
Event
Data Warehouse
Event
Event
Event
Event
Audience
Event
Feed
Event
Event
Event
Event
Event
Audience
Event
Event
Feed
Event
Event
Audience
Feed
Event
Event
Event
Custom Feed
Data Warehouse
Event
Event
Audience
Audience
Audience
Event
Audience
Event
Event
Event
Event
Event
Audience
Audience
Event
Audience
Data Warehouse
Event
Event
Cookie Sync
Audience
Event
Event
Event
Event
Event
Feed
Feed
Event
Event
Event
Audience
Event
Event
Audience
Event
Event
Event
Audience
Feed
Audience
Event
Event
Audience
Audience
Event
Audience
Audience
Event
Audience
Event
Event
Event
Event
Event
Feed
Event
Event
Event
Event
Audience
Feed
Event
Event
Event
Event
Event
Event
Event
Feed
Audience
Event
Event
Custom Pixel
Feed
Event
Event
Event
Event
Event
Audience
Event
Event
Event
Data Warehouse
Event
Audience
Audience
Audience
Audience
Event
Audience
Audience
Cookie Sync
Event
Feed
Event
Audience
Event
Audience
Audience
Event
Event
Event
Event
Cookie Sync
Audience
Cookie Sync
Audience
Feed
Audience
Event
Adobe provides analytics and optimizations for mobile apps and brings together all marketing capabilities across Adobe Marketing Cloud. This version sends data to your account using version 4.X of the Adobe API.
mParticle supports Adobe Marketing Cloud’s Mobile Services through our mobile SDKs and platform forwarding functionality. Data collection is enabled through SDK instrumentation. Once your app is properly instrumented, data is ingested into the mParticle platform, which maps inbound data to the Adobe Mobile Services’ features and their required formats and then forwards the data to Adobe.
Currently mParticle supports Adobe’s 4.x SDK. The workflow of using the mParticle SDK is similar to using Adobe 4.x SDK.
If you are new to setting up Adobe Marketing Cloud’s Mobile Services, your best place to start is of course Adobe itself and the below is a must-read before proceeding:
If you are migrating from Adobe v2 or v3 to the latest Adobe Marketing Cloud platform, please take a moment to read the following:
When mParticle sends data to the Adobe Marketing Cloud, mParticle utilizes the Amazon Marketing Mobile Services’ native APIs. This allows mParticle to implement server side data forwarding and supports our value proposition to customers of not requiring that additional app SDK components be continually added and updated for integrations.
You will need an Adobe Marketing Cloud account to get your Reporting Suite ID (RSID) and your Tracking Server. You will need these settings when configuring Adobe in mParticle Setup.
Follow one of these steps to create your Tracking Server:
The following settings are available for backwards compatibility with Adobe V3.x and are not necessary for Adobe V4.x.
| Adobe Analytics Feature Name | Adobe Analytics Feature Category | Feature Description | mParticle Supported? | Comments |
|---|---|---|---|---|
| Track App States | Analytics | Track the state of your application. | Yes | |
| Track App Actions | Analytics | Actions are the events that occur in your app that you want to measure. | Yes | |
| Track App Crashes | Analytics | Answers to questions about how crashes are tracked and best practices for avoiding false crashes. | Yes | |
| Timed Actions | Analytics | Measure how long an event takes | No | mParticle expects to add support in a future release. For now developers can time events themselves and pass timing via eventLength parameter |
| Visitor Lifetime Value | Analytics | Lifetime value lets you measure and target on a lifetime value for each user. | Yes | |
| Products Variable | Analytics | Product variable store Product details for which an action is taking place. | Yes | |
| Video Analytics | Analytics | Video Analtyics is the process of collecting and aggregating video metrics. | No | |
| Geofencing and points-of-interest (POI) | Location | Location tracking; Automatically calculates distance to a predefined list of POI | Yes | mParticle supports location tracking but not geofencing; geofencing support is planned for a future release. |
| Experience Testing | Target | Create and edit A/B testing campaigns | No | |
| Audience Management | Audience | Audience management allows you to design tests and create audience segments to target content. | No |
Reference: https://marketing.adobe.com/resources/help/en_US/mobile
| Adobe Mobile Services SDK method | mParticle SDK method |
|---|---|
| collectLifecycleData | automatically collected |
mParticle sends all app lifecycle metrics that Adobe collects.
| Metric | Adobe’s Configuration | Additional Comments |
|---|---|---|
| Crashes | Triggered when the application does not exit gracefully. Event is sent on application start after crash (the application is considered to crash if quit is not called). | If the mParticle SDK detects a crash, a CrashEvent will be sent to Adobe. |
| Daily Engaged Users | Triggered when the application is used on a particular day. | The mParticle SDK will forward a DailyEngagedEvent the first time it sees a user within a day. To determine this, the SDK tracks “last use date” (“lud” parameter) and sends that date time along with the last use date stored by Adobe’s SDK (if any) to the mParticle server, and the forwarder will compare the last use date to the date of the current event. |
| First Launches | Triggered on first run after installation (or re-installation). | mParticle forwarder sends the min of the first run timestamp and the install timestamp stored by Adobe’s SDK on a device (if any). |
| Launches | Triggered on every run, including crashes and installs. Also triggered on a resume from background when the lifecycle session timeout has been exceeded. | mParticle forwarder sends the sum of the launch count tracked by the SDK and the previous launch count stored by Adobe’s SDK on a device (if any). |
| Monthly Engaged Users | Triggered when the application is used during a particular month. | mParticle forwards a MonthlyEngagedEvent the first time a user is seen within a month. The logic is similar to above. |
| Previous Session Length | Reports the number of seconds that a previous application session lasted based on how long the application was open and in the foreground. | mParticle calculates session length as “session end time” - “session start time” - “time spent in background”. |
| Upgrades | Triggered on first run after upgrade (anytime the version number changes). | mParticle detects app upgrades and will forward the timestamp of upgrades. |
Note for Existing Adobe Customers:
Since the mParticle SDK always looks for any existing data on a device stored by Adobe’s SDK, the transition to the mParticle SDK is straightforward.
The following methods are used to track state and actions:
| Adobe Mobile Services SDK | mParticle SDK |
|---|---|
| trackState:data: | logScreen:eventData |
| trackAction:data: | logEvent:eventData |
In Adobe Mobile Services v4.x, you can map events using an Event/Attribute structure, which maps almost exactly to mParticle’s data structure.
Notes for Existing Adobe (3.x) Customers
e.Vars and s.Props are no longer needed in the Adobe Mobile Services 4.x, but you can pass Adobe legacy values for each of those by adding them to the attributes of an event.
The following methods are used to track commerce events:
| Adobe Mobile Services SDK | mParticle SDK |
|---|---|
| trackAction:data: | logEvent:eventData |
Product events are mapped between Adobe and mParticle as follows:
| Adobe Product Events | mParticle Commerce event |
|---|---|
| prodView | Product.DETAIL |
| scCart | N/A |
| scOpen | N/A |
| scAdd | Product.ADD_TO_CART |
| scRemove | Product.REMOVE_FROM_CART |
| scCheckout | Product.CHECKOUT |
| purchase | Product.PURCHASE |
| Adobe Mobile Services SDK | mParticle SDK | Additional Comments |
|---|---|---|
| trackLifetimeValueIncrease | logLTVIncrease | mParticle SDK has a “MPProduct” object to help with logging transactions that lead to LTV increase. |
The mParticle SDK can calculate the lifetime value of customers once the mParticle SDK has been added to an app.
| Adobe Mobile Services SDK | mParticle SDK |
|---|---|
| Set default value via privacyStatus in a SDK config file (also has setPrivacyStatus method to change the status in the app) | OptOut in iOS, setOptOut in Android |
mParticle assumes that users have opt-in status by default, whereas Adobe’s SDK supports setting the default status in an SDK config file per app.
| Adobe Mobile Services SDK | mParticle SDK |
|---|---|
| trackLocation:data: | beginLocationTracking in iOS, enableLocationTracking in Android |
If the Generate Location Message setting is enabled, mParticle will forward the location data (if available) of each event to Adobe.
| Adobe Mobile Services SDK | mParticle SDK |
|---|---|
| offlineEnabled setting in config | enabled by default |
The mParticle SDK always collects offline data and sends that data to the mParticle SDK server.
If the Offline Tracking Enabled setting is enabled, mParticle will includes a “ts” parameter that represents the timestamp (in seconds) of the event.
| Adobe Mobile Services SDK | mParticle SDK |
|---|---|
| setUserIdentifier | setUserIdentity (with CustomerId type) |
If the Use Customer ID setting is enabled, and the User Identity Customer ID has been set, mParticle will forward customerId as a custom user identifier (the “vid” parameter in Adobe). Adobe Mobile Services’ 4.x version SDK also has a tracking identifier (aid) that Adobe uses to identify each unique device per app. mParticle generates a random GUID for each device per app and sends it to Adobe as the “aid”. Similar to Adobe’s SDK, this ID is preserved between app upgrades, is saved and restored during the standard application backup process, and is removed on uninstall.
Notes for Existing Adobe Customers
If an app has already integrated with the Adobe Marketing Cloud before using mParticle, then “vid” and “aid” are likely already stored on consumers’ devices. The mParticle SDK checks if there is existing data stored on a device from Adobe’s SDK; if there is it will get the IDs from a device and send them to the mParticle SDK server. mParticle will then use those IDs when sending data to ensure a seamless transition.
mParticle supports forwarding selected App and Device attributes to Adobe as context variables. Add the values you want to forward as a comma-separated list in the Connection Settings panel under App and Device Attributes. Accepted values are:
These values are case sensitive and must be entered exactly.
| Setting Name | Data Type | Default Value | Description |
|---|---|---|---|
| Media Tracking Server | string |
Web Only. The URL of the Adobe media tracking server. When this is filled in, Adobe Heartbeat is loaded. Leave this box blank if you do not want to load Adobe Heartbeat | |
| Report Suite IDs | string |
The report suite ID from Adobe settings page. Multiple IDs can be entered, separated by commas | |
| Tracking Server | string |
The URL of the Adobe tracking server | |
| Character Set | string |
UTF-8 | The character set used to display data in the Adobe interface |
| Timestamp Enabled | enum |
Timestamps Optional | Must match your Reporting Suite’s timestamp settings. The timestamps for a report suite can be configured as: not allowed, required, or optional. Timestamps Optional is the default setting for all new report suites |
| Send Messages Securely | bool |
True | If enabled, mParticle will forward all data to Adobe using SSL |
| Offline Tracking Enabled | bool |
True | If enabled, any messages that are received when the device is offline will be forwarded |
| Experience Cloud Identity Server | string |
Set the domain name used by calls to the Experience Cloud Identity Service. By default this value is “dpm.demdex.net”. Enter the full value (ie. “YourSubdomainName.demdex.net”), and not just the subdomain. |
| Setting Name | Data Type | Default Value | Platform | Description |
|---|---|---|---|---|
| Use Customer ID | bool |
True | All | If enabled, Customer ID will be forwarded if it exists |
| Include User Attributes | bool |
False | All | If enabled, all user attributes will be included in the context data for each event |
| Generate Location Message | bool |
True | All | If enabled, location data will be forwarded if available |
| Context Variables | Custom Field |
All | Mapping of your application’s event attributes to Adobe context variables | |
| Product Incrementors | Custom Field |
All | Mapping of your application’s custom event names to Adobe product incrementor event numbers | |
| Product Merchandisings | Custom Field |
All | Mapping of your application’s event attributes to Adobe product merchandising | |
| Events | Custom Field |
All | Mapping of your application’s custom event names to Adobe event numbers | |
| Props | Custom Field |
All | Mapping of your application’s custom event attributes to Adobe props | |
| eVars | Custom Field |
All | Mapping of your application’s custom event attributes to Adobe eVars | |
| Hier Variables | Custom Field |
All | Mapping of your application’s screen view attributes to Adobe hier variables | |
| Forward as Track State Events | Custom Field |
iOS, Android, tvOS, FireTV | Allows you to log eCommerce events as trackState (screen view), rather than trackAction |
|
| App and Device Attributes | string |
All | A comma separated list of app and device attributes to forward as context variables |