Xamarin - Using the SDK - FreeAppAnalytics Support

Confirming the SDK Integration:

Ensure the SDK has been properly integrated.

Collapse

Tracking Events:

Track user behavior and actions beyond the install.

Standard Events:

Example (Standard Event with Standard Parameters) —

1

2

3

4

var myEvent = new Kochava.Tracker.Event(Kochava.Tracker.EventType.Purchase);

myEvent.Name = "Gold Token";

myEvent.Price = 0.99;

Kochava.Tracker.Client.SendEvent(myEvent);

Example (Standard Event with Standard and Custom Parameters) —

1

2

3

4

5

var myEvent = new Kochava.Tracker.Event(Kochava.Tracker.EventType.LevelComplete);

myEvent.Name = "The Deep Dark Forest";

myEvent.SetCustomValue("attempts", 3);

myEvent.SetCustomValue("score", 12000);

Kochava.Tracker.Client.SendEvent(myEvent);

If you wish to use a custom event type with standard parameters, use a custom event name string within your event constructor in place of a standard event type.

For a detailed list of standard event types and parameters, see: Post Install Event Examples

Custom Events:

Example (Custom Event with Custom Parameters) —

1

2

3

4

5

var myEvent = new Kochava.Tracker.Event("Enemy Defeated");

myEvent.Name = "The Deep Dark Forest";

myEvent.SetCustomValue("enemy", "The Angry Ogre");

myEvent.SetCustomValue("reward", "Gold Token");

Kochava.Tracker.Client.SendEvent(myEvent);

Example (Send a Custom Event with Only a Name, no Event Data) —

1	Kochava.Tracker.Client.SendEventString("Player Defeated", "");

Example (Send a Custom Event with Event Data) —

1	Kochava.Tracker.Client.SendEventString("Player Defeated", "Angry Ogre");

Example (Send a Custom Event with Serialized JSON Data) —

1	Kochava.Tracker.Client.SendEventString("Player Defeated", "{\"enemy\":\"Angry Ogre\"}");

Collapse

1

2

3

4

5

var myEvent = new Kochava.Tracker.Event(Kochava.Tracker.EventType.Purchase);

myEvent.Name = "Loot Box";

myEvent.Price = 4.99;

myEvent.SetReceiptFromGooglePlayStore(receiptData, receiptSignature);

Kochava.Tracker.Client.SendEvent(myEvent);

1

2

3

4

5

var myEvent = new Kochava.Tracker.Event(Kochava.Tracker.EventType.Purchase);

myEvent.Name = "Loot Box";

myEvent.Price = 4.99;

myEvent.SetReceiptFromAppleAppStore(appStoreReceiptBase64EncodedString);

Kochava.Tracker.Client.SendEvent(myEvent);

Example (Custom Purchase Event with Serialized JSON Data):

1	Kochava.Tracker.Client.SendEventString("Purchase", "{\"price\":4.99,\"name\":\"Loot Box\"}");

Example (Custom Subscription Purchase Event with Serialized JSON Data) —

1	Kochava.Tracker.Client.SendEventString("Purchase", "{\"price\":9.99,\"name\":\"Monthly Subscription\"}");

Collapse

Tracking Subscriptions and Trials:

Track user subscriptions and free trials.

In order to effectively track user subscriptions and free trials, an event should be instrumented at the time of the subscription purchase or start of the free trial along with an accompanying identity link.

When a subscription or free trial begins, first set an identity link for this subscriber and then instrument a standard Subscription or Trial event populated with the following values:

Price
Currency
Product Name
User or Subscriber ID (hash suggested)
Receipt (if available)

BEST PRACTICES: Always set the identity link before sending the event, otherwise the identity link will not be properly associated with the event.

Example (Identity Link with Subscription):

1

2

3

4

5

6

7

8

9

10

11

12

13

14

// first set an identity link for this user

IDictionary<string, string> identityLink = new Dictionary<string, string>();

identityLink.Add("Subscriber ID", "ABCDEF123456789");

Kochava.Tracker.Client.SetIdentityLink(identityLink);

// next, instrument the subscription event

var myEvent = new Kochava.Tracker.Event(Kochava.Tracker.EventType.Subscribe);

myEvent.Price = 9.99;

myEvent.Currency = "usd";

myEvent.Name = "Monthly Subscription";

myEvent.UserId = "ABCDEF123456789";

myEvent.SetReceiptFromGooglePlayStore(receiptData, receiptSignature); // Android Only

