KochavaTracker
Class
Represents an instance of the Kochava Tracker.
Method
Starts the tracker with the provided configuration object.
Method
Sends an event using an event name and event data.
Usage:
Tracking Events
Method
Sends an event using an event name and an event map object.
Usage:
Tracking Events
Method
Sends an event using an event name, event map object, and Apple Store receipt.
Usage:
Tracking Events
Method
Sends an event using an event name, event map object, and a Google Play receipt.
Method
Sends an event containing a deeplink uri and source app.
Usage:
Deeplinking
Method
Sets whether advertising identifier tracking should be limited.
Method
Sets an Identity Link object containing string key value pairs.
Usage:
Identity Linking
Method
Retrieves the attribution results as stringified JSON or an empty string if not available.
Usage:
Retrieving Attribution
Method
Retrieves the unique device id string set by Kochava or an empty string if the Tracker is not started.
Method
Returns the Tracker version.
Example:
AndroidTracker 3.4.0 (AIR 2.3.0)
Usage:
Getting the SDK Version
Method
Adds a new push notification token.
Usage:
Push Engagement
Method
Removes an existing push notification token.
Usage:
Push Engagement
Method
Sets the sleep state of the tracker.
Usage:
Sleeping the Tracker
Method
Retrieves the sleep state of the tracker.
Usage:
Sleeping the Tracker
Method
For use only when Intelligent Consent Management is enabled. Called when a user has explicitly granted (true) or declined (false) consent.
Usage:
Intelligent Consent Management – Reporting Consent Results
Method
For use only when both Intelligent Consent Management and Manual Managed Consent Requirements are enabled. Sets whether or not consent is required for this user.
Method
For use only when Intelligent Consent Management is enabled. Called when a consent dialog prompt has been displayed to a user.
Usage:
Intelligent Consent Management – Prompting For Consent
Intelligent Consent Management – Checking Consent Status
Method
For use only when Intelligent Consent Management is enabled. Retrieves the current consent status including required, granted, response time, should prompt, requirements_known, and the partner list as serialized JSON.
Usage:
Intelligent Consent Management – Checking Consent Status
Method
Sets an event listener for the consent status change callback. Set to null to remove an existing listener.
Method
Sets an event listener for the attribution callback. Set to null to remove an existing listener. Retrieve the attribution string as serialized JSON from the event.level parameter.
Usage:
Retrieving Attribution
Method
For use with Enhanced Deeplinking to process a launch deeplink and get a resulting deeplink destination.
Usage:
Enhanced Deeplinking
Method
For use with Enhanced Deeplinking to process a launch deeplink and get a resulting deeplink destination.
Usage:
Enhanced Deeplinking
Deeplink
Represents a deeplink destination.
Usage:
Enhanced Deeplinking
- String destination
- Object raw
Custom Parameters
Represents tracker configuration keys.
Usage:
Starting the Tracker
Custom Tracker Configuration
- KochavaTracker.PARAM_ANDROID_APP_GUID_STRING_KEY
- KochavaTracker.PARAM_IOS_APP_GUID_STRING_KEY
- KochavaTracker.PARAM_PARTNER_NAME_STRING_KEY
- KochavaTracker.PARAM_APP_LIMIT_AD_TRACKING_BOOL_KEY
- KochavaTracker.PARAM_IDENTITY_LINK_MAP_OBJECT_KEY
- KochavaTracker.PARAM_LOG_LEVEL_ENUM_KEY
- KochavaTracker.PARAM_RETRIEVE_ATTRIBUTION_BOOL_KEY
- KochavaTracker.PARAM_INTELLIGENT_CONSENT_MANAGEMENT_BOOL_KEY
- KochavaTracker.PARAM_MANUAL_MANAGED_CONSENT_REQUIREMENTS_BOOL_KEY
- KochavaTracker.PARAM_SLEEP_BOOL_KEY
Log Levels
Used when providing a desired log level during tracker configuration.
Usage:
Enabling Logging
- KochavaTracker.LOG_LEVEL_ENUM_NONE_VALUE
- KochavaTracker.LOG_LEVEL_ENUM_ERROR_VALUE
- KochavaTracker.LOG_LEVEL_ENUM_WARN_VALUE
- KochavaTracker.LOG_LEVEL_ENUM_INFO_VALUE
- KochavaTracker.LOG_LEVEL_ENUM_DEBUG_VALUE
- KochavaTracker.LOG_LEVEL_ENUM_TRACE_VALUE
Consent Status
For use only when Intelligent Consent Management is enabled. Keys for consent status including required, granted, response time, should prompt and the partner list.
Usage:
Intelligent Consent Management – Checking Consent Status
- KochavaTracker.CONSENT_STATUS_DESCRIPTION_STRING_KEY
- KochavaTracker.CONSENT_STATUS_REQUIRED_BOOL_KEY
- KochavaTracker.CONSENT_STATUS_GRANTED_BOOL_KEY
- KochavaTracker.CONSENT_STATUS_SHOULD_PROMPT_BOOL_KEY
- KochavaTracker.CONSENT_STATUS_RESPONSE_TIME_LONG_KEY
- KochavaTracker.CONSENT_STATUS_PARTNERS_KEY
- KochavaTracker.CONSENT_STATUS_PARTNER_NAME_STRING_KEY
- KochavaTracker.CONSENT_STATUS_REQUIREMENTS_KNOWN_BOOL_KEY
Standard Event Types
Event names when creating a Standard Event.
Usage:
Tracking Events
Purchases and Subscriptions
- KochavaTracker.EVENT_TYPE_ACHIEVEMENT_STRING_KEY
- KochavaTracker.EVENT_TYPE_ADD_TO_CART_STRING_KEY
- KochavaTracker.EVENT_TYPE_ADD_TO_WISH_LIST_STRING_KEY
- KochavaTracker.EVENT_TYPE_CHECKOUT_START_STRING_KEY
- KochavaTracker.EVENT_TYPE_LEVEL_COMPLETE_STRING_KEY
- KochavaTracker.EVENT_TYPE_PURCHASE_STRING_KEY
- KochavaTracker.EVENT_TYPE_RATING_STRING_KEY
- KochavaTracker.EVENT_TYPE_REGISTRATION_COMPLETE_STRING_KEY
- KochavaTracker.EVENT_TYPE_SEARCH_STRING_KEY
- KochavaTracker.EVENT_TYPE_TUTORIAL_COMPLETE_STRING_KEY
- KochavaTracker.EVENT_TYPE_VIEW_STRING_KEY
- KochavaTracker.EVENT_TYPE_AD_VIEW_STRING_KEY
- KochavaTracker.EVENT_TYPE_PUSH_RECEIVED_STRING_KEY
- KochavaTracker.EVENT_TYPE_PUSH_OPENED_STRING_KEY
- KochavaTracker.EVENT_TYPE_CONSENT_GRANTED_STRING_KEY
- KochavaTracker.EVENT_TYPE_DEEP_LINK_STRING_KEY
- KochavaTracker.EVENT_TYPE_AD_CLICK_STRING_KEY
- KochavaTracker.EVENT_TYPE_START_TRIAL_STRING_KEY
- KochavaTracker.EVENT_TYPE_SUBSCRIBE_STRING_KEY
KochavaTrackerStatusEvent
Class
Event object returned by the Attribution and Consent Status Change listeners.
Usage:
Retrieving Attribution
Intelligent Consent Management
Property
Contains the data returned by the given event.
Usage:
Retrieving Attribution
