GoogleMobileAds Framework Reference

GADBannerView

@interface GADBannerView : UIView

A view that displays banner ads. See https://developers.google.com/admob/ios/banner to get started.

Initialization

  • Initializes and returns a banner view with the specified ad size and origin relative to the banner’s superview.

    Declaration

    Swift

    init(adSize: GADAdSize, origin: CGPoint)

    Objective-C

    - (nonnull instancetype)initWithAdSize:(GADAdSize)adSize origin:(CGPoint)origin;

  • Initializes and returns a banner view with the specified ad size placed at its superview’s origin.

    Declaration

    Swift

    init(adSize: GADAdSize)

    Objective-C

    - (nonnull instancetype)initWithAdSize:(GADAdSize)adSize;

Pre-Request

  • Required value created on the AdMob website. Create a new ad unit for every unique placement of an ad in your application. Set this to the ID assigned for this placement. Ad units are important for targeting and statistics.

    Example AdMob ad unit ID: @“ca-app-pub-0123456789012345/0123456789”

    Declaration

    Swift

    var adUnitID: String? { get set }

    Objective-C

    @property (copy, nonatomic, nullable) NSString *adUnitID;

  • Required reference to a root view controller that is used by the banner to present full screen content after the user interacts with the ad. The root view controller is most commonly the view controller displaying the banner.

    Declaration

    Swift

    @IBOutlet weak var rootViewController: UIViewController? { get set }

    Objective-C

    @property (nonatomic, nullable) UIViewController *rootViewController;

  • Required to set this banner view to a proper size. Never create your own GADAdSize directly. Use one of the predefined standard ad sizes (such as kGADAdSizeBanner), or create one using the GADAdSizeFromCGSize method. If not using mediation, then changing the adSize after an ad has been shown will cause a new request (for an ad of the new size) to be sent. If using mediation, then a new request may not be sent.

    Declaration

    Swift

    var adSize: GADAdSize { get set }

    Objective-C

    @property (nonatomic) GADAdSize adSize;

  • Optional delegate object that receives state change notifications from this GADBannerView. Typically this is a UIViewController.

    Declaration

    Swift

    @IBOutlet weak var delegate: GADBannerViewDelegate? { get set }

    Objective-C

    @property (nonatomic, nullable) id<GADBannerViewDelegate> delegate;

  • Optional delegate that is notified when creatives cause the banner to change size.

    Declaration

    Swift

    @IBOutlet weak var adSizeDelegate: GADAdSizeDelegate? { get set }

    Objective-C

    @property (nonatomic, nullable) id<GADAdSizeDelegate> adSizeDelegate;

Making an Ad Request

  • Requests an ad. The request object supplies targeting information.

    Declaration

    Swift

    func load(_ request: GADRequest?)

    Objective-C

    - (void)loadRequest:(nullable GADRequest *)request;

  • A Boolean value that determines whether autoloading of ads in the receiver is enabled. If enabled, you do not need to call the loadRequest: method to load ads.

    Declaration

    Swift

    var isAutoloadEnabled: Bool { get set }

    Objective-C

    @property (getter=isAutoloadEnabled, nonatomic) BOOL autoloadEnabled;

Response

  • Information about the ad response that returned the current ad or an error. Nil until the first ad request succeeds or fails.

    Declaration

    Swift

    var responseInfo: GADResponseInfo? { get }

    Objective-C

    @property (readonly, nonatomic, nullable) GADResponseInfo *responseInfo;

  • Called when ad is estimated to have earned money. Available for whitelisted accounts only.

    Declaration

    Swift

    var paidEventHandler: GADPaidEventHandler? { get set }

    Objective-C

    @property (copy, nonatomic, nullable) GADPaidEventHandler paidEventHandler;

Deprecated

  • Indicates whether the currently displayed ad (or most recent failure) was a result of auto refreshing as specified on server. This property is set to NO after each loadRequest: method.

    Declaration

    Swift

    var hasAutoRefreshed: Bool { get }

    Objective-C

    @property (readonly, nonatomic) BOOL hasAutoRefreshed;

  • Deprecated delegate. GADInAppPurchase is deprecated.

    Declaration

    Swift

    @IBOutlet weak var inAppPurchaseDelegate: GADInAppPurchaseDelegate? { get set }

    Objective-C

    @property (nonatomic, nullable) id<GADInAppPurchaseDelegate> inAppPurchaseDelegate;

  • The mediated ad network’s underlying ad view. You may use this property to read the ad’s actual size and adjust this banner view’s frame origin. However, modifying the banner view’s frame size triggers the Mobile Ads SDK to request a new ad. Only update the banner view’s frame origin.

    Declaration

    Swift

    weak var mediatedAdView: UIView? { get }

    Objective-C

    @property (readonly, nonatomic, nullable) UIView *mediatedAdView;

  • The ad network class name that fetched the current ad. Returns nil while the latest ad request is in progress or if the latest ad request failed. For both standard and mediated Google AdMob ads, this property returns @“GADMAdapterGoogleAdMobAds”. For ads fetched via mediation custom events, this property returns @“GADMAdapterCustomEvents”.

    Declaration

    Swift

    var adNetworkClassName: String? { get }

    Objective-C

    @property (readonly, nonatomic, nullable) NSString *adNetworkClassName;