Set up The Tool
The Tool is an analytics partner integrated with Adjust. Our integration lets The Tool 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 The Tool for your app. This includes activating the integration and choosing what data Adjust can share with The Tool.
Before you begin
Requirements
- Admin, Editor, or Custom Editor permissions in Adjust.
- Adjust SDK v4.0.0 and later to map SDK parameters to The Tool 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
ACCOUNT ID
- For help finding your credentials, contact your The Tool representative.
Select The Tool and your app in Campaign Lab
- Under Campaign Lab, select Partners.
- Select New partner > The Tool. 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 The Tool.
- Select Next.
Enable data sharing
Enable data sharing to activate the integration with The Tool. To enable data sharing:
- Enter your ACCOUNT ID.
Once you enable data sharing with The Tool, Adjust automatically sends The Tool the following data, by default:
- install
- 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 The Tool by default:
- install
- event
Send additional data
Choose the amount and type of data that you want to share with The Tool through callbacks. The Tool may use this information to optimize performance.
To send additional data, you can review and customize the following:
In-app revenue (from in-app purchases)
Sharing in-app revenue lets The Tool 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 The Tool can receive. Data for unmapped events is not shared with The Tool.
Under Map events, follow these steps to choose the in-app events you want to directly send to The Tool.
- Select Map event.
- In the Adjust event list, choose the Adjust event that you want to share with The Tool.
- In the Partner event list, choose or enter a custom event name that you want to map the Adjust event to. You might have to map an event to several values.
- Select Apply.
Now The Tool will receive in-app event data for each of your linked events.
Enable The Tool 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 The Tool 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.
List of all parameters forwarded to The Tool
The Tool requires Adjust to send the following parameters (data points) with your callbacks:
| Placeholder | Information |
{adid} | Adjust device ID (all platforms) |
{android_id} | Android ID (Android only) |
{city} | Device city |
{country} | Device two-character country code |
{deeplink} | Deeplink URL appended to click URL |
{device_name} | Device model number |
{device_type} | Device type |
{gps_adid} | Google Play Store advertising ID |
{idfa} | ID for advertisers (iOS only) |
{match_type} | Attribution method |
{os_name} | Device operating system |
{os_version} | Operating system version number |
{postal_code} | Device postal code of IP address |
{app_id} | Store App ID or Google Play Store |
{app_name_dashboard} | Name of the app in the Adjust Dashboard |
{app_name} | Name of the app |
{app_version} | App version number (Android), build-version-number for the bundle (iOS) |
{click_referer} | Referrer header from click |
{connection_type} | Internet connection type |
{engagement_time} | Engagement timestamp |
{installed_at} | Install (i.e., first app open) timestamp |
{is_organic} | 1 if organic traffic, 0 if non-organic |
{rejection_reason} | Reason for a rejected attribution |
{store} | Target store of click |