GoogleMobileAds Framework Reference

Classes

The following classes are available globally.

• DFPBannerView

  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

  Swift

  class DFPBannerView : GADBannerView

  Objective-C

  @interface DFPBannerView : GADBannerView

• DFPBannerViewOptions

  Ad loader options for banner ads.

  Declaration

  Swift

  class DFPBannerViewOptions : GADAdLoaderOptions

  Objective-C

  @interface DFPBannerViewOptions : GADAdLoaderOptions

• DFPInterstitial

  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

  Swift

  class DFPInterstitial : GADInterstitial

  Objective-C

  @interface DFPInterstitial : GADInterstitial

• DFPRequest

  Specifies optional parameters for ad requests.

  Declaration

  Swift

  class DFPRequest : GADRequest

  Objective-C

  @interface DFPRequest : GADRequest

• GADAdChoicesView

  Displays AdChoices content.

  If a GADAdChoicesView is set on GADUnifiedNativeAdView prior to calling -setNativeAd:, AdChoices content will render inside the GADAdChoicesView. By default, AdChoices is placed in the top right corner of GADUnifiedNativeAdView.

  Declaration

  Swift

  class GADAdChoicesView : UIView

  Objective-C

  @interface GADAdChoicesView : UIView

• GADAdLoaderOptions

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

  Declaration

  Swift

  class GADAdLoaderOptions : NSObject

  Objective-C

  @interface GADAdLoaderOptions : NSObject

• GADAdLoader

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

  Declaration

  Swift

  class GADAdLoader : NSObject

  Objective-C

  @interface GADAdLoader : NSObject

• GADAdReward

  Ad reward information.

  Declaration

  Swift

  class GADAdReward : NSObject

  Objective-C

  @interface GADAdReward : NSObject

• GADAdValue

  The monetary value earned from an ad.

  Declaration

  Swift

  class GADAdValue : NSObject, NSCopying

  Objective-C

  @interface GADAdValue : NSObject <NSCopying>

App Open Ad

• GADAppOpenAd

  An app open ad. Used to monetize app load screens.

  Declaration

  Swift

  class GADAppOpenAd : NSObject, GADFullScreenPresentingAd

  Objective-C

  @interface GADAppOpenAd : NSObject <GADFullScreenPresentingAd>

• GADAudioVideoManager

  Provides audio and video notifications and configurations management.

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

  Declaration

  Swift

  class GADAudioVideoManager : NSObject

  Objective-C

  @interface GADAudioVideoManager : NSObject

• GADBannerView

  A view that displays banner ads. See https://developers.google.com/admob/ios/banner to get started.

  Declaration

  Swift

  class GADBannerView : UIView

  Objective-C

  @interface GADBannerView : UIView

• GADCustomEventExtras

  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

  Swift

  class GADCustomEventExtras : NSObject, GADAdNetworkExtras

  Objective-C

  @interface GADCustomEventExtras : NSObject <GADAdNetworkExtras>

• GADCustomEventRequest

  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

  Swift

  class GADCustomEventRequest : NSObject

  Objective-C

  @interface GADCustomEventRequest : NSObject

• GADDebugOptionsViewController

  Displays debug options to the user.

  Declaration

  Swift

  class GADDebugOptionsViewController : UIViewController

  Objective-C

  @interface GADDebugOptionsViewController : UIViewController

• GADDelayedAdRenderingOptions

  Ad loader options for configuring delayed rendering of Google banner ads.

  Declaration

  Swift

  class GADDelayedAdRenderingOptions : GADAdLoaderOptions

  Objective-C

  @interface GADDelayedAdRenderingOptions : GADAdLoaderOptions

• GADDisplayAdMeasurement

  Measurement used for display custom native ad formats.

  Declaration

  Swift

  class GADDisplayAdMeasurement : NSObject

  Objective-C

  @interface GADDisplayAdMeasurement : NSObject

