GoogleMobileAds Framework Reference

Constants

The following constants are available globally.

• GADAdLoaderAdTypeCustomNative

  Use with GADAdLoader to request native custom template ads. To receive ads, the ad loader’s delegate must conform to the GADCustomNativeAdLoaderDelegate protocol. See GADCustomNativeAd.h.

  Declaration

  Swift

  static let customNative: GADAdLoaderAdType

  Objective-C

  extern GADAdLoaderAdType _Nonnull const GADAdLoaderAdTypeCustomNative

• GADAdLoaderAdTypeGAMBanner

  Use with GADAdLoader to request Google Ad Manager banner ads. To receive ads, the ad loader’s delegate must conform to the GAMBannerAdLoaderDelegate protocol. See GAMBannerView.h.

  Declaration

  Swift

  static let gamBanner: GADAdLoaderAdType

  Objective-C

  extern GADAdLoaderAdType _Nonnull const GADAdLoaderAdTypeGAMBanner

• GADAdLoaderAdTypeNative

  Use with GADAdLoader to request native ads. To receive ads, the ad loader’s delegate must conform to the GADNativeAdLoaderDelegate protocol. See GADNativeAd.h.

  Declaration

  Swift

  static let native: GADAdLoaderAdType

  Objective-C

  extern GADAdLoaderAdType _Nonnull const GADAdLoaderAdTypeNative

Deprecated

• kGADAdLoaderAdTypeCustomNative

  Use with GADAdLoader to request native custom template ads. To receive ads, the ad loader’s delegate must conform to the GADCustomNativeAdLoaderDelegate protocol. See GADCustomNativeAd.h.

  Declaration

  Swift

  static let kGADAdLoaderAdTypeCustomNative: GADAdLoaderAdType

  Objective-C

  extern DEPRECATED_MSG_ATTRIBUTE("Use GADAdLoaderAdTypeCustomNative instead")
      GADAdLoaderAdType kGADAdLoaderAdTypeCustomNative

• kGADAdLoaderAdTypeGAMBanner

  Use with GADAdLoader to request Google Ad Manager banner ads. To receive ads, the ad loader’s delegate must conform to the GAMBannerAdLoaderDelegate protocol. See GAMBannerView.h.

  Declaration

  Swift

  static let kGADAdLoaderAdTypeGAMBanner: GADAdLoaderAdType

  Objective-C

  extern DEPRECATED_MSG_ATTRIBUTE("Use GADAdLoaderAdTypeGAMBanner instead")
      GADAdLoaderAdType kGADAdLoaderAdTypeGAMBanner

• kGADAdLoaderAdTypeNative

  Use with GADAdLoader to request native ads. To receive ads, the ad loader’s delegate must conform to the GADNativeAdLoaderDelegate protocol. See GADNativeAd.h.

  Declaration

  Swift

  static let kGADAdLoaderAdTypeNative: GADAdLoaderAdType

  Objective-C

  extern DEPRECATED_MSG_ATTRIBUTE("Use GADAdLoaderAdTypeNative instead")
      GADAdLoaderAdType kGADAdLoaderAdTypeNative

Standard Sizes

• GADAdSizeBanner

  iPhone and iPod Touch ad size. Typically 320x50.

  Declaration

  Swift

  let GADAdSizeBanner: GADAdSize

  Objective-C

  extern const GADAdSize GADAdSizeBanner

• GADAdSizeLargeBanner

  Taller version of GADAdSizeBanner. Typically 320x100.

  Declaration

  Swift

  let GADAdSizeLargeBanner: GADAdSize

  Objective-C

  extern const GADAdSize GADAdSizeLargeBanner

• GADAdSizeMediumRectangle

  Medium Rectangle size for the iPad (especially in a UISplitView’s left pane). Typically 300x250.

  Declaration

  Swift

  let GADAdSizeMediumRectangle: GADAdSize

  Objective-C

  extern const GADAdSize GADAdSizeMediumRectangle

• GADAdSizeFullBanner

  Full Banner size for the iPad (especially in a UIPopoverController or in UIModalPresentationFormSheet). Typically 468x60.

  Declaration

  Swift

  let GADAdSizeFullBanner: GADAdSize

  Objective-C

  extern const GADAdSize GADAdSizeFullBanner

• GADAdSizeLeaderboard

  Leaderboard size for the iPad. Typically 728x90.

  Declaration

  Swift

  let GADAdSizeLeaderboard: GADAdSize

  Objective-C

  extern const GADAdSize GADAdSizeLeaderboard

• GADAdSizeSkyscraper

  Skyscraper size for the iPad. Mediation only. AdMob/Google does not offer this size. Typically 120x600.

  Declaration

  Swift

  let GADAdSizeSkyscraper: GADAdSize

  Objective-C

  extern const GADAdSize GADAdSizeSkyscraper

