react-native-ad-manager (Fork of react-native-admob - only supports ad manager)
A react-native module for Google DFP Banners.
Installation
You can use npm or Yarn to install the latest beta version:
Yarn:
yarn add react-native-admob@next
In order to use this library, you have to link it to your project first. There's excellent documentation on how to do this in the React Native Docs.
iOS
For iOS you will have to add the Google Mobile Ads SDK to your Xcode project.
Android
On Android the AdMob library code is part of Play Services, which is automatically added when this library is linked.
Usage
import { PublisherBanner } from 'react-native-ad-manager'
// Display a DFP Publisher banner
<PublisherBanner
adSize="fullBanner"
adUnitID="your-admob-unit-id"
testDevices={[PublisherBanner.simulatorId]}
onAdFailedToLoad={error => console.error(error)}
onAppEvent={event => console.log(event.name, event.info)}
/>
For a full example reference to the example project.
Reference
AdMobBanner
Properties
adSize
Corresponding to iOS framework banner size constants
Value | Description | Availability | Size (WxH) |
---|---|---|---|
banner |
Standard Banner | Phones and Tablets | 320x50 |
largeBanner |
Large Banner | Phones and Tablets | 320x100 |
mediumRectangle |
IAB Medium Rectangle | Phones and Tablets | 300x250 |
fullBanner |
IAB Full-Size Banner | Tablets | 468x60 |
leaderboard |
IAB Leaderboard | Tablets | 728x90 |
smartBannerPortrait smartBannerLandscape
|
Smart Banner | Phones and Tablets | Screen width x 32|50|90 |
Note: There is no smartBannerPortrait
and smartBannerLandscape
on Android. Both prop values will map to smartBanner
onAdLoaded
Accepts a function. Called when an ad is received.
onAdFailedToLoad
Accepts a function. Called when an ad request failed.
onAdOpened
Accepts a function. Called when an ad opens an overlay that covers the screen.
onAdClosed
Accepts a function. Called when the user is about to return to the application after clicking on an ad.
onAdLeftApplication
Accepts a function. Called when a user click will open another app (such as the App Store), backgrounding the current app.
onSizeChange
Accepts a function. Called when the size of the banner changes. The function is called with an object containing the width and the height.
Above names correspond to the Ad lifecycle event callbacks
PublisherBanner
Properties
Same as AdMobBanner
, with the addition of 2 extra properties:
onAppEvent
Accepts a function. Called when DFP sends an event back to the app.
These events may occur at any time during the ad's lifecycle, even before onAdLoaded
is called. The function is called with an object, containing the name of the event and an info property, containing additional information.
More info here: https://developers.google.com/mobile-ads-sdk/docs/dfp/ios/banner#app_events
validAdSizes
An array of ad sizes which may be eligible to be served.