Skip to content

Latest commit

 

History

History
134 lines (106 loc) · 3.84 KB

README.md

File metadata and controls

134 lines (106 loc) · 3.84 KB
Raw

npm version

react-native-dfp

Unofficial fork from Simon Bugert's react-native-admob, but only implementing Google Mobile Ads' DFP libraries.

Getting started

$ npm install react-native-dfp --save

Mostly automatic installation

$ react-native link react-native-dfp

Manual installation

iOS

  1. In XCode, in the project navigator, right click Libraries ➜ Add Files to [your project's name]
  2. Go to node_modules ➜ react-native-dfp and add RNDfp.xcodeproj
  3. In XCode, in the project navigator, select your project. Add libRNDfp.a to your project's Build Phases ➜ Link Binary With Libraries
  4. Run your project (Cmd+R)<

Android

  1. Open up android/app/src/main/java/[...]/MainActivity.java
  • Add import com.krazylabs.rnnativedfp.RNDfpPackage; to the imports at the top of the file
  • Add new RNDfpPackage() to the list returned by the getPackages() method
  1. Append the following lines to android/settings.gradle: 
    include ':react-native-dfp'
project(':react-native-dfp').projectDir = new File(rootProject.projectDir, 	'../node_modules/react-native-dfp/android')
  2. Insert the following lines inside the dependencies block in android/app/build.gradle: 
      compile project(':react-native-dfp')

Usage

Display a banner

import { RNBanner } from 'react-native-dfp';

// To display a banner
<RNBanner
  style={{ width: 320, height: 50 }}
  onAdViewDidReceiveAd={() => {}}
  onAdViewDidFailToReceiveAd={error => {}}
  onAdViewWillPresentScreen={() => {}}
  onAdViewWillDismissScreen={() => {}}
  onAdViewDidDismissScreen={() => {}}
  onAdViewWillLeaveApplication={() => {}}
  onAdViewEvent={event => {}}
  testDeviceID={testDeviceID}
  adUnitID={adUnitID}
  dimensions={dimensions}
  customTargeting={customTargeting}
  bannerSize={bannerSize}
/>;

Properties:

/**
 * DFP library banner size constants
 * (https://developers.google.com/mobile-ads-sdk/docs/dfp/android/banner#banner_sizes)
 * banner (320x50, Standard Banner for Phones and Tablets)
 * largeBanner (320x100, Large Banner for Phones and Tablets)
 * mediumRectangle (300x250, IAB Medium Rectangle for Phones and Tablets)
 * fullBanner (468x60, IAB Full-Size Banner for Tablets)
 * leaderboard (728x90, IAB Leaderboard for Tablets)
 * smartBannerPortrait (Screen width x 32|50|90, Smart Banner for Phones and Tablets) (default)
 * smartBannerLandscape (Screen width x 32|50|90, Smart Banner for Phones and Tablets)
 *
 * banner is default
 */
bannerSize: React.PropTypes.string,

/**
  * Custom targeting from Amazon APS (a9 TAM) to add to the dfp request
  */
customTargeting: PropTypes.shape({
  amzn_b: PropTypes.string,
  amzn_h: PropTypes.string,
  amznp: PropTypes.string,
  amznslots: PropTypes.string
}),

/**
 * Custom banner size (instead of using bannerSize)
 */
dimensions: PropTypes.shape({
  height: PropTypes.number,
  width: PropTypes.number,
}),

/**
 * DFP ad unit ID
 */
adUnitID: React.PropTypes.string,

/**
 * Test device ID
 */
testDeviceID: React.PropTypes.string,

/**
 * DFP iOS (?) library events
 */
onAdViewDidReceiveAd: PropTypes.func,
onAdViewDidFailToReceiveAd: PropTypes.func,
onAdViewWillPresentScreen: PropTypes.func,
onAdViewWillDismissScreen: PropTypes.func,
onAdViewDidDismissScreen: PropTypes.func,
onAdViewWillLeaveApplication: PropTypes.func,
onAdViewEvent: PropTypes.func,

Display an Interstitial

import { Interstitial } from 'react-native-dfp';

// Initialize your interstitial (usually during start of game.. etc.)
Interstitial.loadAdFromAdUnitId('{adUnitId}');

// Then on your trigger function (e.g. game over page) or desired callback, call this.
Interstitial.showAd();