Documentation

Developers

API References
Data Subject Request API

Data Subject Request API Version 1 and 2

Data Subject Request API Version 3

Platform API

Platform API Overview

Accounts

Apps

Audiences

Calculated Attributes

Data Points

Feeds

Field Transformations

Services

Users

Workspaces

Warehouse Sync API

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

Client SDKs
AMP

AMP SDK

Android

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

Cordova Plugin

Identity

Direct Url Routing

Direct URL Routing FAQ

Web

Android

iOS

Flutter

Getting Started

Usage

API Reference

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

React Native

Getting Started

Identity

Roku

Getting Started

Identity

Media

Unity

Upload Frequency

Getting Started

Opt Out

Initialize the SDK

Event Tracking

Commerce Tracking

Error Tracking

Screen Tracking

Identity

Location Tracking

Session Management

Xbox

Getting Started

Identity

Web

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

Xamarin

Getting Started

Identity

Web

Alexa

Quickstart
Android

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

HTTP Quick Start

Step 1. Create an input

Step 2. Create an output

Step 3. Verify output

iOS Quick Start

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

Java Quick Start

Step 1. Create an input

Step 2. Create an output

Step 3. Verify output

Node Quick Start

Step 1. Create an input

Step 2. Create an output

Step 3. Verify output

Web

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

Python Quick Start

Step 1. Create an input

Step 2. Create an output

Step 3. Verify output

Media SDKs

Android

iOS

Web

Server SDKs

Node SDK

Go SDK

Python SDK

Ruby SDK

Java SDK

Tools

Linting Tools

mParticle Command Line Interface

Smartype

Guides
Partners

Introduction

Outbound Integrations

Outbound Integrations

Firehose Java SDK

Inbound Integrations

Kit Integrations

Overview

Android Kit Integration

JavaScript Kit Integration

iOS Kit Integration

Compose ID

Glossary

Data Hosting Locations

Migrate from Segment to mParticle

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

Guides

Getting Started

Create an Input

Start capturing data

Connect an Event Output

Create an Audience

Connect an Audience Output

Transform and Enhance Your Data

Platform Guide
The New mParticle Experience

The new mParticle Experience

The Overview Map

Observability

Observability Overview

Observability User Guide

Observability Span Glossary

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)

Analytics

Introduction

Setup

Sync and Activate Analytics User Segments in mParticle

User Segment Activation

Welcome Page Announcements

Settings

Project Settings

Roles and Teammates

Organization Settings

Global Project Filters

Portfolio Analytics

Analytics Data Manager

Analytics Data Manager Overview

Events

Event Properties

User Properties

Revenue Mapping

Export Data

UTM Guide

Query Builder

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

Analyses Introduction

Segmentation: Basics

Getting Started

Visualization Options

For Clauses

Date Range and Time Settings

Calculator

Numerical Settings

Segmentation: Advanced

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

Funnels: Basics

Getting Started with Funnels

Group By Settings

Conversion Window

Tracking Properties

Date Range and Time Settings

Visualization Options

Interpreting a Funnel Analysis

Funnels: Advanced

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

Cohorts

Getting Started with Cohorts

Analysis Modes

Save a Cohort Analysis

Export Results

Explore Users

Saved Analyses

Manage Analyses in Dashboards

Journeys

Getting Started

Event Menu

Visualization

Ending Event

Save a Journey Analysis

Users

Getting Started

User Activity Timelines

Time Settings

Export Results

Save A User Analysis

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

Analytics Resources

The Demo Environment

Keyboard Shortcuts

Tutorials

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

APIs

User Segments Export API

Dashboard Filter API

IDSync

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

Data Master
Group Identity

Overview

Create and Manage Group Definitions

Introduction

Catalog

Live Stream

Data Plans

Data Plans

Blocked Data Backfill Guide

Personalization
Predictive Attributes

Predictive Attributes Overview

Create Predictive Attributes

Assess and Troubleshoot Predictions

Use Predictive Attributes in Campaigns

Predictive Audiences

Predictive Audiences Overview

Using Predictive Audiences

Introduction

Profiles

Calculated Attributes

Calculated Attributes Overview

Using Calculated Attributes

Create with AI Assistance

Calculated Attributes Reference

Audiences

Audiences Overview

Real-time Audiences

Standard Audiences

Journeys

Journeys Overview

Manage Journeys

Download an audience from a journey

Audience A/B testing from a journey

Journeys 2.0

Warehouse Sync

Data Privacy Controls

Data Subject Requests

Default Service Limits

Feeds

Cross-Account Audience Sharing

Approved Sub-Processors

Import Data with CSV Files

Import Data with CSV Files

CSV File Reference

Glossary

Video Index

Analytics (Deprecated)
Identity Providers

Single Sign-On (SSO)

Setup Examples

Settings

Debug Console

Data Warehouse Delay Alerting

Introduction

Developer Docs

Introduction

Integrations

Introduction

Rudderstack

Google Tag Manager

Segment

Data Warehouses and Data Lakes

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)

APIs

Dashboard Filter API (Deprecated)

REST API

User Segments Export API (Deprecated)

SDKs

SDKs Introduction

