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
Data Planning API
Custom Access Roles 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
Content Security Policy
Configuration
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
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
Data Hosting Locations
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
Remember that you can collect two types of data with mParticle: event data (data about what your users are doing) and user data (data describing your users).
By default, the mParticle Android SDK will track the following event types with no configuration required:
To track other event types, you must call the appropriate method in mParticle’s SDK directly from your app’s code whenever the event you want to track is triggered by a user.
The Higgs Shop sample app was built so that the code responsible for tracking events is as close as possible to the app components that might trigger those events. While this results in more repetitive code, the repetition is helpful for people new to the SDK.
One of the most basic events to begin tracking is when a user views different pages. We do that with the MParticle.getInstance().logScreen() method.
This method accepts the name of the screen viewed (as a string) and a list of any additional attributes (as an array).
For example, in the LandingActivity.kt file we log views of the landing screen with:
MParticle.getInstance()?.logScreen("Landing")Notice that we don’t include any additional attributes, we only pass in the name of the screen being viewed: Landing.
Now that we’re tracking when a user visits different pages, let’s track some basic interactions using the custom events.
Custom events are created with MPEvent.Builder, which accepts the name of the event as a string, and the event type as EventType.EVENT-TYPE where event type can be one of several pre-defined types. This allows you to define the category of event that you are logging, such as a navigation event or a search event when the user searches for an item. This object doesn’t affect any functionality, but it is helpful when categorizing and organizing your data.
For a list of each custom event type, see Event Tracking.
You can also include any custom attributes you would like as another object customAttributes.
The Higgs Shop uses custom events tracking to log interactions in the navigation bar in the file MainActivity.kt:
val appBarConfiguration = AppBarConfiguration(
setOf(
R.id.navigation_shop,
R.id.navigation_account,
R.id.navigation_cart
)
)
setupActionBarWithNavController(navController, appBarConfiguration)
bottomNavigation.setupWithNavController(navController)
bottomNavigation.setOnItemSelectedListener { item ->
val customAttributes: MutableMap<String, String> = HashMap()
when (item.itemId) {
R.id.navigation_shop -> {
customAttributes["destination"] = getString(R.string.nav_shop)
navController.navigate(R.id.navigation_shop)
}
R.id.navigation_account -> {
customAttributes["destination"] = getString(R.string.nav_account)
navController.navigate(R.id.navigation_account)
}
R.id.navigation_cart -> {
customAttributes["destination"] = getString(R.string.nav_cart)
navController.navigate(R.id.navigation_cart)
}
}
val event = MPEvent.Builder("Navbar Clicked", MParticle.EventType.Navigation)
.customAttributes(customAttributes)
.build()
MParticle.getInstance()?.logEvent(event)
return@setOnItemSelectedListener true
}In this example, notice how a Navbar Clicked event is created with an MPEvent.Builder object. The event type is set to Navigation and the custom attributes denoting which nav bar item was clicked are defined in a MutableMap and included with with the object .customAttributes(customAttributes).
Finally, the event is logged to mParticle with MParticle.getInstance()?.logEvent(event).
Tracking commerce events involves three steps:
Product.Builder(), create an object that defines descriptive values like the product’s label or sku number. CommerceEvent.Builder() and then logged by passing the event into MParticle.getInstance().logEvent(event) where event is the name of the commerce event created.Products are created using Product.Builder(). At a minimum, all products must have a name, an sku, and a price.
// 1. Create a product
val product = Product.Builder("Double Room - Econ Rate", "econ-1", 100.00)
.quantity(4.0)
.build()In The Higgs Shop, we create products in the file ProductDetailActivity.kt:
val product = Product.Builder(productItem.label, productItem.id.toString(), productItem.price.toDouble())
.unitPrice(productItem.price.toDouble())
.build()Similar to logging screen views and custom events, products may include any custom attributes defined as a free-form map. These custom attributes are helpful when there are additional qualities or characteristics of the product that need to be included, such as a refurbished item.
Before a commerce event can be logged in mParticle, the transaction details must be summarized, including a transaction ID (required), in addition to revenue, shipping, and tax (optional).
// 2. Summarize the transaction
val attributes = TransactionAttributes("foo-transaction-id")
.setRevenue(430.00)
.setTax(30.00)In the Higgs Shop, we summarize product purchases in the file: CheckoutActivity.kt:
val attributes: TransactionAttributes = TransactionAttributes(Calendar.getInstance().time.toString())
.setRevenue(priceMap["grandTotal"].toString().toDouble())
.setTax(priceMap["salesTax"].toString().toDouble())
.setShipping(BigDecimal(Constants.CHECKOUT_SHIPPING_COST).toDouble())
event.transactionAttributes(attributes)Again, we can include any custom attributes we want when defining transaction details as long as they are included as an object containing a free-form map.
Commerce events are logged using MParticle.getInstance().logEvent(event), where event is the name of a commerce event created using CommerceEvent.Builder().
// 3. Log the purchase event
val event = CommerceEvent.Builder(Product.PURCHASE, product)
.transactionAttributes(attributes)
.build()
MParticle.getInstance().logEvent(event)A full list of the possible attributes for a commerce event can be found in .
For example, we log purchase events in CheckoutActivity.kt.
The actual event is logged with:
var event = commerceEventConversion(priceMap, Product.CHECKOUT)
MParticle.getInstance()?.logEvent(event)However, the event details including the product info and price are defined later in the code with:
fun commerceEventConversion(priceMap: Map<String, Any>, productAction: String): CommerceEvent {
val cartItems = priceMap["cartItems"] as List<CartItemEntity>
var entity = cartItems.get(0)
val product = Product.Builder(entity.label, entity.id.toString(), entity.price.toDouble())
.customAttributes(mapOf(
"size" to entity.size,
"color" to entity.color
))
.quantity(entity.quantity.toDouble())
.build()
val event = CommerceEvent.Builder(productAction, product)
for (i in 1 until cartItems.size) {
entity = cartItems.get(i)
val product2 = Product.Builder(entity.label, entity.id.toString(), entity.price.toDouble())
.customAttributes(mapOf(
"size" to entity.size,
"color" to entity.color
))
.quantity(entity.quantity.toDouble())
.build()
event.addProduct(product2)
}
if(productAction == Product.PURCHASE) {
val attributes: TransactionAttributes = TransactionAttributes(Calendar.getInstance().time.toString())
.setRevenue(priceMap["grandTotal"].toString().toDouble())
.setTax(priceMap["salesTax"].toString().toDouble())
.setShipping(BigDecimal(Constants.CHECKOUT_SHIPPING_COST).toDouble())
event.transactionAttributes(attributes)
}
return event.build()
}Was this page helpful?