Appodeal

Improve this doc

Plugin to serve ads through native Appodeal SDKs

Repo: https://github.com/appodeal/appodeal-cordova-plugin

Installation

1. Install the Cordova and Ionic Native plugins:
   

   $ ionic cordova plugin add https://github.com/appodeal/appodeal-cordova-plugin.git
   $ npm install --save @ionic-native/appodeal@4
   

2. Add this plugin to your app's module

Supported platforms

• iOS
• Android

Usage

import { Appodeal } from '@ionic-native/appodeal';

constructor(private appodeal: Appodeal) {

   const appKey = '<your app key>';
   appodeal.initialize(appKey, appodeal.AD_TYPES.REWARDED_VIDEO);
   appodeal.show(appodeal.AD_TYPES.REWARDED_VIDEO);

}

Instance Members

readonly

initialize(appKey, adType)

initialize Appodeal SDK

isInitialized()

check if SDK has been initialized

show(adType)

show ad of specified type

showWithPlacement(adType, placement)

show ad of specified type with placement options

hide(adType)

hide ad of specified type

canShow(adType)

confirm use of ads of specified type

isLoaded(adType)

check if ad of specified type has been loaded

isPrecache(adType)

check if ad of specified

setAutoCache(adType, autoCache)

cache(adType)

forcefully cache an ad by type

setTriggerOnLoadedOnPrecache(set)

setSmartBanners(enabled)

enable or disable Smart Banners

setBannerBackground(enabled)

enable or disable banner backgrounds

setBannerAnimation(enabled)

enable or disable banner animations

set728x90Banners(value)

setLogLevel(logging)

enable or disable logging

setTesting(testing)

enable or disable testing mode

resetUUID()

reset device ID

getVersion()

get version of Appdeal SDK

disableNetwork(network, adType)

disableNetworkType(network, adType)

disableLocationPermissionCheck()

disable Location permissions for Appodeal SDK

disableWriteExternalStoragePermissionCheck()

disable Storage permissions for Appodeal SDK

enableInterstitialCallbacks(enabled)

enable event listeners

enableSkippableVideoCallbacks(enabled)

enable event listeners

enableNonSkippableVideoCallbacks(enabled)

enable event listeners

enableBannerCallbacks(enabled)

enable event listeners

enableRewardedVideoCallbacks(enabled)

enable event listeners

setCustomBooleanRule(name, value)

setCustomIntegerRule(name, value)

setCustomDoubleRule(name, value)

set rule with float value

setCustomStringRule(name, value)

set rule with string value

setUserId(id)

set ID preference in Appodeal for current user

setEmail(email)

set Email preference in Appodeal for current user

setBirthday(birthday)

set Birthday preference in Appodeal for current user

setAge(age)

et Age preference in Appodeal for current user

setGender(gender)

set Gender preference in Appodeal for current user

setOccupation(occupation)

set Occupation preference in Appodeal for current user

setRelation(relation)

set Relation preference in Appodeal for current user

setSmoking(smoking)

set Smoking preference in Appodeal for current user

setAlcohol(alcohol)

set Alcohol preference in Appodeal for current user

setInterests(interests)

set Interests preference in Appodeal for current user

onInterstitialLoaded()

onInterstitialFailedToLoad()

onInterstitialShown()

onInterstitialClicked()

onInterstitialClosed()

onSkippableVideoLoaded()

onSkippableVideoFailedToLoad()

onSkippableVideoShown()

onSkippableVideoFinished()

onSkippableVideoClosed()

onRewardedVideoLoaded()

onRewardedVideoFailedToLoad()

onRewardedVideoShown()

onRewardedVideoFinished()

onRewardedVideoClosed()

onNonSkippableVideoLoaded()

onNonSkippableVideoFailedToLoad()

onNonSkippableVideoShown()

onNonSkippableVideoFinished()

onNonSkippableVideoClosed()

onBannerClicked()

onBannerFailedToLoad()

onBannerLoaded()

onBannerShown()

getRewardParametersForPlacement()

getRewardParameters()

canShowWithPlacement()

showTestScreen()

Platforms:Android 

muteVideosIfCallsMuted()

setChildDirectedTreatment()