• GADDynamicHeightSearchRequest

  Use to configure Custom Search Ad (CSA) ad requests. A dynamic height search banner can contain multiple ads and the height is set dynamically based on the ad contents. Please cross-reference the property sections and properties with the official reference document: https://developers.google.com/custom-search-ads/docs/reference

  Declaration

  Swift

  class GADDynamicHeightSearchRequest : GADRequest

  Objective-C

  @interface GADDynamicHeightSearchRequest : GADRequest

• GADExtras

  Ad network extras sent to Google networks.

  Declaration

  Swift

  class GADExtras : NSObject, GADAdNetworkExtras

  Objective-C

  @interface GADExtras : NSObject <GADAdNetworkExtras>

Default Purchase Flow

• GADDefaultInAppPurchase

  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

  Swift

  class GADDefaultInAppPurchase : NSObject

  Objective-C

  
  @interface GADDefaultInAppPurchase : NSObject

Custom Purchase Flow

• GADInAppPurchase

  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

  Swift

  class GADInAppPurchase : NSObject

  Objective-C

  
  @interface GADInAppPurchase : NSObject

• GADAdapterStatus

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

  Declaration

  Swift

  class GADAdapterStatus : NSObject, NSCopying

  Objective-C

  @interface GADAdapterStatus : NSObject <NSCopying>

• GADInitializationStatus

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

  Declaration

  Swift

  class GADInitializationStatus : NSObject, NSCopying

  Objective-C

  @interface GADInitializationStatus : NSObject <NSCopying>

• GADInstreamAd

  An instream ad.

  Declaration

  Swift

  class GADInstreamAd : NSObject

  Objective-C

  
  @interface GADInstreamAd : NSObject

• GADInstreamAdView

  A view that displays instream video ads.

  Declaration

  Swift

  class GADInstreamAdView : UIView

  Objective-C

  
  @interface GADInstreamAdView : UIView

• GADInterstitial

  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. See https://developers.google.com/admob/ios/interstitial to get started.

  Declaration

  Swift

  class GADInterstitial : NSObject

  Objective-C

  @interface GADInterstitial : NSObject

• GADInterstitialAdBeta

  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. See https://developers.google.com/admob/ios/interstitial to get started.

  Declaration

  Swift

  class GADInterstitialAdBeta : NSObject, GADFullScreenPresentingAd

  Objective-C

  @interface GADInterstitialAdBeta : NSObject <GADFullScreenPresentingAd>

• GADMediaContent

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

  Declaration

  Swift

  class GADMediaContent : NSObject

  Objective-C

  @interface GADMediaContent : NSObject

• GADMediaView

  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

  Swift

  class GADMediaView : UIView

  Objective-C

  @interface GADMediaView : UIView

• GADMobileAds

  Google Mobile Ads SDK settings.

  Declaration

  Swift

  class GADMobileAds : NSObject

  Objective-C

  @interface GADMobileAds : NSObject

• GADMultipleAdsAdLoaderOptions

  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

  Swift

  class GADMultipleAdsAdLoaderOptions : GADAdLoaderOptions

  Objective-C

  @interface GADMultipleAdsAdLoaderOptions : GADAdLoaderOptions

• GADMuteThisAdReason

  Reason for muting the ad.

  Declaration

  Swift

  class GADMuteThisAdReason : NSObject

  Objective-C

  @interface GADMuteThisAdReason : NSObject

• GADNativeAd

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

  Declaration

  Swift

  class GADNativeAd : NSObject

  Objective-C

  @interface GADNativeAd : NSObject

• GADNativeAdImage

  Native ad image.

  Declaration

  Swift

  class GADNativeAdImage : NSObject

  Objective-C

  @interface GADNativeAdImage : NSObject

• GADNativeAdImageAdLoaderOptions

  Ad loader options for native ad image settings.

  Declaration

  Swift

  class GADNativeAdImageAdLoaderOptions : GADAdLoaderOptions

  Objective-C

  @interface GADNativeAdImageAdLoaderOptions : GADAdLoaderOptions

