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. Adding the SDK to Your Project

1.1 Adding the SDK Using Gradle

1. Add the Singular SDK repository to the settings.gradle file:

   dependencyResolutionManagement {
        repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
        repositories {
             google()
             mavenCentral()
             maven { url 'https://maven.singular.net/' }
        }
   }

   OR in older Gradle versions, Add the Singular SDK repository to the project/build.gradle file:

   repositories {
           mavenCentral()
           maven { url 'https://maven.singular.net/' }
       }

2. Add the Singular library to the dependencies list in app/build.gradle:

   dependencies {
       implementation 'com.google.android.gms:play-services:6.5.87'
       implementation fileTree(dir: 'libs', include: ['*.jar'])
       ...
       implementation 'com.singular.sdk:singular_sdk:12.3.0'
       ...
   }

3. If you have disabled transitive dependencies for the Singular SDK, add the following to your app/build.gradle:

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

    

4. If your app doesn't implement Google Play Services API 17.0.0 or higher, add the following dependency to the app/build.gradle file:

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

1.2. Adding the SDK Without Gradle

<project ...>
<repositories>
    <repository>
      <id>singular.net</id>
      <url>http://maven.singular.net/</url>
    </repository>
 </repositories>
</project>

<dependency>
    <groupId>com.singular.sdk</groupId>
    <artifactId>singular_sdk</artifactId>
    <version>12.0.2</version>
</dependency>

-keep class com.singular.sdk.** { *; }
-keep public class com.android.installreferrer.** { *; }
# Uncomment this line in case your are calling the 'revenue' function using the Google billing library
#-keep public class com.android.billingclient.** { *; }

1.3. Adding Required Permissions

Add these permissions under the <manifest> tag in your AndroidManifest.xml file:

<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
<uses-permission android:name="BIND_GET_INSTALL_REFERRER_SERVICE" />
<uses-permission android:name="com.android.vending.CHECK_LICENSE" />

If your app build is targeting Android 12/API level 31 or higher, add permissions to access the Google Advertising ID:

<uses-permission android:name="com.google.android.gms.permission.AD_ID" />

2. Setting Up a Basic SDK Integration

2.1. Importing the Singular Library

To import the Singular library, add the following import to your MainActivity file:

import com.singular.sdk.*;

import com.singular.sdk.*

2.2. Constructing a Configuration Object

Before initializing the SDK, you have to create a SingularConfig object. This object will contain the following:

1. Your SDK Key and SDK Secret (to retrieve them, log into your Singular account and go to Developer Tools > SDK Keys).
2. Optionally, any SDK preferences you may want to set.

The following code example creates a configuration object and sets the common configuration options before initializing the Singular SDK.

The following sections give more details about these options and how you can customize them.

@Override
protected void onCreate(Bundle savedInstanceState) {
    ...
    // Create a configuration object
    SingularConfig config = new SingularConfig("SDK KEY", "SDK SECRET");

    // Set up a deep links handler
    config.withSingularLink(
        getIntent(), 
        new SingularLinkHandler() {
            @Override
            public void onResolved(SingularLinkParams params) {
                String deeplink = params.getDeeplink();
                String passthrough = params.getPassthrough();
                boolean isDeferred = params.isDeferred();

                // Add deep link handling code here
            }
        }
    );

    Singular.init(context, config);
    
    ...
}

override fun onCreate(savedInstanceState: Bundle?) {
    super.onCreate(savedInstanceState)

    // Create a configuration object
    val config = SingularConfig("SDK KEY", "SDK SECRET")

    // Set up a deep links handler
    config.withSingularLink(
        intent
    ) { params ->
        val deeplink = params.deeplink
        val passthrough = params.passthrough
        val isDeferred = params.isDeferred

        // Add deep link handling code here
    }

    Singular.init(this, config)

    ...
}

Note: You can get your Singular SDK Key and SDK Secret in the Singular platform at Developer Tools > SDK Keys.

2.3. Adding Deep Linking Support

Deep links are links that lead to specific content inside an app. When a user clicks a deep link on a device with 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).

