react-native-yieldlove

Yieldlove SDK for React Native

Installation

Using npm

$ npm install react-native-yieldlove-v2 --save

Using yarn

$ yarn add react-native-yieldlove-v2

Linking

react-native >= 0.60.0

iOS

The package is automatically linked when building the app. All you need to do is:

$ cd ios && pod install

Android

Add maven { url 'https://slabs-yieldlove-ad-integration.s3.eu-central-1.amazonaws.com/android'} do your gradle settings.

react-native <= 0.59.x

iOS & Android

$ react-native link react-native-yieldlove-v2
$ cd ios && pod install

__ IMPORTANT __

If you have issues linking your iOS project check out this StackOverflow thread on how to fix it.

If you don't want to use the methods above, you can always link the library manually.

Usage

import { Yieldlove, YieldloveBannerAd } from 'react-native-yieldlove-v2';

// before using any other method from Yieldlove and/or rendering YieldloveBannerAd you have to set the application name
Yieldlove.setApplicationName(APPLICATION_NAME);

// loading & showing interstitial ad
Yieldlove.loadInterstitial({
  publisherSlotName: PUBLISHER_SLOT_NAME,
  onAdLoaded: () => {
    Yieldlove.showInterstitial().catch(error => console.log(error));
  }
});

// rendering banner ad
<YieldloveBannerAd/>

On iOS if you receive a crash on application start with message The Google Mobile Ads SDK was initialized incorrectly. it means that you probably forgot to add the GADIsAdManagerApp key with a <true/> value to your app's Info.plist.

API

YieldloveBannerAd component API

| Prop | Mandatory | Description | |---|---|---| |onAdInit|false|Event handler function for "onAdInit" event. The event is triggered on starting to load banner ad.| |onAdLoaded|false|Event handler function for "onAdLoaded" event. nativeEvent contains width: number and height: number of the loaded ad.| |onAdFailedToLoad|false|Event handler function for "onAdFailedToLoad" event.nativeEvent contains code: string and message: string describing the error.| |onAdOpened|false|Event handler function for "onAdOpened" event.| |onAdClosed|false|Event handler function for "onAdClosed" event.| |onAdLeftApplication|false|Event handler function for "onAdLeftApplication" event.| |style|false|Style attributes for the view, as expected in a standard View.|

Yieldlove API

setApplicationName: (applicationName: string) => void

Set this at the start of your app to initialize Yieldlove SDK.

setDebug: (isDebugModeEnabled: boolean) => void

Enable debug logs from native libraries.

setCustomTargeting: (customTargeting: CustomTargetingOptions) => void

Set custom targeting.

loadInterstitial: (options: LoadInterstitialOptions) => void

Load interstitial ad. Available options:

| Prop | Mandatory | Description | |---|---|---| |publisherSlotName|true|Valid publisher slot name string.| |onAdInit|false|Callback function for "onAdInit" event. The event is triggered on starting to load banner ad.| |onAdLoaded|false|Callback function for "onAdLoaded" event.| |onAdFailedToLoad|false|Callback function for "onAdFailedToLoad" event. Expects single argument object which contains code: string and message: string describing the error.| |onAdOpened|false|Callback function for "onAdOpened" event.| |onAdClosed|false|Callback function for "onAdClosed" event.| |onAdLeftApplication|false|Callback function for "onAdLeftApplication" event.|

showInterstitial: () => Promise<void>

Present loaded interstitial ad. Can reject with an error if the ad could not be presented (e.g. when trying to call showInterstitial before ad was actually loaded).