AMP SDK
Cordova Plugin
Identity
Direct URL Routing FAQ
Web
Android
iOS
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
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
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
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
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
Data Hosting Locations
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
Event Forwarding
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)
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
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
Feed
Event
Audience
Event
Audience
Cookie Sync
Server-to-Server Events
Platform SDK Events
Audience
Audience
Audience
Event
Feed
Event
Event
Audience
Event
Data Warehouse
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
Event
Event
Audience
Data Warehouse
Audience
Cookie Sync
Event
Event
Event
Event
Event
Event
Feed
Event
Feed
Event
Event
Audience
Event
Event
Audience
Event
Event
Feed
Event
Audience
Audience
Event
Event
Event
Audience
Audience
Audience
Audience
Event
Audience
Event
Event
Event
Event
Feed
Event
Event
Event
Event
Event
Audience
Feed
Event
Event
Event
Event
Event
Event
Event
Feed
Event
Event
Event
Event
Custom Pixel
Feed
Event
Event
Event
Event
Event
Audience
Event
Data Warehouse
Event
Event
Event
Audience
Audience
Event
Loyalty Feed
Feed
Audience
Audience
Event
Audience
Audience
Feed
Cookie Sync
Audience
Event
Event
Audience
Event
Audience
Audience
Event
Event
Event
Audience
Cookie Sync
Event
Audience
Cookie Sync
Feed
Audience
Event
Airship is a Customer Engagement Platform (CXP) that helps you drive loyalty, engagement, and revenue through channels such as mobile apps, email, and SMS. Airship provides push messaging services, including segmentation and targeting capabilities. To learn more about what you can do with Airship, see Airship’s documentation.
You can send events data to Airship from the following inputs:
Input | Forwarding method |
---|---|
iOS | Client-side via an embedded kit |
Android | Client-side via an embedded kit |
Server-to-server Web | Server-to-server |
Feed | Server-to-server |
Regardless of the input you want to connect to Airship, you must first set up an Airship app and create an Airship output configuration in mParticle.
US
or EU
) for where your Airship credentials were issued.The connection setup instructions differ depending on the input you want to use.
The integration for iOS and Android uses a client-side kit that was built in partnership with Airship and that provides full support for both mParticle’s and Airship’s features. The kit bundles Airship’s native SDK with the mParticle SDK, allowing you to dynamically enable or disable event forwarding and to manage your configuration and filtering settings from mParticle’s UI.
When correctly installed, the embedded kit makes available the following functionality:
The source code for each kit can be found at:
To leverage the functionality described above, and to use other mParticle features, you must make calls to the iOS or Android mParticle SDKs. Similarly, you can use Airship’s other features by making direct API calls to the Airship SDK as described in Airship’s documentation.
This step will add the mParticle SDK (if not present already), the Airship SDK, along with the Airship kit, which acts as a bridge between the two SDKs. See the iOS and Android examples below, and reference the Apple SDK and Android SDK GitHub pages to learn more about kits.
If you’re using CocoaPods, add the following to your app’s Podfile:
pod 'mParticle-UrbanAirship', '~> 8'
If you’re using SPM, using the standard Xcode interface to add the following package to your project:
https://github.com/mparticle-integrations/mparticle-apple-integration-urbanairship
Add the following to your app’s build.gradle file:
dependencies {
compile ('com.mparticle:android-urbanairship-kit:5.+')
}
If you haven’t created an output configuration yet, follow the steps outlined in Create an Airship output configuration before continuing to step 3 below.
Under Token enter your Airship provided bearer token.
If the Airship kit is included in your app, mParticle will pass any push notifications from Airship to the kit for display. However, you will need to provide credentials in the Airship dashboard.
See the Airship’s documentation for push notifications for more detail for the various platforms:
For Android push notifications, you will need to provide your Server Key to Airship. See Airship’s Android Push Notifications documentation for more information.
For iOS push notifications you will need to upload your APNs Push SSL certificate to Airship. See the Airship’s iOS Push Notifications documentation for more information.
If you are integrating with Airship and need to implement a Service Extension for user notifications, please refer to Airship’s Extensions Documentation.
Airship uses tags to group users together based on shared interests, preferences, or behaviors. Each user’s channel can be associated with multiple tags, and these tags can be associated with multiple channels. These tags are analogous to mParticle user attributes and tags. If you want to exclude certain attributes from being mapped to Airship tags, you can filter them from being forwarded using data filters.
To forward tags, check Enable Tags when creating your Airship integration configuration. If you check Send all user attributes as tags, your user attributes are also forwarded as tags.
The mParticle kit integration can automatically set Airship tags when particular events and/or event attributes are detected. When enabling and configuring Airship, you may select the events that you’ve sent to mParticle in the past, and customize exactly which tag(s) those events should trigger. In the screenshot below, when an event named “Map View” is fired, mParticle will set the tag “my tag” within the Airship platform and when an event attribute named “Transaction Id” is seen, mParticle will set the tag “transaction”.
The server-to-server Airship integration forwards commerce and custom events ingested via the Web SDK or a Feed input, allowing you to dynamically enable or disable event forwarding and to manage your configuration and filtering settings from mParticle’s UI.
The S2S integration will not create users in Airship. When data is sent to Airship without a known Named User you will not see these events or users in your Airship account.
Event Filters in mParticle will show all events supported between kit and S2S integrations. Because the S2S integration sends a subset of these events, only filters set on S2S-supported events will affect the forwarded data.
If you haven’t created an output configuration yet, follow the steps outlined in Create an Airship output configuration before continuing to step 2 below.
Under Token enter your Airship provided bearer token.
You can automatically register Airship email channels for your users by selecting the Enable Email Channel Registration setting in your Airship Event integration connection settings. These email channels can be used for audience segmentation with mParticle’s Airship audience integration.
After enabling the Email Channel Registration setting, you can select which mParticle user attributes you want to map to each Airship email channel registration field, as described below. Email channels are automatically associated with named user IDs based on the Named User ID Type setting. See Named users in Airship’s documentation for more information.
Airship supports several “opt-in” and “opt-out” fields that represent what kind of email channel activity your users have consented to, such as commercial emails and click tracking within those emails.
All of these fields are optional. To map an mParticle user attribute to an Airship field, in addition to selecting the Enable Email Channel Registration setting, use the Email Channel Request Mapping dropdown menu in your connection settings. Any mParticle user attribute you select must be formatted as a date-time value according to Airship’s documentation.
Airship Opt-in/Opt-out values | Data type | Description |
---|---|---|
commercial_opted_in |
date-time | The time a user subscribed to commercial emails. |
commercial_opted_out |
date-time | The time a user unsubscribed from commercial emails. |
transactional_opted_in |
date-time | The time a user subscribed to transactional emails. |
transactional_opted_out |
date-time | The time a user unsubscribed from transactional emails. |
open_tracking_opted_in |
date-time | The time a user enabled open tracking for emails. |
open_tracking_opted_out |
date-time | The time a user disabled open tracking for emails. |
click_tracking_opted_in |
date-time | The time a user enabled click tracking for emails. |
click_tracking_opted_out |
date-time | The time a user disabled click tracking for emails. |
Mapping of mParticle events to Airship events occurs automatically in both kit and S2S implementations. mParticle eCommerce events are mapped to Airship events as follows:
mParticle Product Action Event | Airship Mapped Name |
---|---|
Purchase | purchased |
Add To Cart | added_to_cart |
Click | browsed |
Add to Wishlist | starred_item |
If your Airship configuration uses the same App Key for Mobile and Web, all 3 configuration settings are required.
If your Airship configuration is for Web only, enter an App Key, and enable the This App Key is for Web only in my Airship Setup.
setting.
Setting Name | Data Type | Default Value | Description |
---|---|---|---|
App Key | string |
Airship generated string identifying the app setup. Used in the application bundle. | |
App Secret | string |
Airship generated string identifying the app setup secret. Used in the application bundle, and only used for Mobile configurations. | |
Domain | enum |
US | The Airship site your credentials belong to, either ‘US’ or ‘EU’. |
App Key is for Web | boolean |
false | If enabled, this configuration will only be used for Web configurations. |
Setting Name | Data Type | Default Value | Platform | Description |
---|---|---|---|---|
Token | string |
All | Airship generated string identifying the Bearer token. | |
Notification Icon Name | string |
Application Icon | Android | Name of the drawable resource to use for the notification icon, for example, ic_notification. |
Notification Accent Color | string |
System default | Android | Accent color to be used when constructing the notification, for example, #ff0000. |
Named User ID Type | string |
All | Set to “None,” “Other,” “Hashed e-mail address,” or “Customer ID” to define which identity to send to Airship. If a request does not include the Named User ID Type it will be dropped. Airship will return an error if ‘Other’ is selected but the ‘Other’ identity is not present in the event batch. This is required for Web/Feed inputs, but not iOS or Android. | |
Event Names that map to User Tags | Custom Field |
All | Define the mapping of mParticle event names to the corresponding Airship tags. | |
Event Attributes that map to User Tags | Custom Field |
All | Define the mapping of mParticle event attributes to the corresponding Airship tags. | |
Enable Tags | bool |
True | All | If enabled, tags will be sent to Airship. |
Send all user attributes as tags | bool |
False | All | If enabled, all user tags and user attributes will be forwarded to Airship as tags. If not enabled, only user tags will be forwarded to Airship. This setting is dependent on the value of the ‘Enable Tags’ setting. |
Enable Email Channel Registration | bool |
False | S2S | If enabled, mParticle will automatically register the email channel with Airship. |
Email Channel Request Mapping | Custom Field |
S2S | Maps mParticle user attributes to Airship email channel registration request fields. Applicable only if Enable Email Channel Registration is selected. |