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.FinishState An enumeration for the completion state of an ad.
static class	UnityAds.PlacementState Describes state of Unity Ads placements.
static class	UnityAds.UnityAdsError
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 void	addListener(IUnityAdsListener listener) Add listener for IUnityAdsListener callbacks.
static boolean	getDebugMode() Get current debug mode status
static IUnityAdsListener	getListener() Deprecated. this method is deprecated in favor of addListener(IUnityAdsListener) and removeListener(IUnityAdsListener)
static UnityAds.PlacementState	getPlacementState() Get current state of default placement
static UnityAds.PlacementState	getPlacementState(java.lang.String placementId) Get current state of a placement
static java.lang.String	getToken() Get request token.
static java.lang.String	getVersion() Get current SDK version
static void	initialize(android.app.Activity activity, java.lang.String gameId) Deprecated. this method is deprecated in favor of initialize(Context, String) use Application Context
static void	initialize(android.app.Activity activity, java.lang.String gameId, boolean testMode) Deprecated. this method is deprecated in favor of initialize(Context, String, boolean) use Application Context
static void	initialize(android.app.Activity activity, java.lang.String gameId, boolean testMode, boolean enablePerPlacementLoad) Deprecated. this method is deprecated in favor of initialize(Context, String, boolean, boolean) use Application Context
static void	initialize(android.app.Activity activity, java.lang.String gameId, boolean testMode, boolean enablePerPlacementLoad, IUnityAdsInitializationListener initializationListener) Deprecated. this method is deprecated in favor of initialize(Context, String, boolean, boolean, IUnityAdsInitializationListener) use Application Context
static void	initialize(android.app.Activity activity, java.lang.String gameId, boolean testMode, IUnityAdsInitializationListener initializationListener) Deprecated. this method is deprecated in favor of initialize(Context, String, boolean, IUnityAdsInitializationListener) use Application context
static void	initialize(android.app.Activity activity, java.lang.String gameId, IUnityAdsInitializationListener initializationListener) Deprecated. this method is deprecated in favor of initialize(Context, String, IUnityAdsInitializationListener) use Application Context
static void	initialize(android.app.Activity activity, java.lang.String gameId, IUnityAdsListener listener) Deprecated. this method is deprecated in favor of initialize(Context, String) use addListener(IUnityAdsListener) to add a listener and use Application Context
static void	initialize(android.app.Activity activity, java.lang.String gameId, IUnityAdsListener listener, boolean testMode) Deprecated. this method is deprecated in favor of initialize(Context, String, boolean) use addListener(IUnityAdsListener) to add a listener and use Application Context
static void	initialize(android.app.Activity activity, java.lang.String gameId, IUnityAdsListener listener, boolean testMode, boolean enablePerPlacementLoad) Deprecated. this method is deprecated in favor of initialize(Context, String, boolean, boolean) use addListener(IUnityAdsListener) to add a listener and use Application Context
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, boolean enablePerPlacementLoad) Initializes Unity Ads.
static void	initialize(android.content.Context context, java.lang.String gameId, boolean testMode, boolean enablePerPlacementLoad, IUnityAdsInitializationListener initializationListener) 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	isReady() Deprecated. Please migrate to using load call with IUnityAdsLoadListener.
static boolean	isReady(java.lang.String placementId) Deprecated. Please migrate to using load call with IUnityAdsLoadListener.
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	removeListener(IUnityAdsListener listener) Remove listener for IUnityAdsListener callbacks
static void	setDebugMode(boolean debugMode) Toggles debug mode on/off
static void	setListener(IUnityAdsListener listener) Deprecated. this method is deprecated in favor of addListener(IUnityAdsListener)
static void	show(android.app.Activity activity) Deprecated.
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

@Deprecated
public static void initialize(android.app.Activity activity,
                                          java.lang.String gameId,
                                          IUnityAdsListener listener)

Deprecated. this method is deprecated in favor of initialize(Context, String) use addListener(IUnityAdsListener) to add a listener and use Application Context

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

