Banner Ad Positioning (flutter#389)

Author: xtelinco

packages/firebase_admob/README.md

@@ -45,7 +45,8 @@ Ads must be loaded before they're shown.
 ```
 myBanner
   ..load() // typically this happens well before the ad is shown
-  ..show();
+  ..show(anchorOffset: 60.0, anchorType: AnchorType.anchorBottom);
+// Positions the banner ad 60 pixels from the bottom of the screen
 // InterstitialAds are loaded and shown in the same way
 ```
 
@@ -99,8 +100,8 @@ method.
 This is just an initial version of the plugin. There are still some
 limitiations:
 
-- Banner ads always appear at the bottom of the screen. They can't be positioned
-  or animated into view.
+- Banner ads have limited positioning functionality. They can be positioned at the top or the bottom of the screen and at a logical pixel offset from the edge.
+- Banner ads cannot be animated into view.
 - It's not possible to specify a banner ad's size.
 - There's no support for native ads.
 - The existing tests are fairly rudimentary.

packages/firebase_admob/android/src/main/java/io/flutter/plugins/firebaseadmob/FirebaseAdMobPlugin.java

@@ -5,6 +5,7 @@
 package io.flutter.plugins.firebaseadmob;
 
 import android.app.Activity;
+import android.view.Gravity;
 import com.google.android.gms.ads.MobileAds;
 import com.google.firebase.FirebaseApp;
 import io.flutter.plugin.common.MethodCall;
@@ -93,6 +94,13 @@ private void callShowAd(int id, MethodCall call, Result result) {
       result.error("ad_not_loaded", "show failed, the specified ad was not loaded id=" + id, null);
       return;
     }
+    if (call.argument("anchorOffset") != null) {
+      ad.anchorOffset = Double.parseDouble((String) call.argument("anchorOffset"));
+    }
+    if (call.argument("anchorType") != null) {
+      ad.anchorType = call.argument("anchorType").equals("bottom") ? Gravity.BOTTOM : Gravity.TOP;
+    }
+
     ad.show();
     result.success(Boolean.TRUE);
   }

packages/firebase_admob/android/src/main/java/io/flutter/plugins/firebaseadmob/MobileAd.java

