Method 1: Gradle (Recommended)

Add SDK Repository

Configure the Singular Maven repository in your project's dependency management.

Gradle 7+ Configuration

Add the Singular SDK repository to your settings file:

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

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

Older Gradle Versions

For older Gradle versions, add the repository to your project-level build file:

repositories {
    mavenCentral()
    maven {
        url = uri("https://maven.singular.net/")
    }
}

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

Add Singular Library Dependency

Add the Singular library to your app module's dependencies.

dependencies {
    implementation("com.singular.sdk:singular_sdk:12.13.0")
}

dependencies {
    implementation 'com.singular.sdk:singular_sdk:12.13.0'
}

Troubleshooting: Duplicate Class Issues

You may encounter duplicate class errors when multiple dependencies include the same library. This commonly occurs with Google Play Services libraries when using older versions.

Resolution: Exclude Conflicting Dependencies

To resolve duplicate class issues, exclude the conflicting transitive dependency from the Singular SDK or other dependencies causing the conflict.

dependencies {
    // Exclude specific Google Play Services modules from Singular SDK
    implementation("com.singular.sdk:singular_sdk:12.13.0") {
        exclude(group = "com.google.android.gms", module = "play-services")
    }

    // Add the specific Google Play Services libraries your app needs
    implementation("com.google.android.gms:play-services-ads-identifier:17.0.0")
    implementation("com.google.android.gms:play-services-appset:16.0.2")
}

dependencies {
    // Exclude specific Google Play Services modules from Singular SDK
    implementation('com.singular.sdk:singular_sdk:12.13.0') {
        exclude group: 'com.google.android.gms', module: 'play-services'
    }

    // Add the specific Google Play Services libraries your app needs
    implementation 'com.google.android.gms:play-services-ads-identifier:17.0.0'
    implementation 'com.google.android.gms:play-services-appset:16.0.2'
}

Global Exclusion Rules

If the duplicate class conflict affects multiple dependencies across your project, you can apply a global exclusion rule.

configurations.all {
    exclude(group = "com.google.android.gms", module = "play-services")
}

configurations.all {
    exclude group: 'com.google.android.gms', module: 'play-services'
}

Verifying Dependency Resolution

After applying exclusion rules, verify your dependency tree to ensure conflicts are resolved.

./gradlew app:dependencies --configuration debugRuntimeClasspath

This command displays the complete dependency tree for your app, showing which libraries are included and which have been excluded.

Samsung Galaxy Store Support

Add the Samsung Galaxy Store install referrer dependency if your app is distributed through Samsung Galaxy Store.

dependencies {
    implementation("store.galaxy.samsung.installreferrer:samsung_galaxystore_install_referrer:4.0.0")
}

dependencies {
    implementation 'store.galaxy.samsung.installreferrer:samsung_galaxystore_install_referrer:4.0.0'
}

Transitive Dependencies

If you have disabled transitive dependencies for the Singular SDK, manually add these required libraries to your app module's dependencies.

dependencies {
    implementation("com.android.installreferrer:installreferrer:2.2")
    implementation("com.google.android.gms:play-services-appset:16.0.2")
}

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

Google Play Services Dependency

If your app doesn't implement Google Play Services API 17.0.0 or higher, add the following dependency.

dependencies {
    implementation("com.google.android.gms:play-services-ads-identifier:17.0.0")
}

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

Alternative Installation Methods

Manual Download

Download and manually integrate the SDK AAR file into your project.

1. Download the SDK: Download the SDK from the link at the top of this page
2. Extract and add to libs: Unzip the SDK package and add Singular.aar into your Android project's libs directory
3. Create libs directory: If it doesn't exist, create a directory called libs in your project folder (usually at <project>/app/libs )

Maven Installation

Add the Singular Maven repository to your project's pom.xml file.

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

Add the dependency:

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

Eclipse Installation

Integrate the SDK using Eclipse by following these steps.

You can use the Eclipse AAR plugin: gradle-eclipse-aar-plugin

If you don't want to use the plugin, follow these steps:

1. Unzip the AAR: Unzip singular_sdk-12.13.0.aar
2. Rename JAR file: Rename classes.jar to singular_sdk-12.13.0.jar (this is the main SDK jar)
3. Add install referrer: Add the com.android.installreferrer:installreferrer:2.2 library to your project
4. Copy permissions: Copy the BIND_GET_INSTALL_REFERRER_SERVICE permission from the AndroidManifest.xml contained in the AAR to your AndroidManifest.xml
5. Copy license permission: Copy the CHECK_LICENSE permission from the AndroidManifest.xml contained in the AAR to your AndroidManifest.xml