GoogleMobileAds Framework Reference

Type-Definitions

The following type definitions are available globally.

  • Undocumented

    Declaration

    Swift

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

    Objective-C

    typedef NSString *GADAdLoaderAdType
  • Ad metadata key type.

    Declaration

    Swift

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

    Objective-C

    typedef NSString *GADAdMetadataKey
  • A block to be executed when the user earns a reward.

    Declaration

    Swift

    typealias GADUserDidEarnRewardHandler = () -> Void

    Objective-C

    typedef void (^GADUserDidEarnRewardHandler)(void)
  • 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
  • Handles ad events that are estimated to have earned money.

    Declaration

    Swift

    typealias GADPaidEventHandler = (GADAdValue) -> Void

    Objective-C

    typedef void (^GADPaidEventHandler)(GADAdValue *_Nonnull)
  • The handler block to execute when the ad load operation completes. On failure, 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)
  • 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)
  • A block to be executed when the ad request operation completes. On success, interstitialAd is non-nil and |error| is nil. On failure, interstitialAd is nil and |error| is non-nil.

    Declaration

    Swift

    typealias GADInterstitialAdBetaLoadCompletionHandler = (GADInterstitialAdBeta?, Error?) -> Void

    Objective-C

    typedef void (^GADInterstitialAdBetaLoadCompletionHandler)(
        GADInterstitialAdBeta *_Nullable, NSError *_Nullable)
  • 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)
  • Completion handler for presenting Ad Inspector. Returns an error if a problem was detected during presentation, or nil otherwise.

    Declaration

    Swift

    typealias GADAdInspectorCompletionHandler = (Error?) -> Void

    Objective-C

    typedef void (^GADAdInspectorCompletionHandler)(NSError *_Nullable)
  • 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)
  • Maximum ad content rating.

    Declaration

    Swift

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

    Objective-C

    typedef NSString *GADMaxAdContentRating
  • 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)
  • A block to be executed when the ad request operation completes. On success, rewardedAd is non-nil and |error| is nil. On failure, rewardedAd is nil and |error| is non-nil.

    Declaration

    Swift

    typealias GADRewardedAdBetaLoadCompletionHandler = (GADRewardedAdBeta?, Error?) -> Void

    Objective-C

    typedef void (^GADRewardedAdBetaLoadCompletionHandler)(
        GADRewardedAdBeta *_Nullable, NSError *_Nullable)
  • A block to be executed when the ad request operation completes. On success, rewardedInterstitialAd is non-nil and |error| is nil. On failure, rewardedInterstitialAd is nil and |error| is non-nil.

    Declaration

    Swift

    typealias GADRewardedInterstitialAdLoadCompletionHandler = (GADRewardedInterstitialAd?, Error?) -> Void

    Objective-C

    typedef void (^GADRewardedInterstitialAdLoadCompletionHandler)(
        GADRewardedInterstitialAd *_Nullable, NSError *_Nullable)
  • Undocumented

    Declaration

    Swift

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

    Objective-C

    typedef NSString *GADUnifiedNativeAssetIdentifier
  • Undocumented

    Declaration

    Swift

    typealias GAMInterstitialAdBetaLoadCompletionHandler = (GAMInterstitialAdBeta?, Error?) -> Void

    Objective-C

    typedef void (^GAMInterstitialAdBetaLoadCompletionHandler)(
        GAMInterstitialAdBeta *_Nullable interstitialAd, NSError *_Nullable error)
  • 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)
  • Called by the adapter after loading the interscroller 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 GADMediationInterscrollerAdLoadCompletionHandler = (GADMediationInterscrollerAd?, Error?) -> GADMediationBannerAdEventDelegate?

    Objective-C

    typedef id<GADMediationBannerAdEventDelegate> _Nullable (
        ^GADMediationInterscrollerAdLoadCompletionHandler)(
        id<GADMediationInterscrollerAd> _Nullable, NSError *_Nullable)
  • 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)
  • 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)
  • 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)
  • Executes when adapter set up completes.

    Declaration

    Swift

    typealias GADMediationAdapterSetUpCompletionBlock = (Error?) -> Void

    Objective-C

    typedef void (^GADMediationAdapterSetUpCompletionBlock)(NSError *_Nullable)
  • Version number information.

    Declaration

    Objective-C

    typedef struct GADVersionNumber GADVersionNumber
  • 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)