Kochava
6 minute read
Kochava is a leading mobile measurement and app analytics platform that offers unique dynamic deep linking, audience segmenting and data accessibility features for your business.
Find the open source transformer code for this destination in the GitHub repository.
Connection compatibility
| Destination Information | |||
|---|---|---|---|
| |||
Get started
Once you have confirmed that the source platform supports sending events to Kochava, follow these steps:
- From your RudderStack dashboard, add a source. Then, from the list of destinations, select Kochava.
- Assign a name to the destination and click Continue.
Connection settings
To successfully configure Kochava as a destination, you will need to configure the following settings:
- App GUID: Kochava generates a unique ID for your application called the App GUID. You can find this ID by going to your Kochava account and navigating to Apps & Assets > All Apps. You can then select your app to the view the App GUID.
The following two settings are applicable for iOS device mode only:
- Enable AppTrackingTransparency (ATT): Enable this setting if you want to enable the
AppTrackingTransparencyfeature provided by the Kochava iOS SDK.
Make sure to include the keyNSUserTrackingUsageDescriptionin yourinfo.plistalong with a string value explaining why you are requesting authorization to track.
- Enable skAdNetwork: Enable this setting if you want to enable the
skAdNetworkfeature provided by the Kochava iOS SDK.
Adding device mode integration
Follow the below steps to add Kochava to your Flutter Project:
- Add the following dependency to the
dependenciessection of yourpubspec.yamlfile:
rudder_integration_kochava_flutter: ^1.0.1- Run the below command to install the dependency added in the above step:
flutter pub get- Import
RudderIntegrationKochavaFlutterin your application where you are initializing the SDK:
import 'package:rudder_integration_kochava_flutter/rudder_integration_kochava_flutter.dart';- Finally, change the initialization of your
RudderClientas shown:
final RudderController rudderClient = RudderController.instance;
RudderConfigBuilder builder = RudderConfigBuilder();
builder.withFactory(RudderIntegrationKochavaFlutter())
rudderClient.initialize(<write_key>, config: builder.build(), options: null);To add Kochava to your Android project and enable functionalities like push notifications, follow these steps :
- Open your project level
build.gradlefile, and add the following:
buildscript {
repositories {
mavenCentral()
}
}
allprojects {
repositories {
mavenCentral()
}
}- Also, add the following under the
dependenciessection:
implementation 'com.rudderstack.android.integration:kochava:1.0.0'
implementation 'com.google.code.gson:gson:2.8.6'- Initialize the RudderStack SDK in the
Applicationclass’onCreate()method as shown:
// initialize Rudder SDK
val rudderClient =
RudderClient.getInstance(
this,
WRITE_KEY,
RudderConfig.Builder()
.withDataPlaneUrl(DATA_PLANE_URL)
.withFactory(kochavaIntegration.FACTORY)
.build()
)To add Kochava to your iOS project:
- Go your
Podfileand add theRudder-Kochavaextension as shown below:
pod 'Rudder-Kochava'- After adding the dependency followed by
pod install, you can add the imports to yourAppDelegate.mfile as shown:
#import "RudderKochavaFactory.h"- Finally, change the initialization of your
RudderClientas shown:
RudderConfigBuilder *builder = [[RudderConfigBuilder alloc] init];
[builder withDataPlaneUrl:DATA_PLANE_URL];
[builder withFactory:[RudderKochavaFactory instance]];
[RudderClient getInstance:WRITE_KEY config:[builder build]];Track
The track method lets you capture user events along with the properties associated with them.
RudderStack transforms the following events to Kochava’s standard events:
| RudderStack event | Kochava standard event |
|---|---|
Product Added | Add to Cart |
Product Added to Wishlist | Add to Wishlist |
Checkout Started | Checkout Start |
Order Completed | Purchase |
Product Reviewed | Rating |
Products Searched | Search |
Note that:
- RudderStack sends the rest of the events to Kochava as custom events.
- You can send an event with the name same as that of a Kochava standard event. Kochava accepts it as a standard event.
A sample track event sent to Kochava:
[[RudderClient sharedInstance] track:@"Product Added" properties:@{
@"price": @2.0,
@"product_id": @"product_id_a",
@"product_name": @"Product Name A"
}];RudderStack changes the Product Added event to Add to Cart before passing it to Kochava along with the associated properties.
Screen
The screen call lets you record whenever your user views their mobile screen, with any additional relevant information about the screen.
RudderStack sends thescreenevent to Kochava as a custom event.
A sample screen call is shown below:
MainApplication.rudderClient.screen(
"Sample Screen Name",
RudderProperty().putValue("prop_key", "prop_value")
)In the above snippet, RudderStack captures all information related to the viewed screen, along with any additional info associated with that event. In Kochava, the above screen call is shown as “screen view Sample Screen Name “ along with the properties.
Configuring push notifications
Follow these steps to configure push notifications for Kochava for the platform of your choice:
- Register push notifications for your Android device in the Kochava dashboard.
- Add the following dependency in your project level
build.gradlefile inside thebuildscript:
dependencies {
classpath 'com.google.gms:google-services:4.3.5'
}- Next, add the following dependencies and plugin to your app level
build.gradlefile:
dependencies {
// for push notifications
implementation 'com.google.firebase:firebase-messaging:21.1.0'
}
apply plugin: 'com.google.gms.google-services'- Place the
google-services.jsondownloaded from theFirebase consoleinto the root folder of yourapp. - Passing the new Push Token received from FCM to the Kochava SDK. For more information, look into the sample-kotlin app.
// Extending FirebaseMessagingService class
class MyFirebaseMessagingService : FirebaseMessagingService() {
// The onNewToken callback fires whenever a new token is generated.
override fun onNewToken(token: String) {
super.onNewToken(token)
// Method to pass the push token to the Kochava native sdk
registeredForPushNotificationsWithFCMToken(token)
}
}- Add push notifications as a capability by navigating to Target > Signing & Capabilities of your app when opened in Xcode.
- Enable Background Modes/Remote notifications by navigating to Targets > Your App > Capabilities > Background Modes and then check Remote notifications.
- Register the push notifications for the iOS devices in your Kochava dashboard.
- Add the following code in your app just after initializing iOS (Obj-C) SDKiOS (Obj-C) refers to the legacy RudderStack iOS SDK. Note that it will be deprecated soon.
For new implementations, use the iOS (Swift) SDK instead. to register the push notifications.
#import <usernotifications>
// register for push notifications
UNUserNotificationCenter* center = [UNUserNotificationCenter currentNotificationCenter];
center.delegate = self;
[center requestAuthorizationWithOptions:(UNAuthorizationOptionAlert | UNAuthorizationOptionSound | UNAuthorizationOptionBadge)
completionHandler:^(BOOL granted, NSError * _Nullable error) {
if (granted) {
dispatch_async(dispatch_get_main_queue(), ^(void) {
[[UIApplication sharedApplication] registerForRemoteNotifications];
});
}
}];- Add the below handlers to handle the tokens and push notifications accordingly:
#import <rudderkochavaintegration.h>
- (void)application:(UIApplication *)application didRegisterForRemoteNotificationsWithDeviceToken:(NSData *)deviceToken
{
[[RudderKochavaIntegration alloc] registeredForRemoteNotificationsWithDeviceToken:deviceToken];
}
- (void)userNotificationCenter:(UNUserNotificationCenter *)center willPresentNotification:(UNNotification *)notification withCompletionHandler:(void (^)(UNNotificationPresentationOptions))completionHandler
{
completionHandler(UNAuthorizationOptionSound | UNAuthorizationOptionAlert | UNAuthorizationOptionBadge);
}
- (void)userNotificationCenter:(UNUserNotificationCenter *)center didReceiveNotificationResponse:(UNNotificationResponse *)response withCompletionHandler:(void (^)(void))completionHandler
{
[[RudderKochavaIntegration alloc] receivedRemoteNotification:response.notification.request.content.userInfo withActionString:response.actionIdentifier];
}FAQ
Where do I get the Kochava App GUID?
To get your Kochava app GUID, follow these steps:
- Log in to Kochava. Then, go to your account and select the application for the specific campaign.
- Under Apps & Assets, select All Apps
- Click the desired app for which you want the procure the App GUID.
- You will be able to see the App GUID under the title of your application, within the details.
For more information, see the Kochava support guide.