Windows – API Reference


This page lists all public classes, enumerations and other resources available when using the Kochava Windows SDK and is intended to be used only as a developer quick reference guide. For examples and discussion surrounding SDK usage please refer to our Using the SDK support documentation.


Tracker

Class
Represents an instance of the Kochava Tracker.

Constructor
Creates a Tracker instance using a provided configuration object.
Usage:
Starting the Tracker
Custom Tracker Configuration

Constructor
Creates a Tracker instance using only the App ID and desired log level.
Usage:
Starting the Tracker
Custom Tracker Configuration

Method
Sends a custom event using an event name and event data. The event data value can also be either an empty string or serialized json.
Usage:
Tracking Events

Method
Sends a standard event using an EventParameters object.
Usage:
Tracking Events

Method
Sets an identity link using a string key and value pair. Can be called multiple times for multiple values.
Usage:
Identity Linking

Method
Sends a deeplink using an uri.
Usage:
Tracking Deeplinks

Method
Non-typical use. Useful when sending special instructions to the tracker.

Property: boolean
Gets or sets whether advertising identifier tracking should be limited.
Usage:
Enabling App Limit Ad Tracking

Property: boolean
Gets or sets the sleep state of the tracker.
Usage:
Sleeping The Tracker

Property: string
Gets the unique device id string set by Kochava.
Usage:
Getting the Device ID

Property: string
Gets the attribution results as a stringified dictionary.
Usage:
Retrieving Attribution

Property: string
Gets the current version of the SDK.
Example: WindowsWRT10 4.0.2
Usage: Getting the SDK Version

Static Event: LoggingEventHandler(string)
Subscribe to this static event with logging enabled to receive debugging output from the SDK.
Usage:
Enabling Logging

Method
For use only when Intelligent Consent Management is enabled. This helper method returns true if consent is either not required or has been granted for this user. This is typically checked before proceeding with consent-required logic. Recommended over individual checks as these two values should often be checked together.
Usage:
Checking Consent Status

Method
For use only when Intelligent Consent Management is enabled. Returns whether or not consent is required for this user (based on your regional consent settings in the Kochava dashboard).
Usage:
Other Functionality

Method
For use only when Intelligent Consent Management is enabled. Returns whether or not this user has currently granted consent.
Usage:
Other Functionality

Method
For use only when Intelligent Consent Management is enabled. Returns true if this user needs to be freshly prompted for consent. Immediately after displaying the prompt, an additional call to SetConsentPrompted() should always be made.
Usage:
Prompting For Consent
Checking Consent Status

Method
For use only when Intelligent Consent Management is enabled. Called when a consent dialogue prompt has been displayed to a user.
Usage:
Prompting For Consent
Checking Consent Status

Method
For use only when Intelligent Consent Management is enabled. Called when a user has explicitly granted (true) or declined (false) consent.
Usage:
Reporting Consent Results

Method
For use only when Intelligent Consent Management is enabled. Returns whether or not the Kochava SDK has made the first connection with Kochava servers to determine consent requirements for this user. Before this connection is made consent is always required by default.
Usage:
Other Functionality

Method
For use only when Intelligent Consent Management is enabled. Returns the current partner list under the “Partners” key within a stringified json object. If the first connection has not been made with Kochava servers the “Partners” key will not exist.
Usage:
Other Functionality


EventType

Enumeration
Passed to the EventParameters constructor when creating a standard event.

Usage:
Tracking Events

  • Achievement
  • AddToCart
  • AddToWishList
  • AdView
  • CheckoutStart
  • ConsentGranted
  • Custom
  • DeepLink
  • Gameplay
  • LevelComplete
  • Purchase
  • Rating
  • RegistrationComplete
  • Search
  • TutorialComplete
  • View


EventParameters

Class
Represents an instance of standard event parameters.

Usage:
Tracking Events

Constructor
Creates a standard event object to be populated and passed to the Tracker.SendEvent method.

Method
Sets a custom name for this event in place of the EventType.

Method
Sets a custom event parameter value in addition to any standard parameters set.

  • SetAdNetworkName(string)
  • SetAdMediationName(string)
  • SetAdDeviceType(string)
  • SetAdPlacement(string)
  • SetAdType(string)
  • SetAdCampaignID(string)
  • SetAdCampaignName(string)
  • SetAdSize(string)
  • SetAdGroupName(string)
  • SetAdGroupID(string)
  • SetCheckoutAsGuest(string)
  • SetContentId(string)
  • SetContentType(string)
  • SetCurrency(string)
  • SetDateString(string)
  • SetDate(DateTimeOffset)
  • SetEndDate(DateTimeOffset)
  • SetStartDate(DateTimeOffset)
  • SetDescription(string)
  • SetDestination(string)
  • SetDuration(double)
  • SetEndDateString(string)
  • SetItemAddedFrom(string)
  • SetLevel(string)
  • SetMaxRatingValue(double)
  • SetName(string)
  • SetOrderId(string)
  • SetOrigin(string)
  • SetPrice(double)
  • SetQuantity(string)
  • SetRatingValue(double)
  • SetReceiptId(string)
  • SetReferralFrom(string)
  • SetRegistrationMethod(string)
  • SetResults(string)
  • SetScore(string)
  • SetSearchTerm(string)
  • SetSource(string)
  • SetSpatialX(double)
  • SetSpatialY(double)
  • SetSpatialZ(double)
  • SetStartDateString(string)
  • SetSuccess(string)
  • SetUri(string)
  • SetUserId(string)
  • SetUserName(string)
  • SetValidated(string)


Config

Class
Represents an advanced tracker configuration beyond the default settings.

Usage:
For information about using this class, see: Custom Tracker Configuration

  • string AppGUID
  • LogLevel LogLevel
  • string PartnerName
  • string CustomUserAgent
  • bool AppLimitAdTracking
  • string Sleep
  • bool DevelopmentBuild
  • bool IntelligentConsentManagement

  • SetIdentityLink(string,string)
  • SetConsentUpdatedListener(ConsentUpdatedListener)
  • SetAttributionResultsListener(AttributionResultsListener)
  • SetCustomValue(string, object)


LogLevel

Enumeration
Used when providing a desired log level during tracker configuration.

Usage:
Enabling Logging

  • none
  • error
  • warn
  • info
  • debug
  • trace


Delegates

These delegates reside at the Kochava namespace level and are used for subscribing to various events from the Kochava SDK.

Delegate
This delegate is used to create your own attribution results event listener.
Usage:
Retrieving Attribution Results

Delegate
This delegate is used to create your own logging output event listener.
Usage:
Enabling Logging

 
 

Last Modified: Aug 7, 2019 at 3:31 pm