@capgo/capacitor-admob

Documentation

The most complete doc is available here: https://capgo.app/docs/plugins/admob/

Compatibility

| Plugin version | Capacitor compatibility | Maintained | | -------------- | ----------------------- | ---------- | | v8.*.* | v8.*.* | ✅ | | v7.*.* | v7.*.* | On demand | | v6.*.* | v6.*.* | ❌ | | v5.*.* | v5.*.* | ❌ |

Note: The major version of this plugin follows the major version of Capacitor. Use the version that matches your Capacitor installation (e.g., plugin v8 for Capacitor 8). Only the latest major version is actively maintained.

Install

npm install @capgo/capacitor-admob
npx cap sync

API

• start()
• configure(...)
• configRequest(...)
• adCreate(...)
• adIsLoaded(...)
• adLoad(...)
• adShow(...)
• adHide(...)
• trackingAuthorizationStatus()
• requestTrackingAuthorization()
• addListener(string, ...)
• getPluginVersion()
• Interfaces
• Type Aliases
• Enums

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

start()

start() => Promise<void>

Initialize and start the AdMob SDK.

Since: 1.0.0

configure(...)

configure(config: AdMobConfig) => Promise<void>

Configure AdMob settings.

| Param | Type | Description | | ------------ | --------------------------------------------------- | --------------------------------- | | config | AdMobConfig | - Configuration options for AdMob |

Since: 1.0.0

configRequest(...)

configRequest(requestConfig: RequestConfig) => Promise<void>

Configure ad request settings.

| Param | Type | Description | | ------------------- | ------------------------------------------------------- | ------------------------------- | | requestConfig | RequestConfig | - Request configuration options |

Since: 1.0.0

adCreate(...)

adCreate<O extends MobileAdOptions>(opts: O) => Promise<void>

Create a new ad instance.

| Param | Type | Description | | ---------- | -------------- | --------------------------------------------------- | | opts | O | - Options for creating the ad, including ad unit ID |

Since: 1.0.0

adIsLoaded(...)

adIsLoaded(opts: { id: number; }) => Promise<boolean>

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

| Param | Type | Description | | ---------- | ---------------------------- | ----------------------------- | | opts | { id: number; } | - Object containing the ad ID |

Returns: Promise<boolean>

Since: 1.0.0

adLoad(...)

adLoad(opts: { id: number; }) => Promise<void>

Load an ad.

| Param | Type | Description | | ---------- | ---------------------------- | ----------------------------- | | opts | { id: number; } | - Object containing the ad ID |

Since: 1.0.0

adShow(...)

adShow(opts: { id: number; }) => Promise<void>

Show a loaded ad.

| Param | Type | Description | | ---------- | ---------------------------- | ----------------------------- | | opts | { id: number; } | - Object containing the ad ID |

Since: 1.0.0

adHide(...)

adHide(opts: { id: number; }) => Promise<void>

Hide a currently displayed ad.

| Param | Type | Description | | ---------- | ---------------------------- | ----------------------------- | | opts | { id: number; } | - Object containing the ad ID |

Since: 1.0.0

trackingAuthorizationStatus()

trackingAuthorizationStatus() => Promise<{ status: TrackingAuthorizationStatus | false; }>

Get the current tracking authorization status (iOS only).

Returns: Promise<{ status: false | TrackingAuthorizationStatus; }>

Since: 1.0.0

requestTrackingAuthorization()

requestTrackingAuthorization() => Promise<{ status: TrackingAuthorizationStatus | false; }>

Request tracking authorization from the user (iOS only).

Returns: Promise<{ status: false | TrackingAuthorizationStatus; }>

Since: 1.0.0

addListener(string, ...)

addListener(eventName: string, listenerFunc: (event: any) => void) => Promise<PluginListenerHandle> & PluginListenerHandle

Add a listener for ad events.

| Param | Type | Description | | ------------------ | ------------------------------------ | -------------------------------------------- | | eventName | string | - The name of the event to listen for | | listenerFunc | (event: any) => void | - The function to call when the event occurs |

Returns: Promise<PluginListenerHandle> & PluginListenerHandle

Since: 1.0.0

getPluginVersion()

getPluginVersion() => Promise<{ version: string; }>

Get the native Capacitor plugin version.

Returns: Promise<{ version: string; }>

Since: 1.0.0

Interfaces

PluginListenerHandle

| Prop | Type | | ------------ | ----------------------------------------- | | remove | () => Promise<void> |

Type Aliases

AdMobConfig

Configuration options for AdMob.

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

RequestConfig

Configuration for ad requests.

{ /** 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.

{ /** The ad unit ID from AdMob */ adUnitId: string; }

Enums

MaxAdContentRating

| Members | Value | Description | | ----------------- | ----------------- | ------------------ | | G | 'G' | General Audiences | | MA | 'MA' | Mature Audiences | | PG | 'PG' | Parental Guidance | | T | 'T' | Teen | | UNSPECIFIED | '' | Unspecified rating |

TrackingAuthorizationStatus

| Members | Value | Description | | ------------------- | -------------- | ---------------------------------------------------------- | | notDetermined | 0 | User has not yet received an authorization request | | restricted | 1 | User restricted, device is unable to provide authorization | | denied | 2 | User denied authorization | | authorized | 3 | User authorized access |