GoogleMobileAds Framework Reference

Type-Definitions

The following type definitions are available globally.

• GADAdLoaderAdType

  Undocumented

  Declaration

  Swift

  struct GADAdLoaderAdType : _ObjectiveCBridgeable, Hashable, Equatable, _SwiftNewtypeWrapper, RawRepresentable

  Objective-C

  typedef NSString *GADAdLoaderAdType

• GADAdMetadataKey

  Undocumented

  Declaration

  Swift

  struct GADAdMetadataKey : _ObjectiveCBridgeable, Hashable, Equatable, _SwiftNewtypeWrapper, RawRepresentable

  Objective-C

  typedef NSString *GADAdMetadataKey

• GADAdSize

  A valid GADAdSize is considered to be one of the predefined GADAdSize constants or a GADAdSize constructed by GADAdSizeFromCGSize, GADAdSizeFullWidthPortraitWithHeight, GADAdSizeFullWidthLandscapeWithHeight.

  Do not create a GADAdSize manually. Use one of the kGADAdSize constants. Treat GADAdSize as an opaque type. Do not access any fields directly. To obtain a concrete CGSize, use the function CGSizeFromGADAdSize().

  Declaration

  Objective-C

  typedef struct GADAdSize GADAdSize

App Open Ad

• GADAppOpenAdLoadCompletionHandler

  The handler block to execute when the ad load operation completes. If the load failed, the appOpenAd is nil and the |error| is non-nil. On success, the appOpenAd is non-nil and the |error| is nil.

  Declaration

  Swift

  typealias GADAppOpenAdLoadCompletionHandler = (GADAppOpenAd?, Error?) -> Void

  Objective-C

  typedef void (^GADAppOpenAdLoadCompletionHandler)(GADAppOpenAd *_Nullable,
                                                    NSError *_Nullable)

App Open Ad View

• GADAppOpenAdCloseHandler

  The handler block to execute when the ad is about to be closed.

  Declaration

  Swift

  typealias GADAppOpenAdCloseHandler = () -> Void

  Objective-C

  typedef void (^GADAppOpenAdCloseHandler)(void)

• GADInstreamAdLoadCompletionHandler

  Instream ad load completion handler. On load success, |instreamAd| is the non-nil instream ad and |error| is nil. On load failure, |instreamAd| is nil and |error| provides failure information.

  Declaration

  Swift

  typealias GADInstreamAdLoadCompletionHandler = (GADInstreamAd?, Error?) -> Void

  Objective-C

  typedef void (^GADInstreamAdLoadCompletionHandler)(GADInstreamAd *_Nullable,
                                                     NSError *_Nullable)

• GADInitializationCompletionHandler

  A block called with the initialization status when [GADMobileAds startWithCompletionHandler:] completes or times out.

  Declaration

  Swift

  typealias GADInitializationCompletionHandler = (GADInitializationStatus) -> Void

  Objective-C

  typedef void (^GADInitializationCompletionHandler)(
      GADInitializationStatus *_Nonnull)

• GADNativeAdCustomClickHandler

  Native ad custom click handler block. |assetID| is the ID of asset that has received a click.

  Declaration

  Swift

  typealias GADNativeAdCustomClickHandler = (String) -> Void

  Objective-C

  typedef void (^GADNativeAdCustomClickHandler)(NSString *_Nonnull)

• GADMaxAdContentRating

  Maximum ad content rating.

  Declaration

  Swift

  struct GADMaxAdContentRating : _ObjectiveCBridgeable, Hashable, Equatable, _SwiftNewtypeWrapper, RawRepresentable

  Objective-C

  typedef NSString *GADMaxAdContentRating

• GADRewardedAdLoadCompletionHandler

  A block to be executed when the ad request operation completes. If the load failed, the error object is non-null and provides failure information. On success, |error| is nil.

  Declaration

  Swift

  typealias GADRewardedAdLoadCompletionHandler = (GADRequestError?) -> Void

  Objective-C

  typedef void (^GADRewardedAdLoadCompletionHandler)(GADRequestError *_Nullable)

