@addapptr/aatkit-ionic-plugin v1.0.0-beta6

aatkit-ionic-plugin

AATKit SDK plugin for Ionic

Install

npm install @addapptr/aatkit-ionic-plugin
npx cap sync

API

• initialize(...)
• reconfigure(...)
• setCollapsibleBannerOptions(...)
• setLogLevel(...)
• setIsChildDirected(...)
• configureDebugScreen(...)
• enableDebugScreen()
• disableDebugScreen()
• showConsentDialogIfNeeded()
• showConsentDialogIfNeededOrRejected(...)
• editConsent()
• reloadConsent()
• createPlacement(...)
• createRewardedVideoPlacement(...)
• createAppOpenAdPlacement(...)
• reloadPlacement(...)
• startPlacementAutoReload(...)
• stopPlacementAutoReload(...)
• showPlacement(...)
• addPlacementToView(...)
• removePlacementFromView(...)
• setPlacementAlignment(...)
• isTablet()
• maximumBannerSizeLandscape()
• maximumBannerSizePortrait()
• fittingBannerSizesPortrait()
• fittingBannerSizesLandscape()
• setNetworkEnabled(...)
• isNetworkEnabled(...)
• setContentGravity(...)
• addAdNetworkForKeywordTargeting(...)
• removeAdNetworkForKeywordTargeting(...)
• setTargetingInfo(...)
• setTargetingInfoForPlacement(...)
• setContentTargetingUrl(...)
• setContentTargetingUrlForPlacement(...)
• setMultiContentTargetingUrlsForPlacement(...)
• setPublisherProvidedId(...)
• hasAdForPlacement(...)
• isFrequencyCapReachedForPlacement(...)
• muteVideoAds(...)
• isConsentOptIn()
• Interfaces

initialize(...)

initialize(options: AATKitConfiguration) => Promise<void>

Initializes the AATKit library. Should be called once during application initialization before any other calls to AATKit.

reconfigure(...)

reconfigure(options: AATKitRuntimeConfiguration) => Promise<void>

Update AATKit consent arguments after the AATKit is already initialized.

setCollapsibleBannerOptions(...)

setCollapsibleBannerOptions(_: { placementName: string; collapsibleBannerOptions: AATKitCollapsibleBannerOptions; }) => Promise<void>

Allows to set collapsible banner options for given placement

setLogLevel(...)

setLogLevel(options: { level: string; }) => Promise<void>

Allows to set log level from code.

setIsChildDirected(...)

setIsChildDirected(options: { isChildDirected: boolean; }) => Promise<void>

Allows to set if app should be treated as child-directed.

configureDebugScreen(...)

configureDebugScreen(configuration: AATKitDebugScreenConfiguration) => Promise<void>

Sets debug screen configuration.

enableDebugScreen()

enableDebugScreen() => Promise<void>

Enables debug screen that will show after shaking the device. It is already enabled by default.

disableDebugScreen()

disableDebugScreen() => Promise<void>

Disables the debug screen appearing after shaking the device. It is enabled by default.

showConsentDialogIfNeeded()

showConsentDialogIfNeeded() => Promise<void>

Presents the consent screen only if it is required by the used CMP (for example if no user consent has been set yet). It is advised to always call this method when the app starts.

showConsentDialogIfNeededOrRejected(...)

showConsentDialogIfNeededOrRejected(options: { daysAgo: number; }) => Promise<void>

Presents the consent screen if it is required by the used CMP (i.e. no user consent has been set yet) or the user has rejected the consent.

editConsent()

editConsent() => Promise<void>

Presents the consent screen, allowing the user to change consent settings.

reloadConsent()

reloadConsent() => Promise<void>

Tells the CMP to reload. Does not need to be used unless some error occurs.

createPlacement(...)

createPlacement(options: { placementName: string; placementSize: string; }) => Promise<void>

Creates placement with given name and size and adds it to the view.

createRewardedVideoPlacement(...)

createRewardedVideoPlacement(options: { placementName: string; }) => Promise<void>

Creates Rewarded Video placement with given name.

createAppOpenAdPlacement(...)

createAppOpenAdPlacement(options: { placementName: string; }) => Promise<void>

Creates a new App Open Ad with given name.

reloadPlacement(...)

reloadPlacement(options: { placementName: string; }) => Promise<boolean>

Requests placement reload. Works only if automatic reloading is disabled.

Returns: Promise<boolean>

startPlacementAutoReload(...)

startPlacementAutoReload(options: { placementName: string; }) => Promise<void>

Enables automatic reloading of placement. Auto-reloader will use reload time configured on gravite.net account or fallback to default 30L seconds.

stopPlacementAutoReload(...)

stopPlacementAutoReload(options: { placementName: string; }) => Promise<void>

Disables automatic reloading of placement.

showPlacement(...)

showPlacement(options: { placementName: string; }) => Promise<boolean>

Shows interstitial ad if ad is ready.

Returns: Promise<boolean>

addPlacementToView(...)

addPlacementToView(options: { placementName: string; }) => Promise<void>

Adds placement to view. Works only for banner placements.

removePlacementFromView(...)

