SDK VERSION NOTE: This feature has been deprecated.

The Kochava AIR SDK is a lightweight plugin which can be easily integrated into your AIR project. The entire integration process takes less than five minutes and simply requires adding the SDK within your project and then starting the Kochava Tracker in code. If you have already integrated the SDK and started the tracker, please visit Using the SDK and choose a topic.

Integration Note: If targeting Android 13, collection of the ADID requires the normal permission:
<uses-permission android:name=”com.google.android.gms.permission.AD_ID”/>
Please ensure this permission is added to your AndroidManifest.xml in order for ADID collection to continue to take place as of Android 13 and beyond.
Some Google Play policies, such as the Families Policy, require that apps not use the ADID. In those cases this permission should not be included as the ADID should not be collected.

IMPORTANT NOTE: App Tracking Transparency (ATT) implementation is required for Free App Analytics. ONLY devices that have opted-in and have IDFA available will be measured and available in primary reporting and analytics.

Integrating the SDK

Requirements:

• Android API 14
• iOS Target 10.3
• Xcode 12
• Adobe AIR 32

Supported Platforms:

• Android
• iOS

Integration:

Estimated Time to Complete

5 Minutes

(Release Notes)

In order to use the Kochava SDK you must first add it to your project. When downloading the SDK they are two variants to choose from based on your project requirements.

GMS Variant —

This includes Google Mobile (Play) Services bundled for you and does not require you to manually add Google Mobile Services to be able to perform attribution based on the Android Advertising Identifier.

Standard Variant —

If you are already using Google Mobile Services in your app, you can use this variant instead which does not have Google Mobile Services bundled. When using this variant you must ensure you include the play-services-ads-identifier and the installreferrer libraries and all of their dependencies.

Update Application Descriptor —

For Kochava to work, changes are required to the application XML file for the app. Modify the XML file created by your IDE with the following changes:

1. Set your AIR SDK to 32.0 or higher in the app descriptor file.

<application xmlns="http://ns.adobe.com/air/application/32.0">

2. Include a link to the extension in the descriptor.

<extensions>
    <extensionID>com.kochava.extensions.KochavaTracker</extensionID>
</extensions>

3. Update your Android Manifest Additions in the XML element.

<android>
    <manifestAdditions><![CDATA[
        <manifest android:installLocation="auto">
            <uses-permission android:name="android.permission.INTERNET" />
            <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE"
            <uses-permission android:name="android.permission.ACCESS_WIFI_STATE" />
            <application>
                <meta-data android:name="com.google.android.gms.version" android:value="@integer/google_play_services_version" />
                <receiver android:name="com.kochava.base.ReferralReceiver" android:exported="true">
                    <intent-filter>
                        <action android:name="com.android.vending.INSTALL_REFERRER" />
                    </intent-filter>
                </receiver>
            </application>
        </manifest>
    ]]></manifestAdditions>
</android>

Update AIR SDK —

The AIR SDK is missing some functionality required by the iOS platform of the SDK and must be patched with a file from Xcode in order to work properly. More information can be found on the AIR issue tracker.

The file “libclang_rt.ios.a” needs to be copied from Xcode into the AIR SDK. The version of Xcode is in the path and must be adjusted to match your installed version.

Copy the file after adjusting the 12.0.0 to the version of Xcode you have installed.
/Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/lib/clang/12.0.0/lib/darwin/libclang_rt.ios.a
To
[AIRSDK_PATH]/lib/aot/lib/libclang_rt.ios.a

//Required: ADID collection as of API 31+
<uses-permission android:name="com.google.android.gms.permission.AD_ID"/>

Starting the Tracker

Estimated Time to Complete

1 Minute

Once you have added the Kochava SDK to your project, the next step is to configure and start the Kochava Tracker in code. Only your App GUID is required to start the tracker with the default settings, which is the case for typical integrations.

We recommend starting the tracker as soon as the application starts, although this can be done later if needed. Starting the tracker as early as possible will provide more accurate session reporting and help to ensure the tracker has been started before using it. Keep in mind the tracker can only be configured and started once per launch.

//Import
import com.kochava.nativeextensions.*;
import com.kochava.nativeextensions.events.*;

//Configure and Start
var configMapObject:Object = new Object();
configMapObject[KochavaTracker.PARAM_IOS_APP_GUID_STRING_KEY] = "_YOUR_IOS_APP_GUID_";
configMapObject[KochavaTracker.PARAM_ANDROID_APP_GUID_STRING_KEY] = "_YOUR_ANDROID_APP_GUID_";
KochavaTracker.configure(configMapObject);

Developer API Reference:

KochavaTracker.configure(MapObject)
Configuration Parameters

Confirm the Integration

SDK WAYPOINT: At this point basic integration is complete and the Kochava SDK will begin reporting session activity and attributing installs.

Where to Go From Here:

Now that you have completed integration you are ready to utilize the many features offered by the Kochava SDK. Continue on to Using the SDK and choose a topic.

Custom Tracker Configuration

If you would like to make adjustments to the tracker configuration beyond the default settings, set your App GUID and the desired parameters and then pass it to the tracker’s configure method.

Using a Custom Configuration:

var configMapObject:Object = new Object();
configMapObject[KochavaTracker.PARAM_IOS_APP_GUID_STRING_KEY] = "_YOUR_IOS_APP_GUID_";
configMapObject[KochavaTracker.PARAM_ANDROID_APP_GUID_STRING_KEY] = "_YOUR_ANDROID_APP_GUID_";
configMapObject[KochavaTracker.PARAM_LOG_LEVEL_ENUM_KEY] = KochavaTracker.LOG_LEVEL_ENUM_TRACE_VALUE;
KochavaTracker.configure(configMapObject);

NOTE: Setting values within a configuration object will have no effect after the tracker has been started.

Below is a list of all configuration options and their default settings. Keep in mind that in a typical integration these configuration settings should not be adjusted from their default values.

configMapObject[KochavaTracker.PARAM_ANDROID_APP_GUID_STRING_KEY] = "_YOUR_ANDROID_APP_GUID";
configMapObject[KochavaTracker.PARAM_IOS_APP_GUID_STRING_KEY] = "_YOUR_IOS_APP_GUID";