• GADUnifiedNativeAssetIdentifier

  Undocumented

  Declaration

  Swift

  struct GADUnifiedNativeAssetIdentifier : _ObjectiveCBridgeable, Hashable, Equatable, _SwiftNewtypeWrapper, RawRepresentable

  Objective-C

  typedef NSString *GADUnifiedNativeAssetIdentifier

• GADMediationBannerLoadCompletionHandler

  Called by the adapter after loading the banner ad or encountering an error. Returns an ad event object to send ad events to the Google Mobile Ads SDK. The block returns nil if a delegate couldn’t be created or if the block has already been called.

  Declaration

  Swift

  typealias GADMediationBannerLoadCompletionHandler = (GADMediationBannerAd?, Error?) -> GADMediationBannerAdEventDelegate?

  Objective-C

  typedef id<GADMediationBannerAdEventDelegate> _Nullable (
      ^GADMediationBannerLoadCompletionHandler)(
      id<GADMediationBannerAd> _Nullable, NSError *_Nullable)

• GADMediationInterstitialLoadCompletionHandler

  Called by the adapter after loading the interstitial ad or encountering an error. Returns an ad event delegate to send ad events to the Google Mobile Ads SDK. The block returns nil if a delegate couldn’t be created or if the block has already been called.

  Declaration

  Swift

  typealias GADMediationInterstitialLoadCompletionHandler = (GADMediationInterstitialAd?, Error?) -> GADMediationInterstitialAdEventDelegate?

  Objective-C

  typedef id<GADMediationInterstitialAdEventDelegate> _Nullable (
      ^GADMediationInterstitialLoadCompletionHandler)(
      id<GADMediationInterstitialAd> _Nullable, NSError *_Nullable)

• GADMediationNativeLoadCompletionHandler

  Called by the adapter after loading the native ad or encountering an error. Returns an ad event delegate to send ad events to the Google Mobile Ads SDK. The block returns nil if a delegate couldn’t be created or if the block has already been called.

  Declaration

  Swift

  typealias GADMediationNativeLoadCompletionHandler = (GADMediationNativeAd?, Error?) -> GADMediationNativeAdEventDelegate?

  Objective-C

  typedef id<GADMediationNativeAdEventDelegate> _Nullable (
      ^GADMediationNativeLoadCompletionHandler)(
      id<GADMediationNativeAd> _Nullable, NSError *_Nullable)

• GADMediationRewardedLoadCompletionHandler

  Called by the adapter after loading the rewarded ad or encountering an error. Returns an ad event delegate to send ad events to the Google Mobile Ads SDK. The block returns nil if a delegate couldn’t be created or if the block has already been called.

  Declaration

  Swift

  typealias GADMediationRewardedLoadCompletionHandler = (GADMediationRewardedAd?, Error?) -> GADMediationRewardedAdEventDelegate?

  Objective-C

  typedef id<GADMediationRewardedAdEventDelegate> _Nullable (
      ^GADMediationRewardedLoadCompletionHandler)(
      id<GADMediationRewardedAd> _Nullable, NSError *_Nullable)

• GADMediationAdapterSetUpCompletionBlock

  Executes when adapter set up completes.

  Declaration

  Swift

  typealias GADMediationAdapterSetUpCompletionBlock = (Error?) -> Void

  Objective-C

  typedef void (^GADMediationAdapterSetUpCompletionBlock)(NSError *_Nullable)

• GADVersionNumber

  Undocumented

  Declaration

  Objective-C

  typedef struct GADVersionNumber GADVersionNumber

• GADRTBSignalCompletionHandler

  Completion handler for signal generation. Returns either signals or an error object.

  Declaration

  Swift

  typealias GADRTBSignalCompletionHandler = (String?, Error?) -> Void

  Objective-C

  typedef void (^GADRTBSignalCompletionHandler)(NSString *_Nullable,
                                                NSError *_Nullable)