kochava.*

Type Library
Revision Release 2024.3703
Keywords analytics, attribution, Kochava
Platforms Android, iOS

Overview

The Kochava plugin allows you to integrate the Kochava SDK for leveraging hundreds of ad network and publisher partners. This limits the number of third-party SDKs required to run a successful UA strategy while greatly reducing complexity during update cycles.

Important

Check out new init parameters hasUserConsent and intelligentConsentManagement, also setHasUserConsent method and new event type consent to enable GDPR data collection restrictions.

Intelligent Consent Management is an opt-in feature and must be enabled both in the app and on the Edit App page of the Kochava Dashboard in order to function for this new functional to work.

Registration

Before using this plugin, you’ll need to register with Kochava to receive an app ID.

Syntax

local kochava = require( "plugin.kochava" )

Functions

kochava.init()

kochava.logEvent()

kochava.logDeeplinkEvent()

kochava.getAttributionData()

kochava.limitAdTracking()

kochava.getVersion()

kochava.setHasUserConsent()

Events

analyticsRequest

Project Settings

To use this plugin, add the following entry into the plugins table of build.settings. When added, the build server will integrate the plugin during the build phase.

settings =
{
    plugins =
    {
        ["plugin.kochava"] =
        {
            publisherId = "com.coronalabs"
        },
    },
}
Important

For iOS, when submitting your app to the App Store, follow these guidelines:

  • Make sure you select yes when asked if your app uses the Advertising Identifier (IDFA).
  • Ensure that the Attribute this app installation to previously served advertisement box is checked.
Note

For Android, the following permissions/features are automatically added when using this plugin:

  • "android.permission.INTERNET"
  • "android.permission.ACCESS_NETWORK_STATE"
  • "android.permission.ACCESS_WIFI_STATE"

Support