In order to integrate with Kochava Push you must, at a minimum, enable push notifications by passing the user’s push registration token to the Kochava SDK and handle app launches from a Kochava push notification by sending a Push Opened event containing engagement campaign information.
Enabling Push Notifications
In order to enable Kochava push notifications you must pass the push registration token to the Kochava SDK. This will occur the first time the token is created and any time it is updated. If you support opt in or out then this should only occur when the user is currently opted in and during the moment they opt in.
Example (Retrieving the Push Registration Token):
1 2 3 4 | private function onTokenRefreshed(event:MessagingEvent):void { // Add the new/updated push token to Kochava. KochavaTracker.addPushToken(event.token); } |
Developer API Reference:
KochavaTracker.addPushToken(String)
Handling App Launches
When the app launches you must detect if it was caused by the user clicking on a Kochava push notification and if so send a Push Opened event containing the Kochava engagement campaign information to track the launch.
Example (Send Push Opened Event):
1 2 3 4 5 6 7 8 9 10 11 12 13 | // Check for a Kochava Push open in your notification launch handler. public function onNotificationOpened(data:Object):void { if(data.hasOwnProperty("kochava")) { // This app launch was due to a Kochava Push. // Send a Push Opened event containing the Kochava campaign information. var eventMapObject:Object = new Object(); // Set "payload" to the "data" object that contains the "kochava" key/value. eventMapObject["payload"] = data; KochavaTracker.sendEventMapObject(KochavaTracker.EVENT_TYPE_PUSH_OPENED_STRING_KEY, eventMapObject); } } |
Developer API Reference:
KochavaTracker.sendEventMapObject(String, Object)
Standard Event Types
Building the Notification
Android Only:
On Android, Kochava Push uses the FCM Data Message format. This format ensures consistent behavior regardless of if the app is in the foreground or the background. However it requires that the app is responsible for building and displaying the notification when it is received. The app must also determine if it should show the notification based on being in the foreground or background. The “kochava” key contains the engagement campaign information and is always included. Other fields are optional and may vary.
- kochava — Campaign tracking information to be added to the notification bundle and sent with the Push Opened event.
- silent — If this key is present the push was used for tracking uninstalls and should be ignored.
- title — Notification title.
- message — Notification message body.
- icon_resource_id — Mapping string to an app internal drawable resource.
- link — Launch deeplink Uri.
Example (Building the Notification):
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 | private function onMessageReceived(event:MessagingEvent):void { var remoteMessage:RemoteMessage = event.remoteMessage; var data:Object = remoteMessage.data; var isKochava:Boolean = data.hasOwnProperty("kochava"); var isSilen:Boolean = data.hasOwnProperty("silent"); if(isKochava && isSilent) { // This is a Kochava silent push. These are used for tracking uninstalls and should not be acted on. return; } else if(isKochava) { //This is a regular Kochava push. // Map the iconResourceId string to the appropriate icon in the app. // ... // Include kochava in the "extras" bundle of your local notification under the "kochava" key. // ... // Set the notification deeplink to link (if not null). // ... // Show the notification with the given title and message. // ... } } |
Other Functionality
Disabling Push Notifications:
If you provide the ability for users to opt in or out of Kochava Push Notifications you can remove an existing push token which will disable usage of that token by Kochava. If disabled ensure that you do not pass any updated tokens to Kochava until the feature has been enabled again and if enabled immediately add the current token to the Kochava SDK.
Example (Removing a Push Registration Token) —
1 2 | // Remove an existing token from Kochava. KochavaTracker.removePushToken(cachedPushToken); |
Uninstall Tracking:
In order to track uninstalls Kochava sends a “silent push” to all push registration tokens periodically. When the token becomes invalid it can be determined that the user uninstalled the app. On iOS these automatically resolve in the background and no action is required. However on Android these show up in the app and must be specifically ignored. A silent push can be identified and ignored by checking that both the keys “kochava” and “silent” are present within the notification extras map.
Application Icon Badge Number:
iOS Only —
On your Kochava dashboard you may indicate that you want the application icon badge number set when push notifications are sent. If you enable this option you should be prepared to clear your badge number when your application becomes active, or at some other appropriate time. For more information see instance property applicationIconBadgeNumber.
Developer API Reference:
KochavaTracker.removePushToken(String)