Enabling Deep Links Using Singular Links

To enable deep links for your app, see Singular Links Prerequisites.

Adding a Deep Linking Intent Filter

Add an intent filter like the following to your AndroidManifest.xml to enable deep link support in an activity. If you have more than one activity that should be opened through a deep link, do this for each activity.

<activity> 
    <intent-filter>
        <data android:scheme="singular-example" />
        <action android:name="android.intent.action.VIEW" />
        <category android:name="android.intent.category.DEFAULT" />
        <category android:name="android.intent.category.BROWSABLE" />
    </intent-filter>
</activity>

Handling Deep Links

The Singular SDK provides a handler mechanism to read the details of the tracking link that led to the app being opened. A sample handler is included above in the sample code for Constructing a Configuration Object.

Modifying the Deferred Deep Link Timeout

By default, when an app sends the first session to Singular from a certain device, the Singular server looks in its records to see if there is a deferred deep link that matches that device (see What are deferred deep links?). If a deferred deep link is found, it is sent back to the app to process. But if no deferred deep link is found within 60 seconds, the server stops searching.

You can modify the timeout value by calling withDDLTimeoutInSec when you create the SingularConfig object. The example below changes the timeout to 30 seconds:

SingularConfig config = new SingularConfig("SDK KEY", "SDK SECRET");
...
config.withDDLTimeoutInSec(30);
...
Singular.init(context, config);

Handling Non-Singular Deep Links

The Singular SDK supports non-Singular-served deep links. This is required to measure attribution for partners such as Google Ads.

Starting with Android SDK version 12.1.1, non-Singular Universal Links are supported by default. No action is needed on your part to support third-party links if you have the new version of the SDK.

SingularConfig config = new SingularConfig("SDK KEY", "SDK SECRET");

// supportedDomains
List<String> supportedDomains = Arrays.asList("subdomain.mywebsite.com", "subdomain.myotherwebsite.com");
config.withSingularLink(
    getIntent(), 
    new SingularLinkHandler() {
        @Override
        public void onResolved(SingularLinkParams params) {
            // handle callback
        }
    }, 
    supportedDomains
);

2.4. Initializing Singular

The Singular SDK should be initialized every time your app is opened. This is a prerequisite to all Singular attribution functionality, and it also sends a new user session to Singular (sessions are used to calculate user retention).

To initialize Singular, use the following code:

Singular.init(context, config);

The init method can be called at every point in the app but must get called before any event is reported. We recommend calling init in the onCreate of the main activity as well as any activity that will be opened directly by a deep link.

2.5. Sending the User ID to Singular (Optional)

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 uses the user ID in user-level data exports as well as internal BI postbacks (if you configure such postbacks).

There are two ways to send the user ID to Singular:

• Recommended: If you know the user ID when the app opens, set the user ID in the SingularConfig object before initializing the SDK. This makes the user ID available to Singular from the very first session.

  SingularConfig config = new SingularConfig("SDK KEY","SDK SECRET")
      .withCustomUserId("custom_user_id");
      ...
  Singular.init(context, config);

• Alternatively, you can call the setCustomUserId method at any point in the run.

The user ID persists until you unset it using unsetCustomUserId or until the app is uninstalled. Closing/restarting the app does not unset the user ID.

In many cases, you will want to call setCustomUserId when the user logs in to your service and unsetCustomUserId if the user logs out.

Singular.setCustomUserId("custom_user_id");

Singular.unsetCustomUserId();

2.6. Implementing Global Properties (Optional)

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

• You can define up to 5 global properties.
• They persist between app runs (with the latest value you gave them) until you unset them or the user uninstalls the app.
• Each property name and value can be up to 200 characters long. If you pass a longer property name or value, it will be truncated to 200 characters.
• Global properties are accessible and available in user-level exports and postbacks. In the future, aggregate reporting support will be added. Let your Singular customer success manager know if you have any questions, or are interested in updates to global properties support!

Setting Global Properties through SingularConfig

