Documentation

SDK36

Admob

Expo includes support for the Google AdMob SDK for mobile advertising, including components for banner ads and imperative APIs for interstitial and rewarded video ads. expo-ads-admob is largely based of the react-native-admob module, as the documentation and questions surrounding that module may prove helpful. A simple example implementing AdMob SDK can be found here.

Platform Compatibility

Android Device	Android Emulator	iOS Device	iOS Simulator	Web
✅	✅	✅	✅	❌

Installation

For managed apps, you'll need to run expo install expo-ads-admob. To use it in a bare React Native app, follow its installation instructions.

Configuration

For the module to attribute interactions with ads to your AdMob app properly you will need to add a googleMobileAdsAppId property to app.json under [platform].config. More info on where to find the app ID can be found in this Google Support answer. A sample valid app.json would look like:

{
  "expo": {
    "name": "Ads Showcase",
    // ...
    "android": {
      // ...
      "config": {
        // ...
        "googleMobileAdsAppId": "ca-app-pub-3940256099942544~3347511713" // sample id, replace with your own
      }
    },
    "ios": {
      // ...
      "config": {
        // ...
        "googleMobileAdsAppId": "ca-app-pub-3940256099942544~1458002511" // sample id, replace with your own
      }
    }
  }
}

Usage

import {
  AdMobBanner,
  AdMobInterstitial,
  PublisherBanner,
  AdMobRewarded
} from 'expo-ads-admob';

// Display a banner
<AdMobBanner
  bannerSize="fullBanner"
  adUnitID="ca-app-pub-3940256099942544/6300978111" // Test ID, Replace with your-admob-unit-id
  testDeviceID="EMULATOR"
  servePersonalizedAds // true or false
  onDidFailToReceiveAdWithError={this.bannerError} />

// Display a DFP Publisher banner
<PublisherBanner
  bannerSize="fullBanner"
  adUnitID="ca-app-pub-3940256099942544/6300978111" // Test ID, Replace with your-admob-unit-id
  testDeviceID="EMULATOR"
  onDidFailToReceiveAdWithError={this.bannerError}
  onAdMobDispatchAppEvent={this.adMobEvent} />

// Display an interstitial
AdMobInterstitial.setAdUnitID('ca-app-pub-3940256099942544/1033173712'); // Test ID, Replace with your-admob-unit-id
AdMobInterstitial.setTestDeviceID('EMULATOR');
await AdMobInterstitial.requestAdAsync({ servePersonalizedAds: true});
await AdMobInterstitial.showAdAsync();

// Display a rewarded ad
AdMobRewarded.setAdUnitID('ca-app-pub-3940256099942544/5224354917'); // Test ID, Replace with your-admob-unit-id
AdMobRewarded.setTestDeviceID('EMULATOR');
await AdMobRewarded.requestAdAsync();
await AdMobRewarded.showAdAsync();

AdMobBanner

servePersonalizedAds property

The default behavior of the Google Mobile Ads SDK is to serve personalized ads. If a user has consented to receive only non-personalized ads, you can configure the view to specify that only non-personalized ads should be requested. Adding servePersonalizedAds property causes non-personalized ads to be requested regardless of whether or not the user is in the EEA. The default is false — ads won't be personalized.

bannerSize property

Corresponding to iOS framework banner size constants

Prop value	Description	Size
`banner`	Standard Banner for Phones and Tablets	320x50
`largeBanner`	Large Banner for Phones and Tablets	320x100
`mediumRectangle`	IAB Medium Rectangle for Phones and Tablets	300x250
`fullBanner`	IAB Full-Size Banner for Tablet	468x60
`leaderboard`	IAB Leaderboard for Tablets	728x90
`smartBannerPortrait`	Smart Banner for Phones and Tablets (default)	Screen width x 32
`smartBannerLandscape`	Smart Banner for Phones and Tablets	Screen width x 32

Note: There is no smartBannerPortrait and smartBannerLandscape on Android. Both prop values will map to smartBanner

Events as function props

Corresponding to Ad lifecycle event callbacks

Prop
`onAdViewDidReceiveAd()`
`onDidFailToReceiveAdWithError(errorDescription: string)`
`onAdViewWillPresentScreen()`
`onAdViewWillDismissScreen()`
`onAdViewDidDismissScreen()`
`onAdViewWillLeaveApplication()`

AdMobInterstitials

Methods

Name	Description
`setAdUnitID(adUnitID)`	sets the AdUnit ID for all future ad requests.
`setTestDeviceID(deviceID)`	sets the test device ID
`requestAdAsync(options)`	requests an interstitial and resolves when `interstitialDidLoad` or `interstitialDidFailToLoad` event fires. An optional `options` object argument may specify `servePersonalizedAds: true` value — then ads will be personalized.
`showAdAsync()`	shows an interstitial if it is ready and resolves when `interstitialDidOpen` event fires
`getIsReadyAsync()`	resolves with boolean whether interstitial is ready to be shown

For simulators/emulators you can use 'EMULATOR' for the test device ID.

Events

Unfortunately, events are not consistent across iOS and Android. To have one unified API, new event names are introduced for pairs that are roughly equivalent.

iOS	this library	Android
`interstitialDidReceiveAd`	`interstitialDidLoad`	`onAdLoaded`
`interstitial:didFailToReceiveAdWithError`	`interstitialDidFailToLoad`	`onAdFailedToLoad`
`interstitialWillPresentScreen`	`interstitialDidOpen`	`onAdOpened`
`interstitialDidFailToPresentScreen`
`interstitialWillDismissScreen`
`interstitialDidDismissScreen`	`interstitialDidClose`	`onAdClosed`
`interstitialWillLeaveApplication`	`interstitialWillLeaveApplication`	`onAdLeftApplication`

Note that interstitialWillLeaveApplication and onAdLeftApplication are not exactly the same but share one event in this library.

AdMobRewarded

Opens a rewarded AdMob ad.

Methods

Name	Description
`setAdUnitID(adUnitID: string)`	sets the AdUnit ID for all future ad requests.
`setTestDeviceID(testDeviceID: string)`	sets the test device ID
`requestAdAsync(options)`	(async) requests a rewarded ad. An optional `options` object argument may specify `servePersonalizedAds: true` value — then ad will be personalized.
`showAdAsync()`	(async) shows a rewarded if it is ready (async)

Events

iOS	this library	Android
`rewardBasedVideoAd:didRewardUserWithReward`	`rewardedVideoDidRewardUser`	`onRewarded`
`rewardBasedVideoAdDidReceiveAd`	`rewardedVideoDidLoad`	`onRewardedVideoAdLoaded`
`rewardBasedVideoAd:didFailToLoadWithError`	`rewardedVideoDidFailToLoad`	`onRewardedVideoAdFailedToLoad`
`rewardBasedVideoAdDidOpen`	`rewardedVideoDidOpen`	`onRewardedVideoAdOpened`
	`rewardedVideoDidComplete`	`onRewardedVideoCompleted`
`rewardBasedVideoAdDidClose`	`rewardedVideoDidClose`	`onRewardedVideoAdClosed`
`rewardBasedVideoAdWillLeaveApplication`	`rewardedVideoWillLeaveApplication`	`onRewardedVideoAdLeftApplication`
`rewardBasedVideoAdDidStartPlaying`	`rewardedVideoDidStart`	`onRewardedVideoStarted`