Configure your TUNE Network
Offer protocol
When creating offers, ensure that Conversion Tracking
is set to one of the following options for Postback tracking:
-
Server Postback w/ Transaction ID
-
Server Postback w/ Partner ID
When using Server Postback w/ Transaction ID
, if conversions need to be attributed to a default offer goal, ensure that only transaction_id
is sent in the custom_parameters. Do not send goal_name
or goal_id
.
Specify Amounts on Conversion
In order to set the revenue amount via the mParticle event custom attributes, there is one network setting that needs to be changed.
Update the following setting under Company
→ Customize Application
→ Settings
→ Tracking
:
-
Specify Amounts on Conversion
: Enabled
mParticle Events
Custom Events
The TUNE-mParticle integration supports mParticle Custom Events and is able to process values from:
-
the
custom_attributes
map
Required fields
For an mParticle event to successfully record a conversion, the following fields will be required in the custom_attributes
:
-
goal_name
-
For offers using the
Server Postback w/ Transaction ID
protocol:-
transaction_id
-
-
For offers with
Server Postback w/ Partner ID protocol:
-
affiliate_id
-
offer_id
-
Additional parameters
Customers should provide their TUNE CSM with the list of mParticle parameters that they want to include in the TUNE conversion. It should also be specified how those parameters are going to match the TUNE parameters that are going to be used for the conversion.
Ultimately, TUNE will generate a JSON file to represent the field mapping. Here’s an example of a JSON file:
{
"UserIdentities":{
"customer":{"Destination":"adv_sub"},
"other":{"Destination":"adv_sub2"}
},
"CustomAttributes":{
"tune_transaction_id":{"Destination":"transaction_id"},
"goal_name":{"Destination":"goal_name"},
"offer_id":{"Destination":"offer_id"},
"affiliate_id":{"Destination":"aff_id"},
"revenue":{"Destination":"revenue"},
"currency":{"Destination":"currency"}
}
}
Production and Development environments
mParticle offers customers the option to send events to two environments: production
and development
. Customers should be able to specify the environment in the mParticle request using the environment
variable:
"environment": "production"
Customers can refer to the user-agent
in the Conversion Report to identify which TUNE conversions came from an mParticle event. The user-agent
will be set to:
-
mparticle/v1.x.x
for events sent to theProduction
environment -
mparticle-development-test/v1.x.x
for events sent to theDevelopment
environment
Note: The user-agent
field may not be available in the default view of the Conversion Report. To add the user-agent
field to the report, click to expand the ‘Options’ panel, select the ‘User Agent’ checkbox and click the ‘Run Report’ button.
Forward mParticle events to your TUNE network
To enable the mParticle integration:
-
Create the TUNE connection in your mParticle account
-
Setup the mParticle Input feed
-
Configure the TUNE data connector
-
Send a test event to mParticle
Create the TUNE connection in mParticle
On your mParticle home page:
-
In the left-hand sidebar, click on
Directory
-
Find the
TUNE
connector -
Hover over the tile and click on
Setup
-
Select the
Output Event
option and click onConfigure
- Set the value for the following fields:
-
-
-
-
Configuration name
-
TUNE network ID
(this will set thenetwork_id
for both mParticle environments:Production
andDevelopment
)
-
-
Click on
Save
-
-
Setup the mParticle Input feed API key
On your mParticle home page:
-
In the left-hand sidebar, click on
Setup
-
Select the desired platform and click on
+Configure
-
Click on
Issue Keys
-
Store the
Key
andSecret
values
Configure the TUNE data connector
On your mParticle Home page, click on Connections
.
-
Select the available input
2. Click on Connect output
4. Activate the connection
5. Click ‘Done’
Note: Allow up to five minutes for the connection to take effect.
Send a test event to mParticle
Using the HTTP API might be the easiest way to send a test event to mParticle. You are going to need the Key
and Secret
that was generated when you set up the mParticle Input feed.
You can find additional details on how to post events to the mParticle API on this page.
Sending events via Postman
Endpoint
Set up a POST request to the following endpoint:
Authentication
Under the Auth tab:
-
Set
Type
toBasic Auth
-
Use the mParticle input feed
Secret
as theusername
-
Use the mParticle input feed
Key
as thepassword
TUNE session and goal
In your TUNE network:
-
Create a
goal
(Conversion event type) for the offer you are using for testing -
Create a session for the offer you are using for testing
-
Generate a tracking link for the offer
-
Click on the link and store the
transaction_id
-
Note: If conversions need to be attributed to a default offer goal, ensure that only transaction_id is sent in the custom_parameters. Do not send goal_name or goal_id.
Request Body
The following request body records a conversion for the mParticle offer for the measurement
network, under the 20220804_demo
goal name.
Checking your mParticle activity
To review activity in mParticle, visit: https://app.mparticle.com/activity/app