Jump to top

BannerAd

interface

An interface for a Banner advert component.

Example

The BannerAd interface is exposed as a React component, allowing you to integrate ads within your existing React Native code base. The component itself is isolated, meaning any standard View props (e.g. style) are not forwarded on. It is recommended you wrap the BannerAd within your own View if you wish to apply custom props for use-cases such as positioning.

import { BannerAd, BannerAdSize, TestIds } from '@react-native-firebase/admob';

function HomeScreen() {
  return (
    <BannerAd
      unitId={TestIds.BANNER}
      size={BannerAdSize.FULL_BANNER}
      requestOptions={{
        requestNonPersonalizedAdsOnly: true,
      }}
      onAdLoaded={() => {
        console.log('Advert loaded');
      }}
      onAdFailedToLoad={(error) => {
        console.error('Advert failed to load: ', error);
      }}
    />
  );
}

Properties

onAdClosed

</>

Called when the user is about to return to the app after tapping on an ad.

onAdClosed: Function;

onAdFailedToLoad

</>

When an ad has failed to load. Callback contains an Error.

onAdFailedToLoad: Function;

onAdLeftApplication

</>

Called when the user has left the application (e.g. clicking an advert).

onAdLeftApplication: Function;

onAdLoaded

</>

When an ad has finished loading.

onAdLoaded: Function;

onAdOpened

</>

The ad is now visible to the user.

onAdOpened: Function;

requestOptions

</>

The request options for this banner.

requestOptions: RequestOptions;

size

</>

The size of the banner. Can be a predefined size via BannerAdSize or custom dimensions, e.g. 300x200.

size: BannerAdSize | string;

unitId

</>

The AdMob unit ID for the banner.

unitId: string;