Packagecom.distriqt.extension.adverts.rewarded
Interfacepublic interface RewardedVideoAd extends flash.events.IEventDispatcher

Represents a Rewarded Video Ad


Public Methods
 MethodDefined By
  
destroy():void
Destroy the ad.
RewardedVideoAd
  
getAdUnitId():String
Returns the ad unit ID.
RewardedVideoAd
  
getUserId():String
Deprecated: Deprecated
Returns the user id set by setUserId(String).
RewardedVideoAd
  
isLoaded():Boolean
Indicates the rewarded video ad has been loaded and is ready to be displayed.
RewardedVideoAd
  
load(request:AdRequest):void
Starts a load request for a rewarded video ad.
RewardedVideoAd
  
setAdUnitId(adUnitId:String):void
Sets the ad unit ID.
RewardedVideoAd
  
setServerSideVerificationOptions(options:ServerSideVerificationOptions):void
Sets ServerSideVerificationOptions for this rewarded ad.
RewardedVideoAd
  
setUserId(userId:String):void
Deprecated: Use setServerSideVerificationOptions instead
Sets the user id to be used in server-to-server reward callbacks.
RewardedVideoAd
  
show():Boolean
Displays the loaded rewarded video ad.
RewardedVideoAd
Events
 Event Summary Defined By
  
fullscreencontent_dismissed
 Dispatched when the full screen content ad was dismissed (closed) RewardedVideoAd
  
fullscreencontent_failedtoshow
 Dispatched when there was an error attempting to show the full screen content ad RewardedVideoAd
  
fullscreencontent_show
 Dispatched when a full screen content ad is shown RewardedVideoAd
  
paidevent_paid
 Dispatched when an impression occurs that results in revenue data.RewardedVideoAd
  
rewardedvideoad:error
 Dispatched if the ad failed to load.RewardedVideoAd
  
rewardedvideoad:loaded
 This event is dispatched when a rewarded video ad is loaded.RewardedVideoAd
  
rewardedvideoad:reward
 Called when a rewarded video ad has triggered a reward.RewardedVideoAd
Method Detail
destroy()method
public function destroy():void

Destroy the ad. No other methods should be called on the ad after destroy() is called.

getAdUnitId()method 
public function getAdUnitId():String

Returns the ad unit ID.

Returns
String —
getUserId()method 
public function getUserId():String
Deprecated: Deprecated

Returns the user id set by setUserId(String).

Returns
String —
isLoaded()method 
public function isLoaded():Boolean

Indicates the rewarded video ad has been loaded and is ready to be displayed. You can check this flag before calling show

Returns
Boolean — true if the rewarded video ad is ready to be displayed
load()method 
public function load(request:AdRequest):void

Starts a load request for a rewarded video ad.

Parameters

request:AdRequest

setAdUnitId()method 
public function setAdUnitId(adUnitId:String):void

Sets the ad unit ID.

Parameters

adUnitId:String

setServerSideVerificationOptions()method 
public function setServerSideVerificationOptions(options:ServerSideVerificationOptions):void

Sets ServerSideVerificationOptions for this rewarded ad. If you want to set the custom reward string, you must do so before showing the ad.

Parameters

options:ServerSideVerificationOptions — Server side verification options

setUserId()method 
public function setUserId(userId:String):void
Deprecated: Use setServerSideVerificationOptions instead

Sets the user id to be used in server-to-server reward callbacks.

Parameters

userId:String — the user id of current user

show()method 
public function show():Boolean

Displays the loaded rewarded video ad. You should check if the rewarded video ad is loaded before attempting to display the ad.

Returns
Boolean — true if the rewarded video ad was displayed and false if it wasn't loaded or ready to be displayed
Event Detail
fullscreencontent_dismissed Event
Event Object Type: com.distriqt.extension.adverts.events.FullScreenContentEvent
FullScreenContentEvent.type property = com.distriqt.extension.adverts.events.FullScreenContentEvent.DISMISSED

Dispatched when the full screen content ad was dismissed (closed)
fullscreencontent_failedtoshow Event  
Event Object Type: com.distriqt.extension.adverts.events.FullScreenContentEvent
FullScreenContentEvent.type property = com.distriqt.extension.adverts.events.FullScreenContentEvent.FAILED_TO_SHOW

Dispatched when there was an error attempting to show the full screen content ad
fullscreencontent_show Event  
Event Object Type: com.distriqt.extension.adverts.events.FullScreenContentEvent
FullScreenContentEvent.type property = com.distriqt.extension.adverts.events.FullScreenContentEvent.SHOW

Dispatched when a full screen content ad is shown
paidevent_paid Event  
Event Object Type: com.distriqt.extension.adverts.events.PaidEvent
PaidEvent.type property = com.distriqt.extension.adverts.events.PaidEvent.PAID

Dispatched when an impression occurs that results in revenue data. By implementing this handler, you can use the data to calculate a user's life time value, or forward the data downstream to other relevant systems.
rewardedvideoad:error Event  
Event Object Type: com.distriqt.extension.adverts.events.RewardedVideoAdEvent
RewardedVideoAdEvent.type property = com.distriqt.extension.adverts.events.RewardedVideoAdEvent.ERROR

Dispatched if the ad failed to load.

rewardedvideoad:loaded Event  
Event Object Type: com.distriqt.extension.adverts.events.RewardedVideoAdEvent
RewardedVideoAdEvent.type property = com.distriqt.extension.adverts.events.RewardedVideoAdEvent.LOADED

This event is dispatched when a rewarded video ad is loaded.

rewardedvideoad:reward Event  
Event Object Type: com.distriqt.extension.adverts.events.RewardedVideoAdEvent
RewardedVideoAdEvent.type property = com.distriqt.extension.adverts.events.RewardedVideoAdEvent.REWARD

Called when a rewarded video ad has triggered a reward. The app is responsible for crediting the user with the reward.





Thu May 16 2024, 09:04 PM +10:00