Before You Begin: SDK Prerequisites

Follow the steps in Integrating a Singular SDK: Planning and Prerequisites.

These steps are prerequisites for any Singular SDK integration.

1. Installing the SDK

1.1. Downloading and Importing the SDK Package

1. To begin, download the SDK unitypackage file.
2. Import the unitypackage into your app using Assets > Import Package > Custom package.

3. In the Unity platform:

   1. Add an object to your Main scene and call it SingularSDKObject.
   2. Drag and drop the SingularSDK script onto it.
   3. In the inspection pane, paste in your Singular SDK Key and SDK Secret (to retrieve them, log into your Singular account and go to Developer Tools > SDK Keys).

1.2. Configuration for Android

1. In your AndroidManifest.xml file, add the following permissions:

   
   <!--  This permission is needed to use internet connectivity  -->
   <uses-permission android:name="android.permission.INTERNET" />
   
   <!--  This permission is needed to check for an active internet connection  -->
   <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
   
   <!--  This permission is needed to retrieve Google Play Referrer data  -->
   <uses-permission android:name="BIND_GET_INSTALL_REFERRER_SERVICE" />
   
   <!--  This permission is needed to validate Google Install Fraud  -->
   <uses-permission android:name="com.android.vending.CHECK_LICENSE" />
   	

2. If you have disabled transitive dependencies for the Singular SDK, add the following to your app's build.gradle.

   implementation 'com.android.installreferrer:installreferrer:2.2'
   implementation 'com.google.android.gms:play-services-appset:16.0.0'

3. The Singular SDK requires the Google Mobile Ads API, part of the Google Play Services APIs 17.0.0+. If you've already integrated Google Play Services into your app, the requirement is fulfilled. If you haven't, you can integrate Google Mobile Ads individually, by including the following dependency in your app's build.gradle file:

   implementation 'com.google.android.gms:play-services-ads-identifier:17.0.0+'

   For more information, see Google's guide to setting up Google Play Services.

Android Configuration (Proguard and Eclipse)

-keep class com.singular.sdk.** { *; }
-keep public class com.android.installreferrer.** { *; }
-keep public class com.singular.unitybridge.** { *; }

1.3. Configuration for iOS

Link the following libraries/frameworks to your Unity XCode project:

• Security.framework
• SystemConfiguration.framework
• iAD.framework
• AdSupport.framework
• WebKit.framework
• libsqlite3.0.tbd
• libz.tbd
• StoreKit.framework
• AdServices.framework (Must be added, but mark it as Optional since it's only available for devices with iOS 14.3 and higher).

2. Setting Up a Basic SDK Integration

2.1. Using SKAdNetwork

Starting with Unity SDK version 4.0.17, SKAdNetwork is enabled by default. It is enabled in Managed Mode (in which Singular updates the SKAN conversion value for you using a conversion model you choose in the Singular dashboard).

As long as you are using the latest version of the SDK, you do not need to set anything else or add any code to use SKAdNetwork.

Additional Information

// A sign-up event happened
Singular.Event("SignUp");

// Update the conversion value to 7
SingularSDK.SkanUpdateConversionValue(7);

int? value = SingularSDK.SkanGetConversionValue();

public class Main : MonoBehaviour, SingularConversionValueUpdatedHandler {
  void Awake() {
    SingularSDK.SetConversionValueUpdatedHandler(this);
  }

  void OnConversionValueUpdated(int value) {
    // Use the conversion value
  }
}

2.2. Handling ATT Consent (Setting an Initialization Delay)

Displaying an ATT (App Tracking Transparency) Prompt

Starting with iOS 14.5, apps are required to ask for user consent (using the App Tracking Transparency framework) before they can access and share some user data that is helpful for tracking purposes, including the device's IDFA.

Singular highly benefits from having the IDFA to identify devices and perform install attribution (although there are ways to perform attribution without the IDFA). We strongly recommend you ask for the user's consent to get the IDFA.

Delaying Initialization to Wait for ATT Response

By default, the Singular SDK sends a user session when it is initialized. When a session is sent from a new device, it immediately triggers Singular's attribution process - which is performed based only on the data available to Singular at that point. Therefore, asking for consent and retrieving the IDFA before the Singular SDK sends the first session is essential.

To delay the firing of a user session, configure the waitForTrackingAuthorizationWithTimeoutInterval option in the SingularSDKObject. This sets the maximum time (in seconds) that the Singular SDK will wait for the user to authorize/deny AppTrackingTransparency Consent before logging events to Singular's servers. The default value for this option is 0 (no wait).

2.3. Handling Deep Links

Deep links are links that lead into specific content inside an app. When a user clicks a deep link on a device that has the app installed, the app opens and shows a specific product or experience.

Singular tracking links can include deep linking as well as deferred deep linking (see our Deep Linking FAQ and the Singular Links FAQ for more information).

The instructions below will show you how to:

1. Access the tracking link that led to your app being opened,
2. Read the deep link destination, and
3. Show the appropriate content.

Setting Up Deep Linking Prerequisites

1. Prerequisites for iOS and Android: Follow the instructions in Singular Links Prerequisites for iOS and/or Android.

2. Additional Setup for Unity: In the app's AndroidManifest.xml file, change the activity name property from the default UnityPlayerActivity:

   <activity android:name="com.unity3d.player.UnityPlayerActivity"

   to:

   <activity android:name="com.singular.unitybridge.SingularUnityActivity"

   or:

   Note: If you've implemented a custom activity, call this method in the onNewIntent in your activity:

   @Override
   protected void onNewIntent(Intent intent) {
       setIntent(intent);
   
       // Call this method from your custom activity in onNewIntent
       SingularUnityBridge.onNewIntent(intent);
   }

Adding a Deep Links Handler

The Singular SDK provides a handler mechanism to read the details of the tracking link that led to the app being opened.

To use the handler:

1. Implement the SingularLinkHandler interface.
2. Call the SetSingularLinkHandler method at any point in the class to register the class as the handler for deep links.
3. When you call SetSingularLinkHandler, the Singular SDK fetches the tracking link and calls the OnSingularLinkResolved method, passing the tracking link details to it. Override this method to read the link details and process them.

The following sample code shows the three steps:

public class Main : SingularLinkHandler {
    // ...
    void Awake () {
      // Register the class as the Singular Link handler.
      // You can call this method at any point in the app's run. It will fetch the tracking link details and call OnSingularLnkResolved.
      SingularSDK.SetSingularLinkHandler(this);
    }
    
    public void OnSingularLinkResolved(SingularLinkParams linkParams) {
      // The deep link destination, as configured in the Manage Links page
      string deeplink = linkParams.Deeplink;
      
      // The passthrough parameters added to the link, if any.
      string passthrough = linkParams.Passthrough;
      
      // Whether the link configured as a deferred deep link.
      bool isLinkDeferred = linkParams.IsDeferred;
      
      // Add code here to process the deeplink
    }
    
    // ...

Method Reference

public void SetSingularLinkHandler(SingularLinkHandler 
handler)

public class Main : MonoBehaviour, SingularLinkHandler {
    void Awake () {
        SingularSDK.SetSingularLinkHandler(this)
    }
}

public void OnSingularLinkResolved(SingularLinkParams
linkParams)

public void OnSingularLinkResolved(SingularLinkParams
linkParams){
    // Read the tracking link details and log them
    Debug.Log("deeplink: " + linkParams.Deeplink);
    Debug.Log("passthrough: " + linkParams.Passthrough);
    Debug.Log("is_deferred: " + linkParams.IsDeferred);
}

Handling Deep Links with Legacy Links

If you are an older Singular customer, you may be using legacy tracking links (Singular's older tracking link mechanism) rather than the newer Singular Links. Legacy links are managed in the Create Link and View Links pages, and they also provide deep linking and deferred deep linking functionality.

If your organization uses legacy links, you need to implement a handler for deep links called SingularDeferredDeepLinkHandler instead of the SingularLinksHandler described above. The implementation is very similar.

public class Main : SingularDeferredDeepLinkHandler {
              
// ...
                
void Awake () {
    // Register the class as the deep link handler.
    // You can call this method at any point in the app's run.
    SingularSDK.SetDeferredDeepLinkHandler(this);
}
                
public void OnDeferredDeepLink(string deeplink) {
    // Code to handle the deep link goes here.
    // In this example, the deep link is just logged.
    Debug.Log ("Deep link received:" + deeplink);
}
                
// ...

2.4. Initializing the SDK

The SDK initialization code should be called every time your app is opened. It is a prerequisite to all Singular attribution functionality and it also sends a new session to Singular that is used to calculate user retention.

By default, SingularSDK.cs initializes the SDK automatically when the scene is created, through the Awake method.

Manual Initialization

If you prefer to initialize the SDK manually at a later point in the app's run, do the following:

1. Disable the Initialize on Awake option in the inspection pane of the SingularSDK object.
2. Use the SingularSDK.InitializeSingularSDK static method to initialize the SDK:

public void InitializeSingularSDK()

// SDK Key and SDK Secret are set on the 
// game object associated with SingularSDK 
SingularSDK.InitializeSingularSDK();

2.5. Optional: Configuring the Session Timeout

By default, if the app runs in the background for 60 seconds or more before returning to the foreground, the Singular SDK registers a new session. You can change the default timeout value by modifying the Session Timeout Sec property of your SingularSDKObject.

2.6. Optional: Setting the User ID

The Singular SDK can send a user ID from your app to Singular. This can be a username, email address, randomly generated string, or whichever identifier you use as a user ID. Singular will use the user ID in user-level data exports as well as internal BI postbacks (if you configure any).

To send the user ID to Singular, call the SetCustomUserId method. To unset the ID (for example, If the user logs out of their account), call UnsetCustomUserId.

public void SetCustomUserId(string customUserId)

SingularSDK.SetCustomUserId("custom_user_id");

public void UnsetCustomUserId()

SingularSDK.UnsetCustomUserId();

3. Tracking Events and Revenue

3.1. Tracking Events

Singular can collect data about in-app events to help analyze the performance of your campaigns and measure KPIs. For example, your organization may want to collect data about user logins, registrations, tutorial completions, or leveling up in a gaming app.

Singular supports a variety of standard events. These commonly used events are often supported by ad networks for reporting and optimization. Another advantage is that when you use standard event names, Singular recognizes them automatically and adds them to the Events list without you having to define them manually. We recommend using standard events whenever possible.

The list of events sent to Singular (with the accompanying attributes) should be compiled by the UA/marketing/business team based on your organization's marketing KPIs. The business team can follow the guide at How to Track In-App Events: Guide For Singular Attribution Customers.

With each event you track, you can pass various attributes. See the recommended standard attributes per event.

In your code, send standard events to Singular using the event or eventWithArgs methods.

public static void Event(string name)
public static void Event(string name, params object[] args)
public static void Event(Dictionary<string, object> args,
string name)

// Send the standard event Login
SingularSDK.Event(sngLogin);
  
// An example custom event passing two key value pairs
SingularSDK.Event("Myevent", "Key1", "Value1", "Key2", 1234);

// An example JSONEvent passing a dictionary
SingularSDK.Event(new Dictionary<string, object>() {
  {"Key1", "Value1"},  
  {"Key2", new Dictionary<string, object>() {
    {"SubKey1", "SubValue1"},
    {"SubKey2", "SubValue2"}
  }
}}, "JSONEvent");

3.2. Tracking Revenue

Singular can collect data about revenue gained through the app in order to help analyze the performance and ROI of your campaigns. Singular will make the data available in reports, log export, and postbacks.

You can track revenue events using Unity's built-in IAP (In-App Purchases) object. This way, Singular gets all the available information about the purchase for richer reporting. Singular also gets the purchase receipt, which Singular uses in the back end to validate the purchase and rule out attribution fraud.

public static void InAppPurchase(Product product,
Dictionary<string, object> attributes, bool isRestored = false)

public static void InAppPurchase(string eventName,
Product product, Dictionary<string, object> attributes, 
bool isRestored = false)

public static void InAppPurchase(IEnumerable<Product> products,
Dictionary<string, object> attributes, bool isRestored = false)

public static void InAppPurchase(string eventName,
IEnumerable<Product> products, Dictionary<string, object> 
attributes, bool isRestored = false)

// IAP with a single product and no extra attributes
SingularSDK.InAppPurchase(myProduct, null);
// IAP with a single product and attributes
var attr = new Dictionary<string, object>() {
["my_first_attribute"] = "value1",
["my_second_attribute"] = "value2"};
 
SingularSDK.InAppPurchase(myProduct, attr);

// IAP with with a single product, 
// no extra attributes and a custom event name

SingularSDK.InAppPurchase("MyCustomProduct",
myProduct, null);

// IAP with list of products, no extra attributes
SingularSDK.InAppPurchase(myProductList, null);

// IAP with with list of products, no extra attributes
// and a custom event name

SingularSDK.InAppPurchase("MyCustomProducts",
myProductList, null);

public static void Revenue(string currency, double amount)

public static void Revenue(string currency,
double amount, string productSKU, string productName,
string productCategory, int productQuantity, double productPrice)

// Send a revenue event with no product details
SingularSDK.Revenue("USD", 9.99);

// Send a revenue event with product details
SingularSDK.Revenue("USD", 50.50, "abc123", "myProductName", 
"myProductCategory", 2, 25.50)

public static void CustomRevenue(string eventName, 
string currency, double amount)

public static void CustomRevenue(string eventName, 
string currency, double amount, string productSKU, 
string productName, string productCategory, int productQuantity, 
double productPrice)

// Send a revenue event with a custom name
SingularSDK.CustomRevenue("MyCustomRevenue", "USD", 9.99);

// Send a revenue event with a custom name + product details
SingularSDK.CustomRevenue("MyCustomRevenue", "USD", 50.50, 
"abc123", "myProductName", "myProductCategory", 2, 25.50)

4. Advanced Options

4.1. 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 
);

4.2. 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 feature needs to be enabled in your Admob account.
// See https://support.google.com/admob/answer/11322405#getstarted

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);  
  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);
Singular.AdRevenue(data);

// The object received from IronSource's event: OnImpressionSuccess
IronSourceImpressionData impressionData;
SingularAdData data = new SingularAdData("IronSource","USD", impressionData.revenue);
Singular.AdRevenue(data);

// Ensure the ARM SDK Postbacks Flag in IronSource is turned on
// See https://developers.is.com/ironsource-mobile/general/ad-revenue-measurement-postbacks/#step-1

// The object received from TradplusAds event: AddGlobalAdImpression
TradplusAds.Instance().AddGlobalAdImpression(OnGlobalAdImpression);

void OnGlobalAdImpression(Dictionary<string, object="object"> adInfo) {
   double revenue = 0;
   double.TryParse(adInfo["ecpm"].ToString(),NumberStyles.Float| NumberStyles.AllowThousands, CultureInfo.InvariantCulture, out revenue);
   if(revenue != 0)
       revenue = revenue / 1000;
   SingularAdData data = new SingularAdData("TradPlus", "USD", revenue);
   SingularSDK.AdRevenue(data);
}

// Initialize the SingularAdData object with the relevant data
SingularAdData data = new SingularAdData(YOUR_AD_PLATFORM,
  CURRENCY_CODE,
  AMOUNT); // e.g., 9.90

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

4.3. 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>

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");

4.4. Adding Global Properties

The Singular SDK lets you define custom additional properties 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. 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();

4.5. 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.

5. Complying with Data Privacy Laws

5.1. LimitDataSharing

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

5.2. 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();