com.yandex.mobile.ads.rewarded

Class RewardedAd

java.lang.Object

com.yandex.mobile.ads.fullscreen.FullScreenAd

com.yandex.mobile.ads.rewarded.RewardedAd

All Implemented Interfaces:

com.yandex.mobile.ads.fullscreen.FullScreenAdvertisable, com.yandex.mobile.ads.html.BaseAdvertisable

public final class RewardedAd
extends com.yandex.mobile.ads.fullscreen.FullScreenAd

Full-screen rewarded ad.

Constructor Summary

Constructors

Constructor and Description
RewardedAd(android.content.Context context) Constructs a new RewardedAd programmatically.

Method Summary

Modifier and Type	Method and Description
void	destroy() Destroys this RewardedAd entirely and cleans up resources.
java.lang.String	getBlockId() Returns the block id.
boolean	isLoaded() Returns true if this rewarded ad has been successfully loaded and is ready to be shown, otherwise false.
void	loadAd(AdRequest adRequest) Starts loading the ad by AdRequest on a background thread.
void	setBlockId(java.lang.String blockId) Sets a block id.
void	setRewardedAdEventListener(RewardedAdEventListener rewardedAdEventListener) Sets an RewardedAdEventListener.
void	setUserId(java.lang.String userId) Sets a user id.
void	shouldOpenLinksInApp(boolean shouldOpenLinksInApp) Sets whether web links are opened by in-app browser, or by third-party browsers.
void	show() Shows the rewarded ad, only if it has been loaded.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RewardedAd

public RewardedAd(@NonNull
                  android.content.Context context)

Constructs a new RewardedAd programmatically.

Parameters:

context - The activity context the view is running in, through which it can access the current theme, resources, etc. In particular, it uses the window manager and theme in this context to present its UI.

Method Detail

getBlockId

public java.lang.String getBlockId()

Returns the block id.

Returns:

block id.

loadAd

public void loadAd(AdRequest adRequest)

Starts loading the ad by AdRequest on a background thread. NOTE: The block id must be set before that.

Parameters:

adRequest - AdRequest

isLoaded

public boolean isLoaded()

Returns true if this rewarded ad has been successfully loaded and is ready to be shown, otherwise false.

Returns:

true if this rewarded ad has been successfully loaded and is ready to be shown.

setBlockId

public void setBlockId(java.lang.String blockId)

Sets a block id.

Parameters:

blockId - Unique ad placement ID created at partner interface.

setUserId

public void setUserId(java.lang.String userId)

Sets a user id.

Parameters:

userId - Unique string that identifies app's user. Created at partner interface.

setRewardedAdEventListener

public void setRewardedAdEventListener(@Nullable
                                       RewardedAdEventListener rewardedAdEventListener)

Sets an RewardedAdEventListener.

Parameters:

rewardedAdEventListener - RewardedAdEventListener.

shouldOpenLinksInApp

public void shouldOpenLinksInApp(boolean shouldOpenLinksInApp)

Sets whether web links are opened by in-app browser, or by third-party browsers.

Parameters:

shouldOpenLinksInApp - If set to true, web links are opened by in-app browser, otherwise by third-party browsers. Default param is false

show

public void show()

Shows the rewarded ad, only if it has been loaded.

destroy

public void destroy()

Destroys this RewardedAd entirely and cleans up resources. NOTE: Don't work with this RewardedAd thereafter.