Set up Income Access
Income Access is an ad network integrated with Adjust. Our integration lets Income Access receive attribution and in-app event data through automated callbacks.
In this article, learn how to set up measurement with Income Access for your app. This includes activating the integration, creating a campaign link, and choosing what data Adjust can share with Income Access.
Before you begin
Requirements
- Admin, Editor, or Custom Editor permissions in Adjust.
- Adjust SDK v4.0.0 and later to map SDK parameters to Income Access 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
Income Access App ID, Client DB Name, Merchant ID, App Authentication Key, Client Domain
- For help finding your credentials, contact your Income Access representative.
Select Income Access and your app in Campaign Lab
- Under Campaign Lab, select Partners.
- Select New partner > Income Access. 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 Income Access.
- Select Next.
Enable data sharing
Enable data sharing to activate the integration with Income Access. To enable data sharing:
- Enter your Income Access App ID, Client DB Name, Merchant ID, App Authentication Key, Client Domain.
Once you enable data sharing with Income Access, Adjust automatically sends Income Access the following data, by default:
- installs (attributed only)
- event (attributed only)
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 Income Access by default.
- installs (attributed only)
- event (attributed only)
Send additional data
Choose the amount and type of data that you want to share with Income Access through callbacks. Income Access may use this information to optimize performance.
Map events
Map events that you want to share to the values that Income Access can receive. Data for unmapped events is not shared with Income Access.
Map individual events
If you have a multi-platform app, you can choose to share different events per platform with Income Access. 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 Income Access.
- Select Map event.
- In the Adjust event list, choose the Adjust event that you want to share with Income Access.
- Under Partner event, you need to select the Income Access 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 Income Access will receive in-app event data for each of your linked events.
Map all events
If Income Access supports mapping all events automatically, under Map events, select Map all events. This saves time in mapping individual events.
Now Income Access will receive in-app event data for all your linked events.
Map parameters
You usually need to map parameters to share custom data with Income Access.
Partner parameters (available in Adjust SDK version 4.0+) let Adjust collect custom data points from your app and send them to Income Access. This lets Income Access 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 Income Access, 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 Income Access
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 Income Access.
Once you’ve created your link, share it with Income Access for placement in campaigns.
Partner specific setup instructions
While enabling the module, add only the first section of the URL under the Client Domain field.
Income Access' integration allows you to send a predefined parameter for in-app events through partner parameters. If you set up the parameter external_user_id for an event in your Adjust SDK, it will be forwarded to Income Access as the Player ID. You can find out more about implementing partner parameters in the SDK readme specific to the SDK(s) you are working with.
List of all parameters forwarded to Income Access
Income Access requires Adjust to send the following parameters (data points) with your callbacks:
Placeholder | Information |
{idfa||android_id} | IDFA, or Android ID if IDFA is empty |
{ip_address} | Device IP address |
{user_agent} | Incoming raw user agent |
{app_name} | Name of the app |
{created_at} | Activity timestamp |