Unity Ads Android SDK API reference#

This article contains the following API documentation:

Classes

• UnityAds
• UnityAdsLoadOptions
• BannerView
• UnityBannerSize

Enums

• PlacementState
• FinishState
• UnityAdsInitializationError
• UnityAdsLoadError
• UnityAdsShowError
• UnityAdsShowCompletionState
• UnityAdsError

Interfaces

• IUnityAdsInitializationListener
• IUnityAdsLoadListener
• IUnityAdsShowListener

Classes#

UnityAds#

Use this namespace to implement basic ad content, such as rewarded or non-rewarded video, interstitial, or banner ads.

initialize#

initialize(final Context context, final String gameId, final boolean testMode, final IUnityAdsInitializationListener initializationListener)

Initializes the ads service, with a specified Game ID, test mode status, and initialization listener.

load#

public static void load(final String adUnitId, final UnityAdsLoadOptions loadOptions, final IUnityAdsLoadListener listener)

Loads ad content for a specified ad unit. You must call load before calling show.

show#

public static void show(final Activity activity, final String adUnitId, final UnityAdsShowOptions options, final IUnityAdsShowListener showListener)

Displays loaded ad content in a specified ad unit.

addListener#

public static void addListener(IUnityAdsListener listener)

Adds a listener that will receive Unity Ads callbacks. In versions 3.1.0 and later, you can register multiple listeners. This is especially helpful for mediation customers.

removeListener#

public static void removeListener(IUnityAdsListener listener)

Removes an active [IUnityAdsListener].

getVersion#

public static String getVersion()

Returns the current Ads SDK version.

getPlacementState#

public static PlacementState getPlacementState(String adUnitId)

Returns the state of a specified ad unit.

setDebugMode#

public static void setDebugMode(boolean debugMode)

Controls the amount of logging output from the SDK. Set to true for more robust logging.

getDebugMode#

public static boolean getDebugMode()

Returns true if the SDK is in debug mode.

isInitialized#

public static boolean isInitialized()

Returns true if the SDK is initialized successfully, and false if it isn't.

isSupported#

public static bool isSupported()

Returns true if the SDK is supported on the current platform, and false if it isn't.

UnityAdsLoadOptions#

public class UnityAdsLoadOptions extends UnityAdsBaseOptions

This class contains optional metadata to include with the load method. Customers using header bidding in third-party mediation should use this in cases where a bidder from the Unity network wins the ad auction.

setAdMarkup#

public void setAdMarkup(String adMarkup)

This method takes the ad markup returned from the bidder service. When a bidder from Unity's ad network wins a header bidding auction, the Unity Ads SDK receives ad markup from the mediated exchange. The ad markup string contains information needed for Unity to load and show the ad.

setObjectId#

public void setObjectId(String objectId)

This method sets the loaded ad object ID as the ad object ID to show.

BannerView#

public BannerView(Activity activity, String adUnitId, UnityBannerSize size)

getPlacementId#

public String getPlacementId()

Returns the ad unit ID for the Banner ad unit.

getSize#

public UnityBannerSize getSize()

The size of the banner.

setListener#

public void setListener(IListener listener)

Sets the active listener for the banner.

getListener#

public IListener getListener()

Retrieves the active listener for the banner.

load#

public void load()

The basic method for requesting an ad for the banner.

destroy#

public void destroy()

Call this method to remove the banner from the view hierarchy when you’re no longer using it.

UnityBannerSize#

public UnityBannerSize(int width, int height)

Use this class to define the height and width of a banner object.

getWidth#

public int getWidth()

Returns the width in pixels of the banner object.

getHeight#

public int getHeight()

Returns the height in pixels of the banner object.

Enums#

PlacementState#

The enumerated states of an ad unit.

FinishState#

The enumerated states of the user’s interaction with the ad. The SDK passes this value to the onUnityAdsDidFinish callback method when the ad completes.

UnityAdsInitializationError#

The enumerated reasons for SDK initialization to fail.

UnityAdsShowCompletionState#

The enumerated causes for the ad to have finished.

UnityAdsLoadError#

The enumerated reasons for an ad unit failing to load.

UnityAdsShowError#

The enumerated reasons for an ad unit failing to show.

UnityAdsError#

...

The enumerated reasons for an add to fail.

Interfaces#

IUnityAdsInitializationListener#

void onInitializationComplete();
void onInitializationFailed(UnityAds.UnityAdsInitializationError error, String message);

Implement this interface to handle initialize results.

onInitializationComplete#

This callback method handles logic for the SDK successfully initializing.

onInitializationFailed#

This callback method handles logic for the SDK failing to initialize.

IUnityAdsLoadListener#

void onUnityAdsAdLoaded(String placementId);
void onUnityAdsFailedToLoad(String placementId, UnityAds.UnityAdsLoadError error, String message);

Implement this interface to handle load results.

onUnityAdsAdLoaded#

This callback method handles logic for the ad unit successfully loading.

onUnityAdsFailedToLoad#

This callback method handles logic for the ad unit failing to load.

IUnityAdsShowListener#

void onUnityAdsShowFailure(String placementId, UnityAds.UnityAdsShowError error, String message);
void onUnityAdsShowStart(String placementId);
void onUnityAdsShowClick(String placementId);
UnityAds.UnityAdsShowCompletionState state;

Implement this interface to handle show results.

onUnityAdsShowFailure#

This callback method handles logic for the ad unit failing to show.

onUnityAdsShowStart#

This callback method handles logic for the ad starting to play.

onUnityAdsShowClick#

This callback method handles logic for the user clicking on the ad.

onUnityAdsShowComplete#

This callback method handles logic for the ad finishing.

onUnityAdsReady#

Specify logic for ad content being ready to display through a specified ad unit.

onUnityAdsDidError#

Specify logic for ad content failing to display due to an error.

onUnityAdsDidStart#

Specify logic for the player triggering an ad to show.

OnUnityAdsDidFinish#

Specify logic for the player watching the ad in its entirety.

IListener#

String mObjectId = UUID.randomUUID().toString();
void onBannerLoaded(BannerView bannerAdView);
void onBannerShown(BannerView bannerAdView);
void onBannerClick(BannerView bannerAdView);
void onBannerFailedToLoad(BannerView bannerAdView, BannerErrorInfo errorInfo);
void onBannerLeftApplication(BannerView bannerView);

onBannerLoaded#

This callback fires when the banner finishes loading an ad. The view parameter references the banner that should be inserted into the view hierarchy.

onBannerClick#

This callback fires when the banner is clicked.

onBannerError#

This callback fires when an error occurs showing the banner.

onBannerLeftApplication#

This callback fires when the banner links outside the application.