Creating Short Referrer Links

Use short links to transform long, parameter-filled Singular Links into shorter and more secure links that are convenient for sharing.

Typically, you will want to create short links dynamically so that your app's users can share them with friends to invite them to use the app.

To create a short link, you need:

• A Singular Link that leads to your app download (see the Singular Links FAQ).
• Any parameters you want to add to the link dynamically (see Tracking Link Parameters for the list of options).
• The name and ID of the referring user, if you want to be able to track new app installs back to the user who shared the link.

To enable short links, first add this code to the main character constructor:

if (AUnrealTestAppCharacter::singularDelegates == NULL) {
    AUnrealTestAppCharacter::singularDelegates =
      CreateDefaultSubobject<USingularDelegates>(TEXT("SingularShortLinksHandler"));
      singularDelegates->OnSingularShortLinksResolved.AddDynamic(this, &AUnrealTestAppCharacter::SingularShortLinksResolved);
  }
      
  void AUnrealTestAppCharacter::SingularShortLinksResolved(const FSingularShortLinkParams& linkParams) {
    const FString shortLinkURL = linkParams.SingularShortLinksParams["data"];
    const FString errorMessage = linkParams.SingularShortLinksParams["error"];
  // Add your share logic here
  // If there is an error, add logic to retry/abort/modify the params passed 
  // to the function, based on the cause of the error
  }

Then use the CreateReferrerShortLink method to create a short link as in the example below.

// Add parameters to the link (if they don't already exist in the long link URL)
  TMap<FString, FString> params;
  params.Add(TEXT("channel"), TEXT("sms"));
  params.Add(TEXT("anotherparam"), TEXT("paramvalue"));
  
  // Create the short link based on the original Singular Link URL 
// with a referrer name, referrer ID, and optional additional parameters
  USingularSDKBPLibrary::CreateReferrerShortLink(
      "https://sample.sng.link/B4tbm/v8fp?_dl=https%3A%2F%2Fabc.com",
      "referrer name",
      "referrer ID", 
      params
  );

Tracking Uninstalls

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.

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.

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):

<service android:name=".java.MyFirebaseMessagingService"
android:exported="false">
<intent-filter>
    <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:

Singular.setFCMDeviceToken(String fcmDeviceToken);

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. 

public static void SetUninstallToken(FString token)

// pass the token as a hex-string
  USingularSDKBPLibrary::SetUninstallToken("ba85ab31a7c7
f5c2f012587f29fb0e596d4b67e7b7b2838fa1a8582c1f7dbdee");

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.

LimitDataSharing

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 limitDataSharing:NO to indicate that the user consented (opted in) to share their information.
• Use limitDataSharing:YES if the user did not consent.

Singular uses LimitDataSharing in "User Privacy Postbacks" as well as passing this information on to partners who require it in order to comply with relevant regulations. See "User Privacy and Limit Data Sharing" for more information.

// user has opted in to share data
  USingularSDKBPLibrary::LimitDataSharing(false);

Additional Methods for GDPR Compliance

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.

USingularSDKBPLibrary::TrackingOptIn();

USingularSDKBPLibrary::StopAllTracking();

USingularSDKBPLibrary::ResumeAllTracking();

USingularSDKBPLibrary::IsAllTrackingStopped();