Our Xamarin SDK supports all Mono frameworks including MonoGame.
Please use our Windows SDK directly if targeting a windows platform.
<uses-permission android:name="com.google.android.gms.permission.AD_ID"/> Please ensure this permission is added to your AndroidManifest.xml in order for ADID collection to continue to take place as of Android 13 and beyond.
Some Google Play policies, such as the Families Policy, require that apps not use the ADID. In those cases this permission should not be included as the ADID should not be collected.
Integrating the SDK
Requirements:
- Android API 16
- iOS Target 12.4
- Xcode 14.1
Supported Platforms:
- Android
- iOS
Data Privacy:
Migration:
If you are migrating from a Kochava SDK prior to version 4.0.0 to version 4.x usage can be updated by reviewing the code samples for any given topic, as the overall usage of the SDK remains the same.
Integration:
In order to use the Kochava SDK, first add it within your project. This can be accomplished using NuGet (recommended) or by downloading the SDK files manually and adding them.
- Install the latest version of KochavaTrackerXamarin via NuGet.
- KochavaTrackerXamarin should now appear within your project’s references.
NOTE: The NuGet will need to be installed in both the Android and iOS modules of your project.
- After downloading the DLLs for both Android and iOS from the download badge above you can import them into your project as follows where you import the iOS DLL in your iOS project and the Android DLLs in your Android project.
- Right click the References folder in your project and click Edit References.
- Select the .Net Assembly tab and click Browse.
- Locate and select the KochavaXamarin DLL and import it.
Google Play Store:
If you wish for the SDK to collect the Google Play Ads Identifier (ADID), App Set ID (ASID) and/or make use of the Install Referrer, you must integrate Google Play Services by adding the appropriate dependencies. Collection is handled by the Kochava SDK with only the dependency itself needing to be included. The Kochava SDK does not require specific versions of its dependencies however we recommend keeping them up to date whenever possible.
Maven Repository —
1 | google() |
Dependencies —
1 | implementation 'com.google.android.gms:play-services-ads-identifier:17.1.0' |
NOTE: If using a version prior to version 17.1.0 you must also add the following permission.
1 | <uses-permission android:name="com.google.android.gms.permission.AD_ID"/> |
1 | implementation 'com.android.installreferrer:installreferrer:2.2' |
1 | implementation 'com.google.android.gms:play-services-appset:16.0.0' |
Huawei App Gallery:
If you wish for the SDK to collect the Huawei Advertising ID (OAID) and/or make use of the Install Referrer, you must integrate the Huawei Ads SDK by adding the appropriate dependencies. Collection is handled by the Kochava SDK with only the dependency itself needing to be included. The Kochava SDK does not require specific versions of its dependencies however we recommend keeping them up to date whenever possible.
Maven Repository —
1 | maven { url 'https://developer.huawei.com/repo/' } |
Dependencies —
1 | implementation 'com.huawei.hms:ads-identifier:3.4.39.302' |
1 | implementation 'com.huawei.hms:ads-installreferrer:3.4.39.302' |
Network Data Gathering:
The following permissions are optional and used by the Network Datapoint module of the Kochava SDK. They are automatically included if using that module but can be removed if desired.
1 2 3 4 5 6 7 8 9 10 11 | // Wifi State Collection. <uses-permission android:name="android.permission.ACCESS_WIFI_STATE" /> // Remove the automatically included Wifi State permission. <!-- <uses-permission android:name="android.permission.ACCESS_WIFI_STATE" tools:node="remove"/> --> // Network State Collection. <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" /> // Remove the automatically included Network State permission. <!-- <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" tools:node="remove"/> --> |
Minification (ProGuard / R8):
The following minification rules are required when code minification is enabled. They are automatically included when adding the Kochava SDK and typically do not require manual inclusion. If you are experiencing issues after enabling minification you can manually include the rules in your configuration file.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 | # KochavaCore: Ignore SDK warnings for missing dependencies. -dontwarn com.kochava.core** # KochavaCore: Uncomment only if needed. Do not run ProGuard on the SDK at all. #-keep class com.kochava.core** { *; } # KochavaCore: Keep annotations used for json serialization. -keepattributes Signature -keepattributes *Annotation* -keepclassmembers class * { @com.kochava.core.json.annotation.internal.JsonSerialize <fields>; } -keepclassmembers class * { @com.kochava.core.json.annotation.internal.JsonIgnore <fields>; } -keepclassmembers class * { @com.kochava.core.json.annotation.internal.JsonEnumSerializedValue <fields>; } # KochavaCore: BuildConfig -keep class com.kochava.core.BuildConfig { *; } # KochavaCore: Google Instant Apps Collection. -keep class com.google.android.gms.common.wrappers.InstantApps { boolean isInstantApp(android.content.Context); } # KochavaTracker: Ignore SDK warnings for missing dependencies. -dontwarn com.kochava.tracker** # KochavaTracker: Uncomment only if needed. Do not run ProGuard on the SDK at all. #-keep class com.kochava.tracker** { *; } # KochavaTracker: BuildConfig -keep class com.kochava.tracker.BuildConfig { *; } # KochavaTracker: Google ADID Collection. -keep class com.google.android.gms.ads.identifier.AdvertisingIdClient { com.google.android.gms.ads.identifier.AdvertisingIdClient$Info getAdvertisingIdInfo(android.content.Context); } -keep class com.google.android.gms.ads.identifier.AdvertisingIdClient$Info { java.lang.String getId(); boolean isLimitAdTrackingEnabled(); } # KochavaTracker: Google Install Referrer Collection. -keep class com.android.installreferrer.api.InstallReferrerClient { *; } -keep class com.android.installreferrer.api.InstallReferrerClient$InstallReferrerResponse { *; } -keep class com.android.installreferrer.api.InstallReferrerStateListener { *; } -keep class com.android.installreferrer.api.ReferrerDetails { *; } # KochavaTracker: Google App Set ID Collection -keep class com.google.android.gms.appset.AppSet { com.google.android.gms.appset.AppSetIdClient getClient(android.content.Context); } -keep class com.google.android.gms.appset.AppSetIdClient { com.google.android.gms.tasks.Task getAppSetIdInfo(); } -keep class com.google.android.gms.appset.AppSetIdInfo { java.lang.String getId(); int getScope(); } -keep class com.google.android.gms.tasks.Tasks { await(com.google.android.gms.tasks.Task, long, java.util.concurrent.TimeUnit); } # KochavaTracker: Huawei OAID Collection. -keep class com.huawei.hms.ads.identifier.AdvertisingIdClient { com.huawei.hms.ads.identifier.AdvertisingIdClient$Info getAdvertisingIdInfo(android.content.Context); } -keep class com.huawei.hms.ads.identifier.AdvertisingIdClient$Info { java.lang.String getId(); boolean isLimitAdTrackingEnabled(); } # KochavaTracker: Huawei Install Referrer Collection. -keep class com.huawei.hms.ads.installreferrer.api.InstallReferrerClient { *; } -keep class com.huawei.hms.ads.installreferrer.api.InstallReferrerClient$InstallReferrerResponse { *; } -keep class com.huawei.hms.ads.installreferrer.api.InstallReferrerStateListener { *; } -keep class com.huawei.hms.ads.installreferrer.api.ReferrerDetails { *; } # KochavaTracker: Notifications Enabled Collection. -keep class androidx.core.app.NotificationManagerCompat { static androidx.core.app.NotificationManagerCompat from(android.content.Context); boolean areNotificationsEnabled(); } # KochavaTrackerEvents: Ignore SDK warnings for missing dependencies. -dontwarn com.kochava.tracker.events** # KochavaTrackerEvents: Uncomment only if needed. Do not run ProGuard on the SDK at all. #-keep class com.kochava.tracker.events** { *; } # KochavaTrackerEvents: BuildConfig -keep class com.kochava.tracker.events.BuildConfig { *; } # KochavaTrackerEvents: Internal SDK -keep class com.kochava.tracker.events.Events { static com.kochava.tracker.events.EventsApi getInstance(); void setController(com.kochava.tracker.modules.events.internal.EventsControllerApi); com.kochava.tracker.modules.events.internal.EventsControllerApi getController(); } # KochavaTrackerEngagement: Ignore SDK warnings for missing dependencies. -dontwarn com.kochava.tracker.engagement** # KochavaTrackerEngagement: Uncomment only if needed. Do not run ProGuard on the SDK at all. #-keep class com.kochava.tracker.engagement** { *; } # KochavaTrackerEngagement: BuildConfig -keep class com.kochava.tracker.engagement.BuildConfig { *; } # KochavaTrackerEngagement: Internal SDK -keep class com.kochava.tracker.engagement.Engagement { static com.kochava.tracker.engagement.EngagementApi getInstance(); void setController(com.kochava.tracker.modules.engagement.internal.EngagementControllerApi); com.kochava.tracker.modules.engagement.internal.EngagementControllerApi getController(); } # KochavaTrackerDatapointNetwork: Ignore SDK warnings for missing dependencies. -dontwarn com.kochava.tracker.datapointnetwork** # KochavaTrackerDatapointNetwork: Uncomment only if needed. Do not run ProGuard on the SDK at all. #-keep class com.kochava.tracker.datapointnetwork** { *; } # KochavaTrackerDatapointNetwork: BuildConfig -keep class com.kochava.tracker.datapointnetwork.BuildConfig { *; } # KochavaTrackerDatapointNetwork: Internal SDK -keep class com.kochava.tracker.datapointnetwork.internal.DataPointCollectionNetwork { public <methods>; } # KochavaTrackerLegacyReferrer: Ignore SDK warnings for missing dependencies. -dontwarn com.kochava.tracker.legacyreferrer** # KochavaTrackerLegacyReferrer: Uncomment only if needed. Do not run ProGuard on the SDK at all. -keep class com.kochava.tracker.legacyreferrer** { *; } # KochavaTrackerLegacyReferrer: BuildConfig -keep class com.kochava.tracker.legacyreferrer.BuildConfig { *; } # KochavaTrackerLegacyReferrer: Referrer Receiver -keep class com.kochava.tracker.legacyreferrer.LegacyReferrerReceiver { onReceive(android.content.Context, android.content.Intent); } |
Starting the Tracker
Once you have added the Kochava SDK to your project, the next step is to configure and start the Kochava Tracker in code. Only your App GUID is required to start the tracker with the default settings, which is the case for typical integrations.
We recommend starting the tracker as soon as the application starts, although this can be done later if needed. Starting the tracker as early as possible will ensure it’s started before use, provide more accurate session reporting, and quicker deeplink results.
- 123KochavaTracker.Instance.RegisterAndroidAppGuid("YOUR_ANDROID_APP_GUID");KochavaTracker.Instance.RegisterIosAppGuid("YOUR_IOS_APP_GUID");KochavaTracker.Instance.Start();
- 1234Kochava.Tracker.Configuration config = new Kochava.Tracker.Configuration();config.AndroidAppGuid = "YOUR_ANDROID_APP_GUID";config.IosAppGuid = "YOUR_IOS_APP_GUID";Kochava.Tracker.Client.Configure(config);
Confirm the Integration
After integrating the SDK and adding the code to start the tracker, launch and run the app for at least 10 seconds or more. During this time the tracker will start and send an install payload to Kochava. To confirm integration was successful, visit the app’s Install Feed Validation page Apps & Assets > Install Feed Validation. On this page you should see one of two integration messages, indicating integration success or failure.
Integration Successful:
Along with this message you will also see a variety of data points associated with the device used for testing. At this point your integration is successful and you can proceed to the next step(s).
NOTE: It may take a few minutes for the first install to appear within the Install Feed Validation page. If you do not see this message immediately, you may simply need to wait a few minutes and check again.
Integration Not Complete:
If you encounter this message, please review the integration steps, uninstall and reinstall the app, and check again.
Where to Go From Here:
Now that you have completed integration you are ready to utilize the many features offered by the Kochava SDK. Continue on to Using the SDK and choose a topic.
