com.facebook.ads

Class RewardedVideoAd

java.lang.Object

com.facebook.ads.RewardedVideoAd

All Implemented Interfaces:

Ad, FullScreenAd

public class RewardedVideoAd
extends java.lang.Object
implements FullScreenAd

RewardedVideoAd displays a rewarded video advertisement by Facebook

To use the rewarded video, do the following:

 RewardedVideoAd ad = new RewardedVideoAd(context, placementId);
 RewardedVideoLoadAdConfig loadAdConfig = ad.buildLoadAdConfig()
             .withBid(bidPayload)
             .withAdListener(adListener)
             .build();
 ad.loadAd(loadAdConfig);
 

Since:

4.23

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	RewardedVideoAd.RewardedVideoAdLoadConfigBuilder Builder that allows to configure an ad loading.
static interface	RewardedVideoAd.RewardedVideoAdShowConfigBuilder Builder that allows to configure an ad showing.
static interface	RewardedVideoAd.RewardedVideoLoadAdConfig Marker interface for an object that represents an rewarded video ad load config.
static interface	RewardedVideoAd.RewardedVideoShowAdConfig Marker interface for an object that represents an rewarded video ad show config.

Nested classes/interfaces inherited from interface com.facebook.ads.FullScreenAd

FullScreenAd.ShowAdConfig, FullScreenAd.ShowConfigBuilder

Nested classes/interfaces inherited from interface com.facebook.ads.Ad

Ad.LoadAdConfig, Ad.LoadConfigBuilder

Field Summary

Fields

Modifier and Type	Field and Description
static int	UNSET_VIDEO_DURATION

Constructor Summary

Constructors

Constructor and Description
RewardedVideoAd(Context context, java.lang.String placementID) Constructs a RewardedVideoAd given the context and the placement id

Method Summary

Modifier and Type	Method and Description
RewardedVideoAd.RewardedVideoAdLoadConfigBuilder	buildLoadAdConfig() Returns RewardedVideoAd.RewardedVideoAdLoadConfigBuilder that allows to specify ad loading parameters.
RewardedVideoAd.RewardedVideoAdShowConfigBuilder	buildShowAdConfig() Returns RewardedVideoAd.RewardedVideoAdLoadConfigBuilder that allows to specify ad showing parameters.
void	destroy() Destroys the ad control.
java.lang.String	getPlacementId() Get the placementId for this ad.
int	getVideoDuration()
boolean	isAdInvalidated() Indicate whether the ad is still valid.
boolean	isAdLoaded() Tells whether an ad is loaded and ready to show
void	loadAd() Loads an ad.
void	loadAd(RewardedVideoAd.RewardedVideoLoadAdConfig rewardedVideoLoadAdConfig) Loads an ad.
void	registerAdCompanionView(com.facebook.ads.internal.api.AdCompanionView adCompanionView)
void	setExtraHints(ExtraHints extraHints) Deprecated.
boolean	show() Shows the rewarded video ad
boolean	show(RewardedVideoAd.RewardedVideoShowAdConfig rewardedVideoShowAdConfig) Shows the rewarded video ad
void	unregisterAdCompanionView()

Methods inherited from class java.lang.Object

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

Field Detail

UNSET_VIDEO_DURATION

public static final int UNSET_VIDEO_DURATION

See Also:

Constant Field Values

Constructor Detail

RewardedVideoAd

public RewardedVideoAd(Context context,
                       java.lang.String placementID)

Constructs a RewardedVideoAd given the context and the placement id

Parameters:

context - Android context

placementID - id of ad placement

Method Detail

setExtraHints

@Deprecated
public void setExtraHints(ExtraHints extraHints)

Deprecated.

Specified by:

setExtraHints in interface Ad

loadAd

public void loadAd()

Description copied from interface: Ad

Loads an ad.

This method always returns immediately. The ad is loaded asynchronously. The control's ad listener will be called when loading finishes or fails.

Specified by:

loadAd in interface Ad

loadAd

public void loadAd(RewardedVideoAd.RewardedVideoLoadAdConfig rewardedVideoLoadAdConfig)

Loads an ad.

This method always returns immediately. The ad is loaded asynchronously. The control's ad listener will be called when loading finishes or fails.

 RewardedVideoAd ad = new RewardedVideoAd(context, placementId);
 RewardedVideoLoadAdConfig loadAdConfig = ad.buildLoadAdConfig()
             .withBid(bidPayload)
             .withAdListener(adListener)
             .build();
 ad.loadAd(loadAdConfig);
 

Since:

5.6

isAdInvalidated

public boolean isAdInvalidated()

Description copied from interface: Ad

Indicate whether the ad is still valid.

Specified by:

isAdInvalidated in interface Ad

Returns:

true if the ad is not valid anymore.

show

public boolean show()

Shows the rewarded video ad

This method should only be called after loadAd() is called and the ad listener has been notified ad has loaded

Specified by:

show in interface FullScreenAd

Returns:

false if no ad is loaded, true otherwise

show

public boolean show(RewardedVideoAd.RewardedVideoShowAdConfig rewardedVideoShowAdConfig)

Shows the rewarded video ad

This method should only be called after loadAd() is called and the ad listener has been notified ad has loaded

 RewardedVideoShowAdConfig showAdConfig = ad.buildShowAdConfig()
             .withAppOrientation(appOrientation)
             .build();
 ad.show(showAdConfig);
 

Parameters:

rewardedVideoShowAdConfig - rewarded video ad config.

Returns:

false if no ad is loaded, true otherwise

Since:

5.6

destroy

public void destroy()

Description copied from interface: Ad

Destroys the ad control.

This method should be called when the hosting activity of the ad control is destroyed.

Specified by:

destroy in interface Ad

Since:

4.23

isAdLoaded

public boolean isAdLoaded()

Tells whether an ad is loaded and ready to show

Returns:

whether an ad is loaded

getPlacementId

public java.lang.String getPlacementId()

Description copied from interface: Ad

Get the placementId for this ad.

Specified by:

getPlacementId in interface Ad

Returns:

Since:

4.23

getVideoDuration

public int getVideoDuration()

Returns:

Since:

4.28

buildLoadAdConfig

public RewardedVideoAd.RewardedVideoAdLoadConfigBuilder buildLoadAdConfig()

Returns RewardedVideoAd.RewardedVideoAdLoadConfigBuilder that allows to specify ad loading parameters. You should call loadAd(RewardedVideoAd.RewardedVideoLoadAdConfig) after all parameters have been set.

Specified by:

buildLoadAdConfig in interface FullScreenAd

Returns:

builder that allows to configure ad loading

Since:

5.6

buildShowAdConfig

public RewardedVideoAd.RewardedVideoAdShowConfigBuilder buildShowAdConfig()

Returns RewardedVideoAd.RewardedVideoAdLoadConfigBuilder that allows to specify ad showing parameters. You should call show(RewardedVideoAd.RewardedVideoShowAdConfig) after all parameters have been set.

Specified by:

buildShowAdConfig in interface FullScreenAd

Returns:

builder that allows to configure ad showing

Since:

5.6

registerAdCompanionView

public void registerAdCompanionView(com.facebook.ads.internal.api.AdCompanionView adCompanionView)

unregisterAdCompanionView

public void unregisterAdCompanionView()