You can use the withGlobalProperty method to set global properties through SingularConfig before initializing the SDK.

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.

// Set two global properties and override any existing values
SingularConfig config = new SingularConfig("SDK KEY", "SDK SECRET")
  .withGlobalProperty(“MyProperty”, “MyValue”, true)
  .withGlobalProperty(“AnotherProperty”, “AnotherValue”, true);

Setting Global Properties After Initialization

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

boolean result = Singular.setGlobalProperty(“MyProperty”, “MyValue”, true);

Map<String, String> map = Singular.getGlobalProperties();

Singular.unsetGlobalProperty(“MyProperty”);

Singular.clearGlobalProperties();

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.

What are Standard Events and Attributes?

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.

Sending Events

In your code, send events to Singular using the eventJSON or event methods (we recommend eventJSON for readability).

• For standard events, use the event's Android name as it appears in the list of standard events and attributes for the Android SDK, e.g., sngTutorialComplete. See the code examples below.
• If you send any custom events (events that your organization wants to measure that do not match any of Singular's standard events), use any string you like that complies with the limitations.

// Example 1:
// Send the standard event sng_tutorial_complete with the
// recommended standard attributes
JSONObject att = new JSONObject();
att.put(Attributes.sngAttrContent.toString(), <TUTORIAL NAME>);
att.put(Attributes.sngAttrContentId.toString(), <CONTENT ID>);
att.put(Attributes.sngAttrContentType.toString(), <TYPE OF CONTENT>);
att.put(Attributes.sngAttrSuccess.toString(), <LOGIN SUCCESS VALUE>);

Singular.eventJSON(Events.sngTutorialComplete.toString(), att);

// Example 2:
// Send a custom event named "bonus_points_earned" with a custom attribute
JSONObject att = new JSONObject();
att.put("Points", 500);
Singular.eventJSON("Bonus Points Earned", att);

// Example 1:
// Send the standard event sng_tutorial_complete with the
// recommended standard attributes
val att = new JSONObject()
att.put(Attributes.sngAttrContent.toString(), "TUTORIAL NAME")
att.put(Attributes.sngAttrContent.toString(), "CONTENT ID")
att.put(Attributes.sngAttrContent.toString(), "TYPE OF CONTENT")
att.put(Attributes.sngAttrContent.toString(), "LOGIN SUCCESS VALUE")

Singular.eventJSON(Events.sngTutorialComplete.toString(), att)

// Example 2:
// Send a custom event named "bonus_points_earned" with a custom attribute
val att = new JSONObject()
att.put("Points", 500)
Singular.eventJSON("Bonus Points Earned", att)

// Example 1:
// Send the standard event sng_tutorial_complete with the
// recommended standard attributes
Singular.event(Events.sngTutorialComplete.toString(),
  Attributes.sngAttrContent.toString(), <TUTORIAL NAME>,
  Attributes.sngAttrContentId.toString(), <CONTENT ID>,
  Attributes.sngAttrContentType.toString(), <TYPE OF CONTENT>,
  Attributes.sngAttrSuccess.toString(), <SUCCESS>
);

// Example 2:
// Send the standard event "Subscribe" (sng_subscribe), no attributes
Singular.event(Events.sngSubscribe.toString());

// Example 3:
// Send a custom event named "bonus_points_earned" with a custom attribute
Singular.event("Bonus Points Earned", "Points", 500);

// Example 1:
// Send the standard event sng_tutorial_complete with the
// recommended standard attributes
Singular.event(Events.sngTutorialComplete.toString(),
  Attributes.sngAttrContent.toString(), "TUTORIAL NAME",
  Attributes.sngAttrContentId.toString(), "CONTENT ID",
  Attributes.sngAttrContentType.toString(), "TYPE OF CONTENT",
  Attributes.sngAttrSuccess.toString(), "SUCCESS"
)

// Example 2:
// Send the standard event "Subscribe" (sng_subscribe), no attributes
Singular.event(Events.sngSubscribe.toString())

// Example 3:
// Send a custom event named "bonus_points_earned" with a custom attribute
Singular.event("Bonus Points Earned", "Points", 500)

3.2. Tracking Revenue

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

Tracking Revenue Using the Purchase Object

When reporting revenue events to Singular, we recommend passing the purchase object received from the billing library. This has two advantages:

1. Singular gets all the details of the transaction, which enriches your Singular reports.
2. Singular gets the transaction receipt from Google which can be used to validate the transaction in the context of fighting in-app fraud.

Use the revenue and customRevenue methods to report events. CustomRevenue allows you to pass a custom event name, so that you'll be able to view revenue in Singular reports broken down by the different types of revenue events.

Note: Any revenue reported in a different currency will be auto-converted to your organization's preferred currency, as set in your Singular account.

// Send a revenue event to Singular + the purchase object
// that was received from the Google Billing Library 
Singular.revenue("USD", 5.50, purchase);

// Send a revenue event to Singular, passing the event 
// name and the purchase object
Singular.customRevenue("MyCustomRevenue", "USD", 
    5.50, purchase);

Reporting Revenue without the Purchase Object

While we strongly recommend reporting revenue events the way described above, you can also use revenue and customRevenue without passing the purchase object. Instead, you pass the currency and amount of the transaction, and optional product details.

Note that when reporting revenue events this way, Singular does not get the purchase receipt and cannot validate the transaction.

// Send a revenue event to Singular with product details
Singular.revenue("EUR", 5.00, "SKU1928375", 
"Reservation Fee", "Fee" , 1, 5.00);

// Send a revenue event to Singular with no product details
Singular.revenue("USD", 5.50);

// Send a revenue event to Singular with the event name
// and product details
Singular.customRevenue("MyCustomRevenue", "EUR", 5.00, 
"SKU1928375", "Reservation Fee", "Fee" , 1, 5.00);

// Send a revenue event to Singular with the event name
Singular.customRevenue("MyCustomRevenue", "USD", 5.50);

4. Advanced Options

4.1. Creating Short Referrer Links

Note: This functionality is available in SDK version 12.1.1+. Once created, short links remain active for 30 days.

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.

// Create a JSON object to add parameters to the Singular Link (if they don't exist in the link URL yet)
JSONObject params = new JSONObject();       
try {
      params.put("channel","sms");
      params.put("another parameter","parameter value");
} catch (JSONException e) {
      e.printStackTrace();
}

Singular.createReferrerShortLink (
  "https://sample.sng.link/D52wc/cuvk?pcn=test", // The original Singular Link URL
  "Referrer Name",
  "Referrer ID",
  params,
  new ShortLinkHandler() { 
    @Override
      public void onSuccess(final String shortLinkURL) {
        view.post(new Runnable() {
          @Override
          public void run() {
            // Add your share logic here
          }   
        });
      }

    @Override
    public void onError(final String error) {  
      view.post(new Runnable() {    
        @Override
        public void run() { 
          // Logic to retry/abort/modify the params passed to 
          // the function, based on the cause of the error
        }
      });
    }
});

// Create a JSON object to add parameters to the Singular Link (if they don't exist in the link URL yet)
val params = JSONObject()
try {
    params.put("channel", "sms")
    params.put("another parameter", "parameter value")
} catch (e: JSONException) {
    e.printStackTrace()
}

Singular.createReferrerShortLink(
    "https://sample.sng.link/D52wc/cuvk?pcn=test",  // The original Singular Link URL
    "Referrer Name",
    "Referrer ID",
    params,
    object : ShortLinkHandler {
        override fun onSuccess(shortLinkURL: String) {
            view.post(Runnable {
                // Add your share logic here
            })
        }

        override fun onError(error: String) {
            view.post(Runnable {
                // Logic to retry/abort/modify the params passed to
                // the function, based on the cause of the error
            })
        }
    })

4.2. Adding Ad Revenue Attribution Support

Note: Starting in version 11.0.0, Singular added the option to set up ad revenue attribution through the Singular SDK. You still have the option of setting up ad revenue attribution the old way (using API calls), which doesn't require you to update the Singular SDK in your apps.

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

@Override
public void onAdLoaded(@NonNull RewardedAd rewardedAd) {
  mRewardedAd = rewardedAd;
  
  // Set paid event listener
  mRewardedAd.setOnPaidEventListener(new OnPaidEventListener() {
    @Override
    public void onPaidEvent(AdValue adValue) {
      AdValue impressionData = adValue;
      
      SingularAdData data = new SingularAdData("AdMob", impressionData.getCurrencyCode(),
      impressionData.getValueMicros()/1000000.0);
            
      Singular.adRevenue(data);
    }
  });
}

// The object received from AppLovin MAX's event: onMessageReceived
AppLovinCommunicatorMessage message;
Bundle adData = message.getMessageData();

SingularAdData data = new SingularAdData("AppLovin", "USD", adData.getDouble("revenue"));
Singular.adRevenue(data);

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

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

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

TradPlusSdk.setGlobalImpressionListener(new GlobalImpressionManager.GlobalImpressionListener() {
  @Override
  public void onImpressionSuccess(TPAdInfo tpAdInfo) {
    if(tpAdInfo == null) return;
    double revenue = Double.parseDouble(tpAdInfo.ecpm) / 1000;
    SingularAdData data = new SingularAdData("TradPlus", "USD", revenue);
    Singular.adRevenue(data);
  }
});

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

// Report the data to Singular
Singular.adRevenue(data);

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

I. 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 the Google Play Store.

Users/devices who are not running on supported versions of Android will not be available for Singular uninstall tracking.

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

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

4.4. Collecting the Install Referrer on Older Devices

Note: Google is deprecating the install_referrer intent broadcast. See: Still Using InstallBroadcast? Switch to the Play Referrer API by March 1, 2020

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:

If you have an existing install referrer receiver:

Chances are your app already has a BroadcastReceiver that receives the INSTALL_REFERRER from Android.

If so, just go into the BroadcastReceiver's onReceive method and add the following line:

new SingularInstallReceiver().onReceive(context, intent);

For example, if your existing receiver is called MyCustomInstallReceiver, it should look as follows:

public class MyCustomInstallReceiver extends BroadcastReceiver {
    @Override
    public void onReceive(Context context, Intent intent) {
        // Pass install referrer information on to Singular
        new SingularInstallReceiver().onReceive(context, intent);
        // ...
    }
}

If there is no other install referrer receiver:

If you don't have any install referrer receiver in your app, you can let the Singular SDK register the only receiver simply by adding the following to your <application> tag in your manifest file:

<receiver android:exported="true" android:name="com.singular.sdk.SingularInstallReceiver">
    <intent-filter>
        <action android:name="com.android.vending.INSTALL_REFERRER" />
    </intent-filter>
</receiver>

4.5. Managing Sessions

For Android API 14 (Ice Cream Sandwich) and above, the Singular SDK can handle session management automatically. If your app's minSdkVersion is 14 or higher, no additional configuration is required for session management.

Modifying the Session Timeout

By default, if the app runs in the background for 60 seconds or more before returning to the foreground, the SDK registers a new session.

To change the timeout value, use withSessionTimeoutInSec(<timeout in seconds>) in SingularConfig before initializing the SDK.

For example:

// Set the session timeout to 120 seconds
SingularConfig config = new SingularConfig("SDK KEY", "SDK SECRET")
.withSessionTimeoutInSec(120); 

Manual Session Management

If your app's minSdkVersion is below 14, you need to manage sessions manually by calling the Singular's SDK two session-handling methods, onActivityPaused and onActivityResumed, from each of your activities.

Note: If you have a custom common base activity class from which all other activities are derived, you can place these calls to onActivityResumed and onActivityPaused in the common activity's "onResume and onPause methods.

@Override
protected void onResume() {
    super.onResume();
    Singular.onActivityResumed();
    .... //other code if any
}

@Override
protected void onPause() {
    super.onPause();
    Singular.onActivityPaused();
    .... //other code if any
}

4.6. Using the JavaScript Interface

Singular provides a JavaScript interface that you can use in order to call Singular from within javaScript code in your app.

For example, if you set up the JavaScript interface, you can send events to Singular from JavaScript code as follows:

Event Example

SingularInterface.event('event');
SingularInterface.event('test',
    JSON.stringify({"a1":"bar", "a2":"boo", "a3":"baz"}));

The interface supports the following SDK methods:

• setCustomUserID
• unsetCustomUserID
• event
• revenue

To enable the JavaScript interface, add the following lines of code to your main activity, where "myWebView" is the name of your webview.

SingularJSInterface singularJSInterfaceInstance = new SingularJSInterface(this);
singularJSInterfaceInstance.setWebViewId(R.id.webview);
myWebView.addjavascriptInterface(singularJSInterfaceInstance, "SingularInterface");

Your onCreate method may look like this:

public void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);
    setContentView(R.layout.main);

    WebView myWebView = (WebView) this.findViewById(R.id.webview);
    WebSettings webSettings = myWebView.getSettings();
    webSettings.setjavaScriptEnabled(true);
    myWebView.loadUrl("file:///android_asset/index.html");

    SingularConfig config = new SingularConfig("SDK KEY", "SDK SECRET");
    Singular.init(this, config);
    SingularJSInterface singularJSInterfaceInstance = 
        new SingularJSInterface(this);
    singularJSInterfaceInstance.setWebViewId(R.id.webview);
    myWebView.addjavascriptInterface(singularJSInterfaceInstance,
        "SingularInterface");
}

