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
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
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
Node SDK
Go SDK
Python SDK
Ruby SDK
Java SDK
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
Introduction
Outbound Integrations
Firehose Java SDK
Inbound Integrations
Compose ID
Data Hosting Locations
Glossary
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 (Snowplow Schema)
AWS S3 Integration (Define Your Own 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
App Extensions are an iOS feature that allows developers to extend the functionality and content of their app beyond the app itself, making it available to users in other apps or in the main operating system.
From version 7 onwards, The mParticle SDK supports data collection from certain types of app extensions, particularly the iMessage Extension Type. See Apple’s Documentation for more information on App Extensions.
Your App Extension is a separate Target in Xcode. You need to separately import the SDK.
Update your podfile:
pod 'mParticle-Apple-SDK', '~>7'
target '<Your Extension Target>' do
pod 'mParticle-Apple-SDK/AppExtension', '~> 7'
endImport the SDK:
// If using mParticle as a framework:
@import mParticle_Apple_SDK; //Apple recommended syntax, but requires "Enable Modules (C and Objective-C)" in pbxproj
// OR
#import <mParticle_Apple_SDK/mParticle.h> //Works when modules are not enabledYou will need to manually add the SDK to your App Extension target.
For Objective-C projects, go to Build Settings -> Apple LLVM 7.x Preprocessing, expand Preprocessor Macros. For your App Extension target, add MPARTICLE_APP_EXTENSIONS=1 under both the Debug and Release fields. For your main project target, set MPARTICLE_APP_EXTENSIONS=0 under the Debug and Release fields.
For Swift projects, go to Build Settings -> Swift Compiler - Custom Flags. For your App Extension target only, set -DMPARTICLE_APP_EXTENSIONS.
You can initialize the SDK in the extension just as you would normally, but in the viewDidLoad method, instead of didFinishLaunchingWithOptions. There are some special configuration considerations for App Extensions, see below for details.
- (void)viewDidLoad {
[super viewDidLoad];
// Do any additional setup after loading the view.
MParticleOptions *options = [MParticleOptions optionsWithKey:@"foo" secret:@"bar"];
// Recommended for app extensions, see Lifecycle Data.
options.automaticSessionTracking = FALSE;
// Access to the Shared Group ID, this should also be set in your main app code. See App Groups.
options.sharedGroupID = @"group.com.example.domain.shared";
[[MParticle sharedInstance] startWithOptions:options];
[MParticle sharedInstance].logLevel = MPILogLevelDebug;
}override func viewDidLoad() {
super.viewDidLoad()
let options = MParticleOptions(key: "REPLACE WITH APP KEY",
secret: "REPLACE WITH APP SECRET")
// Recommended for app extensions, see Lifecycle Data.
options.automaticSessionTracking = false
// Access to the Shared Group ID, this should also be set in your main app code. See App Groups.
options.sharedGroupID = "group.com.example.domain.shared"
options.logLevel = MPILogLevel.debug
MParticle.sharedInstance().start(with: options)
}Once the SDK is initialized, you can call all mParticle methods as normal.
App Extensions can exist as part of an ‘App Group’ with the main app. This allows both apps to share access to the NSUserDefaults API to store and retrieve user preferences.
Reference Apple’s Documentation for creating an App Group.
The mParticle SDK also makes use of the NSUserDefaults API. To help the SDK track users consistently across the main app and the extension, you can configure the Shared Group ID in the MParticleOptions object.
MParticleOptions *options = [[MParticleOptions alloc] init];
// Do this in both your extension and main app
options.sharedGroupID = @"group.com.example.domain.shared"; //replace with your Shared Group IDlet options = MParticleOptions.init()
options.sharedGroupID = "group.com.example.domain.shared"; //replace with your Shared Group IDIf you do not create an App Group and configure the Shared Group ID in MParticleOptions, any info stored under NSUserDefaults will not be available in the app extension and you may not be able to consistently identify users across your main app and the extension. For this reason, you will need to create a new workspace in mParticle for your app extension, and create a new iOS input, with a new API key and secret to initialize the SDK in the extension.
The SDK can collect Application State Transition events in App Extensions, but since there are no background processes, Session information is unreliable. For this reason, we recommend turning off automatic session tracking in the MParticleOptions object when initializing the SDK in an App Extension. This will not affect session tracking in the main app.
MParticleOptions *options = [[MParticleOptions alloc] init];
// See above for other required settings
options.automaticSessionTracking = FALSE;let options = MParticleOptions.init()
options.automaticSessionTracking = FALSE;Was this page helpful?