Protected_The Ad Unit ID for this Gogole Mobile Ads ad.
Whether the advert is loaded and can be shown.
Snapshot of the loaded ad's response info, or null before load / after destroy.
ProtectedconstructorProtected_Protected_Protected_Protected_Listen to ad events. See AdEventTypes for more information.
Returns an unsubscriber function to stop listening to further events.
// Create InterstitialAd/RewardedAd
const advert = InterstitialAd.createForAdRequest('...');
const unsubscribe = advert.addAdEventListener(AdEventType.LOADED, () => {
});
// Sometime later...
unsubscribe();
The event type, e.g. AdEventType.LOADED.
A listener callback containing a event type, error and data.
Listen to ad events. See AdEventTypes for more information.
Returns an unsubscriber function to stop listening to further events.
// Create InterstitialAd/RewardedAd
const advert = InterstitialAd.createForAdRequest('...');
const unsubscribe = advert.addAdEventsListener(({ type, payload }) => {
});
// Sometime later...
unsubscribe();
A listener callback containing a event type, error and data.
Release native resources for this ad instance. Idempotent; safe to call from React effect cleanup.
Start loading the advert with the provided RequestOptions.
It is recommended you setup ad event handlers before calling this method.
Remove all registered event listeners.
Show the loaded advert to the user.
Uses two error channels:
.catch() (or try { await } catch).showOptions are structurally invalid (checked only on a
loaded ad with no show in flight, so otherwise the rejection comes
first). Fix the call site.The fullscreen hooks' show absorbs both channels.
// Create InterstitialAd/RewardedAd
const advert = InterstitialAd.createForAdRequest('...');
advert.addAdEventListener(AdEventType.LOADED, () => {
advert
.show({
immersiveModeEnabled: true,
})
.catch(console.warn);
});
OptionalshowOptions: AdShowOptions
An optional AdShowOptions interface.
StaticcreateCreates a new InterstitialAd instance.
import { InterstitialAd, AdEventType, TestIds } from 'react-native-google-mobile-ads';
const interstitialAd = InterstitialAd.createForAdRequest(TestIds.INTERSTITIAL, {
requestAgent: 'CoolAds',
});
interstitialAd.addAdEventListener(AdEventType.LOADED, () => {
interstitialAd.show().catch(console.warn);
});
interstitialAd.load();
The Ad Unit ID for the Interstitial. You can find this on your Google Mobile Ads dashboard.
OptionalrequestOptions: RequestOptions
Optional RequestOptions used to load the ad.
Protected_Protected_Protected_Protected_Protected_Protected_Protected_Protected_Protected_Protected_Protected_Protected_Protected_Protected_Protected_Protected_Protected_Protected_
A class for interacting and showing Interstitial Ads.
An Interstitial advert can be pre-loaded and shown at a suitable point in your apps flow, such as at the end of a level in a game. An Interstitial is a full screen advert, laid on-top of your entire application which the user can interact with. Interactions are passed back via events which should be handled accordingly inside of your app.
Example
First create a new Interstitial instance, passing in your Ad Unit ID from the Google Mobile Ads configuration console, and any additional request options. The example below will present a test advert, and only request a non-personalized ad.
Each advert needs to be loaded from Google Mobile Ads before being shown. It is recommended this is performed before the user reaches the checkpoint to show the advert, so it's ready to go. Before loading the advert, we need to setup event listeners to listen for updates from Google Mobile Ads, such as advert loaded or failed to load.
Event types match the
AdEventTypeinterface. Once the advert has loaded, we can trigger it to show:The advert will be presented to the user, and several more events can be triggered such as the user clicking the advert or closing it.