| CLASS info |
| public class RewardAd extends Object |
| Rewarded ad object. |
| Constructor name |
| RewardAd(Context context,String adId) Rewarded ad constructor. |
| Return | Method |
| Reward | getReward() Obtains reward item information. |
| RewardAd | createRewardAdInstance(Context context) Obtains a rewarded ad object. |
| String | getData() Obtains custom data. |
| String | getUserId() Obtains a user ID. |
| RewardAdListener | getRewardAdListener() Obtains a rewarded ad loading listener. |
| void | pause() Pauses a rewarded ad. |
| void | pause(Context context) Pauses a rewarded ad. |
| void | resume() Resumes a rewarded ad. |
| void | resume(Context context) Resumes a rewarded ad. |
| void | setData(String data) Sets custom data. |
| void | setUserId(String userId) Sets a user ID. |
| boolean | isLoaded() Checks whether a rewarded ad is successfully loaded. |
| void | loadAd(AdParam adParam, RewardAdLoadListener listener) Requests a rewarded ad. |
| void | loadAd(String adId, AdParam adParam) Requests a rewarded ad. |
| void | setRewardAdListener(RewardAdListener listener) Sets a rewarded ad listener. |
| void | setRewardVerifyConfig(RewardVerifyConfig options) Sets server-side verification parameters. |
| void | show() Displays a rewarded ad. |
| void | show(Activity activity, RewardAdStatusListener listener) Displays a rewarded ad. |
| constructor |
| public RewardAd(Context context, String adId) |
| Rewarded ad constructor. |
Parameters
| Parameter name | Parameter desc |
| context | Context. |
| adId | Ad slot ID. |
| Method |
| public Reward getReward() |
| Obtains the reward item of a loaded rewarded ad. If the rewarded ad is not loaded, null is returned. Use isLoaded() tocheck whether the rewarded ad has been loaded. |
Return
| type | desc |
| Reward | Reward item. |
| Method |
| public static RewardAd createRewardAdInstance(Context context) |
| Obtains a rewarded ad object. |
Parameters
| Parameter name | Parameter desc |
| context | Context. |
| Method |
| public String getData() |
| Obtains custom data. |
Return
| type | desc |
| String | Custom data. |
| Method |
| public String getUserId() |
| Obtains a user ID. |
Return
| type | desc |
| String | User ID. |
| Method |
| public RewardAdListener getRewardAdListener() |
| Obtains a rewarded ad listener. |
Return
| type | desc |
| RewardAdListener | Rewarded ad listener. |
| Method |
| public void pause() |
| Pauses a rewarded ad. |
| Method |
| public void pause(Context context) |
| Pauses a rewarded ad. |
Parameters
| Parameter name | Parameter desc |
| context | Context. |
| Method |
| public void resume() |
| Resumes a rewarded ad. |
| Method |
| public void resume(Context context) |
| Resumes a rewarded ad. |
Parameters
| Parameter name | Parameter desc |
| context | Context. |
| Method |
| public void setData(String data) |
| Sets custom data. |
Parameters
| Parameter name | Parameter desc |
| data | Custom data. Note: This is a custom parameter of a rewarded ad. This parameter can be combined with a URL and then encoded. After the combination, the length cannot exceed 1024 bytes. Otherwise, the server-side verification is affected. |
| Method |
| public void setUserId(String userId) |
| Sets a user ID. |
Parameters
| Parameter name | Parameter desc |
| userId | User ID. Note: This is a user ID of a rewarded ad. This parameter can be combined with a URL and then the URL is encoded. In this case, the URL length cannot exceed 1024 bytes. Otherwise, the server-side verification is affected. |
| Method |
| public boolean isLoaded() |
| Checks whether there is a rewarded ad available and the ad is ready to be displayed. |
Return
| type | desc |
| boolean | If a rewarded ad is available and ready to be displayed, true is returned. Otherwise, false is returned. |
| Method |
| public void loadAd(AdParam adParam, RewardAdLoadListener listener) |
| Loads a rewarded ad using AdParam. |
Parameters
| Parameter name | Parameter desc |
| adParam | Rewarded ad param. |
| listener | Rewarded ad loading listener. |
| Method |
| public void loadAd(String adId, AdParam adParam) |
| Loads a rewarded ad using adId and AdParam. |
Parameters
| Parameter name | Parameter desc |
| adId | Ad slot ID. |
| adParam | Rewarded ad param. |
| Method |
| public void setRewardAdListener(RewardAdListener listener) |
| Sets a rewarded ad listener. |
Parameters
| Parameter name | Parameter desc |
| listener | Rewarded ad listener. |
| Method |
| public void setRewardVerifyConfig(RewardVerifyConfig config) |
| Sets server-side verification parameters. |
Parameters
| Parameter name | Parameter desc |
| config | Server-side verification parameters. |
| Method |
| public void show() |
| Displays a rewarded ad. |
| Method |
| public void show(Activity activity, RewardAdStatusListener listener) |
| Displays a rewarded ad. |
Parameters
| Parameter name | Parameter desc |
| activity | Activity. |
| listener | Rewarded ad status listener. |