React Native

iOS

Android

Java

JavaScript

Python

Object API

Developer Basics

Aliasing

Integrations

24i

Event

Abakus

Event

Aarki

Audience

ABTasty

Audience

Actable

Feed

AdChemix

Event

Adikteev

Audience

Event

AdMedia

Audience

Adobe Marketing Cloud

Cookie Sync

Event

Adjust

Event

Feed

Adobe Audience Manager

Audience

Adobe Target

Audience

Adobe Campaign Manager

Audience

AgilOne

Event

Algolia

Event

AdPredictive

Feed

AlgoLift

Event

Feed

Airship

Audience

Event

Feed

Alooma

Event

Amazon Advertising

Audience

Amazon Kinesis

Event

Amazon Kinesis Firehose

Audience

Event

Amazon Redshift

Data Warehouse

Amazon S3

Event

Amazon SNS

Event

Amazon SQS

Event

Adobe Marketing Cloud

Event

Amobee

Audience

Ampush

Audience

Event

Amplitude

Event

Forwarding Data Subject Requests

Analytics

Audience

Event

Forwarding Data Subject Requests

Anodot

Event

AppLovin

Audience

Event

AppsFlyer

Event

Feed

Forwarding Data Subject Requests

Apptentive

Event

Apptimize

Event

Apteligent

Event

Attentive

Event

Feed

Microsoft Azure Blob Storage

Event

Attractor

Event

Batch

Audience

Event

Bidease

Audience

Bing Ads

Event

Bluecore

Event

Blueshift

Event

Feed

Forwarding Data Subject Requests

Branch

Event

Feed

Forwarding Data Subject Requests

Bluedot

Feed

Branch S2S Event

Event

Bugsnag

Event

Braze

Audience

Feed

Forwarding Data Subject Requests

Event

Button

Audience

Event

Cadent

Audience

Census

Feed

CleverTap

Audience

Event

Feed

comScore

Event

ciValue

Event

Feed

Conversant

Event

Cordial

Audience

Feed

Cortex

Event

Feed

Forwarding Data Subject Requests

Crossing Minds

Event

Criteo

Audience

Event

Custom Feed

Custom Feed

Customer.io

Audience

Event

Feed

CustomerGlu

Event

Feed

Databricks

Data Warehouse

Datadog

Event

Didomi

Event

Dynalyst

Audience

Edge226

Audience

Dynamic Yield

Audience

Event

Emarsys

Audience

Everflow

Audience

Epsilon

Event

Facebook

Audience

Event

Facebook Offline Conversions

Event

Fiksu

Audience

Event

Flurry

Event

Google Analytics for Firebase

Event

Flybits

Event

Formation

Event

Feed

ForeSee

Event

Foursquare

Audience

Feed

Google Ad Manager

Audience

FreeWheel Data Suite

Audience

Google Analytics

Event

Google Ads

Audience

Event

Google BigQuery

Audience

Data Warehouse

Google Analytics 4

Event

Google Cloud Storage

Audience

Event

Google Enhanced Conversions

Event

Google Marketing Platform

Audience

Cookie Sync

Event

Google Pub/Sub

Event

Google Marketing Platform Offline Conversions

Event

Heap

Event

Google Tag Manager

Event

Herow

Feed

Hightouch

Feed

Hyperlocology

Event

Ibotta

Event

Impact

Event

Indicative

Audience

Event

InMarket

Audience

InMobi

Audience

Event

Insider

Audience

Feed

Event

Inspectlet

Event

Intercom

Event

iPost

Feed

Audience

ironSource

Audience

Iterable

Audience

Event

Feed

Jampp

Audience

Event

Kafka

Event

Kayzen

Audience

Event

Kissmetrics

Event

Kochava

Feed

Event

Forwarding Data Subject Requests

Klaviyo

Audience

Event

Kubit

Event

LaunchDarkly

Feed

Leanplum

Audience

Feed

Event

LifeStreet

Audience

Liftoff

Audience

Event

LiveLike

Event

Localytics

Event

Liveramp

Audience

MadHive

Audience

mAdme Technologies

Event

Marigold

Audience

Mailchimp

Audience

Event

Feed

Mautic

Audience

Event

MediaMath

Audience

Mediasmart

Audience

Microsoft Azure Event Hubs

Event

Mintegral

Audience

Mixpanel

Audience

Event

Forwarding Data Subject Requests

MoEngage

Audience

Event

Feed

Moloco

Audience

Event

Movable Ink

Event

Movable Ink - V2

Event

Monetate

Event

Multiplied

Event

myTarget

Audience

Event

Nami ML

Feed

Nanigans

Event

Narrative

Event

Feed

Audience

Neura

Event

NCR Aloha

Event

OneTrust

Event

Optimizely

Audience

Event

Oracle BlueKai

Event

Oracle Responsys

Audience

Event

Paytronix

Feed

Persona.ly

Audience

Personify XP

Event

PieEye

Inbound Data Subject Requests

Pilgrim

Event

Feed

Plarin

Event

Pinterest

Event

Audience

Postie

Audience

Event

Primer

Event

Punchh

Event

Audience

Feed

Pushwoosh

