com.unity3d.ads

Class UnityAds

java.lang.Object

com.unity3d.ads.UnityAds

public final class UnityAds
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UnityAds.UnityAdsInitializationError Enumeration of UnityAds initialization errors.
static class	UnityAds.UnityAdsLoadError Enumeration of UnityAds load errors.
static class	UnityAds.UnityAdsShowCompletionState
static class	UnityAds.UnityAdsShowError Enumeration of UnityAds show errors.

Constructor Summary

Constructors

Constructor and Description
UnityAds()

Method Summary

Modifier and Type	Method and Description
static boolean	getDebugMode() Get current debug mode status
static java.lang.String	getToken() Get request token.
static void	getToken(IUnityAdsTokenListener listener) Get request token in asynchronous way.
static java.lang.String	getVersion() Get current SDK version
static void	initialize(android.content.Context context, java.lang.String gameId) Initializes Unity Ads.
static void	initialize(android.content.Context context, java.lang.String gameId, boolean testMode) Initializes Unity Ads.
static void	initialize(android.content.Context context, java.lang.String gameId, boolean testMode, IUnityAdsInitializationListener initializationListener) Initializes Unity Ads.
static void	initialize(android.content.Context context, java.lang.String gameId, IUnityAdsInitializationListener initializationListener) Initializes Unity Ads.
static boolean	isInitialized() Checks if Unity Ads has been initialized.
static boolean	isSupported() Checks if current device supports running Unity Ads
static void	load(java.lang.String placementId) Deprecated.
static void	load(java.lang.String placementId, IUnityAdsLoadListener listener) Request fill for a specific placement ID.
static void	load(java.lang.String placementId, UnityAdsLoadOptions loadOptions, IUnityAdsLoadListener listener) Request fill for a specific placement ID with custom options.
static void	setDebugMode(boolean debugMode) Toggles debug mode on/off
static void	show(android.app.Activity activity, java.lang.String placementId) Deprecated.
static void	show(android.app.Activity activity, java.lang.String placementId, IUnityAdsShowListener showListener) Show one advertisement with custom placement and custom options.
static void	show(android.app.Activity activity, java.lang.String placementId, UnityAdsShowOptions options) Deprecated.
static void	show(android.app.Activity activity, java.lang.String placementId, UnityAdsShowOptions options, IUnityAdsShowListener showListener) Show one advertisement with custom placement and custom options.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

UnityAds

public UnityAds()

Method Detail

initialize

public static void initialize(android.content.Context context,
                              java.lang.String gameId)

Initializes Unity Ads. Unity Ads should be initialized when app starts.

Parameters:

context - Current Android context of calling app in favor of Application Context

gameId - Unique identifier for a game, given by Unity Ads admin tools or Unity editor

initialize

public static void initialize(android.content.Context context,
                              java.lang.String gameId,
                              IUnityAdsInitializationListener initializationListener)

Initializes Unity Ads. Unity Ads should be initialized when app starts.

Parameters:

context - Current Android context of calling app in favor of Application Context

gameId - Unique identifier for a game, given by Unity Ads admin tools or Unity editor

initializationListener - Listener for IUnityAdsInitializationListener callbacks

initialize

public static void initialize(android.content.Context context,
                              java.lang.String gameId,
                              boolean testMode)

Initializes Unity Ads. Unity Ads should be initialized when app starts.

Parameters:

context - Current Android context of calling app in favor of Application Context

gameId - Unique identifier for a game, given by Unity Ads admin tools or Unity editor

testMode - If true, only test ads are shown

initialize

public static void initialize(android.content.Context context,
                              java.lang.String gameId,
                              boolean testMode,
                              IUnityAdsInitializationListener initializationListener)

Initializes Unity Ads. Unity Ads should be initialized when app starts.

Parameters:

context - Current Android context of calling app in favor of Application Context

gameId - Unique identifier for a game, given by Unity Ads admin tools or Unity editor

testMode - If true, only test ads are shown

initializationListener - Listener for IUnityAdsInitializationListener callbacks

isInitialized

public static boolean isInitialized()

Checks if Unity Ads has been initialized. This might be useful for debugging initialization problems.

Returns:

If true, Unity Ads has been successfully initialized

isSupported

public static boolean isSupported()

Checks if current device supports running Unity Ads

Returns:

If true, device supports Unity Ads. If false, device can't initialize or show Unity Ads.

getVersion

public static java.lang.String getVersion()

Get current SDK version

Returns:

Current SDK version name

show

@Deprecated
public static void show(android.app.Activity activity,
                                    java.lang.String placementId)

Deprecated.

Show one advertisement with custom placement.

Parameters:

activity - Current Android activity of calling app

placementId - Placement, as defined in Unity Ads admin tools

show

public static void show(android.app.Activity activity,
                        java.lang.String placementId,
                        IUnityAdsShowListener showListener)

Show one advertisement with custom placement and custom options.

Parameters:

activity - Current Android activity of calling app

placementId - Placement, as defined in Unity Ads admin tools

showListener - Listener for IUnityAdsShowListener callbacks

show

@Deprecated
public static void show(android.app.Activity activity,
                                    java.lang.String placementId,
                                    UnityAdsShowOptions options)

Deprecated.

Show one advertisement with custom placement and custom options.

Parameters:

activity - Current Android activity of calling app

placementId - Placement, as defined in Unity Ads admin tools

options - Custom options

show

public static void show(android.app.Activity activity,
                        java.lang.String placementId,
                        UnityAdsShowOptions options,
                        IUnityAdsShowListener showListener)

Show one advertisement with custom placement and custom options.

Parameters:

activity - Current Android activity of calling app

placementId - Placement, as defined in Unity Ads admin tools

options - Custom options

showListener - Listener for IUnityAdsShowListener callbacks

setDebugMode

public static void setDebugMode(boolean debugMode)

Toggles debug mode on/off

Parameters:

debugMode - If true, debug mode is on and there will be lots of debug output from Unity Ads. If false, there will be only some short log messages from Unity Ads.

getDebugMode

public static boolean getDebugMode()

Get current debug mode status

Returns:

If true, debug mode is on. If false, debug mode is off.

load

@Deprecated
public static void load(java.lang.String placementId)

Deprecated.

Request fill for a specific placement ID.

Parameters:

placementId - The placement ID to be loaded.

load

public static void load(java.lang.String placementId,
                        IUnityAdsLoadListener listener)

Request fill for a specific placement ID.

Parameters:

placementId - The placement ID to be loaded.

listener - The listener which is going to be notified about load request result.

load

public static void load(java.lang.String placementId,
                        UnityAdsLoadOptions loadOptions,
                        IUnityAdsLoadListener listener)

Request fill for a specific placement ID with custom options.

Parameters:

placementId - The placement ID to be loaded.

loadOptions - Custom options.

listener - The listener which is going to be notified about load request result.

getToken

public static java.lang.String getToken()

Get request token.

getToken

public static void getToken(IUnityAdsTokenListener listener)

Get request token in asynchronous way.