@@ -27,6 +27,8 @@ abstract class MobileAd extends AdListener {
   final MethodChannel channel;
   final int id;
   Status status;
+  double anchorOffset;
+  int anchorType;
 
   enum Status {
     CREATED,
@@ -41,6 +43,8 @@ private MobileAd(int id, Activity activity, MethodChannel channel) {
     this.activity = activity;
     this.channel = channel;
     this.status = Status.CREATED;
+    this.anchorOffset = 0.0;
+    this.anchorType = Gravity.BOTTOM;
     allAds.put(id, this);
   }
 
@@ -150,8 +154,15 @@ void show() {
         LinearLayout content = new LinearLayout(activity);
         content.setId(id);
         content.setOrientation(LinearLayout.VERTICAL);
-        content.setGravity(Gravity.BOTTOM);
+        content.setGravity(anchorType);
         content.addView(adView);
+        final float scale = activity.getResources().getDisplayMetrics().density;
+
+        if (anchorType == Gravity.BOTTOM) {
+          content.setPadding(0, 0, 0, (int) (anchorOffset * scale));
+        } else {
+          content.setPadding(0, (int) (anchorOffset * scale), 0, 0);
+        }
 
         activity.addContentView(
             content,

packages/firebase_admob/ios/Classes/FLTMobileAd.h

@@ -19,6 +19,7 @@ typedef enum : NSUInteger {
 - (FLTMobileAdStatus)status;
 - (void)loadWithAdUnitId:(NSString *)adUnitId targetingInfo:(NSDictionary *)targetingInfo;
 - (void)show;
+- (void)showAtOffset:(double)anchorOffset fromAnchor:(int)anchorType;
 - (void)dispose;
 @end
 

packages/firebase_admob/ios/Classes/FLTMobileAd.m

@@ -13,11 +13,15 @@ @implementation FLTMobileAd
 NSNumber *_mobileAdId;
 FlutterMethodChannel *_channel;
 FLTMobileAdStatus _status;
+double _anchorOffset;
+int _anchorType;
 
 + (void)initialize {
   if (allAds == nil) {
     allAds = [[NSMutableDictionary alloc] init];
   }
+  _anchorType = 0;
+  _anchorOffset = 0;
 
   if (statusToString == nil) {
     statusToString = @{
@@ -48,6 +52,8 @@ - (instancetype)initWithId:(NSNumber *)mobileAdId channel:(FlutterMethodChannel
     _mobileAdId = mobileAdId;
     _channel = channel;
     _status = CREATED;
+    _anchorOffset = 0;
+    _anchorType = 0;
     allAds[mobileAdId] = self;
   }
   return self;
@@ -61,6 +67,15 @@ - (void)loadWithAdUnitId:(NSString *)adUnitId targetingInfo:(NSDictionary *)targ
   // Implemented by the Banner and Interstitial subclasses
 }
 
+- (void)showAtOffset:(double)anchorOffset fromAnchor:(int)anchorType {
+  _anchorType = anchorType;
+  _anchorOffset = anchorOffset;
+  if (_anchorType == 0) {
+    _anchorOffset = -_anchorOffset;
+  }
+  [self show];
+}
+
 - (void)show {
   // Implemented by the Banner and Interstitial subclasses
 }
@@ -105,6 +120,7 @@ - (void)show {
     _status = PENDING;
     return;
   }
+
   if (_status != LOADED) return;
 
   _banner.translatesAutoresizingMaskIntoConstraints = NO;
@@ -116,7 +132,9 @@ - (void)show {
     UILayoutGuide *guide = screen.safeAreaLayoutGuide;
     [NSLayoutConstraint activateConstraints:@[
       [_banner.centerXAnchor constraintEqualToAnchor:guide.centerXAnchor],
-      [_banner.bottomAnchor constraintEqualToAnchor:guide.bottomAnchor]
+      [_banner.bottomAnchor
+          constraintEqualToAnchor:_anchorType == 0 ? guide.bottomAnchor : guide.topAnchor
+                         constant:_anchorOffset]
     ]];
   } else {
     [self placeBannerPreIos11];
@@ -129,7 +147,12 @@ - (void)show {
 - (void)placeBannerPreIos11 {
   UIView *screen = [FLTMobileAd rootViewController].view;
   CGFloat x = screen.frame.size.width / 2 - _banner.frame.size.width / 2;
-  CGFloat y = screen.frame.size.height - _banner.frame.size.height;
+  CGFloat y;
+  if (_anchorType == 0) {
+    y = screen.frame.size.height - _banner.frame.size.height + _anchorOffset;
+  } else {
+    y = _anchorOffset;
+  }
   _banner.frame = (CGRect){{x, y}, _banner.frame.size};
   [screen addSubview:_banner];
 }

packages/firebase_admob/ios/Classes/FirebaseAdMobPlugin.m

@@ -122,7 +122,16 @@ - (void)callShowAd:(NSNumber *)mobileAdId
     result([FlutterError errorWithCode:@"ad_not_loaded" message:message details:nil]);
   }
 
-  [ad show];
+  double offset = 0.0;
+  int type = 0;
+  if (call.arguments[@"anchorOffset"] != nil) {
+    offset = [call.arguments[@"anchorOffset"] doubleValue];
+  }
+  if (call.arguments[@"anchorType"] != nil) {
+    type = [call.arguments[@"anchorType"] isEqualToString:@"bottom"] ? 0 : 1;
+  }
+
+  [ad showAtOffset:offset fromAnchor:type];
   result([NSNumber numberWithBool:YES]);
 }
 

packages/firebase_admob/lib/firebase_admob.dart

@@ -82,6 +82,8 @@ class MobileAdTargetingInfo {
   }
 }
 
+enum AnchorType { bottom, top }
+
 /// A mobile [BannerAd] or [InterstitialAd] for the [FirebaseAdMobPlugin].
 ///
 /// A [MobileAd] must be loaded with [load] before it is shown with [show].
@@ -128,8 +130,16 @@ abstract class MobileAd {
   ///
   /// The [listener] will be notified when the ad has finished loading or fails
   /// to do so. An ad that fails to load will not be shown.
-  Future<bool> show() {
-    return _invokeBooleanMethod("showAd", <String, dynamic>{'id': id});
+  ///
+  /// anchorOffset is the logical pixel offset from the edge of the screen (default 0.0)
+  /// anchorType place advert at top or bottom of screen (default bottom)
+  Future<bool> show(
+      {double anchorOffset = 0.0, AnchorType anchorType = AnchorType.bottom}) {
+    return _invokeBooleanMethod("showAd", <String, dynamic>{
+      'id': id,
+      'anchorOffset': anchorOffset.toString(),
+      'anchorType': anchorType == AnchorType.top ? "top" : "bottom"
+    });
   }
 
   /// Free the plugin resources associated with this ad.
@@ -166,8 +176,7 @@ class BannerAd extends MobileAd {
     @required String adUnitId,
     MobileAdTargetingInfo targetingInfo,
     MobileAdListener listener,
-  })
-      : super(
+  }) : super(
             adUnitId: adUnitId,
             targetingInfo: targetingInfo,
             listener: listener);
@@ -192,8 +201,7 @@ class InterstitialAd extends MobileAd {
     String adUnitId,
     MobileAdTargetingInfo targetingInfo,
     MobileAdListener listener,
-  })
-      : super(
+  }) : super(
             adUnitId: adUnitId,
             targetingInfo: targetingInfo,
             listener: listener);

packages/firebase_admob/test/firebase_admob_test.dart

@@ -67,6 +67,8 @@ void main() {
         }),
         isMethodCall('showAd', arguments: <String, dynamic>{
           'id': id,
+          'anchorOffset': '0.0',
+          'anchorType': 'bottom',
         }),
         isMethodCall('disposeAd', arguments: <String, dynamic>{
           'id': id,
@@ -83,7 +85,10 @@ void main() {
       final int id = interstitial.id;
 
       expect(await interstitial.load(), true);
-      expect(await interstitial.show(), true);
+      expect(
+          await interstitial.show(
+              anchorOffset: 60.0, anchorType: AnchorType.top),
+          true);
       expect(await interstitial.dispose(), true);
 
       expect(log, <Matcher>[
@@ -94,6 +99,8 @@ void main() {
         }),
         isMethodCall('showAd', arguments: <String, dynamic>{
           'id': id,
+          'anchorOffset': '60.0',
+          'anchorType': 'top',
         }),
         isMethodCall('disposeAd', arguments: <String, dynamic>{
           'id': id,