removePlacementFromView(options: { placementName: string; }) => Promise<void>

Removes placement from view. Works only for banner placements.

setPlacementAlignment(...)

setPlacementAlignment(options: { placementName: string; bannerAlignment: string; }) => Promise<void>

Sets banner placement position on the screen.

isTablet()

isTablet() => Promise<boolean>

Checks if AATKit recognizes given device as tablet.

Returns: Promise<boolean>

maximumBannerSizeLandscape()

maximumBannerSizeLandscape() => Promise<String>

Returns the banner size with maximum width that will fit on a given device in portrait screen orientation.

Returns: Promise<String>

maximumBannerSizePortrait()

maximumBannerSizePortrait() => Promise<String>

Returns the banner size with maximum width that will fit on a given device in portrait screen orientation.

Returns: Promise<String>

fittingBannerSizesPortrait()

fittingBannerSizesPortrait() => Promise<string[]>

Returns the list of baner sizes that will fit on a given device in portrait screen orientation.

Returns: Promise<string[]>

fittingBannerSizesLandscape()

fittingBannerSizesLandscape() => Promise<string[]>

Returns the list of BannerSize that will fit on a given device in landscape screen orientation.

Returns: Promise<string[]>

setNetworkEnabled(...)

setNetworkEnabled(options: { network: string; enabled: boolean; }) => Promise<void>

Allows to enable or disable selected ad networks. By default all networks are enabled

isNetworkEnabled(...)

isNetworkEnabled(options: { network: string; }) => Promise<boolean>

Returns true if ad network is enabled, false otherwise.

Returns: Promise<boolean>

setContentGravity(...)

setContentGravity(options: { placementName: string; gravity: string; }) => Promise<void>

Sets gravity for ads that don't fill entire placement area.

addAdNetworkForKeywordTargeting(...)

addAdNetworkForKeywordTargeting(options: { network: string; }) => Promise<void>

Adds an ad network to the list of ad networks that receive targeting keywords (if any set). If no ad networks are added, any set keywords will be delivered to all ad networks supporting keyword targeting.

removeAdNetworkForKeywordTargeting(...)

removeAdNetworkForKeywordTargeting(options: { network: string; }) => Promise<void>

Removes an ad network from the list of ad networks that receive targeting keywords (if any set). If no ad networks are added to the list, any set keywords will be delivered to all ad networks supporting keyword targeting.

setTargetingInfo(...)

setTargetingInfo(options: { info: { [key: string]: string[]; }; }) => Promise<void>

Sets the targeting information for the application. This information will be used only if no placement-specific targeting is available.

setTargetingInfoForPlacement(...)

setTargetingInfoForPlacement(options: { placementName: string; info: { [key: string]: string[]; }; }) => Promise<void>

Sets the targeting information for the specific placement.

setContentTargetingUrl(...)

setContentTargetingUrl(options: { url: string; }) => Promise<void>

Sets the content targeting url for the application. This information will be used only if no placement-specific targeting is available.

setContentTargetingUrlForPlacement(...)

setContentTargetingUrlForPlacement(options: { placementName: string; url: string; }) => Promise<void>

Sets the content targeting url for the specific placement.

setMultiContentTargetingUrlsForPlacement(...)

setMultiContentTargetingUrlsForPlacement(options: { placementName: string; urls: string[]; }) => Promise<void>

Sets the multi content targeting url for the application. Not all ad-networks supports multiple urls.

setPublisherProvidedId(...)

setPublisherProvidedId(options: { publisherProvidedId: string; }) => Promise<void>

Allows to pass PublisherProvidedId to networks supporting it.

hasAdForPlacement(...)

hasAdForPlacement(options: { placementName: string; }) => Promise<boolean>

Returns true if there is an ad loaded for given placement.

Returns: Promise<boolean>

isFrequencyCapReachedForPlacement(...)

isFrequencyCapReachedForPlacement(options: { placementName: string; }) => Promise<boolean>

Checks if desired impression cap (set on Gravite Dashboard) is reached for given fullscreen or rewarded video placement. Note: this method will ALWAYS return false for other placement types.

Returns: Promise<boolean>

muteVideoAds(...)

muteVideoAds(options: { mute: boolean; }) => Promise<void>

Allows to mute video ads.

isConsentOptIn()

isConsentOptIn() => Promise<boolean>

Returns "consent opt-in status" returned by our server rules. Only returns meaningful information after the rules are downloaded.

Returns: Promise<boolean>

Interfaces

AATKitConfiguration

AATKitConsent

AATKitAdNetworkOptions

AATKitAppNexusOptions

AATKitFeedAdOptions

AATKitAdMobOptions

AATKitDFPOptions

AATKitDatonomyOptions

AATKitSuperAwesomeOptions

AATKitSuperAwesomeBannerOptions

AATKitSuperAwesomeInterstitialAdOptions

AATKitSuperAwesomeRewardedVideOptions

AATKitRuntimeConfiguration

AATKitCollapsibleBannerOptions

AATKitDebugScreenConfiguration

String

Allows manipulation and formatting of text strings and determination and location of substrings within strings.

RegExpMatchArray

RegExp

RegExpExecArray