# RewardedInterstitialAd # RewardedInterstitialAd ``` public abstract class RewardedInterstitialAd ```
*** ** * ** *** Rewarded interstitials are full screen ads that reward users and can be shown without a user opt in. This ad format is different than `https://developers.google.com/ad-manager/mobile-ads-sdk/android/reference/com/google/android/gms/ads/rewarded/RewardedAd` because rewarded ads require the user to opt-in to watching the video. This ad format is different than `https://developers.google.com/ad-manager/mobile-ads-sdk/android/reference/com/google/android/gms/ads/interstitial/InterstitialAd` because interstitial ads do not reward the user. ## Summary | ### Public constructors | |---| | `https://developers.google.com/ad-manager/mobile-ads-sdk/android/reference/com/google/android/gms/ads/rewardedinterstitial/RewardedInterstitialAd#RewardedInterstitialAd()()` | | ### Public methods | |---|---| | `abstract @https://developer.android.com/reference/androidx/annotation/NonNull.html https://developer.android.com/reference/android/os/Bundle.html` | `https://developers.google.com/ad-manager/mobile-ads-sdk/android/reference/com/google/android/gms/ads/rewardedinterstitial/RewardedInterstitialAd#getAdMetadata()()` Gets all available ad metadata for this `https://developers.google.com/ad-manager/mobile-ads-sdk/android/reference/com/google/android/gms/ads/rewardedinterstitial/RewardedInterstitialAd`. | | `abstract @https://developer.android.com/reference/androidx/annotation/NonNull.html https://developer.android.com/reference/java/lang/String.html` | `https://developers.google.com/ad-manager/mobile-ads-sdk/android/reference/com/google/android/gms/ads/rewardedinterstitial/RewardedInterstitialAd#getAdUnitId()()` Returns the ad unit ID. | | `abstract @https://developer.android.com/reference/androidx/annotation/Nullable.html https://developers.google.com/ad-manager/mobile-ads-sdk/android/reference/com/google/android/gms/ads/FullScreenContentCallback` | `https://developers.google.com/ad-manager/mobile-ads-sdk/android/reference/com/google/android/gms/ads/rewardedinterstitial/RewardedInterstitialAd#getFullScreenContentCallback()()` Gets the `https://developers.google.com/ad-manager/mobile-ads-sdk/android/reference/com/google/android/gms/ads/FullScreenContentCallback` for this `https://developers.google.com/ad-manager/mobile-ads-sdk/android/reference/com/google/android/gms/ads/rewardedinterstitial/RewardedInterstitialAd`. | | `abstract @https://developer.android.com/reference/androidx/annotation/Nullable.html https://developers.google.com/ad-manager/mobile-ads-sdk/android/reference/com/google/android/gms/ads/rewarded/OnAdMetadataChangedListener` | `https://developers.google.com/ad-manager/mobile-ads-sdk/android/reference/com/google/android/gms/ads/rewardedinterstitial/RewardedInterstitialAd#getOnAdMetadataChangedListener()()` Gets the `https://developers.google.com/ad-manager/mobile-ads-sdk/android/reference/com/google/android/gms/ads/rewarded/OnAdMetadataChangedListener` for this `https://developers.google.com/ad-manager/mobile-ads-sdk/android/reference/com/google/android/gms/ads/rewardedinterstitial/RewardedInterstitialAd`. | | `abstract @https://developer.android.com/reference/androidx/annotation/Nullable.html https://developers.google.com/ad-manager/mobile-ads-sdk/android/reference/com/google/android/gms/ads/OnPaidEventListener` | `https://developers.google.com/ad-manager/mobile-ads-sdk/android/reference/com/google/android/gms/ads/rewardedinterstitial/RewardedInterstitialAd#getOnPaidEventListener()()` Gets the `https://developers.google.com/ad-manager/mobile-ads-sdk/android/reference/com/google/android/gms/ads/OnPaidEventListener` for this `https://developers.google.com/ad-manager/mobile-ads-sdk/android/reference/com/google/android/gms/ads/rewardedinterstitial/RewardedInterstitialAd`. | | `abstract long` | `https://developers.google.com/ad-manager/mobile-ads-sdk/android/reference/com/google/android/gms/ads/rewardedinterstitial/RewardedInterstitialAd#getPlacementId()()` Gets the placement ID for this `https://developers.google.com/ad-manager/mobile-ads-sdk/android/reference/com/google/android/gms/ads/rewardedinterstitial/RewardedInterstitialAd`. | | `abstract @https://developer.android.com/reference/androidx/annotation/NonNull.html https://developers.google.com/ad-manager/mobile-ads-sdk/android/reference/com/google/android/gms/ads/ResponseInfo` | `https://developers.google.com/ad-manager/mobile-ads-sdk/android/reference/com/google/android/gms/ads/rewardedinterstitial/RewardedInterstitialAd#getResponseInfo()()` Returns information about the loaded ad. | | `abstract @https://developer.android.com/reference/androidx/annotation/NonNull.html https://developers.google.com/ad-manager/mobile-ads-sdk/android/reference/com/google/android/gms/ads/rewarded/RewardItem` | `https://developers.google.com/ad-manager/mobile-ads-sdk/android/reference/com/google/android/gms/ads/rewardedinterstitial/RewardedInterstitialAd#getRewardItem()()` Gets reward item for the loaded rewarded interstitial ad. | | `static void` | `https://developers.google.com/ad-manager/mobile-ads-sdk/android/reference/com/google/android/gms/ads/rewardedinterstitial/RewardedInterstitialAd#load(android.content.Context,java.lang.String,com.google.android.gms.ads.admanager.AdManagerAdRequest,com.google.android.gms.ads.rewardedinterstitial.RewardedInterstitialAdLoadCallback)( @https://developer.android.com/reference/androidx/annotation/NonNull.html https://developer.android.com/reference/android/content/Context.html context, @https://developer.android.com/reference/androidx/annotation/NonNull.html https://developer.android.com/reference/java/lang/String.html adUnitId, @https://developer.android.com/reference/androidx/annotation/NonNull.html https://developers.google.com/ad-manager/mobile-ads-sdk/android/reference/com/google/android/gms/ads/admanager/AdManagerAdRequest adManagerAdRequest, @https://developer.android.com/reference/androidx/annotation/NonNull.html https://developers.google.com/ad-manager/mobile-ads-sdk/android/reference/com/google/android/gms/ads/rewardedinterstitial/RewardedInterstitialAdLoadCallback loadCallback )` Loads a `https://developers.google.com/ad-manager/mobile-ads-sdk/android/reference/com/google/android/gms/ads/rewardedinterstitial/RewardedInterstitialAd`. | | `static void` | `https://developers.google.com/ad-manager/mobile-ads-sdk/android/reference/com/google/android/gms/ads/rewardedinterstitial/RewardedInterstitialAd#load(android.content.Context,java.lang.String,com.google.android.gms.ads.AdRequest,com.google.android.gms.ads.rewardedinterstitial.RewardedInterstitialAdLoadCallback)( @https://developer.android.com/reference/androidx/annotation/NonNull.html https://developer.android.com/reference/android/content/Context.html context, @https://developer.android.com/reference/androidx/annotation/NonNull.html https://developer.android.com/reference/java/lang/String.html adUnitId, @https://developer.android.com/reference/androidx/annotation/NonNull.html https://developers.google.com/ad-manager/mobile-ads-sdk/android/reference/com/google/android/gms/ads/AdRequest adRequest, @https://developer.android.com/reference/androidx/annotation/NonNull.html https://developers.google.com/ad-manager/mobile-ads-sdk/android/reference/com/google/android/gms/ads/rewardedinterstitial/RewardedInterstitialAdLoadCallback loadCallback )` Loads a `https://developers.google.com/ad-manager/mobile-ads-sdk/android/reference/com/google/android/gms/ads/rewardedinterstitial/RewardedInterstitialAd`. | | `abstract void` | `https://developers.google.com/ad-manager/mobile-ads-sdk/android/reference/com/google/android/gms/ads/rewardedinterstitial/RewardedInterstitialAd#setFullScreenContentCallback(com.google.android.gms.ads.FullScreenContentCallback)( @https://developer.android.com/reference/androidx/annotation/Nullable.html https://developers.google.com/ad-manager/mobile-ads-sdk/android/reference/com/google/android/gms/ads/FullScreenContentCallback fullScreenContentCallback )` Registers a callback to be invoked when ads show and dismiss full screen content. | | `abstract void` | `https://developers.google.com/ad-manager/mobile-ads-sdk/android/reference/com/google/android/gms/ads/rewardedinterstitial/RewardedInterstitialAd#setImmersiveMode(boolean)(boolean immersiveModeEnabled)` Sets a flag that controls if this rewarded interstitial ad object will be displayed in immersive mode. | | `abstract void` | `https://developers.google.com/ad-manager/mobile-ads-sdk/android/reference/com/google/android/gms/ads/rewardedinterstitial/RewardedInterstitialAd#setOnAdMetadataChangedListener(com.google.android.gms.ads.rewarded.OnAdMetadataChangedListener)( @https://developer.android.com/reference/androidx/annotation/Nullable.html https://developers.google.com/ad-manager/mobile-ads-sdk/android/reference/com/google/android/gms/ads/rewarded/OnAdMetadataChangedListener listener )` Registers a callback to be invoked when the rewarded interstitial ad's metadata changes. | | `abstract void` | `https://developers.google.com/ad-manager/mobile-ads-sdk/android/reference/com/google/android/gms/ads/rewardedinterstitial/RewardedInterstitialAd#setOnPaidEventListener(com.google.android.gms.ads.OnPaidEventListener)(@https://developer.android.com/reference/androidx/annotation/Nullable.html https://developers.google.com/ad-manager/mobile-ads-sdk/android/reference/com/google/android/gms/ads/OnPaidEventListener listener)` Registers a callback to be invoked when this ad is estimated to have earned money. | | `abstract void` | `https://developers.google.com/ad-manager/mobile-ads-sdk/android/reference/com/google/android/gms/ads/rewardedinterstitial/RewardedInterstitialAd#setPlacementId(long)(long placementId)` Sets a placement ID for the rewarded interstitial ad. | | `abstract void` | `https://developers.google.com/ad-manager/mobile-ads-sdk/android/reference/com/google/android/gms/ads/rewardedinterstitial/RewardedInterstitialAd#setServerSideVerificationOptions(com.google.android.gms.ads.rewarded.ServerSideVerificationOptions)( https://developers.google.com/ad-manager/mobile-ads-sdk/android/reference/com/google/android/gms/ads/rewarded/ServerSideVerificationOptions options )` Sets `https://developers.google.com/ad-manager/mobile-ads-sdk/android/reference/com/google/android/gms/ads/rewarded/ServerSideVerificationOptions` for this rewarded interstitial ad. | | `abstract void` | `https://developers.google.com/ad-manager/mobile-ads-sdk/android/reference/com/google/android/gms/ads/rewardedinterstitial/RewardedInterstitialAd#show(android.app.Activity,com.google.android.gms.ads.OnUserEarnedRewardListener)( @https://developer.android.com/reference/androidx/annotation/NonNull.html https://developer.android.com/reference/android/app/Activity.html activity, @https://developer.android.com/reference/androidx/annotation/NonNull.html https://developers.google.com/ad-manager/mobile-ads-sdk/android/reference/com/google/android/gms/ads/OnUserEarnedRewardListener onUserEarnedRewardListener )` Shows the rewarded interstitial ad. | ## Public constructors ### RewardedInterstitialAd ``` public RewardedInterstitialAd() ``` ## Public methods ### getAdMetadata ``` public abstract @NonNull Bundle getAdMetadata() ``` Gets all available ad metadata for this `https://developers.google.com/ad-manager/mobile-ads-sdk/android/reference/com/google/android/gms/ads/rewardedinterstitial/RewardedInterstitialAd`. Ad metadata is empty if the ad doesn't have metadata. Ad metadata may update. Use `https://developers.google.com/ad-manager/mobile-ads-sdk/android/reference/com/google/android/gms/ads/rewarded/OnAdMetadataChangedListener#onAdMetadataChanged()` to listen for changes. ### getAdUnitId ``` public abstract @NonNull String getAdUnitId() ``` Returns the ad unit ID. ### getFullScreenContentCallback ``` public abstract @Nullable FullScreenContentCallback getFullScreenContentCallback() ``` Gets the `https://developers.google.com/ad-manager/mobile-ads-sdk/android/reference/com/google/android/gms/ads/FullScreenContentCallback` for this `https://developers.google.com/ad-manager/mobile-ads-sdk/android/reference/com/google/android/gms/ads/rewardedinterstitial/RewardedInterstitialAd`. ### getOnAdMetadataChangedListener ``` public abstract @Nullable OnAdMetadataChangedListener getOnAdMetadataChangedListener() ``` Gets the `https://developers.google.com/ad-manager/mobile-ads-sdk/android/reference/com/google/android/gms/ads/rewarded/OnAdMetadataChangedListener` for this `https://developers.google.com/ad-manager/mobile-ads-sdk/android/reference/com/google/android/gms/ads/rewardedinterstitial/RewardedInterstitialAd`. ### getOnPaidEventListener ``` public abstract @Nullable OnPaidEventListener getOnPaidEventListener() ``` Gets the `https://developers.google.com/ad-manager/mobile-ads-sdk/android/reference/com/google/android/gms/ads/OnPaidEventListener` for this `https://developers.google.com/ad-manager/mobile-ads-sdk/android/reference/com/google/android/gms/ads/rewardedinterstitial/RewardedInterstitialAd`. ### getPlacementId ``` public abstract long getPlacementId() ``` Gets the placement ID for this `https://developers.google.com/ad-manager/mobile-ads-sdk/android/reference/com/google/android/gms/ads/rewardedinterstitial/RewardedInterstitialAd`. ### getResponseInfo ``` public abstract @NonNull ResponseInfo getResponseInfo() ``` Returns information about the loaded ad. ### getRewardItem ``` public abstract @NonNull RewardItem getRewardItem() ``` Gets reward item for the loaded rewarded interstitial ad. ### load ``` public static void load(     @NonNull Context context,     @NonNull String adUnitId,     @NonNull AdManagerAdRequest adManagerAdRequest,     @NonNull RewardedInterstitialAdLoadCallback loadCallback ) ``` Loads a `https://developers.google.com/ad-manager/mobile-ads-sdk/android/reference/com/google/android/gms/ads/rewardedinterstitial/RewardedInterstitialAd`. | Parameters | |---|---| | `@https://developer.android.com/reference/androidx/annotation/NonNull.html https://developer.android.com/reference/android/content/Context.html context` | The context. | | `@https://developer.android.com/reference/androidx/annotation/NonNull.html https://developer.android.com/reference/java/lang/String.html adUnitId` | The ad unit ID. | | `@https://developer.android.com/reference/androidx/annotation/NonNull.html https://developers.google.com/ad-manager/mobile-ads-sdk/android/reference/com/google/android/gms/ads/admanager/AdManagerAdRequest adManagerAdRequest` | A Google Ad Manager ad request with targeting information. | | `@https://developer.android.com/reference/androidx/annotation/NonNull.html https://developers.google.com/ad-manager/mobile-ads-sdk/android/reference/com/google/android/gms/ads/rewardedinterstitial/RewardedInterstitialAdLoadCallback loadCallback` | A callback to be invoked when a rewarded interstitial ad finishes loading. | ### load ``` public static void load(     @NonNull Context context,     @NonNull String adUnitId,     @NonNull AdRequest adRequest,     @NonNull RewardedInterstitialAdLoadCallback loadCallback ) ``` Loads a `https://developers.google.com/ad-manager/mobile-ads-sdk/android/reference/com/google/android/gms/ads/rewardedinterstitial/RewardedInterstitialAd`. | Parameters | |---|---| | `@https://developer.android.com/reference/androidx/annotation/NonNull.html https://developer.android.com/reference/android/content/Context.html context` | The context. | | `@https://developer.android.com/reference/androidx/annotation/NonNull.html https://developer.android.com/reference/java/lang/String.html adUnitId` | The ad unit ID. | | `@https://developer.android.com/reference/androidx/annotation/NonNull.html https://developers.google.com/ad-manager/mobile-ads-sdk/android/reference/com/google/android/gms/ads/AdRequest adRequest` | An ad request with targeting information. | | `@https://developer.android.com/reference/androidx/annotation/NonNull.html https://developers.google.com/ad-manager/mobile-ads-sdk/android/reference/com/google/android/gms/ads/rewardedinterstitial/RewardedInterstitialAdLoadCallback loadCallback` | A callback to be invoked when a rewarded interstitial ad finishes loading. | ### setFullScreenContentCallback ``` public abstract void setFullScreenContentCallback(     @Nullable FullScreenContentCallback fullScreenContentCallback ) ``` Registers a callback to be invoked when ads show and dismiss full screen content. ### setImmersiveMode ``` public abstract void setImmersiveMode(boolean immersiveModeEnabled) ``` Sets a flag that controls if this rewarded interstitial ad object will be displayed in immersive mode. Call this method before `https://developers.google.com/ad-manager/mobile-ads-sdk/android/reference/com/google/android/gms/ads/rewardedinterstitial/RewardedInterstitialAd#show(android.app.Activity,com.google.android.gms.ads.OnUserEarnedRewardListener)`. During `https://developers.google.com/ad-manager/mobile-ads-sdk/android/reference/com/google/android/gms/ads/rewardedinterstitial/RewardedInterstitialAd#show(android.app.Activity,com.google.android.gms.ads.OnUserEarnedRewardListener)`, if this flag is on and immersive mode is supported, SYSTEM_UI_FLAG_IMMERSIVE_STICKY \&SYSTEM_UI_FLAG_HIDE_NAVIGATION will be turned on for the rewarded ad. ### setOnAdMetadataChangedListener ``` public abstract void setOnAdMetadataChangedListener(     @Nullable OnAdMetadataChangedListener listener ) ``` Registers a callback to be invoked when the rewarded interstitial ad's metadata changes. ### setOnPaidEventListener ``` public abstract void setOnPaidEventListener(@Nullable OnPaidEventListener listener) ``` Registers a callback to be invoked when this ad is estimated to have earned money. ### setPlacementId ``` public abstract void setPlacementId(long placementId) ``` Sets a placement ID for the rewarded interstitial ad. To ensure this placement ID is included in reporting, call this method before showing the ad. | Parameters | |---|---| | `long placementId` | A long integer provided by the AdMob UI for the configured placement. | ### setServerSideVerificationOptions ``` public abstract void setServerSideVerificationOptions(     ServerSideVerificationOptions options ) ``` Sets `https://developers.google.com/ad-manager/mobile-ads-sdk/android/reference/com/google/android/gms/ads/rewarded/ServerSideVerificationOptions` for this rewarded interstitial ad. ### show ``` public abstract void show(     @NonNull Activity activity,     @NonNull OnUserEarnedRewardListener onUserEarnedRewardListener ) ``` Shows the rewarded interstitial ad. | Parameters | |---|---| | `@https://developer.android.com/reference/androidx/annotation/NonNull.html https://developer.android.com/reference/android/app/Activity.html activity` | The activity from which the rewarded ad should be shown. | | `@https://developer.android.com/reference/androidx/annotation/NonNull.html https://developers.google.com/ad-manager/mobile-ads-sdk/android/reference/com/google/android/gms/ads/OnUserEarnedRewardListener onUserEarnedRewardListener` | The listener to be notified when user earns a reward. |