public abstract class

AppLovinSdk

extends Object
java.lang.Object
   ↳ com.applovin.sdk.AppLovinSdk

Class Overview

This is a base class for AppLovin Ad SDK.

Summary

Constants
String VERSION Current SDK version
int VERSION_CODE
Fields
protected static AppLovinSdkImpl[] sdkInstances
protected static final Object sdkInstancesLock
Public Constructors
AppLovinSdk()
Please use AppLovinSdk.getInstance(Context context) rather than instantiating this class directly.
Public Methods
abstract AppLovinAdService getAdService()
Get an instance of the AppLovin Ad service.
abstract AppLovinEventService getEventService()
Get an instance of the AppLovin event service.
static AppLovinSdk getInstance(Context context)
Get instance of AppLovin SDK that is configured in AndroidManifest.xml.
static AppLovinSdk getInstance(String sdkKey, AppLovinSdkSettings userSettings, Context context)
Get an instance of AppLovin SDK.
static AppLovinSdk getInstance(AppLovinSdkSettings settings, Context context)
Get instance of AppLovin SDK that is configured in AndroidManifest.xml.
abstract String getMediationProvider()
Get the mediation provider that was last set using setMediationProvider(String), or null if none was set.
abstract AppLovinMediationService getMediationService()
Get an instance of the AppLovin mediation service.
abstract AppLovinNativeAdService getNativeAdService()
Get an instance of the AppLovin native ad service.
abstract AppLovinPostbackService getPostbackService()
Get an instance of the AppLovin postback service.
abstract AppLovinSdkSettings getSettings()
Get SDK settings provided on initialization
abstract String getUserIdentifier()
Get the last set user identifier.
abstract boolean hasCriticalErrors()
Check if SDK has a critical error prior to initialization.
static void initializeSdk(Context context)
Intialize the default version of the SDK.
abstract void initializeSdk()
Initialize current version of the SDK
abstract boolean isEnabled()
Check if SDK is enabled.
abstract void setMediationProvider(String mediationProvider)
Set mediation provider using one of the provided strings above specified by AppLovinMediationProvider, or your own if not defined.
abstract void setUserIdentifier(String userIdentifier)
Set a user identifier that will be passed through to your server via S2S postbacks.
[Expand]
Inherited Methods
From class java.lang.Object

Constants

public static final String VERSION

Current SDK version

Constant Value: "8.1.0"

public static final int VERSION_CODE

Constant Value: 810 (0x0000032a)

Fields

protected static AppLovinSdkImpl[] sdkInstances

protected static final Object sdkInstancesLock

Public Constructors

public AppLovinSdk ()

Please use AppLovinSdk.getInstance(Context context) rather than instantiating this class directly.

Public Methods

public abstract AppLovinAdService getAdService ()

Get an instance of the AppLovin Ad service. This service is used to fetch ads from AppLovin servers, track clicks and conversions.

Returns
  • Ad service. Guaranteed not to be null.

public abstract AppLovinEventService getEventService ()

Get an instance of the AppLovin event service. This service is used to track post-install user events.

Returns
  • Event service. Guaranteed not to be null.

public static AppLovinSdk getInstance (Context context)

Get instance of AppLovin SDK that is configured in AndroidManifest.xml. Please make sure that AndroidManifest.xml includes following line:

     <application>
                     . . .
         <meta-data android:value="YOUR_SDK_KEY_HERE" android:name="APPLOVIN_SDK_KEY" />
     </application>
 

Parameters
context Android application context. Must not be null.
Returns
  • An instance of AppLovinSDK

public static AppLovinSdk getInstance (String sdkKey, AppLovinSdkSettings userSettings, Context context)

Get an instance of AppLovin SDK.

Parameters
sdkKey Client SDK's key.
userSettings User-provided settings. May be null.
context Android context. Must not be null. Note that a reference to context.getApplicationContext() will be persisted by the API.
Returns
  • An instance of AppLovinSDK

public static AppLovinSdk getInstance (AppLovinSdkSettings settings, Context context)

Get instance of AppLovin SDK that is configured in AndroidManifest.xml. Please make sure that AndroidManifest.xml includes following line:

     <application>
                     . . .
         <meta-data android:value="YOUR_SDK_KEY_HERE" android:name="APPLOVIN_SDK_KEY" />
     </application>
 

Parameters
settings Settings to use with an SDK. Must not be null.
context Android application context. Must not be null.
Returns
  • An instance of AppLovinSDK

public abstract String getMediationProvider ()

Get the mediation provider that was last set using setMediationProvider(String), or null if none was set.

Returns
  • The mediation provider that was last set, or null if none was set.

public abstract AppLovinMediationService getMediationService ()

Get an instance of the AppLovin mediation service. This service is used to track and manipulate third-party SDK adapters.

Returns
  • Mediation service. Guaranteed not to be null.

public abstract AppLovinNativeAdService getNativeAdService ()

Get an instance of the AppLovin native ad service. This service is used to fetch in-content ads from AppLovin servers, track clicks and conversions.

Returns
  • Ad service. Guaranteed not to be null.

public abstract AppLovinPostbackService getPostbackService ()

Get an instance of the AppLovin postback service. This service is used to dispatch HTTP GET postbacks to arbitrary URLs.

Returns
  • Postback service. Guaranteed not to be null.

public abstract AppLovinSdkSettings getSettings ()

Get SDK settings provided on initialization

Returns
  • Provided settings.

public abstract String getUserIdentifier ()

Get the last set user identifier.

Returns
  • Any user identifier you have previously provided us. Otherwise, null.

public abstract boolean hasCriticalErrors ()

Check if SDK has a critical error prior to initialization. Critical errors could occur when SDK is ran on a device with API level lower then 8.

Returns
  • True if API is disabled because of a critical error.

public static void initializeSdk (Context context)

Intialize the default version of the SDK.

Please make sure that AndroidManifest.xml includes following line:

     <application>
                     . . .
         <meta-data android:name="applovin.sdk.key" android:value="APPLOVIN_SDK_KEY" />
     </application>
 

Parameters
context Android application context. Must not be null.

public abstract void initializeSdk ()

Initialize current version of the SDK

public abstract boolean isEnabled ()

Check if SDK is enabled. SDK is enabled when (1) client successfully registered with the AppLovin server and (2) client is not banned from the server.

Returns
  • True if API is ready to be used.

public abstract void setMediationProvider (String mediationProvider)

Set mediation provider using one of the provided strings above specified by AppLovinMediationProvider, or your own if not defined.

Parameters
mediationProvider The name of the mediation provider.

public abstract void setUserIdentifier (String userIdentifier)

Set a user identifier that will be passed through to your server via S2S postbacks.

If you are using reward validation, you can pass us a user identifier as a String. This could be something like a username, for example. We will pass it to your server when we make our S2S call during reward validation.

Parameters
userIdentifier Some string which will be passed to your server later, for purposes of identifying the user who should receive a reward.