public interface

RewardedVideoAd

com.google.android.gms.ads.reward.RewardedVideoAd

Class Overview

This class is used to request and display a rewarded video.

 public class MainActivity extends ActionBarActivity implements RewardedVideoAdListener {

     private RewardedVideoAd mAd;

     @Override
     protected void onCreate(Bundle savedInstanceState) {
         super.onCreate(savedInstanceState);
         setContentView(R.layout.activity_main);
         mAd = MobileAds.getRewardedVideoAdInstance(this);
         mAd.setRewardedVideoAdListener(this);
         AdRequest adRequest = new AdRequest.Builder().build();
         mAd.loadAd("adUnitId", adRequest);
     }

     @Override
     public void onRewardedVideoAdLoaded() {
         findViewById(R.id.display_button).setVisibility(View.VISIBLE);
     }

     public void onDisplayButtonClicked(View view) {
         if (mAd.isLoaded()) {
             mAd.show();
         }
     }

     @Override
     public void onRewarded(RewardItem rewardItem) {
         Toast.makeText(
             this,
             "onRewarded! currency: "
                 + rewardItem.getType() + "  amount: "
                 + rewardItem.getAmount(), Toast.LENGTH_SHORT).show();
     }

     @Override
     public void onResume() {
         super.onResume();
         mAd.resume(this);
     }

     @Override
     public void onPause() {
         mAd.pause(this);
         super.onPause();
     }

     @Override
     public void onDestroy() {
         mAd.destroy(this);
         super.onDestroy();
     }
 }

Summary

Public Methods
abstract void destroy(Context context)
Destroys the RewardedVideoAd.
abstract void destroy()
This method is deprecated. Replaced by destroy(Context)
abstract String getMediationAdapterClassName()
Returns the mediation adapter class name.
abstract RewardedVideoAdListener getRewardedVideoAdListener()
abstract String getUserId()
This method is deprecated. No replacement.
abstract boolean isLoaded()
Returns true if a rewarded video ad is available and is ready to be shown.
abstract void loadAd(String adUnitId, AdRequest adRequest)
Requests for a rewarded video ad.
abstract void pause(Context context)
Pauses any extra processing associated with this RewardedVideoAd.
abstract void pause()
This method is deprecated. Replaced by pause(Context)
abstract void resume(Context context)
Resumes an RewardedVideoAd.
abstract void resume()
This method is deprecated. Replaced by resume(Context)
abstract void setImmersiveMode(boolean immersiveModeEnabled)
Sets a flag that controls if ads subsequently loaded by this object will be displayed in immersive mode.
abstract void setRewardedVideoAdListener(RewardedVideoAdListener listener)
abstract void setUserId(String userId)
This method is deprecated. No replacement.
abstract void show()
Shows rewarded video ad if available.

Public Methods

public abstract void destroy (Context context)

Destroys the RewardedVideoAd. This method should be called in the parent Activity's onDestroy() method.

Parameters
context Context

public abstract void destroy ()

This method is deprecated.
Replaced by destroy(Context)

Destroys the RewardedVideoAd. This method should be called in the parent Activity's onDestroy() method.

public abstract String getMediationAdapterClassName ()

Returns the mediation adapter class name. In the case of a mediated ad response, this is the name of the class that was responsible for performing the ad request and rendering the ad. For non-mediated responses, this value will be null.

Returns
String

public abstract String getUserId ()

This method is deprecated.
No replacement.

Returns the user id set by setUserId(String). This method will always return null.

Returns
String

public abstract boolean isLoaded ()

Returns true if a rewarded video ad is available and is ready to be shown.

Returns
boolean

public abstract void loadAd (String adUnitId, AdRequest adRequest)

Requests for a rewarded video ad.

Parameters
adUnitId String
adRequest AdRequest

public abstract void pause (Context context)

Pauses any extra processing associated with this RewardedVideoAd. This method should be called in the parent Activity's onPause() method.

Parameters
context Context

public abstract void pause ()

This method is deprecated.
Replaced by pause(Context)

Pauses any extra processing associated with this RewardedVideoAd. This method should be called in the parent Activity's onPause() method.

public abstract void resume (Context context)

Resumes an RewardedVideoAd. This method should be called in the parent Activity's onResume() method.

Parameters
context Context

public abstract void resume ()

This method is deprecated.
Replaced by resume(Context)

Resumes an RewardedVideoAd. This method should be called in the parent Activity's onResume() method.

public abstract void setImmersiveMode (boolean immersiveModeEnabled)

Sets a flag that controls if ads subsequently loaded by this object will be displayed in immersive mode. Call this method before show() to affect subsequent rewarded video ads. During show(), if this flag is on and immersive mode is supported, SYSTEM_UI_FLAG_IMMERSIVE_STICKY & SYSTEM_UI_FLAG_HIDE_NAVIGATION will be turned on when displaying the ad.

Parameters
immersiveModeEnabled boolean

public abstract void setRewardedVideoAdListener (RewardedVideoAdListener listener)

Sets a RewardedVideoAdListener for this RewardedVideoAd.

Parameters
listener RewardedVideoAdListener

public abstract void setUserId (String userId)

This method is deprecated.
No replacement.

Sets the user id of current user. This method is a no-op.

Parameters
userId String

public abstract void show ()

Shows rewarded video ad if available. Applications should check isLoaded() before calling this method.