Unity LevelPlay React-Native Plugin

A bridge for LevelPlay SDK

- LevelPlay Knowledge Center
- Android SDK
- iOS SDK
- React-Native Plugin

Getting Started

Prerequisites

Please refer to the ReactNative official page for environment setup.

Installation

``shell
npm install unity-levelplay-mediation


or


yarn add unity-levelplay-mediation
`

Platform Setup

$3

- Follow LevelPlay Knowledge Center Android integration guide for required settings.

$3

- LevelPlay SDK

$3

- Play Services dependencies must be added to PROJECT_ROOT/android/app/build.gradle.

`groovy
// PROJECT_ROOT/android/app/build.gradle
dependencies {
implementation 'com.google.android.gms:play-services-appset:16.0.2'
implementation 'com.google.android.gms:play-services-ads-identifier:18.0.1'
implementation 'com.google.android.gms:play-services-basement:18.3.0'
}
`

$3

- Follow LevelPlay Knowledge Center iOS integration guide for required settings.

$3

- LevelPlay SDK

$3

#### SKAdNetwork Support

- Add the SKAN IDs of your ad networks on your PROJECT_ROOT/ios/PROJECT_NAME/info.plist
- Get the list of IDs using our SKAdNetwork IDs Manager

`xml
SKAdNetworkItems


SKAdNetworkIdentifier
su67r6k2v3.skadnetwork

...

`

#### App Transport Security Settings

Set NSAllowsArbitraryLoads: true on info.plist to allow http as some mediated networks require http calls. (Note: LevelPlay Network calls are all encrypted.)

Note:

- Make sure that your info.plist does not contain other ATS exceptions such as NSAllowsArbitraryLoadsInWebContent.

`xml
NSAppTransportSecurity

NSAllowsArbitraryLoads


