GoogleMobileAds Framework Reference

  • Globally available functions are provided for managing Google AdMob banner ad sizes in iOS applications.

  • Functions exist for obtaining inline adaptive banner ad sizes for portrait, landscape, and current device orientations, which are suitable for scroll views and allow Google to choose an optimal ad size.

  • Anchored adaptive banner ad size functions are available for portrait, landscape, and current device orientations, providing Google-optimized heights suitable for anchoring near the top or bottom of the app.

  • Custom ad sizes can be created using specific width and height values or by spanning the full width in portrait or landscape orientations with a specified height.

  • Convenience functions are included for comparing, validating, and converting GADAdSize objects, as well as getting a string representation of the version number.

Functions

The following functions are available globally.

Inline Adaptive Sizes

  • Returns a GADAdSize with the given width and the device’s portrait height. This ad size allows Google servers to choose an optimal ad size less than or equal to the returned size. The exact size of the ad returned is passed through the banner’s ad size delegate and is indicated by the banner’s intrinsicContentSize. This ad size is most suitable for ads intended for scroll views.

    Declaration

    Swift

    func portraitInlineAdaptiveBanner(width: CGFloat) -> AdSize

    Objective-C

    extern GADAdSize GADPortraitInlineAdaptiveBannerAdSizeWithWidth(CGFloat width)

  • Returns a GADAdSize with the given width and the device’s landscape height. This ad size allows Google servers to choose an optimal ad size less than or equal to the returned size. The exact size of the ad returned is passed through the banner’s ad size delegate and is indicated by the banner’s intrinsicContentSize. This ad size is most suitable for ads intended for scroll views.

    Declaration

    Swift

    func landscapeInlineAdaptiveBanner(width: CGFloat) -> AdSize

    Objective-C

    extern GADAdSize GADLandscapeInlineAdaptiveBannerAdSizeWithWidth(CGFloat width)

  • Returns a GADAdSize with the given width and the device’s height. This is a convenience function to return GADPortraitInlineAdaptiveBannerAdSizeWithWidth or GADLandscapeInlineAdaptiveBannerAdSizeWithWidth based on the current interface orientation. This function must be called on the main queue.

    Declaration

    Swift

    func currentOrientationInlineAdaptiveBanner(width: CGFloat) -> AdSize

    Objective-C

    extern GADAdSize
GADCurrentOrientationInlineAdaptiveBannerAdSizeWithWidth(CGFloat width)

  • Returns a GADAdSize with the given width and max height. This ad size allows Google servers to choose an optimal ad size less than or equal to the returned size. The exact size of the ad returned is passed through the banner’s ad size delegate and is indicated by the banner’s intrinsicContentSize. This ad size is most suitable for ads intended for scroll views.

    Declaration

    Swift

    func inlineAdaptiveBanner(width: CGFloat, maxHeight: CGFloat) -> AdSize

    Objective-C

    extern GADAdSize
GADInlineAdaptiveBannerAdSizeWithWidthAndMaxHeight(CGFloat width,
                                                   CGFloat maxHeight)

    Parameters

    width

    The ad width.
    maxHeight

    The maximum height a loaded ad will have. Must be at least 32 px, but a max height of 50 px or higher is recommended.

Anchored Adaptive Sizes

  • Returns a GADAdSize with the given width and a Google-optimized height to create a banner ad. The size returned has an aspect ratio similar to that of GADAdSizeBanner, suitable for anchoring near the top or bottom of your app. The height is never larger than 15% of the device’s portrait height and is always between 50-90 points. This function always returns the same height for any width / device combination.

    Declaration

    Swift

    func portraitAnchoredAdaptiveBanner(width: CGFloat) -> AdSize

    Objective-C

    extern GADAdSize GADPortraitAnchoredAdaptiveBannerAdSizeWithWidth(CGFloat width)

  • Returns a GADAdSize with the given width and a Google-optimized height to create a banner ad. The size returned is suitable for use in a banner ad anchored near the top or bottom of your app, similar to use of GADAdSizeBanner. The height is never larger than 15% of the devices’s landscape height and is always between 50-90 points. This function always returns the same height for any width / device combination.

    Declaration

    Swift

    func landscapeAnchoredAdaptiveBanner(width: CGFloat) -> AdSize

    Objective-C

    extern GADAdSize
