AdvertiserService

Overview

The service is a wrapper over IMinimalAdsMediator (IAdsMediator in advanced integration), which allows asynchronous loading of rewards ads, inter ads and provides comfortable banner handling.

Main Api

Mediator

IAdsMediator Mediator { get; }

This property provides access to the mediator implementation that is used for Magify's communication with the specific advertising mediator API. This field is filled in after the initialization of the MagifyService.

WaitForInitialization

UniTask<bool> WaitForInitialization(
    float timeout,
    CancellationToken cancellationToken
)

Asynchronous method that provides an opportunity to wait for mediator implementation initialization. This method is used by the Load...VideoAsync() and Show...VideoAsync() methods, in case mediator has been added and initialization has not completed. You can also use it if you need to wait until the initialization of the advertising mediator is finished.

AdPreloadEnable

IReactiveProperty<bool> AdPreloadEnable { get; }

Allows you to control when ads preloading. You can read more about preloading in the corresponding section.

Banner

IsBannerRequired

IReactiveProperty<bool> IsBannerRequired { get; }

This property indicates if the banner is currently needed or not. This state is controlled at the project level. By default the state is false. If set to true, then Advetriser will try to show the banner by calling Mediator.ShowBanner method. If set to false, then Advetriser will hide the banner by calling Mediator.HideBanner method.

IsBannerActive

IReadOnlyReactiveProperty<bool> IsBannerActive { get; }

The result of all conditions necessary for banner display. The method takes into account global state (IsBannerRequired), temporary deactivations and presence of campaign in Magify. It property cannot be changed.

TemporaryDisableBanner

IDisposable TemporaryDisableBanner()

Call a method to temporarily disable the banner. The method returns IDisposable, after calling Dispose the banner will become active again. You can use the TemporaryDisposableBanner method in the using block to temporarily deactivate the banner display, this can be useful during the display of other campaigns.

RefreshBanner

void RefreshBanner()

The method updates the state of the banner. The banner will be displayed if:

• IsBannerRequired is true;
• Mediator.IsBannerVisible is true;
• There is access to the internet;

Reward

OnBeforeShowRewardVideo

IObservable<Unit> OnBeforeShowRewardVideo { get; }

The event will be triggered before the reward ad is displayed. You can subscribe to execute your logic. For example, to disable the sound in the game (if it will overlap with the sound of advertising)

OnAfterShowRewardVideo

IObservable<Unit> OnAfterShowRewardVideo { get; }

The event will be triggered after displaying the reward ad. You can subscribe to execute your logic. For example, to enable the sound in the game after the previous disabling.

LoadRewardVideoAsync

UniTask<AdLoadResult> LoadRewardVideoAsync(
    CancellationToken cancellationToken
)

The method tries to load a reward ad. If it fails to load the advertisement, then repeated attempts will be made with small pauses between them. The retries will continue for the duration of the Reward Load Timeout which is set in MagifySettings -> Default Features or if the load is not canceled with cancellationToken.

ShowRewardedVideoAsync

UniTask<AdShowResult> ShowRewardedVideoAsync(
    string placement
)

The method in case the advertisement is ready to be displayed (check with Mediator.IsRewardVideoReady) sends OnBeforeShowRewardVideo event before the advertisement starts, then displays the advertisement and sends OnAfterShowRewardVideo event after the advertisement ends.

Interstitial

OnBeforeShowInterstitialVideo

IObservable<Unit> OnBeforeShowInterstitialVideo { get; }

The event will be triggered before the interstitial ad is displayed. You can subscribe to execute your logic. For example, to disable the sound in the game (if it will overlap with the sound of advertising)

OnAfterShowInterstitialVideo

IObservable<Unit> OnAfterShowInterstitialVideo { get; }

The event will be triggered after displaying the interstitial ad. You can subscribe to execute your logic. For example, to enable the sound in the game after the previous disabling.

LoadInterVideoAsync

UniTask<AdLoadResult> LoadInterVideoAsync(
    float timeout,
    CancellationToken cancellationToken
)

The method tries to load a interstitial ad. If it fails to load the advertisement, then repeated attempts will be made with small pauses between them. The retries will continue for the timeout that was passed as an argument or if the download is not canceled with cancellationToken.

ShowInterVideoAsync

UniTask<AdShowResult> ShowInterVideoAsync(
    string placement
)

The method in case the advertisement is ready to be displayed (check with Mediator.IsInterVideoReady) sends OnBeforeShowInterVideo event before the advertisement starts, then displays the advertisement and sends OnAfterShowInterVideo event after the advertisement ends.

Advanced

Advanced Magify SDK integration gives you more advertising opportunities.

The main advantage is the ability to use ad campaigns in your app.

Since you use advanced integration and want to use custom ads mediator you have to implement IAdsMediator interface instead of IMinimalAdsMediator.