Parameters:

activity - Current Android activity of calling app

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

listener - Listener for IUnityAdsListener callbacks

initialize

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

Deprecated. this method is deprecated in favor of initialize(Context, String) use Application Context

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

Parameters:

activity - Current Android activity of calling app

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

initialize

@Deprecated
public static void initialize(android.app.Activity activity,
                                          java.lang.String gameId,
                                          IUnityAdsInitializationListener initializationListener)

Deprecated. this method is deprecated in favor of initialize(Context, String, IUnityAdsInitializationListener) use Application Context

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

Parameters:

activity - Current Android activity of calling app

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

initializationListener - Listener for IUnityAdsInitializationListener callbacks

initialize

@Deprecated
public static void initialize(android.app.Activity activity,
                                          java.lang.String gameId,
                                          IUnityAdsListener listener,
                                          boolean testMode)

Deprecated. this method is deprecated in favor of initialize(Context, String, boolean) use addListener(IUnityAdsListener) to add a listener and use Application Context

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

Parameters:

activity - Current Android activity of calling app

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

listener - Listener for IUnityAdsListener callbacks

testMode - If true, only test ads are shown

initialize

@Deprecated
public static void initialize(android.app.Activity activity,
                                          java.lang.String gameId,
                                          boolean testMode)

Deprecated. this method is deprecated in favor of initialize(Context, String, boolean) use Application Context

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

Parameters:

activity - Current Android activity of calling app

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

testMode - If true, only test ads are shown

initialize

@Deprecated
public static void initialize(android.app.Activity activity,
                                          java.lang.String gameId,
                                          boolean testMode,
                                          IUnityAdsInitializationListener initializationListener)

Deprecated. this method is deprecated in favor of initialize(Context, String, boolean, IUnityAdsInitializationListener) use Application context

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

Parameters:

activity - Current Android activity of calling app

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

initialize

@Deprecated
public static void initialize(android.app.Activity activity,
                                          java.lang.String gameId,
                                          IUnityAdsListener listener,
                                          boolean testMode,
                                          boolean enablePerPlacementLoad)

Deprecated. this method is deprecated in favor of initialize(Context, String, boolean, boolean) use addListener(IUnityAdsListener) to add a listener and use Application Context

Initializes Unity Ads. Unity Ads should be initialized when app starts. Note: The `load` API is in closed beta and available upon invite only. If you would like to be considered for the beta, please contact Unity Ads Support.

Parameters:

activity - Current Android activity of calling app

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

listener - Listener for IUnityAdsListener callbacks

testMode - If true, only test ads are shown

enablePerPlacementLoad - Set this flag to `YES` to disable automatic placement caching. When this is enabled, developer must call `load` on placements before calling show

initialize

@Deprecated
public static void initialize(android.app.Activity activity,
                                          java.lang.String gameId,
                                          boolean testMode,
                                          boolean enablePerPlacementLoad)

Deprecated. this method is deprecated in favor of initialize(Context, String, boolean, boolean) use Application Context

Initializes Unity Ads. Unity Ads should be initialized when app starts. Note: The `load` API is in closed beta and available upon invite only. If you would like to be considered for the beta, please contact Unity Ads Support.

Parameters:

activity - Current Android activity of calling app

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

testMode - If true, only test ads are shown

enablePerPlacementLoad - Set this flag to `YES` to disable automatic placement caching. When this is enabled, developer must call `load` on placements before calling show

initialize

@Deprecated
public static void initialize(android.app.Activity activity,
                                          java.lang.String gameId,
                                          boolean testMode,
                                          boolean enablePerPlacementLoad,
                                          IUnityAdsInitializationListener initializationListener)

Deprecated. this method is deprecated in favor of initialize(Context, String, boolean, boolean, IUnityAdsInitializationListener) use Application Context

Initializes Unity Ads. Unity Ads should be initialized when app starts. Note: The `load` API is in closed beta and available upon invite only. If you would like to be considered for the beta, please contact Unity Ads Support.

