Set up Iterable
Iterable is an ad network integrated with Adjust. Our integration lets Iterable receive attribution and in-app event data through automated callbacks.
In this article, learn how to set up measurement with Iterable for your app. This includes activating the integration, creating a campaign link, and choosing what data Adjust can share with Iterable.
Before you begin
Requirements
- Admin, Editor, or Custom Editor permissions in Adjust.
- Adjust SDK v4.0.0 and later to map SDK parameters to Iterable 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
API KEY
- For help finding your credentials, contact your Iterable representative.
Select Iterable and your app in Campaign Lab
- Under Campaign Lab, select Partners.
- Select New partner > Iterable. 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 Iterable.
- Select Next.
Enable data sharing
Enable data sharing to activate the integration with Iterable. To enable data sharing:
- Enter your API KEY.
Once you enable data sharing with Iterable, Adjust automatically sends Iterable the following data, by default:
- install
- reattribution
- 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 Iterable by default.
- install
- reattribution
- event
Send additional data
Choose the amount and type of data that you want to share with Iterable through callbacks. Iterable 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 Iterable:
- Data from all attribution sources
- Only data attributed to Iterable
In-app revenue (from in-app purchases)
Sharing in-app revenue lets Iterable 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 Iterable can receive. Data for unmapped events is not shared with Iterable.
Map individual events
If you have a multi-platform app, you can choose to share different events per platform with Iterable. 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 Iterable.
- Select Map event.
- In the Adjust event list, choose the Adjust event that you want to share with Iterable.
- Under Partner event, you need to select the Iterable 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 Iterable will receive in-app event data for each of your linked events.
Map all events
If Iterable supports mapping all events automatically, under Map events, select Map all events. This saves time in mapping individual events.
Now Iterable will receive in-app event data for all your linked events.
Map parameters
You usually need to map parameters to share custom data with Iterable.
Partner parameters (available in Adjust SDK version 4.0+) let Adjust collect custom data points from your app and send them to Iterable. This lets Iterable 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 Iterable, 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 Iterable
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 Iterable.
Once you’ve created your link, share it with Iterable for placement in campaigns.
Partner specific setup instructions
By default, Adjust sends callbacks to Iterable's standard API. To enable Adjust to fire callbacks to Iterable's via their EU API, please enable the toggle EU Region
Note: For more details about the EU API , please reach out to your Iterable representative.
If you would like to find out more about how to leverage this integration for your use cases, check out our one pager with Iterable. In case of any questions related to the information provided on the one pager, please reach out to partners@adjust.com.
List of all parameters forwarded to Iterable
Iterable 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) |
{currency} | Original ISO 4217 currency code sent from Adjust SDK |
{idfa} | ID for advertisers (iOS only) |
{language} | Device two-character language code |
{match_type} | Attribution method |
{partner_parameters} | Custom partner parameters collected by the Adjust SDK or S2S request and transmitted to third party providers via postbacks |
{postal_code} | Device postal code of IP address |
{revenue_float} | Revenue, as sent from Adjust SDK, in whole currency units |
{revenue_usd} | Revenue, in US dollars |
{user_agent} | Incoming raw user agent |
{app_name} | Name of the app |
{engagement_time} | Engagement timestamp |