Flutter plugin for Google Ad Manager
flutter_google_ad_manager
Flutter plugin for Google Ad Manager(DoubleClick for Publishers).
Getting Started
ios
Add io.flutter.embedded_views_preview in info.plist
<key>io.flutter.embedded_views_preview</key>
<true/>
Follow any additional instructions found here
Google Ad Manager Getting Started Guide
Android
Add com.google.android.gms.ads.AD_MANAGER_APP in AndroidManifest.xml
<manifest>
<application>
<meta-data
android:name="com.google.android.gms.ads.AD_MANAGER_APP"
android:value="true"/>
</application>
</manifest>
Follow any additional instructions found here
Google Ad Manager Getting Started Guide
Banner Ads
Just write the DFPBanner widget in your favorite place.
DFPBanner(
isDevelop: true,
testDevices: MyTestDevices(),
adUnitId: '/XXXXXXXXX/XXXXXXXXX',
adSize: DFPAdSize.BANNER,
onAdLoaded: () {
print('Banner onAdLoaded');
},
onAdFailedToLoad: (errorCode) {
print('Banner onAdFailedToLoad: errorCode:$errorCode');
},
onAdOpened: () {
print('Banner onAdOpened');
},
onAdClosed: () {
print('Banner onAdClosed');
},
onAdLeftApplication: () {
print('Banner onAdLeftApplication');
},
),
Manual Ad Refresh
You can manually refresh the banner ads on user interaction, use the onAdViewCreated callback to save an instance of the DFPBannerViewController and then call the reload() method to refresh the ad.
DFPBannerViewController _bannerViewController;
_reload() {
_bannerViewController?.reload();
}
DFPBanner(
isDevelop: true,
testDevices: MyTestDevices(),
adUnitId: '/XXXXXXXXX/XXXXXXXXX',
adSize: DFPAdSize.BANNER,
onAdViewCreated: (controller) {
_bannerViewController = controller;
},
onAdLoaded: () {
print('Banner onAdLoaded');
},
onAdFailedToLoad: (errorCode) {
print('Banner onAdFailedToLoad: errorCode:$errorCode');
},
onAdOpened: () {
print('Banner onAdOpened');
},
onAdClosed: () {
print('Banner onAdClosed');
},
onAdLeftApplication: () {
print('Banner onAdLeftApplication');
},
),
About testDevices
If you set isDevelop to true, the test adUnitId will be used.
( If set false, the described adUnitId is used.)
Google Ad Manger needs to register testDevices in case of actual devices.
With this plug-in, you can create the following class and set it to testDevices of DFPBanner.
class MyTestDevices extends TestDevices {
static MyTestDevices _instance;
factory MyTestDevices() {
if (_instance == null) _instance = new MyTestDevices._internal();
return _instance;
}
MyTestDevices._internal();
@override
List<String> get values => List()..add("XXXXXXXX"); // Set here.
}
DFPBanner(
testDevices: MyTestDevices(),
)
About adSize
DFPAdSize is available. This is the same size as that of android.
- BANNER
- FULL_BANNER
- LARGE_BANNER
- LEADERBOARD
- MEDIUM_RECTANGLE
- SMART_BANNER (Only Portrait)
Other custom is also available.
const DFPAdSize.custom({double width, double height}).
About EventListener
The following event listeners are available:
- onAdLoaded
- onAdFailedToLoad
- onAdOpened
- onAdClosed
- onAdLeftApplication
Interstitial Ads
Firstly load it and call the show method at the desired timing.
DFPInterstitialAd _interstitialAd;
@override
void initState() {
super.initState();
_interstitialAd = DFPInterstitialAd(
isDevelop: true,
adUnitId: "XXXXXXXX",
onAdLoaded: () {
print('interstitialAd onAdLoaded');
},
onAdFailedToLoad: (errorCode) {
print('interstitialAd onAdFailedToLoad: errorCode:$errorCode');
},
onAdOpened: () {
print('interstitialAd onAdOpened');
},
onAdClosed: () {
print('interstitialAd onAdClosed');
interstitialAd.load();
},
onAdLeftApplication: () {
print('interstitialAd onAdLeftApplication');
},
);
_interstitialAd.load();
}
@override
void dispose() {
_interstitialAd.dispose();
super.dispose();
}
await interstitialAd.show();
About isDevelop
If you set isDevelop to true, the test adUnitId will be used.
( If set false, the described adUnitId is used.)
About EventListener
The following event listeners are available:
- onAdLoaded
- onAdFailedToLoad
- onAdOpened
- onAdClosed
- onAdLeftApplication
Rewarded Ads
firstly load it and call the show method at the desired timing.
DFPRewardedAd _rewardedAd;
LifecycleEventHandler _lifecycle;
@override
void initState() {
super.initState();
_rewardedAd = DFPRewardedAd(
isDevelop: true,
adUnitId: "XXXXXXX",
onAdLoaded: () {
print('rewardedAd onAdLoaded');
},
onAdFailedToLoad: (errorCode) {
print('rewardedAd onAdFailedToLoad: errorCode:$errorCode');
},
onAdOpened: () {
print('rewardedAd onAdOpened');
},
onAdClosed: () {
print('rewardedAd onAdClosed');
_rewardedAd.load();
},
onAdLeftApplication: () {
print('rewardedAd onAdLeftApplication');
},
onRewarded: (String type, int amount) {
print('rewardedAd onRewarded: type:$type amount:$amount');
},
onVideoStarted: () {
print('rewardedAd onVideoStarted');
},
onVideoCompleted: () {
print('rewardedAd onVideoCompleted');
},
);
_rewardedAd.load();
_lifecycle = LifecycleEventHandler(_rewardedAd);
WidgetsBinding.instance.addObserver(_lifecycle);
}
@override
void dispose() {
WidgetsBinding.instance.removeObserver(_lifecycle);
_rewardedAd.dispose();
super.dispose();
}
await _rewardedAd.show();
It is necessary to call it when resumed and paused, respectively.
For that, please implement WidgetsBindingObserver.
class LifecycleEventHandler extends WidgetsBindingObserver {
final DFPRewardedAd rewardedAd;
LifecycleEventHandler(this.rewardedAd);
@override
didChangeAppLifecycleState(AppLifecycleState state) async {
switch (state) {
case AppLifecycleState.inactive:
break;
case AppLifecycleState.paused:
await rewardedAd.pause();
break;
case AppLifecycleState.suspending:
break;
case AppLifecycleState.resumed:
await rewardedAd.resume();
break;
}
}
}
About isDevelop
If you set isDevelop to true, the test adUnitId will be used.
( If set false, the described adUnitId is used.)
About EventListener
The following event listeners are available:
- onAdLoaded
- onAdFailedToLoad
- onAdOpened
- onAdClosed
- onAdLeftApplication
- onRewarded
- onVideoStarted
- onVideoCompleted
Native Ads
Not implemented.
I am glad if someone will give me a pull request.