App open ads

App open ads are a special ad format for monetizing your app load screens.

Alert

This ad format only supports vertical orientation. When horizontal orientation is used, these ads aren't served.

Note

Examples showing how all the format types work are available in the demo project.

Entity

Description

adUnitId

Use:

Development mode to work with demo ad units.
Production mode to work with R-M-XXXXXX-Y (for the actual ID, check the Yandex Advertising Network interface). R-M-XXXXXX-Y is a template for your actual ad unit ID that will be used to receive various creatives.

Example of creating an app open ad

using UnityEngine;
using UnityEngine.Events;
using YandexMobileAds;
using YandexMobileAds.Base;
using System.Collections.Generic;
using System;

[AddComponentMenu("Yandex Ads/App Open Ad Component")]
public class AppOpenAdComponent : MonoBehaviour
{
    [Header("Ad Settings")]
    public string adName = "Default App Open Ad";

    [Header("Ad Unit IDs")]
    [Tooltip("Ad Unit ID for Android")]
    public string adUnitIdAndroid = "demo-appopenad-yandex";

    [Tooltip("Ad Unit ID for iOS")]
    public string adUnitIdiOS = "demo-appopenad-yandex";

    [Header("Configuration")]
    public bool autoLoading = true;
    public bool showAfterLoading = true;
    public bool showAppOpenAdOnce = true;

    private AppOpenAd appOpenAd;
    private AppOpenAdLoader appOpenAdLoader;
    private bool isColdStartAdShown = false;

    [System.Serializable]
    public class AdEventWithAd : UnityEvent<AppOpenAd> { }

    [System.Serializable]
    public class AppStateChangedEvent : UnityEvent<AppStateChangedEventArgs, AppOpenAd> { }

    [Header("Load Callbacks")]
    public AdEventWithAd OnAdLoaded;
    public UnityEvent<string> OnAdFailedToLoad;

    [Header("Interaction Callbacks")]
    public AdEventWithAd OnAdShown;
    public AdEventWithAd OnAdDismissed;
    public AdEventWithAd OnAdClicked;
    public UnityEvent<string> OnAdFailedToShow;
    public UnityEvent<string> OnImpression;
    public AppStateChangedEvent OnAppStateChange;

    private string CurrentAdUnitId
    {
        get
        {
#if UNITY_IOS
            return adUnitIdiOS;
#elif UNITY_ANDROID
            return adUnitIdAndroid;
#else
            Debug.LogWarning("Unsupported platform for Yandex Ads. Using Android Ad Unit ID by default.");
            return adUnitIdAndroid;
#endif
        }
    }

    private void Start()
    {
        if (!string.IsNullOrEmpty(CurrentAdUnitId))
        {
            AppStateObserver.OnAppStateChanged += HandleAppStateChanged;
            SetupLoader();
            if (autoLoading)
            {
                Load();
            }
            DontDestroyOnLoad(gameObject);
        }
        else
        {
            Debug.Log("App open ad: Ad Unit ID is missing.");
        }
    }

    private void SetupLoader()
    {
        appOpenAdLoader = new AppOpenAdLoader();
        appOpenAdLoader.OnAdLoaded += HandleAdLoaded;
        appOpenAdLoader.OnAdFailedToLoad += HandleAdFailedToLoad;
    }

    private void ConfigureAd()
    {
        double lat = 60.0, lon = 30.0;

        // Build the Location object
        Location location = new Location.Builder()
            .SetLatitude(lat)
            .SetLongitude(lon)
            .Build();

        AdRequestConfiguration adRequestConfiguration = new AdRequestConfiguration.Builder(CurrentAdUnitId)
                .WithAge("25")
                .WithGender("male") // or "female", "other"
                .WithContextTags(new List<string>() { "games", "unity", "test" })
                .WithContextQuery("user_search_query") // search query string
                .WithLocation(location)
                .WithParameters(new Dictionary<string, string> {
                        { "custom1", "value1" },
                        { "custom2", "value2" }
                }).Build();
        try
        {
            appOpenAdLoader.LoadAd(adRequestConfiguration);
        }
        catch (Exception ex)
        {
            OnAdFailedToLoad?.Invoke($"Configuration failed: {ex.Message}");
        }
    }

    public void Load()
    {
        var isBlcokedForLoad = showAppOpenAdOnce && isColdStartAdShown;
        if (!isBlcokedForLoad)
        {
            ConfigureAd();
        }
    }

    public void Show()
    {
        if (appOpenAd != null)
        {

            if (showAppOpenAdOnce)
            {
                if (!isColdStartAdShown)
                {
                    appOpenAd.Show();
                    isColdStartAdShown = true;
                }
            }
            else
            {
                appOpenAd.Show();
            }
        }
        else
        {
            Debug.Log("Failed to show ad. Ad object not loaded");
        }
    }

    public void OnDestroy()
    {
        AppStateObserver.OnAppStateChanged -= HandleAppStateChanged;
        if (appOpenAd != null)
        {
            appOpenAd.OnAdShown -= HandleAdShown;
            appOpenAd.OnAdDismissed -= HandleAdDismissed;
            appOpenAd.OnAdClicked -= HandleAdClicked;
            appOpenAd.OnAdFailedToShow -= HandleAdFailedToShow;
            appOpenAd.OnAdImpression -= HandleImpression;
            appOpenAd.Destroy();
            appOpenAd = null;
        }
    }

    #region Event Handlers

    private void HandleAdLoaded(object sender, AppOpenAdLoadedEventArgs args)
    {
        appOpenAd = args.AppOpenAd;
        appOpenAd.OnAdShown += HandleAdShown;
        appOpenAd.OnAdDismissed += HandleAdDismissed;
        appOpenAd.OnAdClicked += HandleAdClicked;
        appOpenAd.OnAdFailedToShow += HandleAdFailedToShow;
        appOpenAd.OnAdImpression += HandleImpression;
        OnAdLoaded?.Invoke(appOpenAd);
        if (showAfterLoading)
        {
            if (showAppOpenAdOnce)
            {
                if (!isColdStartAdShown)
                {
                    appOpenAd.Show();
                    isColdStartAdShown = true;
                }
            }
            else
            {
                appOpenAd.Show();
            }
        }
    }

    private void HandleAdFailedToLoad(object sender, AdFailedToLoadEventArgs args) => OnAdFailedToLoad?.Invoke(args.Message);

    private void HandleAdShown(object sender, EventArgs args) => OnAdShown?.Invoke(appOpenAd);

    private void HandleAdDismissed(object sender, EventArgs args) => OnAdDismissed?.Invoke(appOpenAd);

    private void HandleAdClicked(object sender, EventArgs args) => OnAdClicked?.Invoke(appOpenAd);

    private void HandleAdFailedToShow(object sender, AdFailureEventArgs args) => OnAdFailedToShow?.Invoke(args.Message);

    private void HandleImpression(object sender, ImpressionData impressionData) => OnImpression?.Invoke(impressionData?.rawData ?? string.Empty);

    private void HandleAppStateChanged(object sender, AppStateChangedEventArgs args) => OnAppStateChange?.Invoke(args, appOpenAd);

    #endregion
}

Checking integration

Build and run your project. You can check if the integration is successful by searching the YandexAds keyword in Logcat in Android Studio:

[Integration] Ad type App Open was integrated successfully

Was the article helpful?

Format setup using UI Inspector

Rewarded ads