A plugin for Flutter that supports loading and displaying banner, interstitial (full-screen), and rewarded video ads using the Firebase AdMob API.
Note: This plugin is in beta, and may still have a few issues and missing APIs. Feedback and Pull Requests are welcome.
The AdMob plugin must be initialized with an AdMob App ID.
FirebaseAdMob.instance.initialize(appId: appId);
Banner and interstitial ads can be configured with target information. And in the example below, the ads are given test ad unit IDs for a quick start.
MobileAdTargetingInfo targetingInfo = new MobileAdTargetingInfo(
keywords: <String>['flutterio', 'beautiful apps'],
contentUrl: 'https://flutter.io',
birthday: new DateTime.now(),
childDirected: false,
designedForFamilies: false,
gender: MobileAdGender.male, // or MobileAdGender.female, MobileAdGender.unknown
testDevices: <String>[], // Android emulators are considered test devices
);
BannerAd myBanner = new BannerAd(
// Replace the testAdUnitId with an ad unit id from the AdMob dash.
// https://developers.google.com/admob/android/test-ads
// https://developers.google.com/admob/ios/test-ads
adUnitId: BannerAd.testAdUnitId,
size: AdSize.smartBanner,
targetingInfo: targetingInfo,
listener: (MobileAdEvent event) {
print("BannerAd event is $event");
},
);
InterstitialAd myInterstitial = new InterstitialAd(
// Replace the testAdUnitId with an ad unit id from the AdMob dash.
// https://developers.google.com/admob/android/test-ads
// https://developers.google.com/admob/ios/test-ads
adUnitId: InterstitialAd.testAdUnitId,
targetingInfo: targetingInfo,
listener: (MobileAdEvent event) {
print("InterstitialAd event is $event");
},
);
Ads must be loaded before they're shown.
myBanner
// typically this happens well before the ad is shown
..load()
..show(
// Positions the banner ad 60 pixels from the bottom of the screen
anchorOffset: 60.0,
// Banner Position
anchorType: AnchorType.bottom,
);
myInterstitial
..load()
..show(
anchorType: AnchorType.bottom,
anchorOffset: 0.0,
);
BannerAd
and InterstitialAd
objects can be disposed to free up plugin
resources. Disposing a banner ad that's been shown removes it from the screen.
Interstitial ads, however, can't be programmatically removed from view.
Banner and interstitial ads can be created with a MobileAdEvent
listener. The
listener can be used to detect when the ad has actually finished loading
(or failed to load at all).
Unlike banners and interstitials, rewarded video ads are loaded one at a time
via a singleton object, RewardedVideoAd.instance
. Its load
method takes an
AdMob ad unit ID and an instance of MobileAdTargetingInfo
:
RewardedVideoAd.instance.load(myAdMobAdUnitId, targetingInfo);
To listen for events in the rewarded video ad lifecycle, apps can define a
function matching the RewardedVideoAdListener
typedef, and assign it to the
listener
instance variable in RewardedVideoAd
. If set, the listener
function will be invoked whenever one of the events in the RewardedVideAdEvent
enum occurs. After a rewarded video ad loads, for example, the
RewardedVideoAdEvent.loaded
is sent. Any time after that, apps can show the ad
by calling show
:
RewardedVideoAd.instance.show();
When the AdMob SDK decides it's time to grant an in-app reward, it does so via
the RewardedVideoAdEvent.rewarded
event:
RewardedVideoAd.instance.listener =
(RewardedVideoAdEvent event, [String rewardType, int rewardAmount]) {
if (event == RewardedVideoAdEvent.rewarded) {
setState(() {
// Here, apps should update state to reflect the reward.
_goldCoins += rewardAmount;
});
}
};
Because RewardedVideoAd
is a singleton object, it does not offer a dispose
method.
This is just an initial version of the plugin. There are still some limitations:
For Flutter plugins for other Firebase products, see FlutterFire.md.
example/lib/main.dart
// Copyright 2017 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
import 'package:flutter/material.dart';
import 'package:firebase_admob/firebase_admob.dart';
// You can also test with your own ad unit IDs by registering your device as a
// test device. Check the logs for your device's ID value.
const String testDevice = 'YOUR_DEVICE_ID';
class MyApp extends StatefulWidget {
@override
_MyAppState createState() => new _MyAppState();
}
class _MyAppState extends State<MyApp> {
static final MobileAdTargetingInfo targetingInfo = new MobileAdTargetingInfo(
testDevices: testDevice != null ? <String>[testDevice] : null,
keywords: <String>['foo', 'bar'],
contentUrl: 'http://foo.com/bar.html',
birthday: new DateTime.now(),
childDirected: true,
gender: MobileAdGender.male,
);
BannerAd _bannerAd;
InterstitialAd _interstitialAd;
int _coins = 0;
BannerAd createBannerAd() {
return new BannerAd(
adUnitId: BannerAd.testAdUnitId,
size: AdSize.banner,
targetingInfo: targetingInfo,
listener: (MobileAdEvent event) {
print("BannerAd event $event");
},
);
}
InterstitialAd createInterstitialAd() {
return new InterstitialAd(
adUnitId: InterstitialAd.testAdUnitId,
targetingInfo: targetingInfo,
listener: (MobileAdEvent event) {
print("InterstitialAd event $event");
},
);
}
@override
void initState() {
super.initState();
FirebaseAdMob.instance.initialize(appId: FirebaseAdMob.testAppId);
_bannerAd = createBannerAd()..load();
RewardedVideoAd.instance.listener =
(RewardedVideoAdEvent event, {String rewardType, int rewardAmount}) {
print("RewardedVideoAd event $event");
if (event == RewardedVideoAdEvent.rewarded) {
setState(() {
_coins += rewardAmount;
});
}
};
}
@override
void dispose() {
_bannerAd?.dispose();
_interstitialAd?.dispose();
super.dispose();
}
@override
Widget build(BuildContext context) {
return new MaterialApp(
home: new Scaffold(
appBar: new AppBar(
title: const Text('AdMob Plugin example app'),
),
body: new SingleChildScrollView(
child: new Center(
child: new Column(
crossAxisAlignment: CrossAxisAlignment.center,
mainAxisSize: MainAxisSize.min,
children: <Widget>[
new RaisedButton(
child: const Text('SHOW BANNER'),
onPressed: () {
_bannerAd ??= createBannerAd();
_bannerAd
..load()
..show();
}),
new RaisedButton(
child: const Text('REMOVE BANNER'),
onPressed: () {
_bannerAd?.dispose();
_bannerAd = null;
}),
new RaisedButton(
child: const Text('LOAD INTERSTITIAL'),
onPressed: () {
_interstitialAd?.dispose();
_interstitialAd = createInterstitialAd()..load();
},
),
new RaisedButton(
child: const Text('SHOW INTERSTITIAL'),
onPressed: () {
_interstitialAd?.show();
},
),
new RaisedButton(
child: const Text('LOAD REWARDED VIDEO'),
onPressed: () {
RewardedVideoAd.instance.load(
adUnitId: RewardedVideoAd.testAdUnitId,
targetingInfo: targetingInfo);
},
),
new RaisedButton(
child: const Text('SHOW REWARDED VIDEO'),
onPressed: () {
RewardedVideoAd.instance.show();
},
),
new Text("You have $_coins coins."),
].map((Widget button) {
return new Padding(
padding: const EdgeInsets.symmetric(vertical: 16.0),
child: button,
);
}).toList(),
),
),
),
),
);
}
}
void main() {
runApp(new MyApp());
}
Add this to your package's pubspec.yaml file:
dependencies:
firebase_admob: ^0.5.4+1
You can install packages from the command line:
with Flutter:
$ flutter packages get
Alternatively, your editor might support flutter packages get
.
Check the docs for your editor to learn more.
Now in your Dart code, you can use:
import 'package:firebase_admob/firebase_admob.dart';
Version | Uploaded | Documentation | Archive |
---|---|---|---|
0.8.0+2 | Feb 15, 2019 |
|
|
0.8.0+1 | Feb 8, 2019 |
|
|
0.8.0 | Jan 25, 2019 |
|
|
0.7.0 | Nov 10, 2018 |
|
|
0.6.1+1 | Oct 12, 2018 |
|
|
0.6.1 | Sep 4, 2018 |
|
|
0.5.7 | Aug 21, 2018 |
|
|
0.5.6 | Jul 23, 2018 |
|
|
0.5.5 | Jun 1, 2018 |
|
|
0.5.4+1 | May 7, 2018 |
|
|
Popularity:
Describes how popular the package is relative to other packages.
[more]
|
97
|
Health:
Code health derived from static analysis.
[more]
|
100
|
Maintenance:
Reflects how tidy and up-to-date the package is.
[more]
|
87
|
Overall:
Weighted score of the above.
[more]
|
96
|
We analyzed this package on Feb 4, 2019, and provided a score, details, and suggestions below. Analysis was completed with status completed using:
Detected platforms: Flutter
References Flutter, and has no conflicting libraries.
The package description is too short. (-13 points)
Add more detail to the description
field of pubspec.yaml
. Use 60 to 180 characters to describe the package, what it does, and its target use case.
Package | Constraint | Resolved | Available |
---|---|---|---|
Direct dependencies | |||
Dart SDK | >=2.0.0-dev.28.0 <3.0.0 | ||
flutter | 0.0.0 | ||
meta | ^1.0.4 | 1.1.6 | 1.1.7 |
platform | ^2.0.0 | 2.2.0 | |
Transitive dependencies | |||
collection | 1.14.11 | ||
sky_engine | 0.0.99 | ||
typed_data | 1.1.6 | ||
vector_math | 2.0.8 | ||
Dev dependencies | |||
flutter_test | |||
mockito | ^2.0.2 |