Globals / Ad
Interface: Ad
A contract declaring the interaction mechanism between mini-apps and native host app to display ads.
Hierarchy
- Ad
Implemented by
Index
Methods
Methods
loadInterstitialAd
▸ loadInterstitialAd(id: string): Promise<string>
Defined in js-miniapp-sdk/src/miniapp.ts:134
Loads the specified Interstittial Ad Unit ID. Can be called multiple times to pre-load multiple ads. Promise is resolved when successfully loaded.
Parameters:
| Name | Type |
|---|---|
id |
string |
Returns: Promise<string>
The Promise of load success response. Promise is rejected if failed to load.
loadRewardedAd
▸ loadRewardedAd(id: string): Promise<string>
Defined in js-miniapp-sdk/src/miniapp.ts:143
Loads the specified Rewarded Ad Unit ID. Can be called multiple times to pre-load multiple ads. Promise is resolved when successfully loaded.
Parameters:
| Name | Type |
|---|---|
id |
string |
Returns: Promise<string>
The Promise of load success response. Promise is rejected if failed to load.
showInterstitialAd
▸ showInterstitialAd(id: string): Promise<string>
Defined in js-miniapp-sdk/src/miniapp.ts:151
Shows the Interstitial Ad for the specified ID. Promise is resolved after the user closes the Ad.
Parameters:
| Name | Type |
|---|---|
id |
string |
Returns: Promise<string>
The Promise of close success response. Promise is rejected if the Ad failed to display wasn’t loaded first using MiniApp.loadInterstitialAd.
showRewardedAd
▸ showRewardedAd(id: string): Promise<Reward>
Defined in js-miniapp-sdk/src/miniapp.ts:160
Shows the Rewarded Ad for the specified ID. Promise is resolved with an object after the user closes the Ad. The object contains the reward earned by the user. Reward will be null if the user did not earn the reward.
Parameters:
| Name | Type |
|---|---|
id |
string |
Returns: Promise<Reward>
The Promise of Rewarded ad response result from injected side. Promise is rejected if the Ad failed to display wasn’t loaded first using MiniApp.loadRewardedAds.