Set up Adpartners
Adpartners is an ad network integrated with Adjust. Our integration lets Adpartners receive attribution and in-app event data through automated callbacks.
In this article, learn how to set up measurement with Adpartners for your app. This includes activating the integration, creating a campaign link, and choosing what data Adjust can share with Adpartners.
Before you begin
Requirements
- Admin, Editor, or Custom Editor permissions in Adjust.
- Adjust SDK v4.0.0 and later to map SDK parameters to Adpartners 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
Select Adpartners and your app in Campaign Lab
- Under Campaign Lab, select Partners.
- Select New partner > Adpartners. 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 Adpartners.
- Select Next.
Enable data sharing
Enable data sharing to activate the integration with Adpartners. To enable data sharing:
- Turn on Enabled
Once you enable data sharing with Adpartners, Adjust automatically sends Adpartners the following data, by default:
- install
- 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 Adpartners by default.
- install
- reinstall
- event
Send additional data
Choose the amount and type of data that you want to share with Adpartners through callbacks. Adpartners 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 Adpartners:
- Data from all attribution sources
- Only data attributed to Adpartners
In-app revenue (from in-app purchases)
Sharing in-app revenue lets Adpartners receive revenue amounts along with your revenue event data. You need to map events that generate revenue to share this data.
Map parameters
You usually need to map parameters to share custom data with Adpartners.
Map events
Map events that you want to share to the values that Adpartners can receive. Data for unmapped events is not shared with Adpartners.
Under Map events, follow these steps to choose the in-app events you want to directly send to Adpartners.
- Select Map event.
- In the Adjust event list, choose the Adjust event that you want to share with Adpartners.
- 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 Adpartners will receive in-app event data for each of your linked events.
Map parameters
Partner parameters (available in Adjust SDK version 4.0+) let Adjust collect custom data points from your app and send them to Adpartners. This lets Adpartners 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 Adpartners, follow these steps.
- Set up partner parameters within the Adjust SDK: iOS, Android
- Check the Parameters data sharing checkbox.
- Map your events.
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 Adpartners
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 Adpartners.
Once you’ve created your link, share it with Adpartners for placement in campaigns.
List of all parameters forwarded to Adpartners
Adpartners requires Adjust to send the following parameters (data points) with your callbacks:
Placeholder | Information |
{country} | Device two-character country code |
{currency} | Original ISO 4217 currency code sent from Adjust SDK |
{device_name} | Device model number |
{device_type} | Device type |
{ip_address} | Device IP address |
{os_name} | Device operating system |
{partner_parameters} | Custom partner parameters collected by the Adjust SDK or S2S request and transmitted to third party providers via postbacks |
{reporting_currency} | Dashboard reporting ISO 4217 currency code |
{reporting_revenue} | Revenue, as reported in the Adjust Dashboard, in whole currency units |
{revenue_float} | Revenue, as sent from Adjust SDK, in whole currency units |
{app_id} | Store App ID or Google Play Store |
{app_name} | Name of the app |
{app_version} | App version number (Android), build-version-number for the bundle (iOS) |
{installed_at} | Install (i.e., first app open) timestamp |
{store} | Target store of click |