Getting Started

Install

bun add @capgo/capacitor-admob
bunx cap sync

Import

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

API Overview

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 } 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 });

adShow

Show a loaded ad.

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

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

adHide

Hide a currently displayed ad.

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

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

trackingAuthorizationStatus

Get the current tracking authorization status (iOS only).

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

const { status } = await AdMob.trackingAuthorizationStatus();
if (status === TrackingAuthorizationStatus.notDetermined) {
  await AdMob.requestTrackingAuthorization();
}

requestTrackingAuthorization

Request tracking authorization from the user (iOS only).

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

const { status } = await AdMob.requestTrackingAuthorization();
console.log('User tracking status:', status);

Type Reference

AdMobConfig

Configuration options for AdMob.

export type AdMobConfig = {
  /** Whether the app should be muted */
  appMuted?: boolean;
  /** The app volume (0.0 to 1.0) */
  appVolume?: number;
};

RequestConfig

Configuration for ad requests.

export type RequestConfig = {
  /** Maximum ad content rating */
  maxAdContentRating?: MaxAdContentRating;
  /** Whether to use the same app key */
  sameAppKey?: boolean;
  /** Tag for child-directed treatment (true, false, or null for unspecified) */
  tagForChildDirectedTreatment?: boolean | null;
  /** Tag for under age of consent (true, false, or null for unspecified) */
  tagForUnderAgeOfConsent?: boolean | null;
  /** Array of test device IDs */
  testDeviceIds?: string[];
};

MobileAdOptions

Base options for mobile ads.

export type MobileAdOptions = {
  /** The ad unit ID from AdMob */
  adUnitId: string;
};

TrackingAuthorizationStatus

Tracking authorization status for iOS App Tracking Transparency.

export enum TrackingAuthorizationStatus {
  /** User has not yet received an authorization request */
  notDetermined = 0,
  /** User restricted, device is unable to provide authorization */
  restricted = 1,
  /** User denied authorization */
  denied = 2,
  /** User authorized access */
  authorized = 3,
}

MaxAdContentRating

Maximum ad content rating enum used to restrict ads based on content rating.

export enum MaxAdContentRating {
  /** General Audiences */
  G = 'G',
  /** Mature Audiences */
  MA = 'MA',
  /** Parental Guidance */
  PG = 'PG',
  /** Teen */
  T = 'T',
  /** Unspecified rating */
  UNSPECIFIED = '',
}

Source Of Truth

This page is generated from the plugin’s src/definitions.ts. Re-run the sync when the public API changes upstream.