Set up Epsilon
Epsilon is an ad network integrated with Adjust. Our integration lets Epsilon receive attribution and in-app event data through automated callbacks.
In this article, learn how to set up measurement with Epsilon for your app. This includes activating the integration, creating a campaign link, and choosing what data Adjust can share with Epsilon.
Before you begin
Requirements
- Admin, Editor, or Custom Editor permissions in Adjust.
- Adjust SDK v4.0.0 and later to map SDK parameters to Epsilon parameters. Follow the guides linked below to use this feature.
iOS | Android | Windows | Unity | React Native | Flutter | Adobe Air | Cordova | Marmalade | Xamarin | Cocos2d-x | Titanium | Corona
Credentials
Company ID and Company Magic
- For help finding your credentials, contact your Epsilon representative.
Select Epsilon and your app in Campaign Lab
- Under Campaign Lab, select Partners.
- Select New partner > Epsilon. Select Next to move to the next screen.
- In the App selection screen, choose the app for which you want to create the link, and enable the integration to share data with Epsilon.
- Select Next.
Enable data sharing
Enable data sharing to activate the integration with Epsilon. To enable data sharing:
- Enter your Company ID and Company Magic.
Once you enable data sharing with Epsilon, Adjust automatically sends Epsilon the following data, by default:
- install
- session
- reinstall
- event
Set your data sharing options
If you’re working with a multi-platform app with data sharing enabled for multiple platforms, you can:
- Separate data sharing options at the platform-level by selecting Use platform-specific settings.
- Set the same data sharing settings for multiple platforms by selecting Use global settings.
Now, under What will be shared by default?, review the activities that Adjust shares with Epsilon by default.
- install
- session
- reinstall
- event
Send additional data
Choose the amount and type of data that you want to share with Epsilon through callbacks. Epsilon may use this information to optimize performance.
- Under What sources of data do you want to share?, choose the attribution source of the data you are sharing with Epsilon:
- Data from all attribution sources
- Only data attributed to Epsilon
Sessions
Adjust does not automatically send session callbacks due to the high volume of sessions. Sharing sessions means Epsilon will receive your app’s session activity.
Uninstalls or reinstalls
Sharing uninstalls or reinstalls lets Epsilon receive your app’s uninstall and/or reinstall data measured by Adjust.
For iOS apps, you might expect a low record of uninstalls and/or reinstalls. For more information, visit Uninstall and reinstall measurement.
In-app revenue (from in-app purchases)
Sharing in-app revenue lets Epsilon receive revenue amounts along with your revenue event data. You need to map events that generate revenue to share this data.
Map events
Map events that you want to share to the values that Epsilon can receive. Data for unmapped events is not shared with Epsilon.
Map individual events
If you have a multi-platform app, you can choose to share different events per platform with Epsilon. This lets you:
- Set individual events to manage campaign strategies for each platform.
- Customize data sharing per platform.
Under Map events, follow these steps to choose the in-app events you want to directly send to Epsilon.
- Select Map event.
- In the Adjust event list, choose the Adjust event that you want to share with Epsilon.
- Under Partner event, you need to select the Epsilon event that corresponds to the Adjust event.
- For single platform apps and multi-platform apps with data sharing enabled for a single platform only, you map events for that platform only. For multi-platform apps with data sharing enabled for multiple platforms, you can:
- Select Use platform-specific mapping to map separate events at the platform-level or to not map events for certain platforms.
- Select Use global mapping to map the same events for all platforms.
- In the Partner event list, choose or enter a custom event name, that you want to map the Adjust event to.
- For single platform apps and multi-platform apps with data sharing enabled for a single platform only, you map events for that platform only. For multi-platform apps with data sharing enabled for multiple platforms, you can:
- Select Apply.
Now Epsilon will receive in-app event data for each of your linked events.
Map all events
If Epsilon supports mapping all events automatically, under Map events, select Map all events. This saves time in mapping individual events.
Now Epsilon will receive in-app event data for all your linked events.
Map parameters
You usually need to map parameters to share custom data with Epsilon.
Partner parameters (available in Adjust SDK version 4.0+) let Adjust collect custom data points from your app and send them to Epsilon. This lets Epsilon receive custom event details for each of your linked events.
Before adding new partner parameters to the Adjust SDK, make sure no pre-existing partner parameters already fit your requirements.
To share partner parameters to Epsilon, follow these steps.
- Set up partner parameters within the Adjust SDK.
- Check Before you begin for all SDK development platform links.
- Under Set your data sharing options, select Parameters.
- Under Map parameters, you can specify how you want to send partner parameters defined in the SDK to the network:
- Select Map parameter.
- In the SDK parameter field, enter the name of the SDK parameter you want to share with the network.
- In the Partner parameter field, enter the network parameter that corresponds to the SDK parameter.
If you set up partner parameters within the Adjust SDK without setting up parameter sharing in the dashboard, Adjust forwards the parameters as named in the Adjust SDK.
Configure your link and settings
You have the option to set your:
Create your link and share it with Epsilon
In the Setup review screen, you can review your choices. You can also go back and make changes to:
- Your selected app
- Data sharing options
- Link structure parameters
- User destinations
- Attribution settings
Select Create link to create your click URL, impression URL, QR code and link token. Creating a link also enables data sharing and the integration with Epsilon.
Once you’ve created your link, share it with Epsilon for placement in campaigns.
Partner specific setup instructions
Epsilon allows you to send a set of predefined parameters. If you attach any of these parameters to an event or session in your adjust SDK, these will be forwarded to Epsilon . You can find out more about attaching partner parameters in the SDK readme specific to the SDK or SDKs you are working with. Below is a list of the defined parameters that Epsilon accepts:
Parameter key > Value
- dtm_fid* > form identifier
- dtm_promo_id* > value that identofy the page type
- dtm_email_hash > SHA-256 hash of customer's email address. Remove leading/trailing spaces and convert email address to lowercase before hashing
- dtm_mobile_hash > SHA-256 hash of customer's mobile phone number in the format: country code + area code without leading zeros + subscriber number. Remove any special charracters.
- dtm_user_id > unique identifier. Cannot be PII or the hashed email address
- dtmc_tcf_string** > GDPR consent string
- dtmc_department*** > the department name for the current view
- dtmc_category*** > the category name for the current view
- dtmc_sub_category*** > the subcategory name for the current view
- dtmc_product_id**** > product ID for current view
- dtmc_brand**** > manufacturer brand
- dtmc_upc**** > manufacturer UPC code
- dtmc_mpn*** > manufacturer model part number
- dtmc_transaction_id***** > client system's unique identifier for each conversion
- dtm_items > an array of all items in the conversion. Each item should include the following
- product_id: SKU of the item
- item_amount: cost of 1 unit of the item
- item_quantity: number of SKU items in the transaction
- item_discount: discount value from the original amount
- dtmc_conv_type > differentiate between types of Online Purcahses: delivery, pickup,...
- dtmc_conv_store_location > for pickup type conversions, denote the store location of the pickup
* mandatory
** mandatory in areas where GDPR restrictions apply
*** conditional - required where known, including product events
_****_Conditional - only required on product view events
***** Mandatory on transactions
List of all parameters forwarded to Epsilon
Epsilon requires Adjust to send the following parameters (data points) with your callbacks:
Placeholder | Information |
{currency} | Original ISO 4217 currency code sent from Adjust SDK |
{deeplink} | Deeplink URL appended to click URL |
{gps_adid} | Google Play Store advertising ID |
{idfa} | ID for advertisers (iOS only) |
{ip_address} | Device IP address |
{partner_parameters} | Custom partner parameters collected by the Adjust SDK or S2S request and transmitted to third party providers via postbacks |
{random} | Random number (unique per callback) |
{revenue_float} | Revenue, as sent from Adjust SDK, in whole currency units |
{user_agent} | Incoming raw user agent |