Unity API reference

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

using UnityEngine.Advertisements;

This article contains the following API documentation:

Classes

• Advertisement
• Banner
• BannerLoadOptions
• BannerOptions
• ShowOptions

Enums

• PlacementState
• ShowResult
• UnityAdsInitializationError
• UnityAdsLoadError
• UnityAdsShowError
• UnityAdsShowCompletionState
• UnityAdsShowError
• BannerPosition

Interfaces

• IUnityAdsInitializationListener
• IUnityAdsLoadListener
• IUnityAdsShowListener
• IUnityAdsListener

Classes

Advertisement

Initialize

public static void Initialize(string gameId, bool testMode, bool enablePerPlacementLoad, IUnityAdsInitializationListener initializationListener)

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

Load

public static void Load (string adUnitId, IUnityAdsLoadListener loadListener)

Loads ad content for a specified Ad Unit. If you initialized the SDK with enablePerPlacementLoad enabled, you must call Load before calling Show.

IsReady

static bool IsReady (string adUnitId) 

Returns true if an ad is ready to show in the specified Ad Unit. If you initialized the SDK with enablePerPlacementLoad enabled, you must call Load before calling Show.

Note: If you call IsReady() without specifying an Ad Unit ID, the method returns results for the Unity Standard Placement.

Show

public static void Show(string adUnitId, ShowOptions showOptions, IUnityAdsShowListener showListener)

Displays loaded ad content in a specified Ad Unit.

Note: If you call Show() without specifying an Ad Unit ID, the method shows loaded content in the Unity Standard Placement.

AddListener

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.

RemoveListener

public static void RemoveListener(IUnityAdsListener listener)

Removes an active IUnityAdsListener.

GetPlacementState

public static PlacementState GetPlacementState(string adUnitId)

Returns the state of a specified Ad Unit.

isInitialized

public static bool 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.

debugMode

public static bool debugMode

Returns true if the SDK is is in debug mode, and false if it isn't. Dubug mode controls the level of logging from the SDK.

version

public static string version

Returns the current SDK version.

isShowing

public static bool isShowing

Returns true if an ad is currently showing, and false if it isn't.

Banner

Use this class to implement banner ads.

Load

public static void Load(string adUnitId, BannerLoadOptions options)

Loads ad content for a specified Banner Ad Unit. If you initialized the SDK with enablePerPlacementLoad enabled, you must call Load before calling Show.

Show

public static void Show(string adUnitId, BannerOptions options)

Shows ad content for a specified Banner Ad Unit. If you initialized the SDK with enablePerPlacementLoad enabled, you must call Load before calling Show.

Hide

public static void Hide(bool destroy = false)

Allows you to hide a banner ad without destroying it altogether.

SetPosition

public void SetPosition (BannerPosition bannerPosition)

Sets the position of the banner ad on the device.

isLoaded

public static bool isLoaded

Returns true if a banner ad is currently loaded to show, and false if it isn't.

ShowOptions

Implement these options to notify the SDK of events when showing content in an Ad Unit. Use ShowOptions.resultCallback to pass a ShowResult enum back to Show when the ad finishes.

resultCallback

public Action<ShowResult> resultCallback { get; set; }

This callback receives the result of an ad.

Obsolete: Implement IUnityAdsListener and call Advertisement.AddListener().

gamerSid

public string gamerSid { get; set; }

Specify an identifier for a specific user in the game.

BannerLoadOptions

Implement these options to notify the SDK of events when loading a banner ad.

loadCallback

public LoadCallback loadCallback { get; set; }

This callback fires when the Banner Ad Unit successfully loads content that is ready to show.

errorCallback

public ErrorCallback errorCallback { get; set; }

This callback fires when the Banner Ad Unit failed to load content.

BannerOptions

Implement these options to notify the SDK of events when displaying a banner ad.

bannerCallback

public BannerCallback bannerCallback { get; set; }

This callback fires when the Banner is visible to the user.

hideCallback

public BannerCallback hideCallback { get; set; }

This callback fires when the banner is hidden from the user.

clickCallback

public BannerCallback clickCallback { get; set; }

This callback fires when the user clicks the banner.

Enums

PlacementState

The enumerated states of an Ad Unit.

ShowResult

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.

UnityAdsLoadError

The enumerated reasons for an Ad Unit failing to load.

UnityAdsShowCompletionState

The enumerated causes for the ad to have finished.

UnityAdsShowError

The enumerated reasons for an Ad Unit failing to show.

BannerPosition

The enumerated positions to anchor a banner on the device display.

Interfaces

IUnityAdsInitializationListener

public interface IUnityAdsInitializationListener {
    void OnInitializationComplete();
    void OnInitializationFailed(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

public interface IUnityAdsLoadListener {
    void OnUnityAdsAdLoaded(string adUnitId);
    void OnUnityAdsFailedToLoad(string adUnitId, UnityAdsLoadError error, string message);
}

Implement this interface to handle Advertisement.Load results.

OnUnityAdsLoaded

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

public interface IUnityAdsShowListener {
    void OnUnityAdsShowFailure(string adUnitId, UnityAdsShowError error, string message);
    void OnUnityAdsShowStart(string adUnitId);
    void OnUnityAdsShowClick(string adUnitId);
    void OnUnityAdsShowComplete(string adUnitId, UnityAdsShowCompletionState showCompletionState);
}

Implement this interface to handle Advertisement.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.

IUnityAdsListener

public interface IUnityAdsListener
{
    void OnUnityAdsReady(string adUnitId);
    void OnUnityAdsDidError(string message);
    void OnUnityAdsDidStart(string adUnitId);
    void OnUnityAdsDidFinish(string adUnitId, ShowResult showResult);
}

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

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.