• GADAdSizeFluid

  An ad size that spans the full width of its container, with a height dynamically determined by the ad.

  Declaration

  Swift

  let GADAdSizeFluid: GADAdSize

  Objective-C

  extern const GADAdSize GADAdSizeFluid

• GADAdSizeInvalid

  Invalid ad size marker.

  Declaration

  Swift

  let GADAdSizeInvalid: GADAdSize

  Objective-C

  extern const GADAdSize GADAdSizeInvalid

Deprecated

• kGADAdSizeSmartBannerPortrait

  An ad size that spans the full width of the application in portrait orientation. The height is typically 50 points on an iPhone/iPod UI, and 90 points tall on an iPad UI.

  Declaration

  Swift

  let kGADAdSizeSmartBannerPortrait: GADAdSize

  Objective-C

  extern const GADAdSize kGADAdSizeSmartBannerPortrait

• kGADAdSizeSmartBannerLandscape

  An ad size that spans the full width of the application in landscape orientation. The height is typically 32 points on an iPhone/iPod UI, and 90 points tall on an iPad UI.

  Declaration

  Swift

  let kGADAdSizeSmartBannerLandscape: GADAdSize

  Objective-C

  extern const GADAdSize kGADAdSizeSmartBannerLandscape

• kGADAdSizeBanner

  iPhone and iPod Touch ad size. Typically 320x50.

  Declaration

  Swift

  let kGADAdSizeBanner: GADAdSize

  Objective-C

  extern const GADAdSize kGADAdSizeBanner

• kGADAdSizeLargeBanner

  Taller version of GADAdSizeBanner. Typically 320x100.

  Declaration

  Swift

  let kGADAdSizeLargeBanner: GADAdSize

  Objective-C

  extern const GADAdSize kGADAdSizeLargeBanner

• kGADAdSizeMediumRectangle

  Medium Rectangle size for the iPad (especially in a UISplitView’s left pane). Typically 300x250.

  Declaration

  Swift

  let kGADAdSizeMediumRectangle: GADAdSize

  Objective-C

  extern const GADAdSize kGADAdSizeMediumRectangle

• kGADAdSizeFullBanner

  Full Banner size for the iPad (especially in a UIPopoverController or in UIModalPresentationFormSheet). Typically 468x60.

  Declaration

  Swift

  let kGADAdSizeFullBanner: GADAdSize

  Objective-C

  extern const GADAdSize kGADAdSizeFullBanner

• kGADAdSizeLeaderboard

  Leaderboard size for the iPad. Typically 728x90.

  Declaration

  Swift

  let kGADAdSizeLeaderboard: GADAdSize

  Objective-C

  extern const GADAdSize kGADAdSizeLeaderboard

• kGADAdSizeSkyscraper

  Skyscraper size for the iPad. Mediation only. AdMob/Google does not offer this size. Typically 120x600.

  Declaration

  Swift

  let kGADAdSizeSkyscraper: GADAdSize

  Objective-C

  extern const GADAdSize kGADAdSizeSkyscraper

• kGADAdSizeFluid

  An ad size that spans the full width of its container, with a height dynamically determined by the ad.

  Declaration

  Swift

  let kGADAdSizeFluid: GADAdSize

  Objective-C

  extern const GADAdSize kGADAdSizeFluid

• kGADAdSizeInvalid

  Invalid ad size marker.

  Declaration

  Swift

  let kGADAdSizeInvalid: GADAdSize

  Objective-C

  extern const GADAdSize kGADAdSizeInvalid

• GADCustomEventParametersServer

  Key for getting the server parameter configured in AdMob when mediating to a custom event adapter. Example: NSString *serverParameter = connector.credentials[GADCustomEventParametersServer].

  Declaration

  Swift

  let GADCustomEventParametersServer: String

  Objective-C

  extern NSString *const _Nonnull GADCustomEventParametersServer

• GADCustomNativeAdMediaViewKey

  Asset key for the GADMediaView asset view.

  Declaration

  Swift

  let GADCustomNativeAdMediaViewKey: String

  Objective-C

  extern NSString *const _Nonnull GADCustomNativeAdMediaViewKey

• GADNativeHeadlineAsset

  Undocumented

  Declaration

  Swift

  static let headlineAsset: GADNativeAssetIdentifier

  Objective-C

  GAD_EXTERN GADNativeAssetIdentifier _Nonnull const GADNativeHeadlineAsset

• GADNativeCallToActionAsset

  Undocumented

  Declaration

  Swift

  static let callToActionAsset: GADNativeAssetIdentifier

  Objective-C

  GAD_EXTERN GADNativeAssetIdentifier _Nonnull const GADNativeCallToActionAsset

