2.0.0-alpha.5 • Published 13 days ago

@pikopika/admob-plus-capacitor v2.0.0-alpha.5

Weekly downloads
-
License
MIT
Repository
github
Last release
13 days ago

NPM version GitHub last commit Dependency status Vulnerabilities NPM license

@admob-plus/capacitor

AdMob Plus Capacitor Plugin

Install

npm install @admob-plus/capacitor
npx cap sync

Documentation

You can find the documentation on the website.

API

start()

start() => Promise<void>

configure(...)

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

configRequest(...)

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

adCreate(...)

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

adIsLoaded(...)

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

Returns: Promise<boolean>


adLoad(...)

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

adShow(...)

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

adHide(...)

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

trackingAuthorizationStatus()

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

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


requestTrackingAuthorization()

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

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


addListener(string, ...)

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

Returns: Promise<PluginListenerHandle> & PluginListenerHandle


Interfaces

PluginListenerHandle

PropType
remove() => Promise<void>

Type Aliases

AdMobConfig

{ appMuted?: boolean appVolume?: number }

RequestConfig

{ maxAdContentRating?: MaxAdContentRating sameAppKey?: boolean tagForChildDirectedTreatment?: boolean | null tagForUnderAgeOfConsent?: boolean | null testDeviceIds?: string[] }

MobileAdOptions

{ adUnitId: string }

Enums

MaxAdContentRating

MembersValue
G'G'
MA'MA'
PG'PG'
T'T'
UNSPECIFIED''

TrackingAuthorizationStatus

MembersValue
notDetermined0
restricted1
denied2
authorized3