myEvent.SetReceiptFromAppleAppStore(appStoreReceiptBase64EncodedString); // iOS Only

Kochava.Tracker.Client.SendEvent(myEvent);

A free trial is handled in a similar way, although the price should be set to 0 and the event type should indicate Trial rather than Subscription. The product name should remain the same, as the event type indicates whether this was free trial or subscription.

Example (Identity Link with Free Trial):

1

2

3

4

5

6

7

8

9

10

11

12

13

14

// first set an identity link for this user

IDictionary<string, string> identityLink = new Dictionary<string, string>();

identityLink.Add("Subscriber ID", "ABCDEF123456789");

Kochava.Tracker.Client.SetIdentityLink(identityLink);

// next, instrument the trial event

var myEvent = new Kochava.Tracker.Event(Kochava.Tracker.EventType.StartTrial);

myEvent.Price = 0.0;

myEvent.Currency = "usd";

myEvent.Name = "Monthly Subscription";

myEvent.UserId = "ABCDEF123456789";

myEvent.SetReceiptFromGooglePlayStore(receiptData, receiptSignature); // Android Only

myEvent.SetReceiptFromAppleAppStore(appStoreReceiptBase64EncodedString); // iOS Only

Kochava.Tracker.Client.SendEvent(myEvent);

Collapse

Deeplinking:

Track deeplink related actions and user activity.

Example (Standard Deeplink Event):

1

2

3

4

var myEvent = new Kochava.Tracker.Event(Kochava.Tracker.EventType.Deeplink);

myEvent.Uri = "some_deeplink_uri";

myEvent.Source = "some_source_app";

Kochava.Tracker.Client.SendEvent(myEvent);

Example (Custom Deeplink Event with Serialized JSON Data):

1	Kochava.Tracker.Client.SendEventString("_Deeplink", "{\"uri\":\"some_deeplink_uri\"}");

Collapse

Enhanced Deeplinking:

Universal click deeplinking and re-engagement attribution.

Example (Acquire the Deeplink) —

Android
iOS

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

// Deeplink routing should be performed in a dedicated routing activity that launches the destination activity.

protected override void OnStart()