• GADNativeIconAsset

  Undocumented

  Declaration

  Swift

  static let iconAsset: GADNativeAssetIdentifier

  Objective-C

  GAD_EXTERN GADNativeAssetIdentifier _Nonnull const GADNativeIconAsset

• GADNativeBodyAsset

  Undocumented

  Declaration

  Swift

  static let bodyAsset: GADNativeAssetIdentifier

  Objective-C

  GAD_EXTERN GADNativeAssetIdentifier _Nonnull const GADNativeBodyAsset

• GADNativeStoreAsset

  Undocumented

  Declaration

  Swift

  static let storeAsset: GADNativeAssetIdentifier

  Objective-C

  GAD_EXTERN GADNativeAssetIdentifier _Nonnull const GADNativeStoreAsset

• GADNativePriceAsset

  Undocumented

  Declaration

  Swift

  static let priceAsset: GADNativeAssetIdentifier

  Objective-C

  GAD_EXTERN GADNativeAssetIdentifier _Nonnull const GADNativePriceAsset

• GADNativeImageAsset

  Undocumented

  Declaration

  Swift

  static let imageAsset: GADNativeAssetIdentifier

  Objective-C

  GAD_EXTERN GADNativeAssetIdentifier _Nonnull const GADNativeImageAsset

• GADNativeStarRatingAsset

  Undocumented

  Declaration

  Swift

  static let starRatingAsset: GADNativeAssetIdentifier

  Objective-C

  GAD_EXTERN GADNativeAssetIdentifier _Nonnull const GADNativeStarRatingAsset

• GADNativeAdvertiserAsset

  Undocumented

  Declaration

  Swift

  static let advertiserAsset: GADNativeAssetIdentifier

  Objective-C

  GAD_EXTERN GADNativeAssetIdentifier _Nonnull const GADNativeAdvertiserAsset

• GADNativeMediaViewAsset

  Undocumented

  Declaration

  Swift

  static let mediaViewAsset: GADNativeAssetIdentifier

  Objective-C

  GAD_EXTERN GADNativeAssetIdentifier _Nonnull const GADNativeMediaViewAsset

• GADNativeAdChoicesViewAsset

  Undocumented

  Declaration

  Swift

  static let adChoicesViewAsset: GADNativeAssetIdentifier

  Objective-C

  GAD_EXTERN GADNativeAssetIdentifier _Nonnull const GADNativeAdChoicesViewAsset

• kGADSimulatorID

  Add this constant to the testDevices property’s array to receive test ads on the simulator.

  Declaration

  Swift

  let kGADSimulatorID: String

  Objective-C

  extern GAD_DEPRECATED_MSG_ATTRIBUTE(
      "Use GADRequestConfiguration/GADSimulatorID instead.") NSString *const
      kGADSimulatorID

• GADMaxAdContentRatingGeneral

  Rating for content suitable for general audiences, including families.

  Declaration

  Swift

  static let general: GADMaxAdContentRating

  Objective-C

  extern GADMaxAdContentRating _Nonnull const GADMaxAdContentRatingGeneral

• GADMaxAdContentRatingParentalGuidance

  Rating for content suitable for most audiences with parental guidance.

  Declaration

  Swift

  static let parentalGuidance: GADMaxAdContentRating

  Objective-C

  extern GADMaxAdContentRating _Nonnull const GADMaxAdContentRatingParentalGuidance

• GADMaxAdContentRatingTeen

  Rating for content suitable for teen and older audiences.

  Declaration

  Swift

  static let teen: GADMaxAdContentRating

  Objective-C

  extern GADMaxAdContentRating _Nonnull const GADMaxAdContentRatingTeen

• GADMaxAdContentRatingMatureAudience

  Rating for content suitable only for mature audiences.

  Declaration

  Swift

  static let matureAudience: GADMaxAdContentRating

  Objective-C

  extern GADMaxAdContentRating _Nonnull const GADMaxAdContentRatingMatureAudience

• GADSimulatorID

  Add this constant to the testDevices property’s array to receive test ads on the simulator.

  Declaration

  Swift

  let GADSimulatorID: String

  Objective-C

  extern NSString *const _Nonnull GADSimulatorID

• GADErrorDomain

  Google AdMob Ads error domain.

  Declaration

  Swift

  let GADErrorDomain: String

  Objective-C

  extern NSString *const _Nonnull GADErrorDomain

• GADGoogleAdNetworkClassName

  Ad network class name for ads returned from Google’s ad network.

  Declaration

  Swift

  let GADGoogleAdNetworkClassName: String

  Objective-C

  extern NSString *const _Nonnull GADGoogleAdNetworkClassName

• GADCustomEventAdNetworkClassName

  Ad network class name for custom event ads.

  Declaration

  Swift

  let GADCustomEventAdNetworkClassName: String

  Objective-C

  extern NSString *const _Nonnull GADCustomEventAdNetworkClassName