Audience

Event

Antavo

Feed

Quadratic Labs

Event

Quantcast

Event

Radar

Event

Feed

Reddit

Audience

Event

Remerge

Audience

Event

Qualtrics

Event

Retina AI

Feed

Event

Regal

Event

Reveal Mobile

Event

RevenueCat

Feed

Rokt

Audience

RTB House

Audience

Event

Sailthru

Audience

Event

Salesforce Email

Audience

Feed

Event

Salesforce Mobile Push

Event

Samba TV

Audience

Event

Scalarr

Event

SessionM

Feed

Event

SendGrid

Feed

Audience

ShareThis

Feed

Audience

Signal

Event

SimpleReach

Event

Shopify

Custom Pixel

Feed

Singular

Feed

Event

Singular-DEPRECATED

Event

Skyhook

Event

Slack

Event

Smadex

Audience

Snapchat

Audience

Event

SmarterHQ

Event

Snapchat Conversions

Event

Snowflake

Data Warehouse

Sprig

Audience

Event

Snowplow

Event

Split

Event

Feed

Splunk MINT

Event

StartApp

Audience

Statsig

Feed

Event

Stormly

Audience

Event

Swrve

Event

Feed

Tapad

Audience

Talon.One

Audience

Event

Feed

Tapjoy

Audience

Taplytics

Event

Taptica

Audience

The Trade Desk

Audience

Cookie Sync

Event

Teak

Audience

Ticketure

Feed

TikTok Event

Audience (Deprecated)

Audience

Audience Migration

Event

Treasure Data

Audience

Event

Triton Digital

Audience

Twitter

Event

Audience

Valid

Event

TUNE

Event

Voucherify

Audience

Event

Vkontakte

Audience

Vungle

Audience

Webtrends

Event

Webhook

Event

Wootric

Event

White Label Loyalty

Event

Xandr

Audience

Cookie Sync

Yahoo (formerly Verizon Media)

Cookie Sync

Audience

YouAppi

Audience

Yotpo

Feed

Z2A Digital

Audience

Event

Zendesk

Feed

Event

Event

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.

Prerequisites

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

Supported Events

Required Event Type

The only native mParticle event type currently supported for sending Enhanced Conversions to Google are Commerce Events with the purchase product action type.

Supported Identifiers

Google recommends to include as many of the following identifiers as possible, but at a minimum to be forwarded, each outgoing conversion and adjustment must have at least one identifier. If none of the following identifiers are present for an incoming event, the conversion will not be forwarded and a system alert will be reported.

User Identifiers

User Identifiers include the email, phone number, and address info of the user. Note that User Identifiers are not forwarded for events using the GBRAID or WBRAID identifiers.

Email

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.

Phone Numbers

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.

Address Info

To include address information for a conversion, all six of the following user attributes are required. If any of these are missing, address info will not be included with the conversion.

  • $FirstName (will be SHA-256 hashed)
  • $LastName (will be SHA-256 hashed)
  • $Address (will be SHA-256 hashed)
  • $City
  • $Country
  • $Zip

Order Id

The order_id associated with the conversion. For commerce purchase events, the transaction_id of the product action will be used as the order_id. Note that User Identifiers will not be sent when the order_id is missing (unless the User Identifiers are the only identifier used).

Click & Braid Identifiers

The Click or Braid Identifier, i.e. the gclid, gbraid, or wbraid associated with the conversion. Note that only one of these will be forwarded for each conversion, with the preference order being: gclid, gbraid, wbraid. Click and Braid Identifiers sent to Google can be configured using Custom Flags or Custom Mappings.

GCLID

GCLID (Google Click Identifier) is the preferred tracking parameter to identify the campaign and other attributes of the click associated with the ad for ad tracking and campaign attribution. GCLID is not available from IOS traffic in some cases due to Apple’s App Tracking Transparency (ATT) policy changes.

GBRAID

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. Note that Custom Variables and User Identifiers are not supported for events using this identifier.

WBRAID

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. Note that Custom Variables and User Identifiers are not supported for events using this identifier.

Native Field Mappings

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

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.

Custom Event Mappings

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.

Enhanced Conversions for Web

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 Supported Identifiers 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.

Custom Variable Mapping

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:

  • The given Custom Variables need to be set-up on Google’s end.
  • The Custom Variable Mapping setting in Connection Settings needs to be configured to map mP attributes to a given Google Custom Variable.
  • The event must not be using a GBRAID or WBRAID identifier.

Settings

Validation

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.

Configuration Settings

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 data will be sent. If you do not use a manager account, this can be left blank.

Connection Settings

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.
Conversion Environment enum Unspecified Environment of the uploaded conversions, either Unspecified, App, or Web. Google enforces that setting the Conversion Environment is only available to allowlisted Google Ads accounts. Contact your Google rep if you are interested in using this, and use this setting only if your Google account is allowlisted.
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.
Default Ad User Data Consent Value string Unspecified The default consent value to forward for the Ad User Data field.
Custom Variable Mapping mapping null The mapping of mParticle event attributes to Google Enhanced Conversion custom variables, as defined in Google Ads portal.
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.
    Last Updated: December 20, 2024