Set up KARTE
KARTE is an analytics partner integrated with Adjust. Our integration lets KARTE 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 KARTE for your app. This includes activating the integration and choosing what data Adjust can share with KARTE.
Before you begin
Requirements
- Admin, Editor, or Custom Editor permissions in Adjust.
- Adjust SDK v4.0.0 and later to map SDK parameters to KARTE 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 KARTE representative.
Select KARTE and your app in Campaign Lab
- Under Campaign Lab, select Partners.
- Select New partner > KARTE. 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 KARTE.
- Select Next.
Enable data sharing
Enable data sharing to activate the integration with KARTE. To enable data sharing:
- Enter your API KEY.
Once you enable data sharing with KARTE, Adjust automatically sends KARTE the following data, by default:
- install
- reinstall
- reattributionReinstall
- 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 KARTE by default:
- install
- reinstall
- reattributionReinstall
- reattribution
- event
Send additional data
Choose the amount and type of data that you want to share with KARTE through callbacks. KARTE may use this information to optimize performance.
To send additional data, you can review and customize the following:
Uninstalls or reinstalls
Sharing uninstalls or reinstalls lets KARTE 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 KARTE 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 KARTE can receive. Data for unmapped events is not shared with KARTE.
Map individual events
If you have a multi-platform app, you can choose to share different events per platform with KARTE. 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 KARTE.
- Select Map event.
- In the Adjust event list, choose the Adjust event that you want to share with KARTE.
- Under Partner event, you need to select the KARTE 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 KARTE will receive in-app event data for each of your linked events.
Map all events
If KARTE supports mapping all events automatically, under Map events, select Map all events. This saves time in mapping individual events.
Now KARTE will receive in-app event data for all your linked events.
Map parameters
You usually need to map parameters to share custom data with KARTE.
Partner parameters (available in Adjust SDK version 4.0+) let Adjust collect custom data points from your app and send them to KARTE. This lets KARTE 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 KARTE, 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.
Enable KARTE 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 KARTE 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.
Partner specific setup instructions
Predefined parameters
Karte allows you to send a set of predefined parameters. If you attach any of these parameters to an event in your adjust SDK, these will be forwarded to Karte. You can find out more about attaching partner parameters in the SDK readme specific to the SDK or SDKs you are working with. Below is a list of the defined parameters that Karte accepts:
Parameter key > Value
- visitor_id > mandatory for sending callbacks to Karte.
To send event callbacks to Karte, you must implement visitor_id as a session and event partner parameter within the Adjust SDK. In the Adjust dashboard, Parameter Forwardingneeds to be turned on.
For the detail, please check Karte Support Page(JP) as well.
List of all parameters forwarded to KARTE
KARTE 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) |
{api_level} | API level (Android only) |
{city} | Device city |
{click_attribution_window} | Attribution window settings for device matching (hours) |
{cost_amount} | Cost of the user engagement (available for ad spend tracking only) |
{cost_currency} | ISO 4217 currency code of the cost data (available for ad spend tracking only) |
{cost_type} | The campaign pricing model (available for ad spend tracking only) |
{country_subdivision} | Device subdivision of country, e.g., state |
{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 |
{environment} | Current Adjust SDK environment setting |
{fire_adid} | Fire OS advertising identifier |
{gps_adid_md5} | Lowercase hex MD5 hash of Google Play Store advertising ID |
{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 |
{isp} | Device internet service provider |
{language} | Device two-character language code |
{last_time_spent} | Length of user's last session, in seconds |
{lifetime_session_count} | Number of sessions recorded across entire user lifetime |
{match_type} | Attribution method |
{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 |
{postal_code} | Device postal code of IP address |
{random_user_id} | Random user ID (per device) |
{random} | Random number (unique per callback) |
{reattribution_attribution_window} | Attribution window settings for reattribution (hours) |
{reftag} | Random device reference tag |
{reporting_cost} | Cost of the user engagement converted to your app's reporting currency and as reported in the Adjust Dashboard (available for ad spend tracking only) |
{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 |
{revenue} | Revenue, as sent from Adjust SDK in cents |
{session_count} | Number of sessions recorded by current Adjust SDK |
{time_spent} | Length of user's current session, in seconds |
{timezone} | Device time zone |
{tracking_enabled} | 1 if tracking is enabled, 0 if not |
{tracking_limited} | 1 if tracking is limited, 0 if not |
{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_dashboard} | Name of the app in the Adjust Dashboard |
{app_version_raw} | App version number (Android), build-version-number for the bundle (iOS) |
{app_version_short} | App version number (Android), release-version-number for the bundle (iOS) |
{app_version} | App version number (Android), build-version-number for the bundle (iOS) |
{attribution_updated_at} | Updated attribution timestamp |
{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 |
{created_at} | Activity timestamp |
{creative_name} | Creative name, as taken from the tracker |
{engagement_time} | Engagement timestamp |
{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 |
{last_session_time} | Last session timestamp |
{network_name} | Network name, as taken from the tracker |
{reattributed_at} | Reattribution timestamp |
{referral_time} | User landed on app Play Store page timestamp (Android and Google Play Store only) |
{reinstalled_at} | Reinstall timestamp |
{store} | Target store of click |
{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 |
{tracker_name} | Current tracker name |
{uninstalled_at} | Uninstall timestamp (estimation based on last session time) |
{google_ads_creative_id} | Google Ads creative ID |