• GADErrorUserInfoKeyResponseInfo

  Key into NSError.userInfo mapping to a GADResponseInfo object. When ads fail to load, errors returned contain an instance of GADResponseInfo.

  Declaration

  Swift

  let GADErrorUserInfoKeyResponseInfo: String

  Objective-C

  extern NSString *_Nonnull GADErrorUserInfoKeyResponseInfo

• kGAMSimulatorID

  Add this constant to the testDevices property’s array to receive test ads on the simulator.

  Declaration

  Swift

  let kGAMSimulatorID: String

  Objective-C

  extern GAD_DEPRECATED_MSG_ATTRIBUTE(
      "Use GADRequestConfiguration/GADSimulatorID instead.") NSString *const
      kGAMSimulatorID

• GoogleMobileAdsVersionString

  Project version string for GoogleMobileAds.

  Declaration

  Objective-C

  extern const unsigned char GoogleMobileAdsVersionString[]

• GADUnifiedNativeHeadlineAsset

  Undocumented

  Declaration

  Swift

  static let headlineAsset: GADUnifiedNativeAssetIdentifier

  Objective-C

  GAD_EXTERN GADUnifiedNativeAssetIdentifier _Nonnull const GADUnifiedNativeHeadlineAsset

• GADUnifiedNativeCallToActionAsset

  Undocumented

  Declaration

  Swift

  static let callToActionAsset: GADUnifiedNativeAssetIdentifier

  Objective-C

  GAD_EXTERN GADUnifiedNativeAssetIdentifier _Nonnull const GADUnifiedNativeCallToActionAsset

• GADUnifiedNativeIconAsset

  Undocumented

  Declaration

  Swift

  static let iconAsset: GADUnifiedNativeAssetIdentifier

  Objective-C

  GAD_EXTERN GADUnifiedNativeAssetIdentifier _Nonnull const GADUnifiedNativeIconAsset

• GADUnifiedNativeBodyAsset

  Undocumented

  Declaration

  Swift

  static let bodyAsset: GADUnifiedNativeAssetIdentifier

  Objective-C

  GAD_EXTERN GADUnifiedNativeAssetIdentifier _Nonnull const GADUnifiedNativeBodyAsset

• GADUnifiedNativeStoreAsset

  Undocumented

  Declaration

  Swift

  static let storeAsset: GADUnifiedNativeAssetIdentifier

  Objective-C

  GAD_EXTERN GADUnifiedNativeAssetIdentifier _Nonnull const GADUnifiedNativeStoreAsset

• GADUnifiedNativePriceAsset

  Undocumented

  Declaration

  Swift

  static let priceAsset: GADUnifiedNativeAssetIdentifier

  Objective-C

  GAD_EXTERN GADUnifiedNativeAssetIdentifier _Nonnull const GADUnifiedNativePriceAsset

• GADUnifiedNativeImageAsset

  Undocumented

  Declaration

  Swift

  static let imageAsset: GADUnifiedNativeAssetIdentifier

  Objective-C

  GAD_EXTERN GADUnifiedNativeAssetIdentifier _Nonnull const GADUnifiedNativeImageAsset

• GADUnifiedNativeStarRatingAsset

  Undocumented

  Declaration

  Swift

  static let starRatingAsset: GADUnifiedNativeAssetIdentifier

  Objective-C

  GAD_EXTERN GADUnifiedNativeAssetIdentifier _Nonnull const GADUnifiedNativeStarRatingAsset

• GADUnifiedNativeAdvertiserAsset

  Undocumented

  Declaration

  Swift

  static let advertiserAsset: GADUnifiedNativeAssetIdentifier

  Objective-C

  GAD_EXTERN GADUnifiedNativeAssetIdentifier _Nonnull const GADUnifiedNativeAdvertiserAsset

• GADUnifiedNativeMediaViewAsset

  Undocumented

  Declaration

  Swift

  static let mediaViewAsset: GADUnifiedNativeAssetIdentifier

  Objective-C

  GAD_EXTERN GADUnifiedNativeAssetIdentifier _Nonnull const GADUnifiedNativeMediaViewAsset

• GADUnifiedNativeAdChoicesViewAsset

  Undocumented

  Declaration

  Swift

  static let adChoicesViewAsset: GADUnifiedNativeAssetIdentifier

  Objective-C

  GAD_EXTERN GADUnifiedNativeAssetIdentifier _Nonnull const GADUnifiedNativeAdChoicesViewAsset

• kGADErrorDomain

  Google AdMob Ads error domain.

  Declaration

  Swift

  let kGADErrorDomain: String

  Objective-C

  extern DEPRECATED_MSG_ATTRIBUTE("Use GADRequestError/GADErrorDomain instead")
      NSString *const kGADErrorDomain