GADLandscapeAnchoredAdaptiveBannerAdSizeWithWidth(CGFloat width)

  • Returns a GADAdSize with the given width and a Google-optimized height. This is a convenience function to return GADPortraitAnchoredAdaptiveBannerAdSizeWithWidth or GADLandscapeAnchoredAdaptiveBannerAdSizeWithWidth based on the current interface orientation. This function must be called on the main queue.

    Declaration

    Swift

    func currentOrientationAnchoredAdaptiveBanner(width: CGFloat) -> AdSize

    Objective-C

    extern GADAdSize
GADCurrentOrientationAnchoredAdaptiveBannerAdSizeWithWidth(CGFloat width)

Custom Sizes

  • Returns a custom GADAdSize for the provided CGSize. Use this only if you require a non-standard size. Otherwise, use one of the standard size constants above.

    Declaration

    Swift

    func adSizeFor(cgSize size: CGSize) -> AdSize

    Objective-C

    extern GADAdSize GADAdSizeFromCGSize(CGSize size)

  • Returns a custom GADAdSize that spans the full width of the application in portrait orientation with the height provided.

    Declaration

    Swift

    func fullWidthPortrait(height: CGFloat) -> AdSize

    Objective-C

    extern GADAdSize GADAdSizeFullWidthPortraitWithHeight(CGFloat height)

  • Returns a custom GADAdSize that spans the full width of the application in landscape orientation with the height provided.

    Declaration

    Swift

    func fullWidthLandscape(height: CGFloat) -> AdSize

    Objective-C

    extern GADAdSize GADAdSizeFullWidthLandscapeWithHeight(CGFloat height)

Convenience Functions

  • Returns YES if the two GADAdSizes are equal, otherwise returns NO.

    Declaration

    Swift

    func isAdSizeEqualToSize(size1: AdSize, size2: AdSize) -> Bool

    Objective-C

    extern BOOL GADAdSizeEqualToSize(GADAdSize size1, GADAdSize size2)

  • Returns YES if |size| is one of the predefined constants or is a custom GADAdSize generated by GADAdSizeFromCGSize.

    Declaration

    Swift

    func isAdSizeValid(size: AdSize) -> Bool

    Objective-C

    extern BOOL IsGADAdSizeValid(GADAdSize size)

  • Returns YES if |size| is a fluid ad size.

    Declaration

    Swift

    func isAdSizeFluid(size: AdSize) -> Bool

    Objective-C

    extern BOOL GADAdSizeIsFluid(GADAdSize size)

  • Returns a CGSize for the provided a GADAdSize constant. If the GADAdSize is unknown, returns CGSizeZero.

    Declaration

    Swift

    func cgSize(for size: AdSize) -> CGSize

    Objective-C

    extern CGSize CGSizeFromGADAdSize(GADAdSize size)

  • Returns a NSString describing the provided GADAdSize.

    Declaration

    Swift

    func string(for size: AdSize) -> String

    Objective-C

    extern NSString *_Nonnull NSStringFromGADAdSize(GADAdSize size)

  • Returns an NSValue representing the GADAdSize.

    Declaration

    Swift

    func nsValue(for size: AdSize) -> NSValue

    Objective-C

    extern NSValue *_Nonnull NSValueFromGADAdSize(GADAdSize size)

  • Returns a GADAdSize from an NSValue. Returns GADAdSizeInvalid if the value is not a GADAdSize.

    Declaration

    Swift

    func adSizeFor(nsValue value: NSValue) -> AdSize

    Objective-C

    extern GADAdSize GADAdSizeFromNSValue(NSValue *_Nonnull value)

  • Returns the closest valid ad size from possibleAdSizes as compared to |original|. The selected size must be smaller than or equal in size to the original. The selected size must also be within a configurable fraction of the width and height of the original. If no valid size exists, returns GADAdSizeInvalid.

    Declaration

    Swift

    func closestValidSizeForAdSizes(original: AdSize, possibleAdSizes: [NSValue]) -> AdSize

    Objective-C

    extern GADAdSize
GADClosestValidSizeForAdSizes(GADAdSize original,
                              NSArray<NSValue *> *_Nonnull possibleAdSizes)

  • Returns a string representation of the version number.

    Declaration

    Swift

    func string(for version: VersionNumber) -> String

    Objective-C

    NSString *_Nonnull GADGetStringFromVersionNumber(GADVersionNumber version)