[NEW] 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.

Use the createReferrerShortLink method to create a short link as in the example below.

void callback(string shortLinkURL, string error){
    // Add your share logic here if shortLinkURL is not null
    // If there was an error, add logic to retry/abort/modify the params
    // passed to the function, based on the cause of the error
}

SingularSDK.createReferrerShortLink(
    "https://sample.sng.link/B4tbm/v8fp?_dl=https%3A%2F%2Fabc.com",
    "John Doe", // Referrer Name
    "342", // Referrer ID
    new Dictionary<string, string>() { 
        // a Dictionary object containing any parameters you want to add
        {"channel", "sms"}
    },
    callback 
);

Adding Ad Revenue Attribution Support

To add ad revenue attribution support in the Singular SDK:

1. If you haven't done so yet, contact your Singular Customer Success Manager to enable ad revenue attribution for your account.
2. Update to the latest version of the Singular SDK.
3. Add the appropriate code snippet to your Singular SDK integration, depending on the mediation platform you use for ad revenue data.

// Note: This is a beta feature. Contact Admob to have it enabled.

RewardedAd rewardedAd;
public void HandleRewardedAdLoaded(object sender, EventArgs args)
{
     this.rewardedAd = args.rewardedAd;
}

AdValue impressionData;
private void HandleAdPaidEvent(object sender, AdValueEventArgs args)
{
    this.impressionData = args.AdValue;

    SingularAdData data = new SingularAdData("Admob", impressionData.CurrencyCode, impressionData.Value/1000000f);

    data.WithNetworkName(this.rewardedAd.GetResponseInfo().GetMediationAdapterClassName());

    Singular.AdRevenue(data);
}

// The object received from AppLovin MAX's event: OnInterstitialAdRevenuePaidEvent
MaxSdkBase.AdInfo impressionData;
string adUnitId;
double revenue = MaxSdk.GetAdInfo(adUnitId).Revenue;

SingularAdData data = new SingularAdData("AppLovin","USD", revenue);

data.WithAdUnitId(impressionData.AdUnitIdentifier).
    WithNetworkName(impressionData.NetworkName).
    WithAdPlacementName(impressionData.Placement);

Singular.AdRevenue(data);

// The object received from IronSource's event: OnImpressionSuccess
IronSourceImpressionData impressionData;

SingularAdData data = new SingularAdData("IronSource","USD", impressionData.revenue);

data.WithAdUnitId(impressionData.getInstanceId).
    WithAdUnitName(impressionData.getInstanceName).
    WithImpressionId(impressionData.getAuctionId).
    WithNetworkName(impressionData.adNetwork).
    WithAdPlacementName(impressionData.placement).
    WithAdType(impressionData.getAdUnit);

Singular.AdRevenue(data);

// Ensure that the ARM SDK Postbacks Flag (click here) in IronSource is turned on

// Initialize the SingularAdData object with the relevant data
SingularAdData data = new SingularAdData("YOUR_AD_PLATFORM", "CURRENCY_CODE", 9.90).

// The more ad data you add, the greater the granularity
data.WithAdGroupId("AD_GROUP_ID")
    .WithNetworkName("AD_NETWORK_NAME");

// Report the data to Singular
SingularSDK.AdRevenue(data);

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:

After retrieving the FCM token, pass it as a parameter to the 'RegisterTokenForUninstall' method:

SingularSDK.RegisterTokenForUninstall(String fcmDeviceToken);

Note that the 'RegisterTokenForUninstall' method should be called before the 'SingularSDK.InitializeSingularSDK()' method.

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 RegisterTokenForUninstall  method, after the SDK is initialized. 

public static void RegisterTokenForUninstall
(string APNSToken)

// pass the APNS token as a hex-string 
  SingularSDK.RegisterTokenForUninstall("ba85ab31a7c7
f5c2f012587f29fb0e596d4b67e7b7b2838fa1a8582c1f7dbdee");

Adding Global Properties

The Singular SDK lets you define custom additional properties that you want to send to the Singular servers with every session and event sent from the app. These properties can represent any information you want about the user, the app mode or status, or anything else. Once you set these properties, they are available as dimensions in your reports and you can use them to break down your data.

For example, if you have a gaming app, you can define a property called "Level" and set it initially to "0". Any session and event sent from the app will be sent with "Level": "0". Once the user levels up you reset the property to "1" and so on. You can then get your reports, including sessions, event counts, and revenue data, broken down by user level.

Setting Global Properties before Initialization

You can use the SetGlobalProperty method to set global properties through SingularSDK before initializing the SDK. Make sure to turn off the `Initialize On awake` flag if you want your global properties to be included in the session. 

Note that since global properties and their values persist between app runs, the property that you are setting may already be set to a different value. Use the overrideExisting parameter to tell the SDK whether to override an existing property with the new value or not.

Setting Global Properties After Initialization

Use the following methods to set, unset, and retrieve global properties at any time in the app's run.

bool result = SingularSDK.SetGlobalProperty("key", "value", false);

Dictionary<string, string> props = SingularSDK.GetGlobalProperties();

SingularSDK.UnsetGlobalProperty(“test_key”);

SingularSDK.clearGlobalProperties();

Collecting the Install Referrer on Older Android Devices

In Android, the install referrer is Singular's most accurate tool to determine attribution, in addition to helping Singular detect and analyze fraud attempts. It is an identifier provided by the Google Play Store that points to the ad that the user clicked on before installing the app.

On devices that have the latest version of the Google Play Store, the Singular SDK collects the install referrer value automatically (since Singular is integrated with the latest Google Play Referrer API).

To collect the install referrer on older devices, follow the instructions in the Android SDK guide.

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 SingularSDK.LimitDataSharing(false) to indicate that the user consented (opted in) to share their information.
• Use SingularSDK.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.

// User has opted in to sharing data
SingularSDK.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.

SingularSDK.TrackingOptIn();

SingularSDK.StopAllTracking();

SingularSDK.ResumeAllTracking();

SingularSDK.IsAllTrackingStopped();