Support Home > Server-to-Server Integration > Install Notification Setup

Install Notification Setup

This feature is available only with paid Kochava accounts. Contact us to learn more.


Feature Summary: This document describes the recommended approach to integrate with the Kochava system to track installs resulting from the marketer’s apps user server to server APIs. Using this method helps to minimize the level of effort to integrate APIs and SDKs with your application when you want to track installs for your apps and can make for a more seamless integration.

 

BEST PRACTICES: If strict authentication rules are being utilized, ensure that the procedures and policies within the Kochava Install Authentication Integration support documentation have been followed.


Kochava SDK is Not Required

Because the Kochava system does not require an SDK, you can begin sending your data to Kochava without any client side updates. Please contact your Kochava Account Management Team for information on how to get your app provisioned for tracking.


About the Kochava System

Kochava provides an open integration layer to connect with major publishers and networks so you can maximize visibility into your promotional efforts. In addition, the Kochava system provides post-back support to 3rd party networks (where applicable) so you don’t have to add additional SDK’s into your app.


Install Tracking

To track the conversions of your media efforts, Kochava must receive a single API “ping” from your servers which correspond to a unique install or startup of your application. It’s important that the API call is made at a point where the user is launching the app for the first time to maximize visibility into conversions for your campaigns. If you are interested in tracking specific post-install actions, please use the post-install event notification system to track those events post-installation.

 

NOTE: Because Kochava works across various publishers; we support all possible identifiers for devices for the purpose of reconciliation. Please note the identifier for the devices in the server-to-server API calls using the device_id_type parameter. The default for Android will be ADID and the default for iOS will be IDFA.

NOTE: With the introduction of iOS6, Apple has provided two new identifiers for advertisers and advertising publishers. To maximize reconciliation approaches, please send both IDFA and IDFV in the server-to-server call.

 

  • Identifier for Advertiser: This is a common ID across all advertisers for a given app.
  • Identifier for Vendor: This is a common ID across all apps for a given vendor.

 

iOS14+ Install Tracking:

With iOS14 Apple introduced the App Tracking Transparency framework, requiring that all apps prompt their users for consent to be tracked. If consent is not granted, the IDFA will not available. Kochava will respect the ATT framework by collecting the end users app_tracking_transparency response and timestamp of the response with our native iOS14 SDK.

Server to Server clients will need to include the below key-value pairs on all install payloads for any installs coming from OS version iOS14 or higher.

 

WARNING: If the app_tracking_transparency flag is not sent on installs for these users, Kochava will assume that consent was not granted, and we will drop the IDFA server side.


Install Event API

To send a usage event from your application, call the below server-to-server endpoint with a POST payload containing the following JSON elements.

http://control.kochava.com/track/json

 

WARNING: Advertisers using a Server-to-Server integration should format payloads so that Kochava can parse the OS version, either by sending the full User Agent string or sending the device_ver in accordance with our support documentation.

 

 

JSON Property Description Req. iOS 14+ Only
kochava_app_id This is the unique application ID used to represent the App. Yes
app_version A string representation of the application version number. No
kochava_device_id kochava_device_id should be sent as a unique string that is consistent for each instance of the app on a single device. This will allow Kochava to associate data correctly when a device_id is not available. In the case that there will always be a device_id present and installs will always be sent before post-install events, kochava_device_id can be sent as null. Yes
device_ids This is where the relevant mobile advertising IDs will be included, most commonly IDFA, IDFV, ADID and Android ID. A custom variant may also be used, but we highly recommend working with your Kocahava CSM to leverage this capability. You must submit at least one identifier within the device_id object, and may submit more than one. Yes
action Action associated to the API event. Yes
origination_ip The IP address of the device on install. Yes
device_ua A string representation of the device user agent as provided by the client. This string is useful when campaigns require fingerprint attribution Yes
data Each event is a JSON object – see examples. Yes
att Boolean indicating if iOS App Tracking Transparency was accepted or not. Yes
att_time The authorization time for iOS App Tracking Transparency. No
att_duration The amount of time in seconds it took the user to respond to the ATT prompt. No
att_detail The current ATTrackingManager.AuthorizationStatus . No

 

Sample Install Event Calls:

 

iOS14+ Sample Install Event Calls:


Apple Search Install Event API

Sending information to the Kochava system is also possible when utilizing Apple Search Ads by adding additional information to the main payload. If not using Apple Search Ads, the below information may be disregarded.

http://control.kochava.com/track/json

 

Sample Event Calls:


Device Specific Instructions

The information below details how to send data from specific devices to Kochava through the server-to-server integration.
 

Device Sending a Usage Event Details
Roku Send GetDeviceUniqueId() as String within the UDID parameter of the S2S feed.

Server-to-Server without Device UA

In scenarios where the device user agent is not able to be included on the install and event payloads, the device version can be sent instead, which will enable Kochava to manufacture a device user agent and perform fingerprint (IP + UA) attribution.

For more information Server-to-Server without Device UA, refer to our support documentation.

 
 

Last Modified: Oct 20, 2020 at 5:08 pm