|Singular Unreal Engine SDK
||Singular Unreal Engine SDK version 1.0.0|
Unreal Engine 4.23+
Note: Uninstall tracking is only available to Enterprise customers.
Android Uninstall Tracking
To enable uninstall tracking for your Android app, first configure the app in the Singular platform as detailed in Setting Up Uninstall Tracking. Then follow the instructions below.
Note: Google deprecated the GCM APIs on April 2018. Use FCM for uninstall tracking.
Enabling Uninstall Tracking Using Firebase Cloud Messaging (FCM)
1. Integrate with FCM:
To track uninstalls, you can use the services of the Firebase Cloud Messaging (FCM) platform. If you are not already using FCM follow Google's instructions on how to Set up a Firebase Cloud Messaging client app on Android.
FCM Requirements (source)
FCM clients require devices running Android 4.1 or higher that also have the Google Play Store app installed, or an emulator running Android 4.1 with Google APIs. Note that you are not limited to deploying your Android apps through Google Play Store.
Users/devices who are not running on supported versions of Android will not be available for Singular uninstall tracking.
2. Update the AndroidManifest.xml File:
Update your AndroidManifest.xml file to add the necessary intent filter for your app (replace MyFirebaseMessagingService with your class that implements the Firebase Service):
<action android:name="com.google.firebase.MESSAGING_EVENT" />
</intent-filter> </service> <service android:name=".java.MyFirebaseMessagingService" android:exported="false"> intent-filter> action android:name="com.google.firebase.MESSAGING_EVENT" /> </intent-filter> </service>
3. Register and Send the FCM Device Token:
Finally, set the FCM device token after your SingularConfig is initialized in OnCreate(), as follows:
iOS Uninstall Tracking
Uninstall tracking on iOS is based on Apple push-notification technology. If your app doesn't currently support push notifications, see Apple's guide. If your app already supports push notifications, all you need to do is pass the device token returned from APNS using the RegisterDeviceTokenForUninstall method, after the SDK is initialized.
|SingularSDK SetUninstallToken Method
|Description||Pass the device token returned from APNS / FCM. Note that the APNS / FCM token is usually binary data in the native form, but you need to pass it as a string.|
Complying with Data Privacy Laws
Singular provides privacy-safeguarding functionality to help you cooperate with any partners who may be complying with consumer privacy laws such as GDPR and CCPA (California Consumer Privacy Act). These partners want to be notified if the end-user has consented to share their private information.
If you have implemented a way to ask users for consent to share their information, use the LimitDataSharing method to notify Singular of the user's choice:
- Use USingularSDKBPLibrary::LimitDataSharing(false) to indicate that the user consented (opted in) to share their information.
- Use USingularSDKBPLibrary::LimitDataSharing(true) if the user did not consent.
Singular will pass this information on to partners who require it in order to comply with relevant regulations.
Note: The use of the method is optional, but there may be attribution information that the partner will share with Singular only if specifically notified that the user has opted in.
|SingularSDK LimitDataSharing Method|
|Signature||public void LimitDataSharing(bool shouldLimitDataSharing)|
|Description||Notify Singular of user consent (opt-in) for sharing private data.|
The Singular SDK provides several methods to help you comply with GDPR policies and let Singular know about user consent or non-consent for tracking.
|SingularSDK TrackingOptIn Method|
|Description||Notify Singular of user consent (opt-in) for tracking.|
|SingularSDK TrackingUnder13 Method|
|Description||Notify Singular that a user is a minor (under 13).|
|SingularSDK StopAllTracking Method|
|Description||Stop all tracking activities for this user on this app.
Note: Calling this method effectively disables the SDK, even after the app restarts (the state is persistent)! The only way to re-enable tracking is by calling resumeAllTracking().
|SingularSDK ResumeAllTracking Method|
|Description||Resume tracking for this user on this app.|
|SingularSDK IsAllTrackingStopped Method|
|Description||Check the tracking status for this user on this app. Returns true if tracking has been stopped using StopAllTracking() and not resumed.|