GoogleMobileAds Framework Reference

Classes

The following classes are available globally.

  • The view that displays Ad Manager banner ads.

    To request this ad type using GADAdLoader, you need to pass kGADAdLoaderAdTypeDFPBanner (see GADAdLoaderAdTypes.h) to the |adTypes| parameter in GADAdLoader’s initializer method. If you request this ad type, your delegate must conform to the DFPBannerAdLoaderDelegate protocol.

    Declaration

    Objective-C

    @interface DFPBannerView : GADBannerView

  • Custom rendered ad. Your application renders the ad.

    Declaration

    Objective-C

    @interface DFPCustomRenderedAd : NSObject

  • Google Ad Manager interstitial ad, a full-screen advertisement shown at natural transition points in your application such as between game levels or news stories.

    Declaration

    Objective-C

    @interface DFPInterstitial : GADInterstitial

  • Specifies optional parameters for ad requests.

    Declaration

    Objective-C

    @interface DFPRequest : GADRequest

  • Displays AdChoices content.

    If a GADAdChoicesView is set on GADNativeAppInstallAdView or GADNativeContentAdView prior to calling -setNativeAppInstallAd: or -setNativeContentAd:, AdChoices content will render inside the GADAdChoicesView. By default, AdChoices is placed in the top right corner of GADNativeAppInstallAdView and GADNativeContentAdView.

    Declaration

    Objective-C

    @interface GADAdChoicesView : UIView

  • Ad loader options base class. See each ad type’s header for available GADAdLoaderOptions subclasses.

    Declaration

    Objective-C

    @interface GADAdLoaderOptions : NSObject

  • Loads ads. See GADAdLoaderAdTypes.h for available ad types.

    Declaration

    Objective-C

    @interface GADAdLoader : NSObject

  • Reward information for GADRewardBasedVideoAd ads.

    Declaration

    Objective-C

    @interface GADAdReward : NSObject

  • Provides audio and video notifications and configurations management.

    Don’t create an instance of this class and use the one available from GADMobileAds sharedInstace’s audioVideoManager.

    Declaration

    Objective-C

    @interface GADAudioVideoManager : NSObject

  • The view that displays banner ads. A minimum implementation to get an ad from within a UIViewController class is:

      // Create and setup the ad view, specifying the size and origin at {0, 0}.
  GADBannerView *adView = [[GADBannerView alloc] initWithAdSize:kGADAdSizeBanner];
  adView.rootViewController = self;
  adView.adUnitID = @ID created when registering your app;
  // Place the ad view onto the screen.
  [self.view addSubview:adView];
  // Request an ad without any additional targeting information.
  [adView loadRequest:[GADRequest request]];

    Declaration

    Objective-C

    @interface GADBannerView : UIView

  • Represents a correlation between multiple ads. Set an instance of this object on multiple ads to indicate they are being used in a common context.

    Declaration

    Objective-C

    @interface GADCorrelator : NSObject

  • Create an instance of this class to set additional parameters for each custom event object. The additional parameters for a custom event are keyed by the custom event label. These extras are passed to your implementation of GADCustomEventBanner or GADCustomEventInterstitial.

    Declaration

    Objective-C

    @interface GADCustomEventExtras : NSObject <GADAdNetworkExtras>

  • Specifies optional ad request targeting parameters that are provided by the publisher and are forwarded to custom events for purposes of populating an ad request to a 3rd party ad network.

    Declaration

    Objective-C

    @interface GADCustomEventRequest : NSObject

  • Displays debug options to the user.

    Declaration

    Objective-C

    @interface GADDebugOptionsViewController : UIViewController

Default Purchase Flow

  • The consumable in-app purchase item that has been purchased by the user. The purchase flow is handled by the Google Mobile Ads SDK. Instances of this class are created and passed to your in-app purchase delegate after the user has successfully paid for a product. Your code must correctly deliver the product to the user and then call the didCompletePurchase method to finish the transaction.

    Declaration

    Objective-C

    
@interface GADDefaultInAppPurchase : NSObject