Parameters:

activity - Current Android activity of calling app

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

testMode - If true, only test ads are shown

enablePerPlacementLoad - Set this flag to `YES` to disable automatic placement caching. When this is enabled, developer must call `load` on placements before calling show

initializationListener - Listener for IUnityAdsInitializationListener callbacks

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

initialize

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

Initializes Unity Ads. Unity Ads should be initialized when app starts. Note: The `load` API is in closed beta and available upon invite only. If you would like to be considered for the beta, please contact Unity Ads Support.

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

enablePerPlacementLoad - Set this flag to `YES` to disable automatic placement caching. When this is enabled, developer must call `load` on placements before calling show

initialize

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

Initializes Unity Ads. Unity Ads should be initialized when app starts. Note: The `load` API is in closed beta and available upon invite only. If you would like to be considered for the beta, please contact Unity Ads Support.

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

enablePerPlacementLoad - Set this flag to `YES` to disable automatic placement caching. When this is enabled, developer must call `load` on placements before calling show

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

setListener

@Deprecated
public static void setListener(IUnityAdsListener listener)

Deprecated. this method is deprecated in favor of addListener(IUnityAdsListener)

Set listener for IUnityAdsListener callbacks. Use this if only ever using one listener. This overwrites the previous set listener.

Parameters:

listener - New listener for IUnityAdsListener callbacks

getListener

@Deprecated
public static IUnityAdsListener getListener()

Deprecated. this method is deprecated in favor of addListener(IUnityAdsListener) and removeListener(IUnityAdsListener)

Get current listener for IUnityAdsListener callbacks. Returns the most recent listener set through setListener or the listener from the first initialize

Returns:

Return IUnityAdsListener that was set from setListener

addListener

public static void addListener(IUnityAdsListener listener)

Add listener for IUnityAdsListener callbacks. Use this if subscribing multiple listeners. It is not recommended to mix setListener with addListener

Parameters:

listener - New listener for IUnityAdsListener callbacks

removeListener

public static void removeListener(IUnityAdsListener listener)

Remove listener for IUnityAdsListener callbacks

Parameters:

listener - New listener for IUnityAdsListener callbacks

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

isReady

@Deprecated
public static boolean isReady()

Deprecated. Please migrate to using load call with IUnityAdsLoadListener.

Check if default placement is ready to show ads

Returns:

If true, default placement is ready to show ads

isReady

@Deprecated
public static boolean isReady(java.lang.String placementId)

Deprecated. Please migrate to using load call with IUnityAdsLoadListener.

Check if placement is ready to show ads

Parameters:

placementId - Placement, as defined in Unity Ads admin tools

Returns:

If true, placement is ready to show ads

getPlacementState

public static UnityAds.PlacementState getPlacementState()

Get current state of default placement

Returns:

If PlacementState.READY, default placement is ready to show ads. Other states give detailed reasons why placement is not ready.

getPlacementState

public static UnityAds.PlacementState getPlacementState(java.lang.String placementId)

Get current state of a placement

Parameters:

placementId - Placement, as defined in Unity Ads admin tools

Returns:

If PlacementState.READY, placement is ready to show ads. Other states give detailed reasons why placement is not ready.

show

@Deprecated
public static void show(android.app.Activity activity)

Deprecated.

Show one advertisement using default placement.

Parameters:

activity - Current Android activity of calling app

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. This functionality is enabled through the `enablePerPlacementLoad` in initialize. Note: The `load` API is in closed beta and available upon invite only. If you would like to be considered for the beta, please contact Unity Ads Support.

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. This functionality is enabled through the `enablePerPlacementLoad` in initialize. Note: The `load` API is in closed beta and available upon invite only. If you would like to be considered for the beta, please contact Unity Ads Support.

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. This functionality is enabled through the `enablePerPlacementLoad` in initialize. Note: The `load` API is in closed beta and available upon invite only. If you would like to be considered for the beta, please contact Unity Ads Support

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.