{

base.OnStart();

// acquire a deeplink whenever one is available and pass it to the SDK with a desired timeout.

string deeplink = Intent?.DataString;

if(!string.IsNullOrEmpty(deeplink))

{

// a standard deeplink exists, so we'll pass it to the SDK to be processed

Kochava.Tracker.Client.ProcessDeeplink(deeplink, 10, DeeplinkProcessed);

}

else

{

// no deeplink exists, so we'll pass an empty string to retrieve any deferred deeplink with a longer timeout

Kochava.Tracker.Client.ProcessDeeplink("", 15, DeeplinkProcessed);

}

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

// Deeplink routing is done in the AppDelegate class by overriding the appropriate functions.

public override bool ContinueUserActivity(UIApplication application, NSUserActivity userActivity, UIApplicationRestorationHandler completionHandler)

{

var url = userActivity.WebPageUrl;

Kochava.Tracker.Client.ProcessDeeplink(url.AbsoluteString, DeeplinkProcessed);

return base.ContinueUserActivity(application, userActivity, completionHandler);

}

public override bool OpenUrl(UIApplication application, NSUrl url, string sourceApplication, NSObject annotation)

{

Kochava.Tracker.Client.ProcessDeeplink(url.AbsoluteString, DeeplinkProcessed);

return OpenUrl(application, url, sourceApplication, annotation);

}

Example (Wait for the Callback) —

1

2

3

4

5

6

7

8

9

10

public void DeeplinkProcessed(Kochava.Tracker.Deeplink deeplink)

{

if(!string.IsNullOrEmpty(deeplink.Destination))

{

// deeplink exists, parse the destination as you see fit and route the user

} else

{

// no deeplink to act upon, route to a default destination or take no action

}

Collapse

Identity Linking:

Link existing user identities with kochava devices.

Example (Set an Identity Link During Tracker Configuration):

1

2

3

4

5

6

7

8

9

10

IDictionary<string, string> identityLink = new Dictionary<string, string>();

identityLink.Add("User ID", "123456789");

identityLink.Add("Login", "username");

Kochava.Tracker.Configuration config = new Kochava.Tracker.Configuration();

config.AndroidAppGuid = "_YOUR_ANDROID_APP_GUID_";

config.IosAppGuid = "_YOUR_IOS_APP_GUID_";

config.LogLevel = Kochava.Tracker.LogLevel.Trace;

config.IdentityLink = identityLink;

Kochava.Tracker.Client.Configure(config);

Example (Set an Identity Link After Starting the Tracker):

1

2

3

4

IDictionary<string, string> identityLink = new Dictionary<string, string>();

identityLink.Add("User ID", "123456789");

identityLink.Add("Login", "username");

Kochava.Tracker.Client.SetIdentityLink(identityLink);

Collapse

Retrieving Attribution:

Access the attribution results within the app.

Example (Requesting Attribution Results):

1

2

3

4

5

6

7

8

9

10

Kochava.Tracker.Configuration config = new Kochava.Tracker.Configuration();

config.AndroidAppGuid = "_YOUR_ANDROID_APP_GUID_";

config.IosAppGuid = "_YOUR_IOS_APP_GUID_";

config.RetrieveAttribution = true;

Kochava.Tracker.Client.Configure(config);

Kochava.Tracker.Client.SetAttributionListener((string attribution) =>

{

// Parse json serialized attribution info.

});

Example (Using the Getter After Attribution Results Have Been Retrieved):

1 2	string attribution = Kochava.Tracker.Client.GetAttribution(); // Parse json serialized attribution info.

The attribution results are provided as a stringified JSON object and can be parsed using a JSONObject or other JSON parsing functionality. If the attribution results have not yet been retrieved, calling the attribution data getter will return an empty string.

Collapse

Getting The Kochava Device ID:

Obtain the unique device identifier assigned by Kochava.

Example (Getting the Kochava Device ID):

1	string kochavaDeviceId = Kochava.Tracker.Client.GetDeviceId();

Collapse

Getting the SDK Version:

Obtain the current version of the SDK.

Estimated Time to Complete

1 Minute

If at any time you’d like to get the current version of the SDK, call the SDK Version string getter. This will return the full string value of the SDK version, such as “AndroidTracker 3.4.2”.

Example (Getting the SDK Version String)

1	string sdkVersion = Kochava.Tracker.Client.GetVersion();

Collapse

Enabling App Limit Ad Tracking:

Limit the ad tracking at the application level.

Example (Enabling App Limit Ad Tracking During Tracker Configuration):

1

2

3

4

5

Kochava.Tracker.Configuration config = new Kochava.Tracker.Configuration();

config.AndroidAppGuid = "_YOUR_ANDROID_APP_GUID_";

config.IosAppGuid = "_YOUR_IOS_APP_GUID_";

config.AppLimitAdTracking = true;

Kochava.Tracker.Client.Configure(config);

Example (Enable App Limit Ad Tracking After Starting the Tracker):

1	Kochava.Tracker.Client.SetAppLimitAdTracking(true);

Collapse

Enabling Logging:

Enable logging output from the SDK.

To enable logging, set the desired log level during tracker configuration. When the tracker runs, each log message will be printed to your console log. In this example we’re setting a higher log level only when a debug build is detected, which is suggested but is not required.

Example (Enabling trace logging in a non-production build):

1

2

3

4

5

6

7

8

9

10

11

Kochava.Tracker.Configuration config = new Kochava.Tracker.Configuration();

config.AndroidAppGuid = "_YOUR_ANDROID_APP_GUID_";

config.IosAppGuid = "_YOUR_IOS_APP_GUID_";

if(DEBUG)

{

config.LogLevel = Kochava.Tracker.LogLevel.Trace;

} else

{

config.LogLevel = Kochava.Tracker.LogLevel.Info;

}

Kochava.Tracker.Client.Configure(config);

Collapse

Sleeping the Tracker:

Delay the start of the tracker.

Example (Enabling Sleep Mode During Tracker Configuration):

1

2

3

4

5

Kochava.Tracker.Configuration config = new Kochava.Tracker.Configuration();

config.AndroidAppGuid = "_YOUR_ANDROID_APP_GUID_";

config.IosAppGuid = "_YOUR_IOS_APP_GUID_";

config.Sleep = true;

Kochava.Tracker.Client.Configure(config);

Example (Enabling Sleep Mode After Starting the Tracker):

1	Kochava.Tracker.Client.SetSleep(true);

Example (Waking the Tracker from Sleep Mode) —

1	Kochava.Tracker.Client.SetSleep(false);

Collapse

Consent — GDPR:

Handle GDPR and consent requirements.

Intelligent Consent Manager:

As GDPR can present many challenges during development, Free App Analytics offers a fully managed solution for all your GDPR consent requirements through the use of our Intelligent Consent Manager 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. For more information on this feature, see: Intelligent Consent Manager.

Self Managed Consent:

Example (Starting the Tracker Only When Consent Allows) —

1

2

3

4

5

6

7

8

if (!consentRequired || consentGranted)

{

// we will not initialize Kochava unless consent requirements are met.

Kochava.Tracker.Configuration config = new Kochava.Tracker.Configuration();

config.AndroidAppGuid = "_YOUR_ANDROID_APP_GUID_";

config.IosAppGuid = "_YOUR_IOS_APP_GUID_";

Kochava.Tracker.Client.Configure(config);

}

Example (Calling Tracker Methods Only When Consent Allows) —

1

2

3

4

5

if(!consentRequired || consentGranted)

{

// we will not call Kochava methods unless consent requirements are met.

Kochava.Tracker.Client.SendEventString("My Event", "");

}

Collapse

Consent — CCPA:

Handle CCPA and consent requirements.

Collapse

Intelligent Consent Manager:

Free App Analytics’ fully managed consent solution.

Estimated Time to Complete

1 Day

As GDPR can present many challenges during development, Free App Analytics offers a fully managed solution for all your GDPR consent requirements through the use of our Intelligent Consent Manager 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. For complete details on how this feature works, see: Intelligent Consent Manager.

Collapse

Setting Up a Test Environment:

Create a test environment to ensure the integration is working properly.

Use an alternate testing App GUID so that your testing activities do not have an impact on your live app analytics.
Enable Logging, if helpful, to gain insight into the SDK’s behavior during runtime.
If you would like the SDK to behave as it would during a new install, be sure to un-install the app before each test.
Test your Free App Analytics integration. For more information see: Testing the Integration.

1

2

3

4

5

6

7

8

9

10

11

12

13

14

Kochava.Tracker.Configuration config = new Kochava.Tracker.Configuration();

if (DEBUG)

{

config.LogLevel = Kochava.Tracker.LogLevel.Trace;

config.AndroidAppGuid = "_YOUR_TEST_ANDROID_APP_GUID_";

config.IosAppGuid = "_YOUR_TEST_IOS_APP_GUID_";

}

else

{

config.LogLevel = Kochava.Tracker.LogLevel.Info;

config.AndroidAppGuid = "_YOUR_PRODUCTION_ANDROID_APP_GUID_";

config.IosAppGuid = "_YOUR_PRODUCTION_IOS_APP_GUID_";

}

Kochava.Tracker.Client.Configure(config);

Analyzing SDK Behavior:

Collapse

Xamarin – Using the SDK

Standard Events:

Example (Standard Event with Standard Parameters) —

Example (Standard Event with Standard and Custom Parameters) —

Custom Events:

Example (Custom Event with Custom Parameters) —

Example (Send a Custom Event with Only a Name, no Event Data) —

Example (Send a Custom Event with Event Data) —

Example (Send a Custom Event with Serialized JSON Data) —

Example (Standard Purchase Event):

Example (Custom Purchase Event with Serialized JSON Data):

Example (Custom Subscription Purchase Event with Serialized JSON Data) —

Example (Identity Link with Subscription):

Example (Identity Link with Free Trial):

Example (Standard Deeplink Event):

Example (Custom Deeplink Event with Serialized JSON Data):

Example (Acquire the Deeplink) —

Example (Wait for the Callback) —

Example (Set an Identity Link During Tracker Configuration):

Example (Set an Identity Link After Starting the Tracker):

Example (Requesting Attribution Results):

Example (Using the Getter After Attribution Results Have Been Retrieved):

Example (Getting the Kochava Device ID):

Example (Getting the SDK Version String)

Example (Enabling App Limit Ad Tracking During Tracker Configuration):

Example (Enable App Limit Ad Tracking After Starting the Tracker):

Example (Enabling trace logging in a non-production build):

Example (Enabling Sleep Mode During Tracker Configuration):

Example (Enabling Sleep Mode After Starting the Tracker):

Example (Waking the Tracker from Sleep Mode) —

Intelligent Consent Manager:

Self Managed Consent:

Example (Starting the Tracker Only When Consent Allows) —

Example (Calling Tracker Methods Only When Consent Allows) —

Analyzing SDK Behavior:

Last Modified: Jun 25, 2020 at 9:22 am

In This Guide:

Related Pages:

In This Guide: