Full-screen interstitial ads. The ad unit ID must be set prior to calling
loadAd(AdRequest)
.
Publishers using DoubleClick for Publishers should use PublisherInterstitialAd
.
Sample code:
public class MyActivity extends Activity { private InterstitialAd mInterstitialAd; private Button mNextLevelButton; private TextView mTextView; @Override public void onCreate(Bundle savedInstanceState) { super.onCreate(savedInstanceState); // Create an interstitial ad. When a natural transition in the app occurs (such as a // level ending in a game), show the interstitial. In this simple example, the press of a // button is used instead. // // If the button is clicked before the interstitial is loaded, the user should proceed to // the next part of the app (in this case, the next level). // // If the interstitial is finished loading, the user will view the interstitial before // proceeding. mInterstitialAd = new InterstitialAd(this); mInterstitialAd.setAdUnitId("myAdUnitId"); // Create an ad request. AdRequest.Builder adRequestBuilder = new AdRequest.Builder(); // Set an AdListener. mInterstitialAd.setAdListener(new AdListener() { @Override public void onAdLoaded() { Toast.makeText(MyActivity.this, "The interstitial is loaded", Toast.LENGTH_SHORT).show(); } @Override public void onAdClosed() { // Proceed to the next level. goToNextLevel(); } }); // Start loading the ad now so that it is ready by the time the user is ready to go to // the next level. mInterstitialAd.loadAd(adRequestBuilder.build()); // Create the button to go to the next level. mNextLevelButton = new Button(this); mNextLevelButton.setText("Next Level"); mNextLevelButton.setOnClickListener(new View.OnClickListener() { @Override public void onClick(View view) { // Show the interstitial if it is ready. Otherwise, proceed to the next level // without ever showing it. if (mInterstitialAd.isLoaded()) { mInterstitialAd.show(); } else { // Proceed to the next level. goToNextLevel(); } } }); // Add the next level button to the layout. LinearLayout layout = new LinearLayout(this); layout.setOrientation(LinearLayout.VERTICAL); layout.addView(mNextLevelButton); // Create a TextView to display the current level. mTextView = new TextView(this); mTextView.setText("Level 1"); layout.addView(mTextView); setContentView(layout); } public void goToNextLevel() { // Show the next level (and disable the next level button since there are no more levels. mNextLevelButton.setEnabled(false); mTextView.setText("Level 2"); } }
Public Constructor Summary
Public Method Summary
AdListener |
getAdListener()
Returns the
AdListener
for this InterstitialAd .
|
String |
getAdUnitId()
Returns the ad unit ID.
|
String |
getMediationAdapterClassName()
This method is deprecated. Use
getResponseInfo() and
getMediationAdapterClassName() .
|
ResponseInfo |
getResponseInfo()
Returns the
ResponseInfo
object for the loaded ad.
|
boolean |
isLoaded()
Returns
true if the ad was successfully loaded and is ready to be
shown.
|
boolean |
isLoading()
Returns
true if the ad is loading.
|
void | |
void | |
void | |
void |
setImmersiveMode(boolean immersiveModeEnabled)
Sets a flag that controls if this interstitial object will be displayed in
immersive mode.
|
void |
setOnPaidEventListener(OnPaidEventListener
listener)
Register a callback to be invoked when this ad is estimated to have earned
money.
|
void |
show()
Show the interstitial ad.
|
Inherited Method Summary
Public Constructors
public InterstitialAd (Context context)
Construct an InterstitialAd
.
Public Methods
public AdListener getAdListener ()
Returns the AdListener
for this InterstitialAd
.
public String getAdUnitId ()
Returns the ad unit ID.
public String getMediationAdapterClassName ()
This method is deprecated.
Use getResponseInfo()
and
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
.
public ResponseInfo getResponseInfo ()
Returns the ResponseInfo
object for the loaded ad. Returns null
until the ad successfully
loads.
public boolean isLoaded ()
Returns true
if the ad was successfully loaded and is ready to be
shown.
public boolean isLoading ()
Returns true
if the ad is loading.
public void loadAd (AdRequest adRequest)
Loads an ad.
Throws
IllegalStateException | If the the ad unit ID has not been set. |
---|
public void setAdListener (AdListener adListener)
Sets an AdListener
for this InterstitialAd
.
public void setAdUnitId (String adUnitId)
Sets the ad unit ID.
Throws
IllegalStateException | If the ad unit ID was already set. |
---|
public void setImmersiveMode (boolean immersiveModeEnabled)
Sets a flag that controls if this interstitial object will be displayed in immersive
mode. Call this method before show()
to affect subsequent interstitial 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 for interstitial ad.
public void setOnPaidEventListener (OnPaidEventListener listener)
Register a callback to be invoked when this ad is estimated to have earned money.
public void show ()
Show the interstitial ad.