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
Getting Started
Identity
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
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
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
Data Hosting Locations
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
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
Organize Dashboards
Dashboard Filters
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
Audience
Event
Audience
Feed
Event
Audience
Cookie Sync
Event
Audience
Audience
Feed
Audience
Event
Event
Event
Audience
Event
Event
Data Warehouse
Event
Event
Event
Audience
Event
Event
Event
Event
Event
Audience
Event
Event
Event
Feed
Event
Audience
Event
Feed
Event
Event
Event
Data Warehouse
Custom Feed
Feed
Event
Audience
Event
Audience
Audience
Event
Audience
Event
Event
Event
Event
Event
Audience
Event
Audience
Event
Audience
Data Warehouse
Event
Audience
Cookie Sync
Event
Event
Event
Event
Feed
Event
Feed
Event
Event
Event
Audience
Event
Event
Audience
Event
Event
Event
Feed
Audience
Event
Audience
Audience
Event
Event
Audience
Audience
Audience
Event
Audience
Event
Event
Event
Event
Event
Feed
Event
Event
Event
Event
Feed
Audience
Event
Event
Event
Event
Event
Event
Event
Audience
Feed
Event
Event
Custom Pixel
Feed
Event
Event
Event
Event
Event
Event
Event
Audience
Event
Data Warehouse
Event
Audience
Audience
Audience
Audience
Event
Audience
Audience
Cookie Sync
Event
Feed
Audience
Event
Event
Event
Audience
Audience
Event
Event
Event
Audience
Cookie Sync
Event
Audience
Audience
Cookie Sync
Feed
Google’s Enhanced conversions
offerings help you to improve the accuracy of your conversion measurement by supplementing your existing conversion tags with first-party conversion data, like email address
and phone number
. How the data is used depends on whether you’re uploading enhanced conversions for web
or for leads
.
Check out these docs to learn more about Enhanced Conversions
and its types: Google Enhanced Conversions Overview.
This integration utilizes Google’s Upload Click Conversions and Upload Conversion Adjustments APIs.
To set up the Google Enhanced Conversions Event integration, you will need to have a working Ads account and know your Client Customer ID, which you can obtain from your Google Account Manager. Full requirements on Google’s end are noted in their set-up docs, respectively:
When you add the integration from the mP Directory, sign into your Google Ads account using your username
and password
in order to give mParticle permission to upload conversion information.
Note: to send product
information along with relevant conversions to Google, your account also needs to be whitelisted as per Google’s docs
If specified for a given user, mParticle will try to forward an email identity in an outgoing conversion.
This is determined by the Email Identity Type
drop-down Connection Setting. mParticle sends emails to Google Ads as SHA-256 hashed values.
If specified for a given user, mParticle will try to forward one of the 3 phone number identities in an outgoing conversion.
This is determined by the Phone Identity Type
drop-down Connection Setting. mParticle sends phone numbers to Google Ads as SHA-256 hashed values.
As per Google’s docs, each outgoing conversion
and adjustment
needs to have one of the following specified:
order_id
associated with the conversion.gclid
associated with the conversion, along with the conversion_date_time
.If neither of those conditions hold for a given incoming event, it will be dropped rather than forwarded to Google.
The only native mParticle event type supported by this integration is CommerceEvent. mParticle supports the following event mappings:
mParticle Event | Google Ads Event |
---|---|
Commerce Event with purchase product action. |
Click Conversion |
Other CommerceEvent types remain unsupported.
mParticle supports the following field mappings for native CommerceEvents:
mParticle Field | Google Event Field | Description |
---|---|---|
event.product_action.transaction_id | order_id |
The Order ID |
event.product_action.currency | currency_code |
ISO 4217 code. |
event.timestamp | conversion_date_time |
The date and time of the conversion. |
event.product_action.total_amount | conversion_value |
The total value of the order or items sold. If omitted, mP will try to calculate the total by summing each constituent product total (i.e. item.price*item.quantity). |
event.product_action.products[x].price | cart_data.items[x].unit_price |
The price of the given item. |
event.product_action.products[x].quantity | cart_data.items[x].quantity |
Number of the given item. |
event.product_action.products[x].id | cart_data.items[x].product_id |
ID of the given item. |
Custom Flags should be specified on each valid incoming CommerceEvent in order to support specific fields for each outgoing conversion.
mParticle Custom Flag | Google EC Event Field | Is Required | Description |
---|---|---|---|
GoogleEnhancedConversions.Gclid |
gclid |
False | The identifier you captured at the time of the click for the conversion’s click or impression. Populate this field for the most accurate measurement. |
GoogleEnhancedConversions.Gbraid |
gbraid |
False | gbraid is used for measuring app-to-app conversions with Apple’s ATT framework. gbraid is sent when gclid is absent. |
GoogleEnhancedConversions.Wbraid |
wbraid |
False | wbraid is used for measuring web-to-app conversions with Apple’s ATT framework. wbraid is sent when gclid and gbraid are absent. |
GoogleEnhancedConversions.ConversionActionId |
conversion_action |
True | The provided ID is used to resolve the resource name of the ConversionAction for the click conversion. The conversion action must have a type of UPLOAD_CLICKS , and must exist in the Google Ads conversion customer of the Google Ads account associated with the click. |
GoogleEnhancedConversions.LocalTransactionCost |
cart_data.local_transaction_cost |
False | The sum of all transaction-level discounts, in the currency_code of the ClickConversion . |
mParticle includes these values in outgoing events to Google. If these values are set via both custom mappings and custom flags, the custom mapping value will be used.
This integration also supports Custom Mappings as well.
These can be configured for a particular connection within our UI to support both Click Conversions
and Conversion Adjustments
, given that the latter don’t map one-to-one with a mP event type.
This feature allows incoming mParticle events to be mapped to known Google event types, including specific attributes and outgoing parameters.
To integrate with Google’s Enhanced Conversions for Web functionality, the Enhancement Adjustment
Custom Mapping can be configured via the mParticle UI.
As per Google’s docs, each outgoing Enhancement Adjustment
event requires the order_id
field, even if the gclid
is known as well. If not, it will be dropped instead of forwarded.
This is in contrast with other supported event types. See Required Fields for all Outgoing Events for more.
Google Ads has several notions of user-provided consent, only one of which applies to Enhanced Conversions for Leads: ad_user_data
. This represents consent for ad user data.
To configure user consent forwarding under this value, a mapping should be set-up leveraging mParticle’s notion of ConsentPurposes
.
To learn more about handling user consent within mParticle’s platform, see the following docs: Data Privacy Controls.
Once a ConsentPurpose
is set-up, user consent information can be associated with it in subsequent EventBatches
.
The ConsentPurpose
data mapping can then be configured for downstream forwarding via the User Consent Data Mapping
connection setting.
In the absence of a user-defined consent value for the ad_user_data
field via the ConsentPurpose
mapping, a default
value can be optionally configured via a separate drop-down
setting.
When no user consent is provided, the default status is used as specified by the default dropdown setting.
All valid incoming events for this integration can optionally specify custom variables
to be forwarded along to Google with the given conversion.
For this to work, the following needs to occur:
Custom Variables
need to be set-up on Google’s end.Custom Variable Mapping
setting in Connection Settings needs to be configured to map mP attributes to a given Google Custom Variable
.Click Identifiers sent to Google can be configured using Custom Flags or Custom Mappings as described above.
GCLID (Google Click Identifier) is a tracking parameter to identify the campaign and other attributes of the click associated with the ad for ad tracking and campaign attribution. With Apple’s App Tracking Transparency (ATT) policy changes, Google is not sending GCLID parameters on iOS traffic coming from various Google apps.
GBRAID is used for measuring app-to-app conversions. This new parameter, compliant with Apple’s App Tracking Transparency (ATT) framework, helps measure app conversions driven by ad campaigns on iOS.
WBRAID is used for measuring web-to-app conversions. This new parameter, compliant with Apple’s App Tracking Transparency (ATT) framework, helps attribute conversions back to ad campaigns and work with conversion modeling to give a more accurate measurement on iOS.
After you save or update a Google Enhanced Conversions configuration, mParticle verifies the provided setting information and makes an API call to validate it for consistency. If there’s any inconsistency between the provided customer IDs and the associated login, an error is displayed to prompt the user to verify and try again.
In addition to the settings below, the UI will prompt you to log in to Google via a redirect and grant mP the appropriate access.
Setting Name | Data Type | Default | Description |
---|---|---|---|
Client Customer ID | string |
null |
Your Google Ads Client Customer ID. Please contact your Google TAM or AM to obtain this value. |
Manager Customer ID | string |
null |
The Customer ID of the Google Ads Manager account that manages the Ads account where Audience data will be sent. If you do not use a manager account, this can be left blank. |
Setting Name | Data Type | Default | Description |
---|---|---|---|
Merchant ID | string |
null |
The ID of the associated Merchant Center account. |
Merchant Feed Country Code | string |
null |
The ISO 3166 two-character region code of the Merchant Center feed. |
Merchant Feed Language Code | string |
null |
The ISO 639-1 language code of the Merchant Center feed. |
Email Identity Type | enum |
null |
The Identity Type to forward as the email to Google. It will be hashed before forwarding. |
Phone Identity Type | enum |
null |
The Identity Type to forward as the phone number to Google. It will be hashed before forwarding. |
Custom Variable Mapping | mapping |
null |
The mapping of mParticle event attributes to Google Enhanced Conversion custom variables, as defined in Google Ads portal. |
User Consent Data Mapping | mapping |
null |
The mParticle ConsentPurpose mapping. This allows user-specified consent values to be forwarded for the ad_user_data field. |
Ad User Data Default Consent Value | string |
null |
The default consent value to forward for the Ad User Data field. |
Enrich with Cookie Identifiers | bool |
False |
If enabled, cookie-based identifiers will be stored on a user’s profile, and a batch will be enriched with the most-recently seen identifiers when missing from the batch. Currently, cookie identifiers include only gclid. |