• GADNativeAdMediaAdLoaderOptions

  Ad loader options for native ad media settings.

  Declaration

  Swift

  class GADNativeAdMediaAdLoaderOptions : GADAdLoaderOptions

  Objective-C

  @interface GADNativeAdMediaAdLoaderOptions : GADAdLoaderOptions

• GADNativeAdViewAdOptions

  Ad loader options for configuring the view of native ads.

  Declaration

  Swift

  class GADNativeAdViewAdOptions : GADAdLoaderOptions

  Objective-C

  @interface GADNativeAdViewAdOptions : GADAdLoaderOptions

• GADNativeCustomTemplateAd

  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

  Swift

  class GADNativeCustomTemplateAd : GADNativeAd

  Objective-C

  @interface GADNativeCustomTemplateAd : GADNativeAd

• GADNativeExpressAdView

  A view that displays native express ads.

  Declaration

  Swift

  class GADNativeExpressAdView : UIView

  Objective-C

  
  @interface GADNativeExpressAdView : UIView

• GADNativeMuteThisAdLoaderOptions

  Mute This Ad options.

  Declaration

  Swift

  class GADNativeMuteThisAdLoaderOptions : GADAdLoaderOptions

  Objective-C

  @interface GADNativeMuteThisAdLoaderOptions : GADAdLoaderOptions

• GADRequest

  Specifies optional parameters for ad requests.

  Declaration

  Swift

  class GADRequest : NSObject, NSCopying

  Objective-C

  @interface GADRequest : NSObject <NSCopying>

• GADRequestConfiguration

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

  Declaration

  Swift

  class GADRequestConfiguration : NSObject

  Objective-C

  @interface GADRequestConfiguration : NSObject

• GADRequestError

  Represents the error generated due to invalid request parameters.

  Declaration

  Swift

  class GADRequestError : NSError

  Objective-C

  @interface GADRequestError : NSError

• GADAdNetworkResponseInfo

  Response metadata for an individual ad network in an ad response.

  Declaration

  Swift

  class GADAdNetworkResponseInfo : NSObject

  Objective-C

  @interface GADAdNetworkResponseInfo : NSObject

• GADResponseInfo

  Information about a response to an ad request.

  Declaration

  Swift

  class GADResponseInfo : NSObject

  Objective-C

  @interface GADResponseInfo : NSObject

• GADRewardBasedVideoAd

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

  Declaration

  Swift

  class GADRewardBasedVideoAd : NSObject

  Objective-C

  
  @interface GADRewardBasedVideoAd : NSObject

• GADRewardedAd

  A rewarded ad. Rewarded ads are ads that users have the option of interacting with in exchange for in-app rewards. See https://developers.google.com/admob/ios/rewarded-ads to get started.

  Declaration

  Swift

  class GADRewardedAd : NSObject

  Objective-C

  @interface GADRewardedAd : NSObject

• GADRewardedAdBeta

  A rewarded ad. Rewarded ads are ads that users have the option of interacting with in exchange for in-app rewards.

  Declaration

  Swift

  class GADRewardedAdBeta : NSObject, GADAdMetadataProvider, GADFullScreenPresentingAd

  Objective-C

  @interface GADRewardedAdBeta
      : NSObject <GADAdMetadataProvider, GADFullScreenPresentingAd>

• GADRewardedInterstitialAd

  A rewarded interstitial ad. Rewarded Interstitial ads are full screen ads that can be presented without user-opt in and allow you to reward the user with in-app items.

  Declaration

  Swift

  class GADRewardedInterstitialAd : NSObject, GADAdMetadataProvider, GADFullScreenPresentingAd

  Objective-C

  @interface GADRewardedInterstitialAd
      : NSObject <GADAdMetadataProvider, GADFullScreenPresentingAd>