4.7. Collecting the OAID (Open Advertising ID)

In countries that do not use Google Play, Android devices do not have a Google Advertising ID (GAID, also called AIFA in Singular). Instead, the devices may offer an identifier called OAID (Open Advertising Identifier) that can be used to track sessions and events coming from the device.

OAID is currently offered on devices by Huawei and by brands that belong to the Mobile Security Alliance (MSA).

For your app to collect the OAID, you first have to integrate the MSA SDK and Huawei OAID SDK. You need to integrate both SDKs to be able to collect the OAID on all the platforms that offer it.

Then, to tell the Singular SDK to use OAID for tracking, add a call to withOAIDCollection in the config object before initializing Singular.

SingularConfig config = new SingularConfig("SDK KEY","SDK SECRET")
    .withOAIDCollection();
Singular.init(context, config);

The Singular SDK will automatically detect if the device has an OAID as well as which OAID SDK should be used to collect the identifier.

4.8. Collecting the IMEI Number

If your app is offered in countries that do not use Google Play, devices do not have a Google Advertising ID. In this case, you may want to collect the device IMEI (International Mobile Equipment Identity) instead.

Note: If you use Google Play Services, you should not collect the IMEI number because it's a violation of the Google Play service agreement.

To collect the IMEI number:

Add the android.permission.READ_PHONE_STATE permission to the app's AndroidManifest.xml file:

<uses-permission android:name="android.permission.READ_PHONE_STATE"/>

Add code like the following to fetch the device's IMEI number:

TelephonyManager telephonyManager = (TelephonyManager)getSystemService(Context.TELEPHONY_SERVICE);

String imei = null;

if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.O) {
    imei = telephonyManager.getImei();
} else {
    imei = telephonyManager.getDeviceId();
}

To send the IMEI number to Singular, use one of the following methods:

Recommended: Set the IMEI number in SingularConfig using withIMEI before you initialize the Singular SDK, as in the following example. This makes the IMEI number available to Singular from the very first session.

SingularConfig config = new SingularConfig("SDK KEY","SDK SECRET")
  .withIMEI("537769845792516");
Singular.init(context, config);

To set the IMEI number at any point in the code after the SDK initialization, call setIMEI.

Singular.setIMEI(IMEIString);

4.9. 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 Singular.limitDataSharing(false) to indicate that the user consented (opted in) to share their information.

Use Singular.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 into sharing data
Singular.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.

Singular.trackingOptIn();

Singular.stopAllTracking();

Singular.resumeAllTracking();

Singular.isAllTrackingStopped();