AdMob Capacitor plugin

Using @capgo/capacitor-admob

AdMob Plus Plugin interface for displaying Google AdMob ads in Capacitor apps.

Install

bun add @capgo/capacitor-admob
bunx cap sync

bunx cap sync copies the plugin's native code into your native projects. Run it again after every plugin upgrade.

Import

import { AdMob } from '@capgo/capacitor-admob';

API at a glance

Examples

start()

Initialize and start the AdMob SDK.

import { AdMob } from '@capgo/capacitor-admob';

await AdMob.start();

configure()

Configure AdMob settings.

import { AdMob } from '@capgo/capacitor-admob';

await AdMob.configure({
  appMuted: false,
  appVolume: 0.5
});

configRequest()

Configure ad request settings.

import { AdMob, MaxAdContentRating } from '@capgo/capacitor-admob';

await AdMob.configRequest({
  maxAdContentRating: MaxAdContentRating.PG,
  tagForChildDirectedTreatment: true,
  testDeviceIds: ['test-device-id']
});

adCreate()

Create a new ad instance.

import { AdMob } from '@capgo/capacitor-admob';

await AdMob.adCreate({
  adUnitId: 'ca-app-pub-3940256099942544/1033173712'
});

adIsLoaded()

Check if an ad is loaded and ready to be shown.

import { AdMob } from '@capgo/capacitor-admob';

const isLoaded = await AdMob.adIsLoaded({ id: 1 });
if (isLoaded) {
  await AdMob.adShow({ id: 1 });
}

adLoad()

Load an ad.

import { AdMob } from '@capgo/capacitor-admob';

await AdMob.adLoad({ id: 1 });

The table above lists the 10 core methods. Listener and version helpers, and the full contract of each method, are documented in the GitHub repository.

Listen to events

addListener returns a handle. Call handle.remove() when the screen unmounts.

Full reference

• GitHub repository
• Documentation
• API reference

Keep going from Using @capgo/capacitor-admob

If you are using Using @capgo/capacitor-admob to plan native plugin work, connect it with @capgo/capacitor-admob for the implementation detail in @capgo/capacitor-admob, Getting Started for the implementation detail in Getting Started, Capgo Plugin Directory for the product workflow in Capgo Plugin Directory, Capacitor Plugins by Capgo for the implementation detail in Capacitor Plugins by Capgo, and Adding or Updating Plugins for the implementation detail in Adding or Updating Plugins.