Skip to main content

Android - Adapty SDK Installation and configuration

Adapty comprises two crucial SDKs for seamless integration into your mobile app:

  • Core AdaptySDK: This is a fundamental, mandatory SDK necessary for the proper functioning of Adapty within your app.
  • AdaptyUI SDK: This optional SDK becomes necessary if you use the Adapty Paywall builder: a user-friendly, no-code tool for easily creating cross-platform paywalls. These paywalls are built in a visual constructor right in our dashboard, run entirely natively on the device, and require minimal effort from you to create something that performs well.

You can install Adapty SDK via Gradle.

danger

Go through the release checklist before releasing your app

Before releasing your application, make sure to carefully review the Release Checklist thoroughly. This checklist ensures that you've completed all necessary steps and provides criteria for evaluating the success of your integration.

Install via Gradle​

dependencies {
    ...
    implementation platform('io.adapty:adapty-bom:3.1.1')
    implementation 'io.adapty:android-sdk'
    implementation 'io.adapty:android-ui'
    implementation 'io.adapty:android-ui-video' // Required only if using video in Paywall Builder
}

If the dependency is not being resolved, please make sure that you have mavenCentral() in your Gradle scripts.

The instruction on how to add it

If your project doesn't have dependencyResolutionManagement in your settings.gradle, add the following to your top-level build.gradle at the end of repositories:

top-level build.gradle
allprojects {
    repositories {
        ...
        mavenCentral()
    }
}

Otherwise, add the following to your settings.gradle in repositories of dependencyResolutionManagement section:

settings.gradle
dependencyResolutionManagement {
    ...
    repositories {
        ...
        mavenCentral()
    }
}

Configure Proguard​

You should add -keep class com.adapty.** { *; } to your Proguard configuration.

Configure Adapty SDK​

Add the following to your Application class:

override fun onCreate() {
    super.onCreate()
    Adapty.activate(
      applicationContext,
      AdaptyConfig.Builder("PUBLIC_SDK_KEY")
          .withObserverMode(false) //default false
          .withCustomerUserId(customerUserId) //default null
          .withIpAddressCollectionDisabled(false) //default false
          .build()
    )  
      
    //OR 
    //the method is deprecated since Adapty SDK v2.10.5
    
    Adapty.activate(applicationContext, "PUBLIC_SDK_KEY", observerMode = false, customerUserId = "YOUR_USER_ID")
}

Configurational options:

ParameterPresenceDescription
PUBLIC_SDK_KEYrequired

The key you can find in the Public SDK key field of your app settings in Adapty: App settings-> General tab -> API keys subsection.

Make sure you use the Public SDK key for Adapty initialization, the Secret key should be used for server-side API only.

observerModeoptional

A boolean value that controls Observer mode. Turn it on if you handle purchases and subscription status yourself and use Adapty for sending subscription events and analytics. The default value is false.

🚧 When running in Observer mode, Adapty SDK won't close any transactions, so make sure you're handling it.

customerUserIdoptionalAn identifier of the user in your system. We send it in subscription and analytical events, to attribute events to the right profile. You can also find customers by customerUserId in the Profiles and Segments menu. If you don't have a user ID at the time of Adapty initialization, you can set it later using .identify() method. Read more in the Identifying users section.
ipAddressCollectionDisabledoptional

A boolean parameter. Set to true to disable the collection of the user IP address. The default value is false.

Parameter works with AdaptyConfig.Builder only.

note

SDK keys are unique for every app, so if you have multiple apps make sure you choose the right one.

Set up the logging system​

Adapty logs errors and other important information to help you understand what is going on. There are the following levels available:

LevelDescription
AdaptyLogLevel.NONENothing will be logged. Default value
AdaptyLogLevel.ERROROnly errors will be logged
AdaptyLogLevel.WARNErrors and messages from the SDK that do not cause critical errors, but are worth paying attention to will be logged.
AdaptyLogLevel.INFOErrors, warnings, and various information messages will be logged.
AdaptyLogLevel.VERBOSEAny additional information that may be useful during debugging, such as function calls, API queries, etc. will be logged.

You can set the log level in your app before configuring Adapty.

Adapty.logLevel = AdaptyLogLevel.VERBOSE

Redirect the logging system messages​

If you for some reason need to send messages from Adapty to your system or save them to a file, you can override the default behavior:

Adapty.setLogHandler { level, message ->
    //handle the log
}