Support Home > SDK Integration > SDK – KochavaTracker > KochavaTracker – Methods

KochavaTracker – Methods

KochavaTracker (Adobe Air)

Methods

All methods are a wrapper over the native iOS and Android SDK’s. The reference documentation for those platforms is available for more details.

 

iOS Reference: https://support.kochava.com/sdk-integration/sdk-kochavatracker-ios

Android Reference: https://support.kochava.com/sdk-integration/sdk-kochavatracker-android


configure(configMapObject)

The KochavaTracker must be configured before it can be used. Call this method to perform the configuration.

 

Config Parameters:

PARAM_ANDROID_APP_GUID_STRING_KEY –

App Guid used on the Android platform. Required if building for Android.

 

PARAM_IOS_APP_GUID_STRING_KEY –

App Guid used on the iOS platform. Required if building for iOS.

 

PARAM_APP_LIMIT_AD_TRACKING_BOOL_KEY –

Sets if app level advertising tracking should be limited. This is unrelated to the operating system limit ad tracking flag that is already accounted for by the SDK.

 

PARAM_IDENTITY_LINK_MAP_OBJECT_KEY –

Sets a user identity link that is used for linking based off of external criteria such as a username.

 

PARAM_LOG_LEVEL_ENUM_KEY –

Sets the log level for the Tracker from one of the following.

  • LOG_LEVEL_ENUM_NONE_VALUE
  • LOG_LEVEL_ENUM_ERROR_VALUE
  • LOG_LEVEL_ENUM_WARN_VALUE
  • LOG_LEVEL_ENUM_INFO_VALUE (Default)
  • LOG_LEVEL_ENUM_DEBUG_VALUE
  • LOG_LEVEL_ENUM_TRACE_VALUE

 

PARAM_RETRIEVE_ATTRIBUTION_BOOL_KEY –

Attribution information is assessed and stored within Kochava’s Servers, where it is reported back to you through your Kochava account. You may also retrieve this information from within your app by setting the retrieve attribution boolean to true.

 

PARAM_INTELLIGENT_CONSENT_MANAGEMENT_BOOL_KEY –

Enables Kochava Intelligent Consent Management. This must be enabled both here and on the Kochava Dashboard in order to function. See Intelligent Consent Management for more information on how to use Intelligent Consent Management.

Refer to our Intelligent Consent Management support documentation for more information on use.


Attribution Event Listener:

Attribution information is accessed and stored within Kochava’s Servers, where it is reported back to you through your Kochava account. You may also retrieve this information from within your app. Note that this should only be done if your app makes use of this information, otherwise it causes needless network communication.
To retrieve attribution information in app you must pass the PARAM_RETRIEVE_ATTRIBUTION_BOOL_KEY parameter with a value of true during configuration and add the event listener as follows after configuring the KochavaTracker.


Consent Status Change Event Listener:

To retrieve consent status change events you must first have enabled Intelligent Consent Management during configuration. To ensure no changes are missed this should be set immediately following configuration.

This is called any time the SDK detects the consent status has changed. This includes when consent requirements are first determined, if required status changes, if a partner is added, if prompt ID invalidation occurs, or if the prompt retry interval expires.

This may be called multiple times while the app is running if a change has been observed. These typically occur, but are not limited to, during an app launch or on the app coming to the foreground.


sendEventString(nameString, infoString)

Sends an event with a name and info string.


sendEventMapObject(nameString, infoMapObject)

Sends an event with a name and info map object. Kochava has a list of standard event names and parameters that can be used for consistent reporting. Kochava Standard Event List. You may also use any custom event name or parameters as desired.


sendEventAppleAppStoreReceipt(nameString, mapObject, appStoreReceiptBase64EncodedString)

Sends an apple app store receipt. Additional data may be sent using a map object.


sendEventGooglePlayReceipt(nameString, mapObject, receiptData, receiptDataSignature)

Sends a google play store receipt. Additional data may be sent using a map object.


sendDeepLink(openURLString, sourceApplicationString)

Sends a deep link event to Kochava, along with the associated opening URL and source application string. The second parameter is omitted on Android.


setAppLimitAdTracking(appLimitAdTrackingBool)

Sets a boolean switch which indicates whether a user of the app wants to limit advertising tracking.


setIdentityLink(mapObject)

Sends identity information to Kochava, where it can be integrated into your Analytics.


String getAttribution()

Gets the attribution map object that has already been retrieved by the tracker from the Kochava Server.


String getDeviceId()

Gets the device identification string used by the tracker.


String getVersion()

Gets the KochavaTracker version. This is a combination of the Native SDK and the wrapper version.


addPushToken(tokenString)

Adds a push token.


removePushToken(tokenString)

Removes a push token.


setConsentGranted(grantedBool)

Sets the user’s response to the consent prompt. If they dismiss the dialog or otherwise do not answer then do not call this method.


setConsentPrompted()

Indicates that the user was prompted for consent.


getConsentStatus(callback)

Gets the consent status.

 
 

Last Modified: Jul 9, 2018 at 8:20 am