Set up Atlas
Atlas is an analytics partner integrated with Adjust. Our integration lets Atlas receive data measured in Adjust through automated callbacks. Use this data with the partners' tools for analytics and insights.
In this article, learn how to set up measurement with Atlas for your app. This includes activating the integration and choosing what data Adjust can share with Atlas.
Before you begin
Requirements
- Admin, Editor, or Custom Editor permissions in Adjust.
- Adjust SDK v4.0.0 and later to map SDK parameters to Atlas 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
UNIVERSAL TAG ID, ADVERTISER ID, and CONNECTION ID
- For help finding your credentials, contact your Atlas representative.
Select Atlas and your app in Campaign Lab
- Under Campaign Lab, select Partners.
- Select New partner > Atlas. 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 Atlas.
- Select Next.
Enable data sharing
Enable data sharing to activate the integration with Atlas. To enable data sharing:
- Enter your UNIVERSAL TAG ID, ADVERTISER ID, and CONNECTION ID.
Once you enable data sharing with Atlas, Adjust automatically sends Atlas the following data, by default:
- click
- install
- session
- 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 Atlas by default:
- click
- install
- session
- event
Send additional data
Choose the amount and type of data that you want to share with Atlas through callbacks. Atlas may use this information to optimize performance.
To send additional data, you can review and customize the following:
Sessions
Adjust does not automatically send session callbacks due to the high volume of sessions. Sharing sessions means Atlas will receive your app’s session activity.
In-app revenue (from in-app purchases)
Sharing in-app revenue lets Atlas 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 Atlas can receive. Data for unmapped events is not shared with Atlas.
Map individual events
If you have a multi-platform app, you can choose to share different events per platform with Atlas. 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 Atlas.
- Select Map event.
- In the Adjust event list, choose the Adjust event that you want to share with Atlas.
- Under Partner event, you need to select the Atlas 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 Atlas will receive in-app event data for each of your linked events.
Map all events
If Atlas supports mapping all events automatically, under Map events, select Map all events. This saves time in mapping individual events.
Now Atlas will receive in-app event data for all your linked events.
Map parameters
You usually need to map parameters to share custom data with Atlas.
Partner parameters (available in Adjust SDK version 4.0+) let Adjust collect custom data points from your app and send them to Atlas. This lets Atlas 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 Atlas, 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.
Enable Atlas for your app
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
Select Enable partner to enable Atlas for your app. Analytics partners don't work with links for campaigns. Once enabled, our integration sends attribution and in-app event data via automated callbacks.
Partner specific setup instructions
Atlas allows you to send a set of predefined parameters. If you attach any of these parameters to an event in your adjust SDK, these will be forwarded to Atlas. 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 Atlas accepts:
Parameter key > Value
- order_id > order ID of a transaction
- qty > quantity of a transaction
List of all parameters forwarded to Atlas
Atlas requires Adjust to send the following parameters (data points) with your callbacks:
Placeholder | Information |
{currency} | Original ISO 4217 currency code sent from Adjust SDK |
{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} | Revenue, as sent from Adjust SDK in cents |
{user_agent} | Incoming raw user agent |
{adgroup_name} | Adgroup name, as taken from the tracker |
{campaign_name} | Campaign name, as taken from the tracker |
{created_at} | Activity timestamp |
{creative_name} | Creative name, as taken from the tracker |
{network_name} | Network name, as taken from the tracker |