Custom Purchase Flow

  • The in-app purchase item to be purchased with the purchase flow handled by you, the application developer. Instances of this class are created and passed to your GADInAppPurchaseDelegate object when users click a buy button. It is important to report the result of the purchase back to the SDK in order to track metrics about the transaction.

    Declaration

    Objective-C

    
@interface GADInAppPurchase : NSObject

  • An immutable snapshot of a mediation adapter’s initialization status.

    Declaration

    Objective-C

    @interface GADAdapterStatus : NSObject <NSCopying>

  • An immutable snapshot of the Google Mobile Ads SDK’s initialization status, categorized by mediation adapter.

    Declaration

    Objective-C

    @interface GADInitializationStatus : NSObject <NSCopying>

  • An interstitial ad. This is a full-screen advertisement shown at natural transition points in your application such as between game levels or news stories.

    Declaration

    Objective-C

    @interface GADInterstitial : NSObject

  • Provides media content information. Interact with instances of this class on the main queue only.

    Declaration

    Objective-C

    @interface GADMediaContent : NSObject

  • Displays native ad media content.

    To display media content in GADUnifiedNativeAdView instances, add a GADMediaView subview, assign the native ad view’s mediaView property, and set the native ad’s mediaContent property to the media view.

    If the native ad contains video content, the media view displays the video content.

    If the native ad doesn’t have video content and image loading is enabled, the media view displays the first image from the native ad’s |images| property.

    If the native ad doesn’t have video content and image loading is disabled, the media view is empty.

    Declaration

    Objective-C

    @interface GADMediaView : UIView

  • Google Mobile Ads SDK settings.

    Declaration

    Objective-C

    @interface GADMobileAds : NSObject

  • Ad loader options for requesting multiple ads. Requesting multiple ads in a single request is currently only available for native app install ads and native content ads.

    Declaration

    Objective-C

    @interface GADMultipleAdsAdLoaderOptions : GADAdLoaderOptions

  • Reason for muting the ad.

    Declaration

    Objective-C

    @interface GADMuteThisAdReason : NSObject

  • Native ad base class. All native ad types are subclasses of this class.

    Declaration

    Objective-C

    @interface GADNativeAd : NSObject

  • Native ad image.

    Declaration

    Objective-C

    @interface GADNativeAdImage : NSObject

  • Native app install ad. To request this ad type, you need to pass kGADAdLoaderAdTypeNativeAppInstall (see GADAdLoaderAdTypes.h) to the |adTypes| parameter in GADAdLoader’s initializer method. If you request this ad type, your delegate must conform to the GADNativeAppInstallAdLoaderDelegate protocol.

    Declaration

    Objective-C

    
@interface GADNativeAppInstallAd : GADNativeAd

Native App Install Ad View

  • Base class for app install ad views. Your app install ad view must be a subclass of this class and must call superclass methods for all overriden methods.

    Declaration

    Objective-C

    
@interface GADNativeAppInstallAdView : UIView

Native Content Ad Assets

  • Native content ad. To request this ad type, you need to pass kGADAdLoaderAdTypeNativeContent (see GADAdLoaderAdTypes.h) to the |adTypes| parameter in GADAdLoader’s initializer method. If you request this ad type, your delegate must conform to the GADNativeContentAdLoaderDelegate protocol.

    Declaration

    Objective-C

    
@interface GADNativeContentAd : GADNativeAd

Native Content Ad View

  • Base class for content ad views. Your content ad view must be a subclass of this class and must call superclass methods for all overriden methods.

    Declaration

    Objective-C

    
@interface GADNativeContentAdView : UIView

  • Native custom template ad. To request this ad type, you need to pass kGADAdLoaderAdTypeNativeCustomTemplate (see GADAdLoaderAdTypes.h) to the |adTypes| parameter in GADAdLoader’s initializer method. If you request this ad type, your delegate must conform to the GADNativeCustomTemplateAdLoaderDelegate protocol.

    Declaration

    Objective-C

    @interface GADNativeCustomTemplateAd : GADNativeAd

  • The view that displays native ads. A minimum implementation to get an ad from within a UIViewController class is:

      // Create and setup the ad view, specifying the size and origin at {0, 0}.
  GADNativeExpressAdView *adView =
      [[GADNativeExpressAdView alloc] initWithAdSize:kGADAdSizeBanner];
  adView.rootViewController = self;
  adView.adUnitID = @ID created when registering your app;
  // Place the ad view onto the screen.
  [self.view addSubview:adView];
  // Request an ad without any additional targeting information.
  [adView loadRequest:[GADRequest request]];

    Declaration

    Objective-C

    
