api android - Unity-Technologies/unity-ads GitHub Wiki

/*
Title: Android API reference Description:
Sort: 5 */

This article contains the following API documentation:

Classes

• UnityAds
• BannerView
• UnityBannerSize

Enums

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

Interfaces

• IUnityAdsInitializationListener
• IUnityAdsLoadListener
• IUnityAdsShowListener
• IUnityAdsListener

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

public static void initialize(final Context context, final String gameId, final boolean testMode, final boolean enablePerPlacementLoad, final IUnityAdsInitializationListener initializationListener) 

Initializes the ads service, with a specified Game ID, test mode status, and Ad Unit load setting.

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

Loads ad content for a specified Ad Unit. If you initialized the SDK with enablePerPlacementLoad enabled, you must call load before calling 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.

public static void addListener(IUnityAdsListener listener) 

Adds a listener that will recieve Unity Ads callbacks. Versions 3.1.0 and higher allow you to register multiple listeners. This is especially helpful for mediation customers.

public static void removeListener(IUnityAdsListener listener) 

Removes an active IUnityAdsListener.

public static String getVersion() 

Returns the current Ads SDK version.

public static PlacementState getPlacementState(String adUnitId) 

Returns the state of a specified Ad Unit.

public static void setDebugMode(boolean debugMode) 

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

public static boolean getDebugMode()

Returns true if the SDK is in debug mode.

public static boolean isInitialized()

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

public static bool isSupported()

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

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

Use this constructor to implement a banner view using an Ad Unit ID and banner size.

public String getPlacementId()

Returns the Ad Unit ID for the Banner Ad Unit.

public UnityBannerSize getSize()

Returns the size of the banner.

public void setListener(IListener listener);

Sets the active listener for the banner.

public IListener getListener();

Retrieves the active listener for the banner.

public void load();

The basic method for requesting an ad for the banner.

public void destroy();

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

public UnityBannerSize(int width, int height)

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

public int getWidth()

Returns the width in pixels of the banner object.

public int getHeight()

Returns the height in pixels of the banner object.

The enumerated states of an Ad Unit.

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.

The enumerated reasons for SDK initialization to fail.

The enumerated causes for the ad to have finished.

The enumerated reasons for an Ad Unit failing to load.

The enumerated reasons for an Ad Unit failing to show.

public enum UnityAdsError {
    NOT_INITIALIZED,
    INITIALIZE_FAILED,
    INVALID_ARGUMENT,
    VIDEO_PLAYER_ERROR,
    INIT_SANITY_CHECK_FAIL,
    AD_BLOCKER_DETECTED,
    FILE_IO_ERROR,
    DEVICE_ID_ERROR,
    SHOW_ERROR,
    INTERNAL_ERROR
}

The enumerated reasons for an add to fail.

public interface IUnityAdsInitializationListener {
	void onInitializationComplete();
	void onInitializationFailed(UnityAds.UnityAdsInitializationError error, String message);
}

Implement this interface to handle initialize results.

This callback method handles logic for the SDK successfully initializing.

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

public interface IUnityAdsLoadListener {
    void onUnityAdsAdLoaded(String adUnitId);
	void onUnityAdsFailedToLoad(String adUnitId, UnityAds.UnityAdsLoadError error, String message);
}

Implement this interface to handle UnityAds.load results.

This callback method handles logic for the Ad Unit successfully loading.

This callback method handles logic for the Ad Unit failing to load.

public interface IUnityAdsShowListener {
    void onUnityAdsShowFailure(String adUnitId, UnityAds.UnityAdsShowError error, String message);
	void onUnityAdsShowStart(String adUnitId);
	void onUnityAdsShowClick(String adUnitId);
	void onUnityAdsShowComplete(String adUnitId, UnityAds.UnityAdsShowCompletionState state);
}

Implement this interface to handle UnityAds.show results.

This callback method handles logic for the Ad Unit failing to show.

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

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

This callback method handles logic for the ad finishing.

public interface IUnityAdsListener
{
    void onUnityAdsReady(String adUnitId);
    void onUnityAdsDidError(UnityAds.UnityAdsError error, String message);
    void onUnityAdsDidStart(String adUnitId);
    void onUnityAdsDidFinish(String adUnitId, FinishState result);
}

Implement this interface to handle various states of an ad. Implement this listener in your script to define logic for rewarded ads.

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

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

Specify logic for the player triggering an ad to show.

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

public interface IListener {
    void onBannerLoaded(BannerView bannerAdView);
    void onBannerClick(BannerView bannerAdView);
    void onBannerFailedToLoad(BannerView bannerAdView, BannerErrorInfo errorInfo);
    void onBannerLeftApplication(BannerView bannerView);
}

This interface grants access to banner lifecycle events. In addition, you can implement the following override methods:

public static abstract class Listener implements IListener {
    @Override
    public void onBannerLoaded(BannerView bannerAdView) {
    }
    @Override
    public void onBannerFailedToLoad(BannerView bannerAdView, BannerErrorInfo errorInfo) {
    }
    @Override
    public void onBannerClick(BannerView bannerAdView) {
    }
    @Override
    public void onBannerLeftApplication(BannerView bannerAdView) {
    }
}

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

This callback fires when the banner is clicked.

This callback fires when an error occurs showing the banner.

This callback fires when the banner links outside the application.