Support Home > SDK Integration > Adobe AIR – SDK Integration

Adobe AIR – SDK Integration


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.


Integrating the SDK

Requirements:

  • Android API 14
  • Xcode 9.2
  • Adobe AIR 28

 

Supported Platforms:

  • Android
  • iOS

Integration:

Estimated Time to Complete
5 Minutes

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 play-services-ads-identifier and all of its dependencies which at this time includes play-services-basement.

  1. Create a new Android or iOS project.
  2. Select File>Publish Settings.
  3. Select the wrench icon next to Script for ActionScript Settings.
  4. Select the Library Path tab.
  5. Click Browse for Native Extension (ANE) File and Select the com.kochava.extensions.Kochava.ane file.
  6. Click OK.
  7. Select the wrench icon next to Target for Player Settings.
  8. Select the Permissions tab>Enable:
    • INTERNET
    • ACCESS_NETWORK_STATE
    • ACCESS_WIFI_STATE
  9. Check Manually manage permissions and manifest additions for this app.
  10. Click OK.

  1. Go to Project Properties.
  2. Select Native Extensions under Actionscript Build Path.
  3. Choose Add ANE… and Navigate to the com.kochava.extensions.Kochava.ane file.
  4. Select the Native Extensions tab, and Click the Package checkbox next to the extension.

 

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 28.0 or higher in the app descriptor file.
  2. Include a link to the extension in the descriptor.
  3. Update your Android Manifest Additions in the XML element.

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.

 

Developer API Reference:

KochavaTracker.configure(MapObject)
Configuration Parameters

 

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:

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.

Default — None

This string should be set to your Kochava App GUID, which can be found in your Edit App page within the Kochava dashboard. This value is always required (unless a Partner Name is set).

Default — None

Provide an attribution event listener if you wish to be notified of attribution results from Kochava servers. This is not necessary unless you wish to parse the attribution results for use within the app.

For complete details and examples, see: Retrieving Attribution.

Default — LOG_LEVEL_ENUM_INFO_VALUE

Set this value to the desired Log Level to be used by the SDK for debugging purposes.

For complete details and examples, see: Enabling Logging.

Default — False

If you wish to limit ad tracking at the application level, with respect to Kochava conversions, set this value to true. It can also be toggled after starting the tracker.

For complete details and examples, see: App Limit Ad Tracking.

Default — None

This is a reserved setting and should not be set unless provided by your Client Success Manager.

Default — None

This is a reserved value and should not be set unless provided by your Client Success Manager.

Default — False
As GDPR compliance can present many challenges during development, Kochava offers a fully managed solution for all your GDPR consent requirements through the use of our Intelligent Consent Management feature. By using this feature the Kochava SDK will handle determining when consent is required for any user while shouldering much the GDPR burden for you.

NOTE: This is an advanced feature requiring additional setup within your Kochava dashboard and should not be enabled without a full and complete understanding of how to use the Intelligent Consent Management feature.

For complete details and examples, see: Intelligent Consent Management.


 
 

Last Modified: Dec 6, 2018 at 12:16 pm