`

#### App Tracking Transparency (ATT) Prompt

Implement the ATT prompt to request user authorization for app-related data.

Note:

- This is not part of LevelPlay SDK but a bridge for AppTrackingTransparency ATTrackingManager.
- You have to add NSUserTrackingUsageDescription to your info.plist if you intend to call this API.

`typescript
async function checkATT() {
if (Platform.OS !== 'ios') return

const currentStatus = await ATTrackingManager.getTrackingAuthorizationStatus()
console.log(ATTStatus: ${currentStatus})

if (currentStatus === ATTStatus.NotDetermined) {
const returnedStatus =
await ATTrackingManager.requestTrackingAuthorization()
console.log(ATTStatus returned: ${returnedStatus})
}
}
`

Read more about Apple's ATT and user privacy guideline here.

General Usage

$3

Note:

- Only one listener can be registered. When setListener is called, the listener previously registered to the event will be removed.

#### LevelPlayRewardedAdListener
`typescript
function SomeComponent() {
useEffect(() => {
const listener: LevelPlayRewardedAdListener = {
onAdLoaded: (adInfo: LevelPlayAdInfo) => {},
onAdLoadFailed: (error: LevelPlayAdError) => {},
onAdInfoChanged: (adInfo: LevelPlayAdInfo) => {},
onAdDisplayed: (adInfo: LevelPlayAdInfo) => {},
onAdDisplayFailed: (error: LevelPlayAdError, adInfo: LevelPlayAdInfo) => {},
onAdClicked: (adInfo: LevelPlayAdInfo) => {},
onAdClosed: (adInfo: LevelPlayAdInfo) => {},
onAdRewarded: (reward: LevelPlayReward, adInfo: LevelPlayAdInfo) => {}
}
// Use listener ...
}, [])

// return some view
}
`

#### LevelPlayInterstitialAdListener
`typescript
function SomeComponent() {
useEffect(() => {
const listener: LevelPlayInterstitialAdListener = {
onAdLoaded: (adInfo: LevelPlayAdInfo) => {},
onAdLoadFailed: (error: LevelPlayAdError) => {},
onAdInfoChanged: (adInfo: LevelPlayAdInfo) => {},
onAdDisplayed: (adInfo: LevelPlayAdInfo) => {},
onAdDisplayFailed: (error: LevelPlayAdError, adInfo: LevelPlayAdInfo) => {},
onAdClicked: (adInfo: LevelPlayAdInfo) => {},
onAdClosed: (adInfo: LevelPlayAdInfo) => {}
}
// Use listener ...
}, [])

// return some view
}
`

#### LevelPlayBannerAdViewListener
`typescript
function SomeComponent() {
useEffect(() => {
const listener: LevelPlayBannerAdViewListener = {
onAdLoaded: (adInfo: LevelPlayAdInfo) => {},
onAdLoadFailed: (error: LevelPlayAdError) => {},
onAdDisplayed: (adInfo: LevelPlayAdInfo) => {},
onAdDisplayFailed: (adInfo: LevelPlayAdInfo, error: LevelPlayAdError) => {},
onAdClicked: (adInfo: LevelPlayAdInfo) => {},
onAdExpanded: (adInfo: LevelPlayAdInfo) => {},
onAdCollapsed: (adInfo: LevelPlayAdInfo) => {},
onAdLeftApplication: (adInfo: LevelPlayAdInfo) => {},
};
// Use listener ...
}, [])

// return some view
}
`

#### LevelPlayNativeAdListener
`typescript
function SomeComponent() {
useEffect(() => {
const listener: LevelPlayNativeAdListener = {
onAdLoaded: (nativeAd: LevelPlayNativeAd, adInfo: AdInfo) => {},
onAdLoadFailed: (nativeAd: LevelPlayNativeAd, error: IronSourceError) => {},
onAdClicked: (nativeAd: LevelPlayNativeAd, adInfo: AdInfo) => {},
onAdImpression: (nativeAd: LevelPlayNativeAd, adInfo: AdInfo) => {},
};
// Add the listener to the LevelPlayNativeAd instance...
}, [])

// return some view
}
`

$3

`typescript
async function init() {
const appKey = "[YOUR_APP_KEY]"
const userId = "[YOUR_USER_ID]"
let initRequest: LevelPlayInitRequest = LevelPlayInitRequest.builder(appKey)
.withUserId(userId)
.build();
const initListener: LevelPlayInitListener = {
onInitFailed: (error: LevelPlayInitError) => {},
onInitSuccess: (configuration: LevelPlayConfiguration) => {}
}
await LevelPlay.init(initRequest, initListener)
}
`

$3

#### LevelPlayRewardedVideo
`typescript
const SomeComponent: React.FC = () => {
const [rewardedAd, setRewardedAd] = useState(new LevelPlayRewardedAd('YOUR_AD_UNIT_ID'));
const listener: LevelPlayRewardedAdListener = {
// Implement listener methods...
}

useEffect(() => {
rewardedAd.setListener(listener);
}, [rewardedAd]);

const loadAd = async () => {
await rewardedAd.loadAd();
};

const showAd = async () => {
if (await rewardedAd.isAdReady()) {
await rewardedAd.showAd('YOUR_PLACEMENT');
}
};

/// Rest of component, return some view ...
`

#### LevelPlayInterstitial

`typescript
const SomeComponent: React.FC = () => {
const [interstitialAd, setInterstitialAd] = useState(new LevelPlayInterstitialAd('YOUR_AD_UNIT_ID'))
const listener: LevelPlayInterstitialAdListener = {
// Implement listener methods...
}

useEffect(() => {
interstitialAd.setListener(listener);
}, [interstitialAd]);

const loadAd = async () => {
await interstitialAd.loadAd();
};

const showAd = async () => {
if (await interstitialAd.isAdReady()) {
await interstitialAd.showAd('YOUR_PLACEMENT');
}
};

/// Rest of component, return some view ...
`

#### LevelPlayBanner

`typescript
const SomeComponent: React.FC = () => {
// State to manage the reference to the banner ad view
const bannerAdViewRef = useRef(null);
const adSize = LevelPlayAdSize.BANNER
const adUnitId = 'YOUR_AD_UNIT_ID'
const placement = 'YOUR_PLACEMENT'

// LevelPlay Banner Ad View listener
const listener: LevelPlayBannerAdViewListener = {
// Implement listener methods...
}

// Load ad
const loadAd = useCallback(() => {
bannerAdViewRef.current?.loadAd();
}, []);

return (

ref={bannerAdViewRef}
adUnitId={adUnitId}
adSize={adSize}
placementName={placement}
listener={listener}
style={{width: adSize.width, height: adSize.height, alignSelf: 'center'}}
onLayout={(_) => loadAd()}
/>

);
};
`

#### LevelPlayNativeAd
`typescript
export const LevelPlayNativeAdSection = () => {
const [nativeAd, setNativeAd] = useState()

// LevelPlay NativeAd listener
const listener: LevelPlayNativeAdListener = {
// Implement listener methods...
};

useEffect(() => {
const levelPlayNativeAd = LevelPlayNativeAd.builder()
.withPlacement('DefaultNativeAd') // Your placement name string
.withListener(listener) // Your level play native ad listener
.build();
setNativeAd(levelPlayNativeAd);
}, []);

// Load native ad
const loadAd = useCallback(() => {
nativeAd?.loadAd();
}, [nativeAd]);

return (

{nativeAd &&
nativeAd={nativeAd}
templateType={LevelPlayTemplateType.Medium}
style={{ width: 350, height: 300, alignSelf: 'center' }}
onLayout={(_) => loadAd()}
/>
}

);
}
`

Refer to the example app for the more detailed implementation sample.

Note:

- Make sure to read the official documents at LevelPlay Knowledge Center for proper usage.
- Some config functions must be called before LevelPlay.init.

Functions Not Supported

Some functions are not supported.

- initISDemandOnly
- setLanguage
- SegmentListener: onSegmentReceived
- showISDemandOnlyRewardedVideo
- loadISDemandOnlyRewardedVideo
- isISDemandOnlyRewardedVideoAvailable
- loadISDemandOnlyInterstitial
- showISDemandOnlyInterstitial
- isISDemandOnlyInterstitialReady

Mediation

- Many networks require certain additional configuration.
- Make sure to use compatible Adapter versions.

Android

Make sure to follow LevelPlay Knowledge Center document for additional setup.

- Add adapter/sdk dependencies to PROJECT_ROOT/android/app/build.gradle
- Add required settings to PROJECT_ROOT/android/app/src/main/AndroidManifest.xml

iOS

Make sure to follow LevelPlay Knowledge Center document for additional setup.

- Add adapter/sdk pod dependencies to PROJECT_ROOT/ios/Podfile
- Add required settings to PROJECT_ROOT/ios/APP_NAME/info.plist

Example App

Almost all the features are implemented on the example app. We recommend running it first to see how it works.

`shell


The plugin project root

cd unity-levelplay-mediation

Install dependencies

npm install

or

yarn install

The example project

cd example

npm install

or

yarn install

Run the Android app

npm run android

or

yarn run android

Run the iOS app

npm run ios

or

yarn run ios
``

Version history

You can find a summary of the LevelPlay SDK version history here.

Contact US

For any question please contact us here.

License

The license can be viewed here