react-native-yieldlove v2.6.2

react-native-yieldlove

Yieldlove SDK for React Native (2.6.1)

Change log

2.6.1

• Gravite and Confiant are added as Plugin
• Support Stroeer to Gravite Placements Mapping Table.
• Support Gravite Direct Call
• Added the ad source. (Stroeer / Gravite)
• Disabled the error log for error report requests.

2.5.0

• Backfill feature is not supported.

2.4.2

• Fixed the issue causing the initial advertisement loading to fail.

2.4.1

• Added privacy manifest file for IOS (If you don't want to update library check the appendix part)

2.4.0

• Added a BackFill feature.
• Java version is updated (17)

Installation

Using npm

$ npm install react-native-yieldlove --save

Using yarn

$ yarn add react-native-yieldlove

Configuring

react-native >= 0.73.0

iOS

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

$ cd ios && pod install

If you don't want use Cocoapods, you can always link the library manually.

Android

Add our ad-integration SDK into your app's build.gradle file:

allprojects {
	repositories {
	  ...
		maven { url 'https://slabs-yieldlove-ad-integration.s3.eu-central-1.amazonaws.com/android' }
	}
}

Usage

Contact to your account manager to obtain your application name (APPLICATION_NAME) and call strings (INTERSTITIAL_CALL_STRING and BANNER_CALL_STRING). Each call string represents a single slot.

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

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

// optional global custom targeting
Yieldlove.setCustomTargeting({fruit: 'apple', colour: 'pink'});

// optional global content url
Yieldlove.setContentUrl("https://www.example.com/content/global.html")

// loading & showing interstitial ad
Yieldlove.loadInterstitial({
  callString: INTERSTITIAL_CALL_STRING,
  options: {
    contentUrl: 'https://www.example.com/content/interstitial.html',
    customTargeting: {
      fruit: 'banana',
      day: 'saturday'
    }
  },
  onAdLoaded: (event) => {
    console.log('interstitial onAdLoaded', event);
    Yieldlove.showInterstitial().catch(error => console.log(error));
  },
  onAdFailedToLoad: (event) => {
    console.log('interstitial onAdFailedToLoad', event);
  }
});

// rendering banner ad
// ...
<YieldloveBannerAd
  callString={BANNER_CALL_STRING}
  options={{
    customTargeting: {
      fruit: 'orange',
      day: 'monday'
    },
    contentUrl: 'https://www.example.com/content/banner.html'
  }}
  onAdLoaded={({nativeEvent}) => {
    console.log('banner onAdLoaded', nativeEvent);
    // can use to change the style
    // const { width, height } = nativeEvent;
    // this.setState({ width, height });
  }}
/>

API

YieldloveBannerAd

Yieldlove

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: { [key: string]: string }) => void

Set global (default) custom targeting.

setContentUrl: (contentUrl: string) => void

Set global (default) content URL for targeting purposes.

clearConfigurationCache: () => void

For each application name, extended configuration is downloaded and cached on the user's device for a period of time. This function clears the cache. As a result, the next call to setApplicationName will always download a new copy of the configuration.

loadInterstitial: (options: LoadInterstitialParams, ) => void

Load interstitial ad. Available options:

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).

AdOptions

Error Events

The nativeEvent for the onAdFailedToLoad event handler contains code: number and message: string describing the error. Any error means no ad was delivered and rendered.

See ErrorCode enum to see the current list of supported codes. More may be added in future releases.

ErrorEvent

The nativeEvent implements the following interface:

ErrorCode enum

Use Gravite and Confiant.

For more detailed information, refer to the Development Document Link

Testing ads

Please contact your account manager to get your test configuration.

Troubleshooting

My application crashes on start

The Google Mobile Ads SDK may be initialized without an application ID.

Ad Manager

iOS: Update your Info.plist. Android: Get Started

AdMob

iOS: Update your Info.plist. Android: Get Started