public final class

AppLovinSdk

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

Class Overview

This is a base class for AppLovin Ad SDK.

Summary

Nested Classes
interface AppLovinSdk.SdkInitializationListener Listener interface to be used with initializeSdk(SdkInitializationListener)  
Fields
public static final String VERSION Current SDK version.
public static final int VERSION_CODE
Public Methods
AppLovinAdService getAdService()
Get an instance of the AppLovin Ad service.
AppLovinSdkConfiguration getConfiguration()
Get the SDK configuration object provided upon initialization.
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.
String getMediationProvider()
Get the mediation provider that was last set using setMediationProvider(String), or null if none was set.
AppLovinNativeAdService getNativeAdService()
Get an instance of the AppLovin native ad service.
AppLovinPostbackService getPostbackService()
Get an instance of the AppLovin postback service.
AppLovinSdkSettings getSettings()
Get SDK settings provided on initialization
String getUserIdentifier()
An identifier for the current user.
AppLovinUserService getUserService()
Get an instance of the AppLovin user service object for performing user-related tasks.
AppLovinVariableService getVariableService()
Get an instance of the AppLovin variable service.
boolean hasCriticalErrors()
Check if SDK has a critical error prior to initialization.
void initializeSdk(AppLovinSdk.SdkInitializationListener listener)
Initialize the SDK with a given listener.
static void initializeSdk(Context context, AppLovinSdk.SdkInitializationListener listener)
Initialize the default version of the SDK.
static void initializeSdk(Context context)
Initialize the default version of the SDK.
void initializeSdk()
Initialize the SDK
boolean isEnabled()
Check if SDK is enabled.
void setMediationProvider(String mediationProvider)
Set mediation provider using one of the provided strings above specified by AppLovinMediationProvider, or your own if not defined.
void setPluginVersion(String version)
Set Plugin version.
void setUserIdentifier(String userIdentifier)
Set an identifier for the current user.
void showMediationDebugger()
Present the mediation debugger UI.
String toString()
[Expand]
Inherited Methods
From class java.lang.Object

Fields

public static final String VERSION

Current SDK version.

public static final int VERSION_CODE

Public Methods

public AppLovinAdService getAdService ()

Get an instance of the AppLovin Ad service. This service is used to fetch ads from AppLovin servers.

Returns
  • Ad service. Guaranteed not to be null.

public AppLovinSdkConfiguration getConfiguration ()

Get the SDK configuration object provided upon initialization.

Returns
  • An instance of the SDK configuration.

public 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 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 AppLovinNativeAdService getNativeAdService ()

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

Returns
  • Ad service. Guaranteed not to be null.

public 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 AppLovinSdkSettings getSettings ()

Get SDK settings provided on initialization

Returns
  • Provided settings.

public String getUserIdentifier ()

An identifier for the current user. This identifier will be tied to SDK events and our optional S2S postbacks.

If you're using reward validation, you can optionally set an identifier to be included with currency validation postbacks. For example, a username or email. We'll include this in the postback when we ping your currency endpoint from our server.

public AppLovinUserService getUserService ()

Get an instance of the AppLovin user service object for performing user-related tasks.

Returns
  • User service. Guaranteed not to be null.

public AppLovinVariableService getVariableService ()

Get an instance of the AppLovin variable service. This service is used to perform various AB tests that you have set up on your AppLovin dashboard on your users.

Returns
  • Variable service. Guaranteed not to be null.

public boolean hasCriticalErrors ()

Check if SDK has a critical error prior to initialization.

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

public void initializeSdk (AppLovinSdk.SdkInitializationListener listener)

Initialize the SDK with a given listener.

The callback will be invoked on the main thread.

Parameters
listener The callback that will be run when the SDK finishes initializing. May be null.

public static void initializeSdk (Context context, AppLovinSdk.SdkInitializationListener listener)

Initialize 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.
listener The callback that will be run when the SDK finishes initializing. May be null.

public static void initializeSdk (Context context)

Initialize 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 void initializeSdk ()

Initialize the SDK

public 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 SDK is ready to be used.

public 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 void setPluginVersion (String version)

Set Plugin version.

Parameters
version Plugin version to set.

public void setUserIdentifier (String userIdentifier)

Set an identifier for the current user. This identifier will be tied to SDK events and our optional S2S postbacks.

If you're using reward validation, you can optionally set an identifier to be included with currency validation postbacks. For example, a username or email. We'll include this in the postback when we ping your currency endpoint from our server.

Parameters
userIdentifier The user identifier to be set.

public void showMediationDebugger ()

Present the mediation debugger UI. This debugger tool provides the status of your integration for each third-party ad network. Please call this method after the SDK has initialized, e.g. initializeSdk(SdkInitializationListener).

public String toString ()