You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
CrowdControl/Assets/MaxSdk/Scripts/MaxSdkUnityEditor.cs

1449 lines
60 KiB
C#

// This script is used for Unity Editor and non Android or iOS platforms.
#if UNITY_EDITOR || !(UNITY_ANDROID || UNITY_IPHONE || UNITY_IOS)
using System;
using System.Collections;
using System.Collections.Generic;
using System.Globalization;
using AppLovinMax.Internal;
using AppLovinMax.ThirdParty.MiniJson;
#if UNITY_EDITOR
using UnityEditor;
#endif
using UnityEngine;
using UnityEngine.UI;
using Object = UnityEngine.Object;
/// <summary>
/// Unity Editor AppLovin MAX Unity Plugin implementation
/// </summary>
public class MaxSdkUnityEditor : MaxSdkBase
{
private static bool _isInitialized;
private static bool _hasSdkKey;
private static bool _hasUserConsent = false;
private static bool _isUserConsentSet = false;
private static bool _isAgeRestrictedUser = false;
private static bool _isAgeRestrictedUserSet = false;
private static bool _doNotSell = false;
private static bool _isDoNotSellSet = false;
private static bool _showStubAds = true;
private static SafeAreaInsets _safeAreaInsets = new SafeAreaInsets(new int[] {0, 0, 0, 0});
private static readonly HashSet<string> RequestedAdUnits = new HashSet<string>();
private static readonly HashSet<string> ReadyAdUnits = new HashSet<string>();
private static readonly Dictionary<string, GameObject> StubBanners = new Dictionary<string, GameObject>();
public static MaxUserServiceUnityEditor UserService
{
get { return MaxUserServiceUnityEditor.Instance; }
}
[RuntimeInitializeOnLoadMethod]
public static void InitializeMaxSdkUnityEditorOnLoad()
{
// Unity destroys the stub banners each time the editor exits play mode, but the StubBanners stays in memory if Enter Play Mode settings is enabled.
StubBanners.Clear();
}
/// <summary>
/// Set AppLovin SDK Key.
///
/// This method must be called before any other SDK operation
/// </summary>
/// <param name="sdkKey">AppLovin SDK key. Must not be null.</param>
public static void SetSdkKey(string sdkKey)
{
_hasSdkKey = true;
}
#region Initialization
/// <summary>
/// Initialize the default instance of AppLovin SDK.
///
/// Please make sure that application's Android manifest or Info.plist includes the AppLovin SDK key.
///
/// <param name="adUnitIds">
/// OPTIONAL: Set the MAX ad unit ids to be used for this instance of the SDK. 3rd-party SDKs will be initialized with the credentials configured for these ad unit ids.
/// This should only be used if you have different sets of ad unit ids / credentials for the same package name.</param>
/// </summary>
public static void InitializeSdk(string[] adUnitIds = null)
{
_ensureHaveSdkKey();
_isInitialized = true;
_hasSdkKey = true;
// Slight delay to emulate the SDK initializing
ExecuteWithDelay(0.1f, () =>
{
_isInitialized = true;
#if UNITY_EDITOR
MaxSdkCallbacks.EmitSdkInitializedEvent();
#endif
});
}
/// <summary>
/// Check if the SDK has been initialized.
/// </summary>
/// <returns>True if SDK has been initialized</returns>
public static bool IsInitialized()
{
return _isInitialized;
}
/// <summary>
/// Prevent stub ads from showing in the Unity Editor
/// </summary>
public static void DisableStubAds()
{
_showStubAds = false;
}
#endregion
#region User Info
/// <summary>
/// Set an identifier for the current user. This identifier will be tied to SDK events and our optional S2S postbacks.
///
/// If you're using reward validation, you can optionally set an identifier to be included with currency validation postbacks.
/// For example, a username or email. We'll include this in the postback when we ping your currency endpoint from our server.
/// </summary>
///
/// <param name="userId">The user identifier to be set. Must not be null.</param>
public static void SetUserId(string userId) { }
/// <summary>
/// User segments allow us to serve ads using custom-defined rules based on which segment the user is in. For now, we only support a custom string 32 alphanumeric characters or less as the user segment.
/// </summary>
public static MaxUserSegment UserSegment
{
get { return SharedUserSegment; }
}
/// <summary>
/// This class allows you to provide user or app data that will improve how we target ads.
/// </summary>
public static MaxTargetingData TargetingData
{
get { return SharedTargetingData; }
}
#endregion
#region MAX
/// <summary>
/// Returns the list of available mediation networks.
///
/// Please call this method after the SDK has initialized.
/// </summary>
public static List<MaxSdkBase.MediatedNetworkInfo> GetAvailableMediatedNetworks()
{
return new List<MaxSdkBase.MediatedNetworkInfo>();
}
/// <summary>
/// Present the mediation debugger UI.
/// This debugger tool provides the status of your integration for each third-party ad network.
///
/// Please call this method after the SDK has initialized.
/// </summary>
public static void ShowMediationDebugger()
{
if (!_isInitialized)
{
MaxSdkLogger.UserWarning("The mediation debugger cannot be shown before the MAX SDK has been initialized."
+ "\nCall 'MaxSdk.InitializeSdk();' and listen for 'MaxSdkCallbacks.OnSdkInitializedEvent' before showing the mediation debugger.");
}
else
{
MaxSdkLogger.UserWarning("The mediation debugger cannot be shown in the Unity Editor. Please export the project to Android or iOS first.");
}
}
/// <summary>
/// Present the mediation debugger UI.
///
/// Please call this method after the SDK has initialized.
/// </summary>
public static void ShowCreativeDebugger()
{
if (!_isInitialized)
{
MaxSdkLogger.UserWarning("The creative debugger cannot be shown before the MAX SDK has been initialized."
+ "\nCall 'MaxSdk.InitializeSdk();' and listen for 'MaxSdkCallbacks.OnSdkInitializedEvent' before showing the mediation debugger.");
}
else
{
MaxSdkLogger.UserWarning("The creative debugger cannot be shown in the Unity Editor. Please export the project to Android or iOS first.");
}
}
/// <summary>
/// Returns the arbitrary ad value for a given ad unit identifier with key. Returns null if no ad is loaded.
/// </summary>
/// <param name="adUnitIdentifier">Ad unit identifier for which to get the ad value for. Must not be null.</param>
/// <param name="key">Ad value key. Must not be null.</param>
/// <returns>Arbitrary ad value for a given key, or null if no ad is loaded.</returns>
public static string GetAdValue(string adUnitIdentifier, string key)
{
return "";
}
#endregion
#region Privacy
/// <summary>
/// Get the SDK configuration for this user.
///
/// Note: This method should be called only after SDK has been initialized.
/// </summary>
public static SdkConfiguration GetSdkConfiguration()
{
return SdkConfiguration.CreateEmpty();
}
/// <summary>
/// Set whether or not user has provided consent for information sharing with AppLovin and other providers.
/// </summary>
/// <param name="hasUserConsent"><c>true</c> if the user has provided consent for information sharing with AppLovin. <c>false</c> by default.</param>
public static void SetHasUserConsent(bool hasUserConsent)
{
_hasUserConsent = hasUserConsent;
_isUserConsentSet = true;
}
/// <summary>
/// Check if user has provided consent for information sharing with AppLovin and other providers.
/// </summary>
/// <returns><c>true</c> if user has provided consent for information sharing. <c>false</c> if the user declined to share information or the consent value has not been set <see cref="IsUserConsentSet"/>.</returns>
public static bool HasUserConsent()
{
return _hasUserConsent;
}
/// <summary>
/// Check if user has set consent for information sharing.
/// </summary>
/// <returns><c>true</c> if user has set a value of consent for information sharing.</returns>
public static bool IsUserConsentSet()
{
return _isUserConsentSet;
}
/// <summary>
/// Mark user as age restricted (i.e. under 16).
/// </summary>
/// <param name="isAgeRestrictedUser"><c>true</c> if the user is age restricted (i.e. under 16).</param>
public static void SetIsAgeRestrictedUser(bool isAgeRestrictedUser)
{
_isAgeRestrictedUser = isAgeRestrictedUser;
_isAgeRestrictedUserSet = true;
}
/// <summary>
/// Check if user is age restricted.
/// </summary>
/// <returns><c>true</c> if the user is age-restricted. <c>false</c> if the user is not age-restricted or the age-restriction has not been set<see cref="IsAgeRestrictedUserSet"/>.</returns>
public static bool IsAgeRestrictedUser()
{
return _isAgeRestrictedUser;
}
/// <summary>
/// Check if user set its age restricted settings.
/// </summary>
/// <returns><c>true</c> if user has set its age restricted settings.</returns>
public static bool IsAgeRestrictedUserSet()
{
return _isAgeRestrictedUserSet;
}
/// <summary>
/// Set whether or not user has opted out of the sale of their personal information.
/// </summary>
/// <param name="doNotSell"><c>true</c> if the user has opted out of the sale of their personal information.</param>
public static void SetDoNotSell(bool doNotSell)
{
_doNotSell = doNotSell;
_isDoNotSellSet = true;
}
/// <summary>
/// Check if the user has opted out of the sale of their personal information.
/// </summary>
/// <returns><c>true</c> if the user has opted out of the sale of their personal information. <c>false</c> if the user opted in to the sell of their personal information or the value has not been set <see cref="IsDoNotSellSet"/>.</returns>
public static bool IsDoNotSell()
{
return _doNotSell;
}
/// <summary>
/// Check if the user has set the option to sell their personal information.
/// </summary>
/// <returns><c>true</c> if user has chosen an option to sell their personal information.</returns>
public static bool IsDoNotSellSet()
{
return _isDoNotSellSet;
}
#endregion
#region Banners
/// <summary>
/// Create a new banner.
/// </summary>
/// <param name="adUnitIdentifier">Ad unit identifier of the banner to create. Must not be null.</param>
/// <param name="bannerPosition">Banner position. Must not be null.</param>
public static void CreateBanner(string adUnitIdentifier, BannerPosition bannerPosition)
{
ValidateAdUnitIdentifier(adUnitIdentifier, "create banner");
RequestAdUnit(adUnitIdentifier);
if (_showStubAds && !StubBanners.ContainsKey(adUnitIdentifier))
{
CreateStubBanner(adUnitIdentifier, bannerPosition);
}
ExecuteWithDelay(1f, () =>
{
var eventProps = Json.Serialize(CreateBaseEventPropsDictionary("OnBannerAdLoadedEvent", adUnitIdentifier));
MaxSdkCallbacks.ForwardEvent(eventProps);
});
}
/// <summary>
/// Create a new banner with a custom position.
/// </summary>
/// <param name="adUnitIdentifier">Ad unit identifier of the banner to create. Must not be null.</param>
/// <param name="x">The X coordinate (horizontal position) of the banner relative to the top left corner of the screen.</param>
/// <param name="y">The Y coordinate (vertical position) of the banner relative to the top left corner of the screen.</param>
/// <seealso cref="GetBannerLayout">
/// The banner is placed within the safe area of the screen. You can use this to get the absolute position of the banner on screen.
/// </seealso>
public static void CreateBanner(string adUnitIdentifier, float x, float y)
{
ValidateAdUnitIdentifier(adUnitIdentifier, "create banner");
RequestAdUnit(adUnitIdentifier);
// TODO: Add stub ads support
}
private static void CreateStubBanner(string adUnitIdentifier, BannerPosition bannerPosition)
{
#if UNITY_EDITOR
// Only support BottomCenter and TopCenter for now
var bannerPrefabName = bannerPosition == BannerPosition.BottomCenter ? "BannerBottom" : "BannerTop";
var prefabPath = MaxSdkUtils.GetAssetPathForExportPath("MaxSdk/Prefabs/" + bannerPrefabName + ".prefab");
var bannerPrefab = AssetDatabase.LoadAssetAtPath<GameObject>(prefabPath);
var stubBanner = Object.Instantiate(bannerPrefab, Vector3.zero, Quaternion.identity);
stubBanner.SetActive(false); // Hidden by default
Object.DontDestroyOnLoad(stubBanner);
var bannerText = stubBanner.GetComponentInChildren<Text>();
bannerText.text += ":\n" + adUnitIdentifier;
StubBanners.Add(adUnitIdentifier, stubBanner);
#endif
}
/// <summary>
/// Load a new banner ad.
/// NOTE: The <see cref="CreateBanner()"/> method loads the first banner ad and initiates an automated banner refresh process.
/// You only need to call this method if you pause banner refresh.
/// </summary>
/// <param name="adUnitIdentifier">Ad unit identifier of the banner to load. Must not be null.</param>
public static void LoadBanner(string adUnitIdentifier)
{
ValidateAdUnitIdentifier(adUnitIdentifier, "load banner");
ExecuteWithDelay(1f, () =>
{
var eventProps = Json.Serialize(CreateBaseEventPropsDictionary("OnBannerAdLoadedEvent", adUnitIdentifier));
MaxSdkCallbacks.ForwardEvent(eventProps);
});
}
/// <summary>
/// Set the banner placement for an ad unit identifier to tie the future ad events to.
/// </summary>
/// <param name="adUnitIdentifier">Ad unit identifier of the banner to set the placement for. Must not be null.</param>
/// <param name="placement">Placement to set</param>
public static void SetBannerPlacement(string adUnitIdentifier, string placement)
{
MaxSdkLogger.UserDebug("Setting banner placement to '" + placement + "' for ad unit id '" + adUnitIdentifier + "'");
}
/// <summary>
/// Starts or resumes auto-refreshing of the banner for the given ad unit identifier.
/// </summary>
/// <param name="adUnitIdentifier">Ad unit identifier of the banner for which to start auto-refresh. Must not be null.</param>
public static void StartBannerAutoRefresh(string adUnitIdentifier)
{
MaxSdkLogger.UserDebug("Starting banner auto refresh.");
}
/// <summary>
/// Pauses auto-refreshing of the banner for the given ad unit identifier.
/// </summary>
/// <param name="adUnitIdentifier">Ad unit identifier of the banner for which to stop auto-refresh. Must not be null.</param>
public static void StopBannerAutoRefresh(string adUnitIdentifier)
{
MaxSdkLogger.UserDebug("Stopping banner auto refresh.");
}
/// <summary>
/// Updates the position of the banner to the new position provided.
/// </summary>
/// <param name="adUnitIdentifier">The ad unit identifier of the banner for which to update the position. Must not be null.</param>
/// <param name="bannerPosition">A new position for the banner. Must not be null.</param>
public static void UpdateBannerPosition(string adUnitIdentifier, BannerPosition bannerPosition)
{
Debug.Log("[AppLovin MAX] Updating banner position to '" + bannerPosition + "' for ad unit id '" + adUnitIdentifier + "'");
}
/// <summary>
/// Updates the position of the banner to the new coordinates provided.
/// </summary>
/// <param name="adUnitIdentifier">The ad unit identifier of the banner for which to update the position. Must not be null.</param>
/// <param name="x">The X coordinate (horizontal position) of the banner relative to the top left corner of the screen.</param>
/// <param name="y">The Y coordinate (vertical position) of the banner relative to the top left corner of the screen.</param>
/// <seealso cref="GetBannerLayout">
/// The banner is placed within the safe area of the screen. You can use this to get the absolute position of the banner on screen.
/// </seealso>
public static void UpdateBannerPosition(string adUnitIdentifier, float x, float y)
{
MaxSdkLogger.UserDebug("Updating banner position to '(" + x + "," + y + ")");
}
/// <summary>
/// Overrides the width of the banner in points/dp.
/// </summary>
/// <param name="adUnitIdentifier">The ad unit identifier of the banner for which to override the width for. Must not be null.</param>
/// <param name="width">The desired width of the banner in points/dp</param>
public static void SetBannerWidth(string adUnitIdentifier, float width)
{
// NOTE: Will implement in a future release
Debug.Log("[AppLovin MAX] Set banner width to '" + width + "' for ad unit id '" + adUnitIdentifier + "'");
}
/// <summary>
/// Show banner at a position determined by the 'CreateBanner' call.
/// </summary>
/// <param name="adUnitIdentifier">Ad unit identifier of the banner to show. Must not be null.</param>
public static void ShowBanner(string adUnitIdentifier)
{
ValidateAdUnitIdentifier(adUnitIdentifier, "show banner");
if (!IsAdUnitRequested(adUnitIdentifier))
{
MaxSdkLogger.UserWarning("Banner '" + adUnitIdentifier + "' was not created, can not show it");
}
else
{
GameObject stubBanner;
if (StubBanners.TryGetValue(adUnitIdentifier, out stubBanner))
{
stubBanner.SetActive(true);
}
}
}
/// <summary>
/// Remove banner from the ad view and destroy it.
/// </summary>
/// <param name="adUnitIdentifier">Ad unit identifier of the banner to destroy. Must not be null.</param>
public static void DestroyBanner(string adUnitIdentifier)
{
ValidateAdUnitIdentifier(adUnitIdentifier, "destroy banner");
GameObject stubBanner;
if (StubBanners.TryGetValue(adUnitIdentifier, out stubBanner))
{
Object.Destroy(stubBanner);
StubBanners.Remove(adUnitIdentifier);
}
}
/// <summary>
/// Hide banner.
/// </summary>
/// <param name="adUnitIdentifier">Ad unit identifier of the banner to hide. Must not be null.</param>
public static void HideBanner(string adUnitIdentifier)
{
ValidateAdUnitIdentifier(adUnitIdentifier, "hide banner");
GameObject stubBanner;
if (StubBanners.TryGetValue(adUnitIdentifier, out stubBanner))
{
stubBanner.SetActive(false);
}
}
/// <summary>
/// Set non-transparent background color for banners to be fully functional.
/// </summary>
/// <param name="adUnitIdentifier">Ad unit identifier of the banner to set background color for. Must not be null.</param>
/// <param name="color">A background color to set for the ad. Must not be null.</param>
public static void SetBannerBackgroundColor(string adUnitIdentifier, Color color)
{
ValidateAdUnitIdentifier(adUnitIdentifier, "set background color");
GameObject stubBanner;
if (StubBanners.TryGetValue(adUnitIdentifier, out stubBanner))
{
stubBanner.GetComponentInChildren<Image>().color = color;
}
}
/// <summary>
/// Set an extra parameter for the banner ad.
/// </summary>
/// <param name="adUnitIdentifier">Ad unit identifier of the banner to set the extra parameter for. Must not be null.</param>
/// <param name="key">The key for the extra parameter. Must not be null.</param>
/// <param name="value">The value for the extra parameter.</param>
public static void SetBannerExtraParameter(string adUnitIdentifier, string key, string value)
{
ValidateAdUnitIdentifier(adUnitIdentifier, "set banner extra parameter");
}
/// <summary>
/// Set a local extra parameter for the banner ad.
/// </summary>
/// <param name="adUnitIdentifier">Ad unit identifier of the banner to set the local extra parameter for. Must not be null.</param>
/// <param name="key">The key for the local extra parameter. Must not be null.</param>
/// <param name="value">The value for the local extra parameter.</param>
public static void SetBannerLocalExtraParameter(string adUnitIdentifier, string key, object value)
{
ValidateAdUnitIdentifier(adUnitIdentifier, "set banner local extra parameter");
}
/// <summary>
/// The custom data to tie the showing banner ad to, for ILRD and rewarded postbacks via the <c>{CUSTOM_DATA}</c> macro. Maximum size is 8KB.
/// </summary>
/// <param name="adUnitIdentifier">Banner ad unit identifier of the banner to set the custom data for. Must not be null.</param>
/// <param name="customData">The custom data to be set.</param>
public static void SetBannerCustomData(string adUnitIdentifier, string customData)
{
ValidateAdUnitIdentifier(adUnitIdentifier, "set banner custom data");
}
/// <summary>
/// The banner position on the screen. When setting the banner position via <see cref="CreateBanner(string, float, float)"/> or <see cref="UpdateBannerPosition(string, float, float)"/>,
/// the banner is placed within the safe area of the screen. This returns the absolute position of the banner on screen.
/// </summary>
/// <param name="adUnitIdentifier">Ad unit identifier of the banner for which to get the position on screen. Must not be null.</param>
/// <returns>A <see cref="Rect"/> representing the banner position on screen.</returns>
public static Rect GetBannerLayout(string adUnitIdentifier)
{
ValidateAdUnitIdentifier(adUnitIdentifier, "get banner layout");
return Rect.zero;
}
#endregion
#region MRECs
/// <summary>
/// Create a new MREC.
/// </summary>
/// <param name="adUnitIdentifier">Ad unit identifier of the MREC to create. Must not be null.</param>
/// <param name="mrecPosition">MREC position. Must not be null.</param>
public static void CreateMRec(string adUnitIdentifier, AdViewPosition mrecPosition)
{
ValidateAdUnitIdentifier(adUnitIdentifier, "create MREC");
RequestAdUnit(adUnitIdentifier);
ExecuteWithDelay(1f, () =>
{
var eventProps = Json.Serialize(CreateBaseEventPropsDictionary("OnMRecAdLoadedEvent", adUnitIdentifier));
MaxSdkCallbacks.ForwardEvent(eventProps);
});
}
/// <summary>
/// Create a new MREC with a custom position.
/// </summary>
/// <param name="adUnitIdentifier">Ad unit identifier of the MREC to create. Must not be null.</param>
/// <param name="x">The X coordinate (horizontal position) of the MREC relative to the top left corner of the screen.</param>
/// <param name="y">The Y coordinate (vertical position) of the MREC relative to the top left corner of the screen.</param>
/// <seealso cref="GetMRecLayout">
/// The MREC is placed within the safe area of the screen. You can use this to get the absolute position Rect of the MREC on screen.
/// </seealso>
public static void CreateMRec(string adUnitIdentifier, float x, float y)
{
ValidateAdUnitIdentifier(adUnitIdentifier, "create MREC");
RequestAdUnit(adUnitIdentifier);
}
/// <summary>
/// Load a new MREC ad.
/// NOTE: The <see cref="CreateMRec()"/> method loads the first MREC ad and initiates an automated MREC refresh process.
/// You only need to call this method if you pause MREC refresh.
/// </summary>
/// <param name="adUnitIdentifier">Ad unit identifier of the MREC to load. Must not be null.</param>
public static void LoadMRec(string adUnitIdentifier)
{
ValidateAdUnitIdentifier(adUnitIdentifier, "load MREC");
ExecuteWithDelay(1f, () =>
{
var eventProps = Json.Serialize(CreateBaseEventPropsDictionary("OnMRecAdLoadedEvent", adUnitIdentifier));
MaxSdkCallbacks.ForwardEvent(eventProps);
});
}
/// <summary>
/// Set the MREC placement for an ad unit identifier to tie the future ad events to.
/// </summary>
/// <param name="adUnitIdentifier">Ad unit identifier of the MREC to set the placement for. Must not be null.</param>
/// <param name="placement">Placement to set</param>
public static void SetMRecPlacement(string adUnitIdentifier, string placement)
{
MaxSdkLogger.UserDebug("Setting MREC placement to '" + placement + "' for ad unit id '" + adUnitIdentifier + "'");
}
/// <summary>
/// Starts or resumes auto-refreshing of the MREC for the given ad unit identifier.
/// </summary>
/// <param name="adUnitIdentifier">Ad unit identifier of the MREC for which to start auto-refresh. Must not be null.</param>
public static void StartMRecAutoRefresh(string adUnitIdentifier)
{
MaxSdkLogger.UserDebug("Starting banner auto refresh.");
}
/// <summary>
/// Pauses auto-refreshing of the MREC for the given ad unit identifier.
/// </summary>
/// <param name="adUnitIdentifier">Ad unit identifier of the MREC for which to stop auto-refresh. Must not be null.</param>
public static void StopMRecAutoRefresh(string adUnitIdentifier)
{
MaxSdkLogger.UserDebug("Stopping banner auto refresh.");
}
/// <summary>
/// Updates the position of the MREC to the new position provided.
/// </summary>
/// <param name="adUnitIdentifier">The ad unit identifier of the MREC for which to update the position. Must not be null.</param>
/// <param name="mrecPosition">A new position for the MREC. Must not be null.</param>
public static void UpdateMRecPosition(string adUnitIdentifier, AdViewPosition mrecPosition)
{
MaxSdkLogger.UserDebug("Updating MREC position to '" + mrecPosition + "' for ad unit id '" + adUnitIdentifier + "'");
}
/// <summary>
/// Updates the position of the MREC to the new coordinates provided.
/// </summary>
/// <param name="adUnitIdentifier">The ad unit identifier of the MREC for which to update the position. Must not be null.</param>
/// <param name="x">The X coordinate (horizontal position) of the MREC relative to the top left corner of the screen.</param>
/// <param name="y">The Y coordinate (vertical position) of the MREC relative to the top left corner of the screen.</param>
/// <seealso cref="GetMRecLayout">
/// The MREC is placed within the safe area of the screen. You can use this to get the absolute position Rect of the MREC on screen.
/// </seealso>
public static void UpdateMRecPosition(string adUnitIdentifier, float x, float y)
{
MaxSdkLogger.UserDebug("Updating MREC position to '(" + x + "," + y + ")");
}
/// <summary>
/// Show MREC at a position determined by the 'CreateMRec' call.
/// </summary>
/// <param name="adUnitIdentifier">Ad unit identifier of the MREC to show. Must not be null.</param>
public static void ShowMRec(string adUnitIdentifier)
{
ValidateAdUnitIdentifier(adUnitIdentifier, "show MREC");
if (!IsAdUnitRequested(adUnitIdentifier))
{
MaxSdkLogger.UserWarning("MREC '" + adUnitIdentifier + "' was not created, can not show it");
}
}
/// <summary>
/// Remove MREC from the ad view and destroy it.
/// </summary>
/// <param name="adUnitIdentifier">Ad unit identifier of the MREC to destroy. Must not be null.</param>
public static void DestroyMRec(string adUnitIdentifier)
{
ValidateAdUnitIdentifier(adUnitIdentifier, "destroy MREC");
}
/// <summary>
/// Hide MREC.
/// </summary>
/// <param name="adUnitIdentifier">Ad unit identifier of the MREC to hide. Must not be null.</param>
public static void HideMRec(string adUnitIdentifier)
{
ValidateAdUnitIdentifier(adUnitIdentifier, "hide MREC");
}
/// <summary>
/// Set an extra parameter for the MREC ad.
/// </summary>
/// <param name="adUnitIdentifier">Ad unit identifier of the MREC to set the extra parameter for. Must not be null.</param>
/// <param name="key">The key for the extra parameter. Must not be null.</param>
/// <param name="value">The value for the extra parameter.</param>
public static void SetMRecExtraParameter(string adUnitIdentifier, string key, string value)
{
ValidateAdUnitIdentifier(adUnitIdentifier, "set MREC extra parameter");
}
/// <summary>
/// Set a local extra parameter for the MREC ad.
/// </summary>
/// <param name="adUnitIdentifier">Ad unit identifier of the MREC to set the local extra parameter for. Must not be null.</param>
/// <param name="key">The key for the local extra parameter. Must not be null.</param>
/// <param name="value">The value for the local extra parameter.</param>
public static void SetMRecLocalExtraParameter(string adUnitIdentifier, string key, object value)
{
ValidateAdUnitIdentifier(adUnitIdentifier, "set MREC local extra parameter");
}
/// <summary>
/// The custom data to tie the showing MREC ad to, for ILRD and rewarded postbacks via the <c>{CUSTOM_DATA}</c> macro. Maximum size is 8KB.
/// </summary>
/// <param name="adUnitIdentifier">MREC Ad unit identifier of the banner to set the custom data for. Must not be null.</param>
/// <param name="customData">The custom data to be set.</param>
public static void SetMRecCustomData(string adUnitIdentifier, string customData)
{
ValidateAdUnitIdentifier(adUnitIdentifier, "set MREC custom data");
}
/// <summary>
/// The MREC position on the screen. When setting the MREC position via <see cref="CreateMRec(string, float, float)"/> or <see cref="UpdateMRecPosition(string, float, float)"/>,
/// the MREC is placed within the safe area of the screen. This returns the absolute position of the MREC on screen.
/// </summary>
/// <param name="adUnitIdentifier">Ad unit identifier of the MREC for which to get the position on screen. Must not be null.</param>
/// <returns>A <see cref="Rect"/> representing the banner position on screen.</returns>
public static Rect GetMRecLayout(string adUnitIdentifier)
{
ValidateAdUnitIdentifier(adUnitIdentifier, "get MREC layout");
return Rect.zero;
}
#endregion
#region Interstitials
/// <summary>
/// Start loading an interstitial.
/// </summary>
/// <param name="adUnitIdentifier">Ad unit identifier of the interstitial to load</param>
public static void LoadInterstitial(string adUnitIdentifier)
{
ValidateAdUnitIdentifier(adUnitIdentifier, "load interstitial");
RequestAdUnit(adUnitIdentifier);
ExecuteWithDelay(1f, () =>
{
AddReadyAdUnit(adUnitIdentifier);
var eventProps = Json.Serialize(CreateBaseEventPropsDictionary("OnInterstitialLoadedEvent", adUnitIdentifier));
MaxSdkCallbacks.ForwardEvent(eventProps);
});
}
/// <summary>
/// Check if interstitial ad is loaded and ready to be displayed.
/// </summary>
/// <param name="adUnitIdentifier">Ad unit identifier of the interstitial to load</param>
/// <returns>True if the ad is ready to be displayed</returns>
public static bool IsInterstitialReady(string adUnitIdentifier)
{
ValidateAdUnitIdentifier(adUnitIdentifier, "check interstitial loaded");
if (!IsAdUnitRequested(adUnitIdentifier))
{
MaxSdkLogger.UserWarning("Interstitial '" + adUnitIdentifier +
"' was not requested, can not check if it is loaded");
return false;
}
return IsAdUnitReady(adUnitIdentifier);
}
/// <summary>
/// Present loaded interstitial for a given placement to tie ad events to. Note: if the interstitial is not ready to be displayed nothing will happen.
/// </summary>
/// <param name="adUnitIdentifier">Ad unit identifier of the interstitial to load</param>
/// <param name="placement">The placement to tie the showing ad's events to</param>
/// <param name="customData">The custom data to tie the showing ad's events to. Maximum size is 8KB.</param>
public static void ShowInterstitial(string adUnitIdentifier, string placement = null, string customData = null)
{
ValidateAdUnitIdentifier(adUnitIdentifier, "show interstitial");
if (!IsAdUnitRequested(adUnitIdentifier))
{
MaxSdkLogger.UserWarning(
"Interstitial '" + adUnitIdentifier + "' was not requested, can not show it");
return;
}
if (!IsInterstitialReady(adUnitIdentifier))
{
MaxSdkLogger.UserWarning("Interstitial '" + adUnitIdentifier + "' is not ready, please check IsInterstitialReady() before showing.");
return;
}
RemoveReadyAdUnit(adUnitIdentifier);
if (_showStubAds)
{
ShowStubInterstitial(adUnitIdentifier);
}
}
private static void ShowStubInterstitial(string adUnitIdentifier)
{
#if UNITY_EDITOR
var prefabPath = MaxSdkUtils.GetAssetPathForExportPath("MaxSdk/Prefabs/Interstitial.prefab");
var interstitialPrefab = AssetDatabase.LoadAssetAtPath<GameObject>(prefabPath);
var stubInterstitial = Object.Instantiate(interstitialPrefab, Vector3.zero, Quaternion.identity);
var interstitialText = GameObject.Find("MaxInterstitialTitle").GetComponent<Text>();
var closeButton = GameObject.Find("MaxInterstitialCloseButton").GetComponent<Button>();
Object.DontDestroyOnLoad(stubInterstitial);
interstitialText.text += ":\n" + adUnitIdentifier;
closeButton.onClick.AddListener(() =>
{
var adHiddenEventProps = Json.Serialize(CreateBaseEventPropsDictionary("OnInterstitialHiddenEvent", adUnitIdentifier));
MaxSdkCallbacks.ForwardEvent(adHiddenEventProps);
Object.Destroy(stubInterstitial);
});
var adDisplayedEventProps = Json.Serialize(CreateBaseEventPropsDictionary("OnInterstitialDisplayedEvent", adUnitIdentifier));
MaxSdkCallbacks.ForwardEvent(adDisplayedEventProps);
#endif
}
/// <summary>
/// Set an extra parameter for the ad.
/// </summary>
/// <param name="adUnitIdentifier">Ad unit identifier of the interstitial to set the extra parameter for.</param>
/// <param name="key">The key for the extra parameter.</param>
/// <param name="value">The value for the extra parameter.</param>
public static void SetInterstitialExtraParameter(string adUnitIdentifier, string key, string value)
{
ValidateAdUnitIdentifier(adUnitIdentifier, "set interstitial extra parameter");
}
/// <summary>
/// Set a local extra parameter for the ad.
/// </summary>
/// <param name="adUnitIdentifier">Ad unit identifier of the interstitial to set the local extra parameter for.</param>
/// <param name="key">The key for the local extra parameter.</param>
/// <param name="value">The value for the local extra parameter.</param>
public static void SetInterstitialLocalExtraParameter(string adUnitIdentifier, string key, object value)
{
ValidateAdUnitIdentifier(adUnitIdentifier, "set interstitial local extra parameter");
}
#endregion
#region App Open Ads
/// <summary>
/// Start loading an app open ad.
/// </summary>
/// <param name="adUnitIdentifier">Ad unit identifier of the app open ad to load. Must not be null.</param>
public static void LoadAppOpenAd(string adUnitIdentifier)
{
ValidateAdUnitIdentifier(adUnitIdentifier, "load app open ad");
RequestAdUnit(adUnitIdentifier);
ExecuteWithDelay(1f, () =>
{
AddReadyAdUnit(adUnitIdentifier);
var eventProps = Json.Serialize(CreateBaseEventPropsDictionary("OnAppOpenAdLoadedEvent", adUnitIdentifier));
MaxSdkCallbacks.ForwardEvent(eventProps);
});
}
/// <summary>
/// Check if app open ad ad is loaded and ready to be displayed.
/// </summary>
/// <param name="adUnitIdentifier">Ad unit identifier of the app open ad to load. Must not be null.</param>
/// <returns>True if the ad is ready to be displayed</returns>
public static bool IsAppOpenAdReady(string adUnitIdentifier)
{
ValidateAdUnitIdentifier(adUnitIdentifier, "check app open ad loaded");
if (!IsAdUnitRequested(adUnitIdentifier))
{
MaxSdkLogger.UserWarning("App Open Ad '" + adUnitIdentifier +
"' was not requested, can not check if it is loaded");
return false;
}
return IsAdUnitReady(adUnitIdentifier);
}
/// <summary>
/// Present loaded app open ad for a given placement to tie ad events to. Note: if the app open ad is not ready to be displayed nothing will happen.
/// </summary>
/// <param name="adUnitIdentifier">Ad unit identifier of the app open ad to load. Must not be null.</param>
/// <param name="placement">The placement to tie the showing ad's events to</param>
/// <param name="customData">The custom data to tie the showing ad's events to. Maximum size is 8KB.</param>
public static void ShowAppOpenAd(string adUnitIdentifier, string placement = null, string customData = null)
{
ValidateAdUnitIdentifier(adUnitIdentifier, "show app open ad");
if (!IsAdUnitRequested(adUnitIdentifier))
{
MaxSdkLogger.UserWarning(
"App Open Ad '" + adUnitIdentifier + "' was not requested, can not show it");
return;
}
if (!IsAppOpenAdReady(adUnitIdentifier))
{
MaxSdkLogger.UserWarning("App Open Ad '" + adUnitIdentifier + "' is not ready, please check IsAppOpenAdReady() before showing.");
return;
}
RemoveReadyAdUnit(adUnitIdentifier);
if (_showStubAds)
{
ShowStubAppOpenAd(adUnitIdentifier);
}
}
private static void ShowStubAppOpenAd(string adUnitIdentifier)
{
#if UNITY_EDITOR
var prefabPath = MaxSdkUtils.GetAssetPathForExportPath("MaxSdk/Prefabs/Interstitial.prefab");
var appOpenAdPrefab = AssetDatabase.LoadAssetAtPath<GameObject>(prefabPath);
var stubAppOpenAd = Object.Instantiate(appOpenAdPrefab, Vector3.zero, Quaternion.identity);
var appOpenAdText = GameObject.Find("MaxInterstitialTitle").GetComponent<Text>();
var closeButton = GameObject.Find("MaxInterstitialCloseButton").GetComponent<Button>();
Object.DontDestroyOnLoad(stubAppOpenAd);
appOpenAdText.text = "MAX App Open Ad:\n" + adUnitIdentifier;
closeButton.onClick.AddListener(() =>
{
var adHiddenEventProps = Json.Serialize(CreateBaseEventPropsDictionary("OnAppOpenAdHiddenEvent", adUnitIdentifier));
MaxSdkCallbacks.ForwardEvent(adHiddenEventProps);
Object.Destroy(stubAppOpenAd);
});
var adDisplayedEventProps = Json.Serialize(CreateBaseEventPropsDictionary("OnAppOpenAdDisplayedEvent", adUnitIdentifier));
MaxSdkCallbacks.ForwardEvent(adDisplayedEventProps);
#endif
}
/// <summary>
/// Set an extra parameter for the ad.
/// </summary>
/// <param name="adUnitIdentifier">Ad unit identifier of the app open ad to set the extra parameter for. Must not be null.</param>
/// <param name="key">The key for the extra parameter. Must not be null.</param>
/// <param name="value">The value for the extra parameter.</param>
public static void SetAppOpenAdExtraParameter(string adUnitIdentifier, string key, string value)
{
ValidateAdUnitIdentifier(adUnitIdentifier, "set app open ad extra parameter");
}
/// <summary>
/// Set a local extra parameter for the ad.
/// </summary>
/// <param name="adUnitIdentifier">Ad unit identifier of the app open ad to set the local extra parameter for. Must not be null.</param>
/// <param name="key">The key for the local extra parameter. Must not be null.</param>
/// <param name="value">The value for the local extra parameter.</param>
public static void SetAppOpenAdLocalExtraParameter(string adUnitIdentifier, string key, object value)
{
ValidateAdUnitIdentifier(adUnitIdentifier, "set app open ad local extra parameter");
}
#endregion
#region Rewarded
/// <summary>
/// Start loading an rewarded ad.
/// </summary>
/// <param name="adUnitIdentifier">Ad unit identifier of the rewarded ad to load. Must not be null.</param>
public static void LoadRewardedAd(string adUnitIdentifier)
{
ValidateAdUnitIdentifier(adUnitIdentifier, "load rewarded ad");
RequestAdUnit(adUnitIdentifier);
ExecuteWithDelay(1f, () =>
{
AddReadyAdUnit(adUnitIdentifier);
var eventProps = Json.Serialize(CreateBaseEventPropsDictionary("OnRewardedAdLoadedEvent", adUnitIdentifier));
MaxSdkCallbacks.ForwardEvent(eventProps);
});
}
/// <summary>
/// Check if rewarded ad ad is loaded and ready to be displayed.
/// </summary>
/// <param name="adUnitIdentifier">Ad unit identifier of the rewarded ad to load. Must not be null.</param>
/// <returns>True if the ad is ready to be displayed</returns>
public static bool IsRewardedAdReady(string adUnitIdentifier)
{
ValidateAdUnitIdentifier(adUnitIdentifier, "check rewarded ad loaded");
if (!IsAdUnitRequested(adUnitIdentifier))
{
MaxSdkLogger.UserWarning("Rewarded ad '" + adUnitIdentifier +
"' was not requested, can not check if it is loaded");
return false;
}
return IsAdUnitReady(adUnitIdentifier);
}
/// <summary>
/// Present loaded rewarded ad for a given placement to tie ad events to. Note: if the rewarded ad is not ready to be displayed nothing will happen.
/// </summary>
/// <param name="adUnitIdentifier">Ad unit identifier of the interstitial to load. Must not be null.</param>
/// <param name="placement">The placement to tie the showing ad's events to</param>
/// <param name="customData">The custom data to tie the showing ad's events to. Maximum size is 8KB.</param>
public static void ShowRewardedAd(string adUnitIdentifier, string placement = null, string customData = null)
{
ValidateAdUnitIdentifier(adUnitIdentifier, "show rewarded ad");
if (!IsAdUnitRequested(adUnitIdentifier))
{
MaxSdkLogger.UserWarning("Rewarded ad '" + adUnitIdentifier +
"' was not requested, can not show it");
return;
}
if (!IsRewardedAdReady(adUnitIdentifier))
{
MaxSdkLogger.UserWarning("Rewarded ad '" + adUnitIdentifier + "' is not ready, please check IsRewardedAdReady() before showing.");
return;
}
RemoveReadyAdUnit(adUnitIdentifier);
if (_showStubAds)
{
ShowStubRewardedAd(adUnitIdentifier);
}
}
private static void ShowStubRewardedAd(string adUnitIdentifier)
{
#if UNITY_EDITOR
var prefabPath = MaxSdkUtils.GetAssetPathForExportPath("MaxSdk/Prefabs/Rewarded.prefab");
var rewardedPrefab = AssetDatabase.LoadAssetAtPath<GameObject>(prefabPath);
var stubRewardedAd = Object.Instantiate(rewardedPrefab, Vector3.zero, Quaternion.identity);
var grantedReward = false;
var rewardedTitle = GameObject.Find("MaxRewardTitle").GetComponent<Text>();
var rewardStatus = GameObject.Find("MaxRewardStatus").GetComponent<Text>();
var closeButton = GameObject.Find("MaxRewardedCloseButton").GetComponent<Button>();
var rewardButton = GameObject.Find("MaxRewardButton").GetComponent<Button>();
Object.DontDestroyOnLoad(stubRewardedAd);
rewardedTitle.text += ":\n" + adUnitIdentifier;
closeButton.onClick.AddListener(() =>
{
if (grantedReward)
{
var rewardEventPropsDict = CreateBaseEventPropsDictionary("OnRewardedAdReceivedRewardEvent", adUnitIdentifier);
rewardEventPropsDict["rewardLabel"] = "coins";
rewardEventPropsDict["rewardAmount"] = "5";
var rewardEventProps = Json.Serialize(rewardEventPropsDict);
MaxSdkCallbacks.ForwardEvent(rewardEventProps);
}
var adHiddenEventProps = Json.Serialize(CreateBaseEventPropsDictionary("OnRewardedAdHiddenEvent", adUnitIdentifier));
MaxSdkCallbacks.ForwardEvent(adHiddenEventProps);
Object.Destroy(stubRewardedAd);
});
rewardButton.onClick.AddListener(() =>
{
grantedReward = true;
rewardStatus.text = "Reward granted. Will send reward callback on ad close.";
});
var adDisplayedEventProps = Json.Serialize(CreateBaseEventPropsDictionary("OnRewardedAdDisplayedEvent", adUnitIdentifier));
MaxSdkCallbacks.ForwardEvent(adDisplayedEventProps);
#endif
}
/// <summary>
/// Set an extra parameter for the ad.
/// </summary>
/// <param name="adUnitIdentifier">Ad unit identifier of the rewarded ad to set the extra parameter for. Must not be null.</param>
/// <param name="key">The key for the extra parameter. Must not be null.</param>
/// <param name="value">The value for the extra parameter.</param>
public static void SetRewardedAdExtraParameter(string adUnitIdentifier, string key, string value)
{
ValidateAdUnitIdentifier(adUnitIdentifier, "set rewarded extra parameter");
}
/// <summary>
/// Set a local extra parameter for the ad.
/// </summary>
/// <param name="adUnitIdentifier">Ad unit identifier of the rewarded ad to set the local extra parameter for. Must not be null.</param>
/// <param name="key">The key for the local extra parameter. Must not be null.</param>
/// <param name="value">The value for the local extra parameter.</param>
public static void SetRewardedAdLocalExtraParameter(string adUnitIdentifier, string key, object value)
{
ValidateAdUnitIdentifier(adUnitIdentifier, "set rewarded local extra parameter");
}
#endregion
#region Rewarded Interstitial
/// <summary>
/// Start loading an rewarded interstitial ad.
/// </summary>
/// <param name="adUnitIdentifier">Ad unit identifier of the rewarded interstitial ad to load. Must not be null.</param>
public static void LoadRewardedInterstitialAd(string adUnitIdentifier)
{
ValidateAdUnitIdentifier(adUnitIdentifier, "load rewarded interstitial ad");
RequestAdUnit(adUnitIdentifier);
ExecuteWithDelay(1f, () =>
{
AddReadyAdUnit(adUnitIdentifier);
var eventProps = Json.Serialize(CreateBaseEventPropsDictionary("OnRewardedInterstitialAdLoadedEvent", adUnitIdentifier));
MaxSdkCallbacks.ForwardEvent(eventProps);
});
}
/// <summary>
/// Check if rewarded interstitial ad ad is loaded and ready to be displayed.
/// </summary>
/// <param name="adUnitIdentifier">Ad unit identifier of the rewarded ad to load. Must not be null.</param>
/// <returns>True if the ad is ready to be displayed</returns>
public static bool IsRewardedInterstitialAdReady(string adUnitIdentifier)
{
ValidateAdUnitIdentifier(adUnitIdentifier, "check rewarded interstitial ad loaded");
if (!IsAdUnitRequested(adUnitIdentifier))
{
MaxSdkLogger.UserWarning("Rewarded interstitial ad '" + adUnitIdentifier +
"' was not requested, can not check if it is loaded");
return false;
}
return IsAdUnitReady(adUnitIdentifier);
}
/// <summary>
/// Present loaded rewarded interstitial ad for a given placement to tie ad events to. Note: if the rewarded interstitial ad is not ready to be displayed nothing will happen.
/// </summary>
/// <param name="adUnitIdentifier">Ad unit identifier of the rewarded interstitial to show. Must not be null.</param>
/// <param name="placement">The placement to tie the showing ad's events to</param>
/// <param name="customData">The custom data to tie the showing ad's events to. Maximum size is 8KB.</param>
public static void ShowRewardedInterstitialAd(string adUnitIdentifier, string placement = null, string customData = null)
{
ValidateAdUnitIdentifier(adUnitIdentifier, "show rewarded interstitial ad");
if (!IsAdUnitRequested(adUnitIdentifier))
{
MaxSdkLogger.UserWarning("Rewarded interstitial ad '" + adUnitIdentifier +
"' was not requested, can not show it");
return;
}
if (!IsRewardedInterstitialAdReady(adUnitIdentifier))
{
MaxSdkLogger.UserWarning("Rewarded interstitial ad '" + adUnitIdentifier + "' is not ready, please check IsRewardedInterstitialAdReady() before showing.");
return;
}
RemoveReadyAdUnit(adUnitIdentifier);
if (_showStubAds)
{
ShowStubRewardedInterstitialAd(adUnitIdentifier);
}
}
private static void ShowStubRewardedInterstitialAd(string adUnitIdentifier)
{
#if UNITY_EDITOR
var prefabPath = MaxSdkUtils.GetAssetPathForExportPath("MaxSdk/Prefabs/Rewarded.prefab");
var rewardedPrefab = AssetDatabase.LoadAssetAtPath<GameObject>(prefabPath);
var stubRewardedAd = Object.Instantiate(rewardedPrefab, Vector3.zero, Quaternion.identity);
var grantedReward = false;
var rewardedTitle = GameObject.Find("MaxRewardTitle").GetComponent<Text>();
var rewardStatus = GameObject.Find("MaxRewardStatus").GetComponent<Text>();
var closeButton = GameObject.Find("MaxRewardedCloseButton").GetComponent<Button>();
var rewardButton = GameObject.Find("MaxRewardButton").GetComponent<Button>();
Object.DontDestroyOnLoad(stubRewardedAd);
rewardedTitle.text = "MAX Rewarded Interstitial Ad:\n" + adUnitIdentifier;
closeButton.onClick.AddListener(() =>
{
if (grantedReward)
{
var rewardEventPropsDict = CreateBaseEventPropsDictionary("OnRewardedInterstitialAdReceivedRewardEvent", adUnitIdentifier);
rewardEventPropsDict["rewardLabel"] = "coins";
rewardEventPropsDict["rewardAmount"] = "5";
var rewardEventProps = Json.Serialize(rewardEventPropsDict);
MaxSdkCallbacks.ForwardEvent(rewardEventProps);
}
var adHiddenEventProps = Json.Serialize(CreateBaseEventPropsDictionary("OnRewardedInterstitialAdHiddenEvent", adUnitIdentifier));
MaxSdkCallbacks.ForwardEvent(adHiddenEventProps);
Object.Destroy(stubRewardedAd);
});
rewardButton.onClick.AddListener(() =>
{
grantedReward = true;
rewardStatus.text = "Reward granted. Will send reward callback on ad close.";
});
var adDisplayedEventProps = Json.Serialize(CreateBaseEventPropsDictionary("OnRewardedAdDisplayedEvent", adUnitIdentifier));
MaxSdkCallbacks.ForwardEvent(adDisplayedEventProps);
#endif
}
/// <summary>
/// Set an extra parameter for the ad.
/// </summary>
/// <param name="adUnitIdentifier">Ad unit identifier of the rewarded interstitial ad to set the extra parameter for. Must not be null.</param>
/// <param name="key">The key for the extra parameter. Must not be null.</param>
/// <param name="value">The value for the extra parameter.</param>
public static void SetRewardedInterstitialAdExtraParameter(string adUnitIdentifier, string key, string value)
{
ValidateAdUnitIdentifier(adUnitIdentifier, "set rewarded interstitial extra parameter");
}
/// <summary>
/// Set a local extra parameter for the ad.
/// </summary>
/// <param name="adUnitIdentifier">Ad unit identifier of the rewarded interstitial ad to set the local extra parameter for. Must not be null.</param>
/// <param name="key">The key for the local extra parameter. Must not be null.</param>
/// <param name="value">The value for the local extra parameter.</param>
public static void SetRewardedInterstitialAdLocalExtraParameter(string adUnitIdentifier, string key, object value)
{
ValidateAdUnitIdentifier(adUnitIdentifier, "set rewarded interstitial local extra parameter");
}
#endregion
#region Event Tracking
/// <summary>
/// Track an event using AppLovin.
/// </summary>
/// <param name="name">An event from the list of pre-defined events may be found in MaxEvents.cs as part of the AppLovin SDK framework. Must not be null.</param>
/// <param name="parameters">A dictionary containing key-value pairs further describing this event.</param>
public static void TrackEvent(string name, IDictionary<string, string> parameters = null) { }
#endregion
#region Settings
private static bool _isMuted;
/// <summary>
/// Set whether to begin video ads in a muted state or not.
///
/// Please call this method after the SDK has initialized.
/// </summary>
/// <param name="muted"><c>true</c> if video ads should being in muted state.</param>
public static void SetMuted(bool muted)
{
_isMuted = muted;
}
/// <summary>
/// Whether video ads begin in a muted state or not. Defaults to <c>false</c>.
///
/// Note: Returns <c>false</c> if the SDK is not initialized yet.
/// </summary>
/// <returns><c>true</c> if video ads begin in muted state.</returns>
public static bool IsMuted()
{
return _isMuted;
}
/// <summary>
/// Toggle verbose logging of AppLovin SDK. If enabled AppLovin messages will appear in standard application log. All log messages will have "AppLovinSdk" tag.
/// </summary>
/// <param name="enabled"><c>true</c> if verbose logging should be enabled.</param>
public static void SetVerboseLogging(bool enabled)
{
#if UNITY_EDITOR
EditorPrefs.SetBool(MaxSdkLogger.KeyVerboseLoggingEnabled, enabled);
#endif
}
/// <summary>
/// Whether or not verbose logging is enabled.
/// </summary>
/// <returns><c>true</c> if verbose logging is enabled.</returns>
public static bool IsVerboseLoggingEnabled()
{
#if UNITY_EDITOR
return EditorPrefs.GetBool(MaxSdkLogger.KeyVerboseLoggingEnabled, false);
#else
return false;
#endif
}
/// <summary>
/// Whether the creative debugger will be displayed on fullscreen ads after flipping the device screen down twice. Defaults to true.
/// </summary>
/// <param name="enabled"><c>true</c> if the creative debugger should be enabled.</param>
public static void SetCreativeDebuggerEnabled(bool enabled) { }
/// <summary>
/// Enable devices to receive test ads, by passing in the advertising identifier (IDFA/GAID) of each test device.
/// Refer to AppLovin logs for the IDFA/GAID of your current device.
/// </summary>
/// <param name="advertisingIdentifiers">String list of advertising identifiers from devices to receive test ads.</param>
public static void SetTestDeviceAdvertisingIdentifiers(string[] advertisingIdentifiers)
{
if (IsInitialized())
{
MaxSdkLogger.UserError("Test Device Advertising Identifiers must be set before SDK initialization.");
}
}
/// <summary>
/// Whether or not the native AppLovin SDKs listen to exceptions. Defaults to <c>true</c>.
/// </summary>
/// <param name="enabled"><c>true</c> if the native AppLovin SDKs should not listen to exceptions.</param>
public static void SetExceptionHandlerEnabled(bool enabled) { }
/// <summary>
/// Whether or not AppLovin SDK will collect the device location if available. Defaults to <c>true</c>.
/// </summary>
/// <param name="enabled"><c>true</c> if AppLovin SDK should collect the device location if available.</param>
public static void SetLocationCollectionEnabled(bool enabled) { }
/// <summary>
/// Set an extra parameter to pass to the AppLovin server.
/// </summary>
/// <param name="key">The key for the extra parameter. Must not be null.</param>
/// <param name="value">The value for the extra parameter. May be null.</param>
public static void SetExtraParameter(string key, string value) { }
/// <summary>
/// Get the native insets in pixels for the safe area.
/// These insets are used to position ads within the safe area of the screen.
/// </summary>
public static SafeAreaInsets GetSafeAreaInsets()
{
return _safeAreaInsets;
}
#endregion
#region Internal
private static void RequestAdUnit(string adUnitId)
{
_ensureInitialized();
RequestedAdUnits.Add(adUnitId);
}
private static bool IsAdUnitRequested(string adUnitId)
{
_ensureInitialized();
return RequestedAdUnits.Contains(adUnitId);
}
private static void AddReadyAdUnit(string adUnitId)
{
_ensureInitialized();
ReadyAdUnits.Add(adUnitId);
}
private static bool IsAdUnitReady(string adUnitId)
{
_ensureInitialized();
return ReadyAdUnits.Contains(adUnitId);
}
private static void RemoveReadyAdUnit(string adUnitId)
{
ReadyAdUnits.Remove(adUnitId);
}
private static void _ensureHaveSdkKey()
{
if (_hasSdkKey) return;
MaxSdkLogger.UserWarning(
"MAX Ads SDK did not receive SDK key. Please call Max.SetSdkKey() to assign it");
}
private static void _ensureInitialized()
{
_ensureHaveSdkKey();
if (_isInitialized) return;
MaxSdkLogger.UserWarning(
"MAX Ads SDK is not initialized by the time ad is requested. Please call Max.InitializeSdk() in your first scene");
}
private static Dictionary<string, string> CreateBaseEventPropsDictionary(string eventName, string adUnitId)
{
return new Dictionary<string, string>()
{
{"name", eventName},
{"adUnitId", adUnitId}
};
}
private static void ExecuteWithDelay(float seconds, Action action)
{
MaxEventExecutor.Instance.StartCoroutine(ExecuteAction(seconds, action));
}
private static IEnumerator ExecuteAction(float seconds, Action action)
{
yield return new WaitForSecondsRealtime(seconds);
action();
}
internal static void SetUserSegmentField(string key, string value) { }
internal static void SetTargetingDataYearOfBirth(int yearOfBirth) { }
internal static void SetTargetingDataGender(string gender) { }
internal static void SetTargetingDataMaximumAdContentRating(int maximumAdContentRating) { }
internal static void SetTargetingDataEmail(string email) { }
internal static void SetTargetingDataPhoneNumber(string phoneNumber) { }
internal static void SetTargetingDataKeywords(string[] keywords) { }
internal static void SetTargetingDataInterests(string[] interests) { }
internal static void ClearAllTargetingData() { }
#endregion
#region Obsolete
[Obsolete("This method has been deprecated. Please use `GetSdkConfiguration().ConsentDialogState`")]
public static ConsentDialogState GetConsentDialogState()
{
return ConsentDialogState.Unknown;
}
[Obsolete("This method has been deprecated. The AdInfo object is returned with ad callbacks.")]
public static AdInfo GetAdInfo(string adUnitIdentifier)
{
return new AdInfo(new Dictionary<string, object>());
}
#endregion
}
#endif