Extends
BaseRewardedAd
Represents a full-screen rewarded interstitial ad.
Rewarded interstitial ads completely cover the screen of the host application.
Rewarded interstitial ads completely cover the screen of the host application.
| Properties | |
|---|---|
ad
|
The callback to receive ad event notifications. |
ad
|
The unique ad unit ID used to request and load this specific ad.
|
server
|
Configuration for secure server-to-server validation.
|
| Methods | |
|---|---|
destroy
|
Destroys the ad, stopping any extra processing and destroying
resources associated with it.
|
get
|
Gets information about the ad response for this ad.
|
set
|
Sets the placement ID for this ad. |
show
|
Shows the rewarded ad. |
load
|
Loads a rewarded interstitial ad. |
Properties
Optional adEventCallback
adEventCallback?:
AdEventCallback
Readonly adUnitId
adUnitId: string
Optional serverSideVerificationOptions
serverSideVerificationOptions?:
ServerSideVerificationOptions
Assign this before calling the show method to securely validate the reward on your own backend.
Methods
destroy
destroy(): void
Destroys the ad, stopping any extra processing and destroying
resources associated with it.
Do not call any other methods after this.
Do not call any other methods after this.
getResponseInfo
getResponseInfo(): ResponseInfo
Gets information about the ad response for this ad.
| Returns | |
|---|---|
ResponseInfo
|
A ResponseInfo object containing metadata about the loaded ad. |
setPlacementId
setPlacementId(placementId): void
Sets the placement ID for this ad. Before presenting the ad, you
must set this property.
| Parameters | |
|---|---|
placementId: bigint
|
The identifier for the placement in reporting. |
show
show(onUserEarnedReward?): void
Shows the rewarded ad.
| Parameters | |
|---|---|
|
Callback triggered when the user finishes watching the ad and earns the reward. |
Static load
load(request): Promise<RewardedInterstitialAd>
Loads a rewarded interstitial ad.
| Parameters | |
|---|---|
request:
AdRequest
|
The ad request configuration. |
| Returns | |
|---|---|
Promise<RewardedInterstitialAd>
|
A Promise that resolves to the loaded RewardedInterstitialAd instance. |