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
This guide is meant for integration partners who would like add their own SDK or functionality to the mParticle platform. mParticle integrates with over 100 partners in the mobile app ecosystem, and each integration is unique. Whereas most integrations are via our Firehose API, or developed internally for the server-side, the mParticle mobile SDKs are designed to be extensible in the form of “kits” for client-side integrations.
The mParticle Core iOS and Android SDKs are responsible for detecting, initializing, and forwarding data to the kit framework. By default, the Core SDK dependency does not include any kits - each desired kit must be specified as an additional dependency. The kit framework allows you to hook into and listen for mParticle’s public APIs as well as crucial application lifecycle events. It’s the responsibility of the kit implementation to then map those APIs onto the respective partner APIs. Kits will often include a 3rd-party SDK, or they might just contain a bit of additional functionality.
At runtime, the Core SDKs will receive configuration from the mParticle server, instructing it of which kits it should initialize. In a typical scenario whereby a kit wraps/embeds a 3rd-party SDK, the configuration will include a map of settings, including the API key/credentials that the given SDK needs in order to be initialized. Customers use the mParticle platform UI to enable kits and input their credentials.
mParticle has developed and currently manages a large number of Android kits. These mParticle-managed kits are hosted within the mParticle-integrations organization on GitHub and releases are performed by the mParticle engineering team. This is not a requirement though, some partners choose to manage their own kits, meaning they host the repository and perform releases however they prefer. This guide covers the few key differences between self-managed and mParticle-managed Android kits.
If you are building a self-managed kit, see the consideration in For Self Managed Kits.
We provide an example skeleton kit on GitHub. You can choose to clone this kit and use it as a starting point, or just use it as a reference.
For more information on the contents of the example-kit, see API Overview - Editing the Example Kit
There are two distinct approaches to building and deploying your kit locally in a sample app: adding the kit as a submodule and using the latest mParticle SDK release in maven as a dependency, or building the kit and mParticle SDK dependencies from scratch locally. The former is much simpler and the recommended approach, but the latter may be necessary if you plan on changing code in the core SDK and want to observe how the components interact.
SampleApp ->
- app -> (application code)
- build.gradle
- MyKit -> (kit code)
- settings.gradle
to create a new submodule, in Android Studio select: File -> New -> New Module -> Import Gradle Project -> select Kit from file picker
settings.gradle
file. If your kit/submodule’s directory name is “MyKit”, then this file should contain include ':MyKit'
(replace MyKit
with the actual directory name). For example:include ':app', ':MyKit'
include(":app", ":MyKit")
If you cloned an existing kit, you may need to add this line.
build.gradle
, add a dependency on the kit module. Match the value you used in your settings.gradle
file in the previous step:dependencies {
...
implementation project(':MyKit')
}
dependencies {
...
implementation(project(":MyKit"))
}
MParticleOptions
:val options = MParticleOptions.builder(context)
.configurations(
KitOptions()
.addKit({KIT-ID}, MyKit::class.java)
)
...
.build()
MParticle.start(options)
KitOptions kitOptions = KitOptions()
.addKit({KIT-ID}, MyKit.class)
MParticleOptions options = MParticleOptions.builder(context)
.configurations(kitOptions)
...
.build()
MParticle.start(options)
Note: see KitIds for more information
In order to build and iterate on your kit, there are a few steps to get the Core SDK and your kit integrated:
Clone your fork of the core SDK, and create a branch for your changes:
git clone git@github.com:MYORGANIZATION/mparticle-android-sdk.git
cd mparticle-android-sdk/
git checkout -b add-my-company
Add your fork of the Example Kit as a submodule to the Core repository:
git submodule add git@github.com:MYORGANIZATION/mparticle-android-integration-example.git kits/COMPANYNAME-kit
kit ID
. This is a numeric identifier within mParticle’s partner ecosystem that will uniquely identify your kit../settings-kits.gradle
, adding your kit to the Gradle project:include ':kits:COMPANYNAME-kit', ...)
include(":kits:COMPANYNAME-kit", ...)
ServiceProviders
interface in ./android-core/src/main/java/com/mparticle/MParticle.java, creating a new integer constant for your company name and setting it to your kit ID
.KitIntegrationFactory#setupKnownIntegrations()
in ./android-core/src/main/java/com/mparticle/kits/KitIntegrationFactory.java, using the new ServiceProviders
constant you defined above, and specify the fully-qualified class name of your kit implementation.Deploy your new version of the Core and your kit to your local Maven repository:
./gradlew publishLocal # deploy the core
./gradlew publishLocal -c settings-kits.gradle # deploy the kits
mavenLocal()
to the repositories
closure of your build.gradle, above mavenCentral()
repositories {
mavenLocal()
...
mavenCentral()
}
repositories {
mavenLocal()
...
mavenCentral()
}
dependencies
of your app:dependencies {
implementation 'com.mparticle:android-COMPANYNAME-kit:x.x.x-SNAPSHOT'
}
dependencies {
implementation("com.mparticle:android-COMPANYNAME-kit:x.x.x-SNAPSHOT")
}
Note: The example kit is an mParticle managed kit.
You’ll want to edit the following files to be specific to your implementation:
./build.gradle
to add any necessary dependencies, such as your company’s SDK..src/main/java/com/mparticle/kits/ExampleKit.java
- this is where your primary implementation belongs.
./README.md
./src/main/AndroidManifest.xml
./consumer-proguard.pro
./build.gradle
remove the classpath 'com.mparticle:android-kit-plugin:x.x.x
plugin. This plugin is only required for mParticle managed kits and primarily contains standardized gradle configuration options as well as release scripts../build.gradle
for the mParticle KitManager, for example:implementation {
...
api `com.mparticle:android-core:x.x.x`
}
implementation {
...
api("com.mparticle:android-core:x.x.x")
}
The core of your implementation will live in ExampleKit.java
(renamed for your company). This file must be a subclass of the KitIntegration
class which is made available by the mParticle kit framework. This class provides additional interfaces that you must implement depending on the type of data that your kit can process:
KitIntegration.ActivityListener
Implement this interface when you require Activity callbacks for any reason.
KitIntegration.ApplicationStateListener
Implement this interface in order to receive application foreground and background callbacks.
KitIntegration.CommerceListener
Implement this interface in order to receive eCommerce events as they are sent into the mParticle SDK.
KitIntegration.EventListener
Implement this listener to ensure you receive events as they are sent into the mParticle SDK.
KitIntegration.IdentityListener
Implement this interface to receive callbacks when Identity API requests complete or when the current user changes.
KitIntegration.PushListener
Implement this interface when you have Google Cloud Messaging/push features.
KitIntegration.SessionListener
Implement this interface in order to listen for Session Start and Session End events.
KitIntegration.UserAttributeListener
Implement this interface to receive callbacks when user attributes are modified or consent state changes.
KitIntegration.AttributeListener
(Deprecated)see KitIntegration.UserAttributeListener
See the javadocs for more information on the KitIntegration
class and its interfaces.
KitId is a unique Integer that serves as the identifier for a Kit. When a configuration is received, kit settings, mappings and projections are stored on a per-kitId basis and the SDK is able to assign the correct kit configuration to the correct kit based on a list of “known kits” mapping. For mParticle managed kits, kitIds are added statically to the KitIntegrationFactory, but they also can be added at runtime via MParticleOptions.KitOptions
. If you are testing a new kit and are not taking the approach that involves building the entire mParticle SDK, then you can register a new kitId (at runtime):
val options = MParticleOptions.builder(context)
.configurations(
KitOptions()
.addKit({KIT-ID}, MyKit::class.java)
)
...
.build()
MParticle.start(options)
KitOptions kitOptions = KitOptions()
.addKit({KIT-ID}, MyKit.class);
MParticleOptions options = MParticleOptions.builder(context)
.configurations(kitOptions)
...
.build();
MParticle.start(options);
by replacing {KIT-ID} with the integer value of you kitId
Was this page helpful?