398 lines
21 KiB
C#
398 lines
21 KiB
C#
using System;
|
|
using UnityEngine.Advertisements.Platform;
|
|
using UnityEngine.Advertisements.Utilities;
|
|
|
|
namespace UnityEngine.Advertisements
|
|
{
|
|
/// <summary>
|
|
/// The wrapper class used to interact with the Unity Ads SDK.
|
|
/// </summary>
|
|
public static class Advertisement
|
|
{
|
|
private static IPlatform s_Platform;
|
|
|
|
static Advertisement()
|
|
{
|
|
if (s_Platform == null)
|
|
{
|
|
s_Platform = CreatePlatform();
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Returns <c>true</c> if the SDK is initialized successfully, and <c>false</c> if it isn't.
|
|
/// </summary>
|
|
public static bool isInitialized => s_Platform.IsInitialized;
|
|
|
|
/// <summary>
|
|
/// Returns <c>true</c> if the SDK is supported on the current platform, and <c>false</c> if it isn't.
|
|
/// </summary>
|
|
public static bool isSupported => IsSupported();
|
|
|
|
/// <summary>
|
|
/// Returns <c>true</c> if the SDK is is in debug mode, and <c>false</c> if it isn't. Debug mode controls the level of logging from the SDK.
|
|
/// </summary>
|
|
public static bool debugMode
|
|
{
|
|
get => s_Platform.DebugMode;
|
|
set => s_Platform.DebugMode = value;
|
|
}
|
|
|
|
/// <summary>
|
|
/// Returns the current SDK version.
|
|
/// </summary>
|
|
public static string version => s_Platform.Version;
|
|
|
|
/// <summary>
|
|
/// Returns <c>true</c> if an ad is currently showing, and <c>false</c> if it isn't.
|
|
/// </summary>
|
|
public static bool isShowing => s_Platform.IsShowing;
|
|
|
|
/// <summary>
|
|
/// Initializes the SDK with a specified <a href="../manual/MonetizationResourcesDashboardGuide.html#project-settings">Game ID</a>.
|
|
/// </summary>
|
|
/// <param name="gameId">The platform-specific Unity game identifier for your Project, found on the <a href="https://operate.dashboard.unity3d.com/">developer dashboard</a>.</param>
|
|
public static void Initialize(string gameId)
|
|
{
|
|
Initialize(gameId, false, false);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Initializes the SDK with a specified Game ID and test mode setting.
|
|
/// </summary>
|
|
/// <param name="gameId">The platform-specific Unity game identifier for your Project, found on the <a href="https://operate.dashboard.unity3d.com/">developer dashboard</a>.</param>
|
|
/// <param name="testMode"><a href="../manual/MonetizationResourcesDashboardGuide.html#project-settings">Test mode</a> allows you to test your integration without serving live ads. Use <c>true</c> to initialize in test mode.</param>
|
|
public static void Initialize(string gameId, bool testMode)
|
|
{
|
|
Initialize(gameId, testMode, false);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Initializes the SDK with a specified Game ID and test mode setting.
|
|
/// </summary>
|
|
/// <param name="gameId">The platform-specific Unity game identifier for your Project, found on the <a href="https://operate.dashboard.unity3d.com/">developer dashboard</a>.</param>
|
|
/// <param name="testMode"><a href="../manual/MonetizationResourcesDashboardGuide.html#project-settings">Test mode</a> allows you to test your integration without serving live ads. Use <c>true</c> to initialize in test mode.</param>
|
|
/// <param name="enablePerPlacementLoad">Enable the load API lifecycle. See <see cref="Advertisements.Advertisement.Load(string)"/> for more information.</param>
|
|
public static void Initialize(string gameId, bool testMode, bool enablePerPlacementLoad)
|
|
{
|
|
Initialize(gameId, testMode, enablePerPlacementLoad, null);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Initializes the SDK with a specified Game ID, test mode setting, and Placement load setting.
|
|
/// </summary>
|
|
/// <param name="gameId">The platform-specific Unity <a href="../manual/MonetizationResourcesDashboardGuide.html#project-settings">game identifier</a> for your Project, found on the <a href="https://operate.dashboard.unity3d.com/">developer dashboard</a>.</param>
|
|
/// <param name="testMode"><a href="../manual/MonetizationResourcesDashboardGuide.html#project-settings">Test mode</a> allows you to test your integration without serving live ads. Use <c>true</c> to initialize in test mode.</param>
|
|
/// <param name="enablePerPlacementLoad">Enable the load API lifecycle. See <see cref="Advertisements.Advertisement.Load(string)"/> for more information.</param>
|
|
/// <param name="initializationListener">Listener for IUnityAdsInitializationListener callbacks</param>
|
|
public static void Initialize(string gameId, bool testMode, bool enablePerPlacementLoad, IUnityAdsInitializationListener initializationListener)
|
|
{
|
|
#if UNITY_2020_1_OR_NEWER && ENABLE_CLOUD_SERVICES_ADS && (UNITY_IOS || UNITY_ANDROID || UNITY_EDITOR)
|
|
if (testMode == false && UnityAdsSettings.testMode)
|
|
{
|
|
Debug.Log("Unity Ads is initializing in test mode since test mode is enabled in Service Window.");
|
|
}
|
|
s_Platform.Initialize(gameId, UnityAdsSettings.testMode || testMode, enablePerPlacementLoad, initializationListener);
|
|
#else
|
|
s_Platform.Initialize(gameId, testMode, enablePerPlacementLoad, initializationListener);
|
|
#endif
|
|
}
|
|
|
|
/// <summary>
|
|
/// Returns <c>true</c> if an ad is available to display on the default <a href="../manual/MonetizationPlacements.html">Placement</a>, and <c>false</c> if it isn't.
|
|
/// </summary>
|
|
public static bool IsReady()
|
|
{
|
|
return s_Platform.IsReady(null);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Returns <c>true</c> if an ad is available to display for a specified <a href="../manual/MonetizationPlacements.html">Placement</a>, and <c>false</c> if it isn't.
|
|
/// </summary>
|
|
/// <param name="placementId">The unique identifier for a specific Placement, found on the <a href="https://operate.dashboard.unity3d.com/">developer dashboard</a>.</param>
|
|
public static bool IsReady(string placementId)
|
|
{
|
|
return s_Platform.IsReady(placementId);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Loads ad content for a specified Placement. If you initialized the SDK with <c>enablePerPlacementLoad</c> enabled, you must call <c>Load</c> before calling <c>Show</c>. Note that the <c>Load</c> API is in beta and available upon invite only. If you would like to be considered for the beta, please contact us at unityads-support@unity3d.com.
|
|
/// </summary>
|
|
/// <param name="placementId">The unique identifier for a specific Placement, found on the <a href="https://operate.dashboard.unity3d.com/">developer dashboard</a>.</param>
|
|
/// <seealso cref="Advertisement.Initialize(string, bool, bool)"/>
|
|
/// <seealso cref="Advertisement.Show(string)"/>
|
|
public static void Load(string placementId)
|
|
{
|
|
Load(placementId, null);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Loads ad content for a specified Placement. If you initialized the SDK with <c>enablePerPlacementLoad</c> enabled, you must call <c>Load</c> before calling <c>Show</c>. Note that the <c>Load</c> API is in beta and available upon invite only. If you would like to be considered for the beta, please contact us at unityads-support@unity3d.com.
|
|
/// </summary>
|
|
/// <param name="placementId">The unique identifier for a specific Placement, found on the <a href="https://operate.dashboard.unity3d.com/">developer dashboard</a>.</param>
|
|
/// <param name="loadListener">A listener for <c>IUnityAdsLoadListener</c> callbacks</param>
|
|
/// <seealso cref="Advertisement.Initialize(string, bool, bool)"/>
|
|
/// <seealso cref="Advertisement.Show(string)"/>
|
|
public static void Load(string placementId, IUnityAdsLoadListener loadListener)
|
|
{
|
|
s_Platform.Load(placementId, loadListener);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Displays an ad in the <a href="https://unityads.unity3d.com/help/monetization/ad-units-management#unity-standard-placements">default Ad Unit or Placement</a> if it is ready.
|
|
/// </summary>
|
|
/// <seealso cref="Advertisement.IsReady()"/>
|
|
public static void Show()
|
|
{
|
|
s_Platform.Show();
|
|
}
|
|
|
|
/// <summary>
|
|
/// Displays an ad in the default <a href="../manual/MonetizationPlacements.html">Placement</a> if it is ready, and passes a <a href="..api/UnityEngine.Advertisements.ShowResult.html"><c>ShowResult</c></a> enum to the <a href="../api/UnityEngine.Advertisements.ShowOptions.html"><c>ShowOptions.resultCallback</c></a> callback when the ad finishes.
|
|
/// </summary>
|
|
/// <param name="showOptions">A collection of options, including <c>resultCallback</c>, for modifying ad behavior.</param>
|
|
public static void Show(ShowOptions showOptions)
|
|
{
|
|
Show(null, showOptions, null);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Displays an ad in a specified <a href="../manual/MonetizationPlacements.html">Placement</a> if it is ready.
|
|
/// </summary>
|
|
/// <seealso cref="Advertisement.IsReady()"/>
|
|
/// <param name="placementId">The unique identifier for a specific Placement, found on the <a href="https://operate.dashboard.unity3d.com/">developer dashboard</a>.</param>
|
|
public static void Show(string placementId)
|
|
{
|
|
Show(placementId, null, null);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Displays an ad in a specified <a href="../manual/MonetizationPlacements.html">Placement</a> if it is ready, and passes a <a href="..api/UnityEngine.Advertisements.ShowResult.html"><c>ShowResult</c></a> enum to the <a href="../api/UnityEngine.Advertisements.ShowOptions.html"><c>ShowOptions.resultCallback</c></a> callback when the ad finishes.
|
|
/// </summary>
|
|
/// <param name="placementId">The unique identifier for a specific Placement, found on the <a href="https://operate.dashboard.unity3d.com/">developer dashboard</a>.</param>
|
|
/// <param name="showOptions">A collection of options, including <c>resultCallback</c>, for modifying ad behavior.</param>
|
|
public static void Show(string placementId, ShowOptions showOptions)
|
|
{
|
|
Show(placementId, showOptions, null);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Displays an ad in a specified <a href="../manual/MonetizationPlacements.html">Placement</a> if it is ready.
|
|
/// </summary>
|
|
/// <seealso cref="Advertisement.IsReady()"/>
|
|
/// <param name="placementId">The unique identifier for a specific Placement, found on the <a href="https://operate.dashboard.unity3d.com/">developer dashboard</a>.</param>
|
|
/// <param name="showListener">A listener for <c>IUnityAdsShowListener</c> callbacks</param>
|
|
public static void Show(string placementId, IUnityAdsShowListener showListener)
|
|
{
|
|
Show(placementId, null, showListener);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Displays an ad in a specified <a href="../manual/MonetizationPlacements.html">Placement</a> if it is ready, and passes a <a href="..api/UnityEngine.Advertisements.ShowResult.html"><c>ShowResult</c></a> enum to the <a href="../api/UnityEngine.Advertisements.ShowOptions.html"><c>ShowOptions.resultCallback</c></a> callback when the ad finishes.
|
|
/// </summary>
|
|
/// <param name="placementId">The unique identifier for a specific Placement, found on the <a href="https://operate.dashboard.unity3d.com/">developer dashboard</a>.</param>
|
|
/// <param name="showOptions">A collection of options, including <c>resultCallback</c>, for modifying ad behavior.</param>
|
|
/// <param name="showListener">A listener for <c>IUnityAdsShowListener</c> callbacks</param>
|
|
public static void Show(string placementId, ShowOptions showOptions, IUnityAdsShowListener showListener)
|
|
{
|
|
s_Platform.Show(placementId, showOptions, showListener);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Sets various metadata for the SDK.
|
|
/// </summary>
|
|
/// <param name="metaData">A metadata container.</param>
|
|
public static void SetMetaData(MetaData metaData)
|
|
{
|
|
s_Platform.SetMetaData(metaData);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Adds a listener that will recieve Unity Ads callbacks. SDK versions 3.1+ allow you to register multiple listeners. This is especially helpful for mediation customers.
|
|
/// </summary>
|
|
/// <param name="listener">A listener for Unity Ads callbacks.</param>
|
|
public static void AddListener(IUnityAdsListener listener)
|
|
{
|
|
s_Platform?.AddListener(listener);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Allows you to remove an active listener.
|
|
/// </summary>
|
|
/// <param name="listener">A listener for Unity Ads callbacks.</param>
|
|
public static void RemoveListener(IUnityAdsListener listener)
|
|
{
|
|
s_Platform?.RemoveListener(listener);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Returns the state of the default <a href="../manual/MonetizationPlacements.html">Placement</a>.
|
|
/// </summary>
|
|
public static PlacementState GetPlacementState()
|
|
{
|
|
return s_Platform.GetPlacementState(null);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Returns the state of a specified <a href="../manual/MonetizationPlacements.html">Placement</a>.
|
|
/// </summary>
|
|
/// <param name="placementId">The unique identifier for a specific Placement, found on the <a href="https://operate.dashboard.unity3d.com/">developer dashboard</a>.</param>
|
|
public static PlacementState GetPlacementState(string placementId)
|
|
{
|
|
return s_Platform.GetPlacementState(string.IsNullOrEmpty(placementId) ? null : placementId);
|
|
}
|
|
|
|
private static IPlatform CreatePlatform()
|
|
{
|
|
try
|
|
{
|
|
IUnityLifecycleManager unityLifecycleManager = new UnityLifecycleManager();
|
|
INativePlatform nativePlatform;
|
|
INativeBanner nativeBanner;
|
|
#if UNITY_EDITOR
|
|
nativeBanner = new Platform.Editor.EditorBanner();
|
|
nativePlatform = new Platform.Editor.EditorPlatform();
|
|
#elif UNITY_ANDROID
|
|
nativeBanner = new Platform.Android.AndroidBanner();
|
|
var androidPlatform = new Platform.Android.AndroidPlatform();
|
|
unityLifecycleManager.SetOnApplicationQuitCallback(() => {
|
|
androidPlatform.RemoveListener();
|
|
});
|
|
nativePlatform = androidPlatform;
|
|
#elif UNITY_IOS
|
|
nativeBanner = new Platform.iOS.IosBanner();
|
|
nativePlatform = new Platform.iOS.IosPlatform();
|
|
#else
|
|
nativeBanner = new Platform.Unsupported.UnsupportedBanner();
|
|
nativePlatform = new Platform.Unsupported.UnsupportedPlatform();
|
|
#endif
|
|
IBanner banner = new Advertisements.Banner(nativeBanner, unityLifecycleManager);
|
|
return new Platform.Platform(nativePlatform, banner, unityLifecycleManager);
|
|
}
|
|
catch (Exception exception)
|
|
{
|
|
try
|
|
{
|
|
Debug.LogError("Initializing Unity Ads.");
|
|
Debug.LogError(exception.Message);
|
|
}
|
|
catch (MissingMethodException)
|
|
{
|
|
}
|
|
|
|
var unsupportedPlatform = new Platform.Unsupported.UnsupportedPlatform();
|
|
var coroutineExecutor = new UnityLifecycleManager();
|
|
var unsupportedBanner = new Platform.Unsupported.UnsupportedBanner();
|
|
var genericBanner = new Advertisements.Banner(unsupportedBanner, coroutineExecutor);
|
|
return new Platform.Platform(unsupportedPlatform, genericBanner, coroutineExecutor);
|
|
}
|
|
}
|
|
|
|
private static bool IsSupported()
|
|
{
|
|
return Application.isEditor || Application.platform == RuntimePlatform.Android || Application.platform == RuntimePlatform.IPhonePlayer;
|
|
}
|
|
|
|
/// <summary>
|
|
/// A static class for implementing banner ads.
|
|
/// </summary>
|
|
public static class Banner
|
|
{
|
|
/// <summary>
|
|
/// Loads the banner ad with the default <a href="../manual/MonetizationPlacements.html">Placement</a>, and no callbacks.
|
|
/// </summary>
|
|
public static void Load()
|
|
{
|
|
Load(null, null);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Loads the banner ad with the default <a href="../manual/MonetizationPlacements.html">Placement</a>, but fires the <c>loadCallback</c> callback on successful load, and the <c>errorCallback</c> callback on failure to load.
|
|
/// </summary>
|
|
/// <param name="options">A collection of options that notify the SDK of events when loading the banner.</param>
|
|
public static void Load(BannerLoadOptions options)
|
|
{
|
|
Load(null, options);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Loads the banner ad with a specified <a href="../manual/MonetizationPlacements.html">Placement</a>, and no callbacks.
|
|
/// </summary>
|
|
/// <param name="placementId">The unique identifier for a specific Placement, found on the <a href="https://operate.dashboard.unity3d.com/">developer dashboard</a>.</param>
|
|
public static void Load(string placementId)
|
|
{
|
|
Load(placementId, null);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Loads the banner ad with a specified <a href="../manual/MonetizationPlacements.html">Placement</a>, but fires the <c>loadCallback</c> callback on successful load, and the <c>errorCallback</c> callback on failure to load.
|
|
/// </summary>
|
|
/// <param name="placementId">The unique identifier for a specific Placement, found on the <a href="https://operate.dashboard.unity3d.com/">developer dashboard</a>.</param>
|
|
/// <param name="options">A collection of options that notify the SDK of events when loading the banner.</param>
|
|
public static void Load(string placementId, BannerLoadOptions options)
|
|
{
|
|
s_Platform.Banner.Load(placementId, options);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Displays the banner ad with the default <a href="../manual/MonetizationPlacements.html">Placement</a>, and no callbacks.
|
|
/// </summary>
|
|
public static void Show()
|
|
{
|
|
Show(null, null);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Displays the banner ad with the default <a href="../manual/MonetizationPlacements.html">Placement</a>, but fires the <c>showCallback</c> callback if the banner is visible, and the <c>hideCallback</c> if it isn't.
|
|
/// </summary>
|
|
/// <param name="options">A collection of options that notify the SDK of events when displaying the banner.</param>
|
|
public static void Show(BannerOptions options)
|
|
{
|
|
Show(null, options);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Displays the banner ad with a specified <a href="../manual/MonetizationPlacements.html">Placement</a>, and no callbacks.
|
|
/// </summary>
|
|
/// <param name="placementId">The unique identifier for a specific Placement, found on the <a href="https://operate.dashboard.unity3d.com/">developer dashboard</a>.</param>
|
|
public static void Show(string placementId)
|
|
{
|
|
Show(placementId, null);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Displays the banner ad with a specified <a href="../manual/MonetizationPlacements.html">Placement</a>, but fires the <c>showCallback</c> callback if the banner is visible, and the <c>hideCallback</c> if it isn't.
|
|
/// </summary>
|
|
/// <param name="placementId">The unique identifier for a specific Placement, found on the <a href="https://operate.dashboard.unity3d.com/">developer dashboard</a>.</param>
|
|
/// <param name="options">A collection of options that notify the SDK of events when displaying the banner.</param>
|
|
public static void Show(string placementId, BannerOptions options)
|
|
{
|
|
s_Platform.Banner.Show(string.IsNullOrEmpty(placementId) ? null : placementId, options);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Allows you to hide a banner ad, instead of destroying it altogether.
|
|
/// </summary>
|
|
public static void Hide(bool destroy = false)
|
|
{
|
|
s_Platform.Banner.Hide(destroy);
|
|
}
|
|
|
|
/// <summary>
|
|
/// <para>Sets the position of the banner ad, using the <a href="../api/UnityEngine.Advertisements.BannerPosition.html"><c>BannerPosition</c></a> enum.</para>
|
|
/// <para>Banner position defaults to <c>BannerPosition.BOTTOM_CENTER</c>.</para>
|
|
/// </summary>
|
|
/// <param name="position">An enum representing the on-screen anchor position of the banner ad.</param>
|
|
public static void SetPosition(BannerPosition position)
|
|
{
|
|
s_Platform.Banner.SetPosition(position);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Returns <c>true</c> if a banner is currently available, and <c>false</c> if it isn't.
|
|
/// </summary>
|
|
public static bool isLoaded => s_Platform.Banner.IsLoaded;
|
|
}
|
|
}
|
|
}
|