Adding the SDK to Your Project

To add the SDK using Gradle:

1. 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.android.support:appcompat-v7:21.0.3'
       ...
       implementation 'com.singular.sdk:singular_sdk:12.1.1'
       ...
   }

3. If you have disabled transitive dependencies for the Singular SDK, add 'com.android.installreferrer:installreferrer:2.2' and 'com.google.android.gms:play-services-appset:16.0.0' to your app's build.gradle.

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

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

To add the SDK if you don't use 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.** { *; }

Setting Up Prerequisites

Adding 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" />

Note: If you're integrating the Kids SDK, you shouldn't add this permission.

Importing the Singular Library

To import the Singular library, add the following code:

import com.singular.sdk.*;

Initializing the Singular 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 user session to Singular. Sessions are used to calculate user retention.

1. Constructing the SingularConfig Object

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

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.

To create a basic SingularConfig object use this code:

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

However, you will probably want to add settings to enable various capabilities offered by Singular.

To add settings, you will use the SingularConfig object's ".with" methods. For example:

// Configure the SDK to pass the user ID to Singular
// and set the session timeout to 120 seconds
SingularConfig config = new SingularConfig("SDK KEY", "SDK SECRET")
    .withCustomUserId(UserId)
    .withSessionTimeoutInSec(120)

Read the rest of this SDK guide to learn about the various settings available.

2. Initializing Singular

After creating the SingularConfig object, initialize Singular using the init method, passing the config object.

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.

@Override
protected void onCreate(Bundle savedInstanceState) {
    ...
    Singular.init(context, config);
    ...
}

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 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 call unsetCustomUserId if the user logs out.

Singular.setCustomUserId("custom_user_id");

Singular.unsetCustomUserId();