• GADSearchBannerView

  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 GADDynamicHeightSearchRequest object to hold the search query and other search data. 3) Call GADSearchBannerView’s -loadRequest: method with the GADDynamicHeightSearchRequest object.

  Declaration

  Swift

  class GADSearchBannerView : GADBannerView

  Objective-C

  @interface GADSearchBannerView : GADBannerView

• GADServerSideVerificationOptions

  Options for server-side verification callbacks for a rewarded ad.

  Declaration

  Swift

  class GADServerSideVerificationOptions : NSObject, NSCopying

  Objective-C

  @interface GADServerSideVerificationOptions : NSObject <NSCopying>

• GADUnifiedNativeAd

  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

  Swift

  class GADUnifiedNativeAd : NSObject

  Objective-C

  @interface GADUnifiedNativeAd : NSObject

Unified Native Ad View

• GADUnifiedNativeAdView

  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

  Swift

  class GADUnifiedNativeAdView : UIView

  Objective-C

  @interface GADUnifiedNativeAdView : UIView

• GADVideoController

  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

  Swift

  class GADVideoController : NSObject

  Objective-C

  @interface GADVideoController : NSObject

• GADVideoOptions

  Video ad options.

  Declaration

  Swift

  class GADVideoOptions : GADAdLoaderOptions

  Objective-C

  @interface GADVideoOptions : GADAdLoaderOptions

• GAMInterstitialAdBeta

  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

  Swift

  class GAMInterstitialAdBeta : GADInterstitialAdBeta

  Objective-C

  @interface GAMInterstitialAdBeta : GADInterstitialAdBeta

• GADMediatedUnifiedNativeAdNotificationSource

  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

  Swift

  class GADMediatedUnifiedNativeAdNotificationSource : NSObject

  Objective-C

  @interface GADMediatedUnifiedNativeAdNotificationSource : NSObject

• GADMediationAdConfiguration

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

  Declaration

  Swift

  class GADMediationAdConfiguration : NSObject

  Objective-C

  @interface GADMediationAdConfiguration : NSObject

• GADMediationBannerAdConfiguration

  Banner ad configuration.

  Declaration

  Swift

  class GADMediationBannerAdConfiguration : GADMediationAdConfiguration

  Objective-C

  @interface GADMediationBannerAdConfiguration : GADMediationAdConfiguration

• GADMediationInterstitialAdConfiguration

  Interstitial ad configuration.

  Declaration

  Swift

  class GADMediationInterstitialAdConfiguration : GADMediationAdConfiguration

  Objective-C

  @interface GADMediationInterstitialAdConfiguration : GADMediationAdConfiguration

• GADMediationNativeAdConfiguration

  Native ad configuration.

  Declaration

  Swift

  class GADMediationNativeAdConfiguration : GADMediationAdConfiguration

  Objective-C

  @interface GADMediationNativeAdConfiguration : GADMediationAdConfiguration

• GADMediationRewardedAdConfiguration

  Rewarded ad configuration.

  Declaration

  Swift

  class GADMediationRewardedAdConfiguration : GADMediationAdConfiguration

  Objective-C

  @interface GADMediationRewardedAdConfiguration : GADMediationAdConfiguration

• GADMediationCredentials

  Mediation configuration set by the publisher on the AdMob UI.

  Declaration

  Swift

  class GADMediationCredentials : NSObject

  Objective-C

  @interface GADMediationCredentials : NSObject

• GADMediationServerConfiguration

  Third party SDK configuration.

  Declaration

  Swift

  class GADMediationServerConfiguration : NSObject

  Objective-C

  @interface GADMediationServerConfiguration : NSObject

• GADRTBMediationSignalsConfiguration

  Mediation configuration for a particular ad request.

  Declaration

  Swift

  class GADRTBMediationSignalsConfiguration : NSObject

  Objective-C

  @interface GADRTBMediationSignalsConfiguration : NSObject

• GADRTBRequestParameters

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

  Declaration

  Swift

  class GADRTBRequestParameters : NSObject

  Objective-C

  @interface GADRTBRequestParameters : NSObject