Set up Kayzen
Kayzen is an ad network integrated with Adjust. Our integration lets Kayzen receive attribution and in-app event data through automated callbacks.
In this article, learn how to set up measurement with Kayzen for your app. This includes activating the integration, creating a campaign link, and choosing what data Adjust can share with Kayzen.
Before you begin
Requirements
- Admin, Editor, or Custom Editor permissions in Adjust.
- Adjust SDK v4.0.0 and later to map SDK parameters to Kayzen 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 Kayzen representative.
Select Kayzen and your app in Campaign Lab
- Under Campaign Lab, select Partners.
- Select New partner > Kayzen. 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 Kayzen.
- Select Next.
Enable data sharing
Enable data sharing to activate the integration with Kayzen. To enable data sharing:
- Enter your API_KEY.
Once you enable data sharing with Kayzen, Adjust automatically sends Kayzen the following data, by default:
- install
- session
- uninstall
- reinstall
- reattributionReinstall
- reattribution
- event
- rejectedInstall
- rejectedReattribution
- ad revenue
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 Kayzen by default.
- install
- session
- uninstall
- reinstall
- reattributionReinstall
- reattribution
- event
- rejectedInstall
- rejectedReattribution
- ad revenue
Send additional data
Choose the amount and type of data that you want to share with Kayzen through callbacks. Kayzen 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 Kayzen:
- Data from all attribution sources
- Only data attributed to Kayzen
Ad revenue (from ad views)
Ad revenue sharing lets Kayzen receive user ad revenue data. This lets Kayzen use ad revenue data to optimize your user targeting and campaigns.
This feature is available with Adjust’s Ad Revenue package. To purchase our Ad Revenue package, contact your sales representative.
To share ad revenue to Kayzen, select one or more Ad Revenue Sources.
- If you leave this field empty, we send ad revenue data from all integrated mediation sources.
Sessions
Adjust does not automatically send session callbacks due to the high volume of sessions. Sharing sessions means Kayzen will receive your app’s session activity.
Uninstalls or reinstalls
Sharing uninstalls or reinstalls lets Kayzen receive your app’s uninstall and/or reinstall data measured by Adjust.
For iOS apps, you might expect a low record of uninstalls and/or reinstalls. For more information, visit Uninstall and reinstall measurement.
In-app revenue (from in-app purchases)
Sharing in-app revenue lets Kayzen 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 Kayzen can receive. Data for unmapped events is not shared with Kayzen.
Map individual events
If you have a multi-platform app, you can choose to share different events per platform with Kayzen. 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 Kayzen.
- Select Map event.
- In the Adjust event list, choose the Adjust event that you want to share with Kayzen.
- Under Partner event, you need to select the Kayzen 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 Kayzen will receive in-app event data for each of your linked events.
Map all events
If Kayzen supports mapping all events automatically, under Map events, select Map all events. This saves time in mapping individual events.
Now Kayzen will receive in-app event data for all your linked events.
Map parameters
You usually need to map parameters to share custom data with Kayzen.
Partner parameters (available in Adjust SDK version 4.0+) let Adjust collect custom data points from your app and send them to Kayzen. This lets Kayzen 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 Kayzen, 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 Kayzen
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 Kayzen.
Once you’ve created your link, share it with Kayzen for placement in campaigns.
List of all parameters forwarded to Kayzen
Kayzen requires Adjust to send the following parameters (data points) with your callbacks:
| Placeholder | Information |
{adid} | Adjust device ID (all platforms) |
{city} | Device city |
{click_attribution_window} | Attribution window settings for device matching (hours) |
{country} | Device two-character country code |
{currency} | Original ISO 4217 currency code sent from Adjust SDK |
{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) |
{idfv} | Uppercase iOS ID for vendors |
{impression_attribution_window} | Attribution window settings for impression matching (hours) |
{inactive_user_definition} | Inactivity period required for reattribution (hours) |
{ip_address} | Device IP address |
{is_reattributed} | 1 if user was reattributed at least once from an earlier source. 0 if user has never been reattributed |
{isp} | Device internet service provider |
{language} | Device two-character language code |
{lifetime_session_count} | Number of sessions recorded across entire user lifetime |
{match_type} | Attribution method |
{mcc} | Mobile country code: three-digit code identifying a device's country. Use with the mobile network code to identify a device's carrier. |
{mnc} | Mobile network code: two-digit code. Use with the mobile country code to identify a device's carrier. |
{nonce} | Random lowercase alphanumeric string (unique per callback) |
{os_name} | Device operating system |
{os_version} | Operating system version number |
{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) |
{reattribution_attribution_window} | Attribution window settings for reattribution (hours) |
{revenue_float} | Revenue, as sent from Adjust SDK, in whole currency units |
{revenue_usd_cents} | Revenue, in US cents |
{revenue_usd} | Revenue, in US dollars |
{revenue} | Revenue, as sent from Adjust SDK in cents |
{time_spent} | Length of user's current session, in seconds |
{timezone} | Device time zone |
{user_agent} | Incoming raw user agent |
{activity_kind} | Type of user activity |
{adgroup_name} | Adgroup name, as taken from the tracker |
{app_id} | Store App ID or Google Play Store |
{app_name} | Name of the app |
{campaign_name} | Campaign name, as taken from the tracker |
{click_time} | Attributed click timestamp |
{connection_type} | Internet connection type |
{conversion_duration} | Time between click and install or reattribution in seconds |
{cpu_type} | CPU type |
{created_at} | Activity timestamp |
{creative_name} | Creative name, as taken from the tracker |
{device_manufacturer} | Device manufacturer name |
{engagement_time} | Engagement timestamp |
{hardware_name} | Hardware name |
{impression_based} | 1 if impression-based engagement, 0 if not |
{impression_time} | Attributed impression timestamp |
{install_begin_time} | App download began timestamp (Android and Google Play Store only) |
{install_finish_time} | App download completion timestamp |
{installed_at} | Install (i.e., first app open) timestamp |
{is_organic} | 1 if organic traffic, 0 if non-organic |
{network_name} | Network name, as taken from the tracker |
{network_type} | Network type |
{reattributed_at} | Reattribution timestamp |
{reinstalled_at} | Reinstall timestamp |
{rejection_reason} | Reason for a rejected attribution |
{time_to_reinstall} | Time between latest app uninstall and subsequent reinstall in seconds |
{time_to_uninstall} | Time between app install (or latest reinstall) and subsequent uninstall in seconds |
{uninstalled_at} | Uninstall timestamp (estimation based on last session time) |
{ad_impressions_count} | Number of mobile ads served to end users |
{ad_revenue_network} | Ad network that displayed the ad |
{ad_revenue_unit} | Ad unit that generated the revenue |
{ad_revenue_placement} | User placement, as defined on the platform |
{is_s2s} | 1 if server to server engagement, 0 if not |
{proxy_ip_address} | IP address of user's proxy |
{ad_mediation_platform} | Mediation platform name |
{ad_revenue_payload} | Impression-level revenue data (ILRD) as a JSON |