@interface GADNativeExpressAdView : UIView

  • Specifies optional parameters for ad requests.

    Declaration

    Objective-C

    @interface GADRequest : NSObject <NSCopying>

  • Request configuration. The settings in this class will apply to all ad requests.

    Declaration

    Objective-C

    @interface GADRequestConfiguration : NSObject

  • Represents the error generated due to invalid request parameters.

    Declaration

    Objective-C

    @interface GADRequestError : NSError

  • The GADRewardBasedVideoAd class is used for requesting and presenting a reward based video ad. This class isn’t thread safe.

    Declaration

    Objective-C

    @interface GADRewardBasedVideoAd : NSObject

  • The GADRewardedAd class is used for requesting and presenting a rewarded ad.

    Declaration

    Objective-C

    @interface GADRewardedAd : NSObject

  • A view that displays search ads. To show search ads: 1) Create a GADSearchBannerView and add it to your view controller’s view hierarchy. 2) Create a GADSearchRequest ad request object to hold the search query and other search data. 3) Call GADSearchBannerView’s -loadRequest: method with the GADSearchRequest object.

    Declaration

    Objective-C

    @interface GADSearchBannerView : GADBannerView

  • Options for server-to-server verification callbacks for a rewarded ad.

    Declaration

    Objective-C

    @interface GADServerSideVerificationOptions : NSObject <NSCopying>

  • Unified native ad. To request this ad type, pass kGADAdLoaderAdTypeUnifiedNative (see GADAdLoaderAdTypes.h) to the |adTypes| parameter in GADAdLoader’s initializer method. If you request this ad type, your delegate must conform to the GADUnifiedNativeAdLoaderDelegate protocol.

    Declaration

    Objective-C

    @interface GADUnifiedNativeAd : NSObject

Unified Native Ad View

  • Base class for native ad views. Your native ad view must be a subclass of this class and must call superclass methods for all overridden methods.

    Declaration

    Objective-C

    @interface GADUnifiedNativeAdView : UIView

  • The video controller class provides a way to get the video metadata and also manages video content of the ad rendered by the Google Mobile Ads SDK. You don’t need to create an instance of this class. When the ad rendered by the Google Mobile Ads SDK loads video content, you may be able to get an instance of this class from the rendered ad object.

    Declaration

    Objective-C

    @interface GADVideoController : NSObject

  • Notifies the Google Mobile Ads SDK about the events performed by adapters. Adapters may perform some action (e.g. opening an in app browser or opening the iTunes store) when handling callbacks from GADMediatedNativeAdDelegate. Adapters in such case should notify the Google Mobile Ads SDK by calling the relevant methods from this class.

    Declaration

    Objective-C

    @interface GADMediatedNativeAdNotificationSource : NSObject

  • Notifies the Google Mobile Ads SDK about the events performed by adapters. Adapters may perform some action (e.g. opening an in app browser or opening the iTunes store) when handling methods in GADMediatedUnifiedNativeAd. Adapters in such case should notify the Google Mobile Ads SDK by calling the relevant methods from this class.

    Declaration

    Objective-C

    @interface GADMediatedUnifiedNativeAdNotificationSource : NSObject

  • Provided by the Google Mobile Ads SDK for the adapter to render the ad. Contains 3PAS and other ad configuration information.

    Declaration

    Objective-C

    @interface GADMediationAdConfiguration : NSObject

  • Mediation configuration set by the publisher on the AdMob UI.

    Declaration

    Objective-C

    @interface GADMediationCredentials : NSObject

  • Third party SDK configuration.

    Declaration

    Objective-C

    @interface GADMediationServerConfiguration : NSObject

  • Request parameters provided by the publisher and Google Mobile Ads SDK.

    Declaration

    Objective-C

    @interface GADRTBRequestParameters : NSObject