Skip to content
rdlabo.devdocs
日本語

App Open Ads

App open ads monetize app-load screens and are designed to show when the user brings the app to the foreground. The user can close them at any time. Google's app open guides for Android and iOS explain the format.

Call this after initialize and consent. Load the ad ahead of time and confirm it is available before presentation. Do not block app startup indefinitely while waiting for an ad to load.

import {
  AdLoadInfo,
  AdMob,
  AdMobRevenueData,
  AppOpenAdOptions,
  AppOpenAdPluginEvents,
} from '@capacitor-community/admob';

await AdMob.addListener(AppOpenAdPluginEvents.Loaded, (info: AdLoadInfo) => {
  console.log('App Open Ad loaded', info.adUnitId);
});
await AdMob.addListener(AppOpenAdPluginEvents.FailedToLoad, console.error);
await AdMob.addListener(AppOpenAdPluginEvents.Opened, () => {
  console.log('App Open Ad open');
});
await AdMob.addListener(AppOpenAdPluginEvents.Closed, () => {
  console.log('App Open Ad close');
});
await AdMob.addListener(AppOpenAdPluginEvents.FailedToShow, console.error);
await AdMob.addListener(AppOpenAdPluginEvents.AdImpression, (data: AdMobRevenueData) => {
  console.log(data);
});

const options: AppOpenAdOptions = {
  adId: 'YOUR_AD_UNIT_ID',
};
const { adUnitId } = await AdMob.loadAppOpen(options);
const { value: isLoaded } = await AdMob.isAppOpenLoaded({ adId: adUnitId });
if (isLoaded) {
  await AdMob.showAppOpen({ adId: adUnitId });
}

method loadAppOpen(...)

Loads an App Open ad and returns the loaded ad unit ID.

loadAppOpen(options: AppOpenAdOptions) => Promise<AdLoadInfo>

method isAppOpenLoaded(...)

Checks whether an App Open ad is loaded.

isAppOpenLoaded(options?: AdShowOptions | undefined) => Promise<{ value: boolean; }>

method showAppOpen(...)

Shows a loaded App Open ad.

showAppOpen(options?: AdShowOptions | undefined) => Promise<void>

interface AppOpenAdOptions

Options for loading an App Open ad.

Prop Type Description
adId string The App Open ad unit ID to load.

There is no isTesting flag; during development set adId to Google's App Open demo ad unit.

Use the Closed event to resume your app flow and begin loading the next ad.

When no adId is passed to showAppOpen() or isAppOpenLoaded(), the most recently loaded ad is targeted. See Ad Events for the event list.

Edit this page on GitHub