GoogleMobileAds Framework Reference

  • GADAdChoicesView is used to display AdChoices content within a GADNativeAdView.

  • GADAdLoader is the class used for loading various types of ads.

  • GADAdReward provides information about the reward earned from an ad.

  • GADAppOpenAd is a full-screen ad type for app load screens.

  • GADBannerView is a view designed to display banner ads.

Classes

The following classes are available globally.

  • Displays AdChoices content.

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

    Declaration

    Swift

    class AdChoicesView : UIView

    Objective-C

    
@interface GADAdChoicesView : UIView

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

    Declaration

    Swift

    class AdLoader : NSObject

    Objective-C

    
@interface GADAdLoader : NSObject

  • 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

  • Ad reward information.

    Declaration

    Swift

    class AdReward : NSObject

    Objective-C

    
@interface GADAdReward : NSObject

  • The monetary value earned from an ad.

    Declaration

    Swift

    class AdValue : NSObject, NSCopying

    Objective-C

    
@interface GADAdValue : NSObject <NSCopying>

App Open Ad

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

    Declaration

    Swift

    class AppOpenAd : NSObject, FullScreenPresentingAd

    Objective-C

    
@interface GADAppOpenAd : NSObject <GADFullScreenPresentingAd>

  • 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 AudioVideoManager : NSObject

    Objective-C

    
@interface GADAudioVideoManager : NSObject

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

    Declaration

    Swift

    class BannerView : UIView

    Objective-C

    
@interface GADBannerView : UIView

  • 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 CustomEventExtras : NSObject, AdNetworkExtras

    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

    Swift

    class CustomEventRequest : NSObject

    Objective-C

    
@interface GADCustomEventRequest : NSObject

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

    Declaration

    Swift

    class CustomNativeAd : NSObject

    Objective-C

    
@interface GADCustomNativeAd : NSObject

  • Displays debug options to the user.

    Declaration

    Swift

    class DebugOptionsViewController : UIViewController

    Objective-C

    
@interface GADDebugOptionsViewController : UIViewController

  • Measurement used for display custom native ad formats.

    Declaration

    Swift

    class DisplayAdMeasurement : NSObject

    Objective-C

    
@interface GADDisplayAdMeasurement : NSObject

  • Ad network extras sent to Google networks.

    Declaration

    Swift

    class Extras : NSObject, AdNetworkExtras

    Objective-C

    
@interface GADExtras : NSObject <GADAdNetworkExtras>

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

    Declaration

    Swift

    class AdapterStatus : NSObject, NSCopying

    Objective-C

    
@interface GADAdapterStatus : NSObject <NSCopying>

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

    Declaration

    Swift

    class InitializationStatus : NSObject, NSCopying

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

    Declaration

    Swift

    class InterstitialAd : NSObject, FullScreenPresentingAd

    Objective-C

    
@interface GADInterstitialAd : NSObject <GADFullScreenPresentingAd>

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

    Declaration

    Swift

    class MediaContent : NSObject

    Objective-C

    
@interface GADMediaContent : NSObject

  • Displays native ad media content.

    To display media content in GADNativeAdView 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 MediaView : UIView

    Objective-C

    
@interface GADMediaView : UIView

  • Google Mobile Ads SDK settings.

    Declaration

    Swift

    class MobileAds : NSObject

    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

    Swift

    class MultipleAdsAdLoaderOptions : GADAdLoaderOptions

    Objective-C

    
@interface GADMultipleAdsAdLoaderOptions : GADAdLoaderOptions

  • Reason for muting the ad.

    Declaration

    Swift

    class MuteThisAdReason : NSObject

    Objective-C

    
@interface GADMuteThisAdReason : NSObject

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

    Declaration

    Swift

    class NativeAd : NSObject

    Objective-C

    
@interface GADNativeAd : 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

    Swift

    class NativeAdView : UIView

    Objective-C

    
@interface GADNativeAdView : UIView

  • Ad loader options for custom click gestures. Available for allowlisted publishers only. These options will be ignored for publishers not allowlisted.

    Declaration

    Swift

    class NativeAdCustomClickGestureOptions : GADAdLoaderOptions

    Objective-C

    
@interface GADNativeAdCustomClickGestureOptions : GADAdLoaderOptions

  • Native ad image.

    Declaration

    Swift

    class NativeAdImage : NSObject

    Objective-C

    
@interface GADNativeAdImage : NSObject

  • Ad loader options for native ad image settings.

    Declaration

    Swift

    class NativeAdImageAdLoaderOptions : GADAdLoaderOptions

    Objective-C

    
@interface GADNativeAdImageAdLoaderOptions : GADAdLoaderOptions

  • Ad loader options for native ad media settings.

    Declaration

    Swift

    class NativeAdMediaAdLoaderOptions : GADAdLoaderOptions

    Objective-C

    
@interface GADNativeAdMediaAdLoaderOptions : GADAdLoaderOptions

  • Ad loader options for configuring the view of native ads.

    Declaration

    Swift

    class NativeAdViewAdOptions : GADAdLoaderOptions

    Objective-C

    
@interface GADNativeAdViewAdOptions : GADAdLoaderOptions

  • Mute This Ad options.

    Declaration

    Swift

    class NativeMuteThisAdLoaderOptions : GADAdLoaderOptions

    Objective-C

    
@interface GADNativeMuteThisAdLoaderOptions : GADAdLoaderOptions

  • Query info used in requests.

    Declaration

    Swift

    class QueryInfo : NSObject

    Objective-C

    
@interface GADQueryInfo : NSObject

  • Specifies optional parameters for ad requests.

    Declaration

    Swift

    class Request : NSObject, NSCopying

    Objective-C

    
@interface GADRequest : NSObject <NSCopying>

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

    Declaration

    Swift

    class RequestConfiguration : NSObject

    Objective-C

    
@interface GADRequestConfiguration : NSObject

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

    Declaration

    Swift

    class AdNetworkResponseInfo : NSObject

    Objective-C

    
@interface GADAdNetworkResponseInfo : NSObject

  • Information about a response to an ad request.

    Declaration

    Swift

    class ResponseInfo : NSObject

    Objective-C

    
@interface GADResponseInfo : NSObject

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

    Declaration

    Swift

    class RewardedAd : NSObject, AdMetadataProvider, FullScreenPresentingAd

    Objective-C

    
@interface GADRewardedAd
    : NSObject <GADAdMetadataProvider, GADFullScreenPresentingAd>

  • 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 RewardedInterstitialAd : NSObject, AdMetadataProvider, FullScreenPresentingAd

    Objective-C

    
@interface GADRewardedInterstitialAd
    : NSObject <GADAdMetadataProvider, GADFullScreenPresentingAd>

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

    Declaration

    Swift

    class ServerSideVerificationOptions : NSObject, NSCopying

    Objective-C

    
@interface GADServerSideVerificationOptions : NSObject <NSCopying>

  • 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 VideoController : NSObject

    Objective-C

    
@interface GADVideoController : NSObject

  • Video ad options.

    Declaration

    Swift

    class VideoOptions : GADAdLoaderOptions

    Objective-C

    
@interface GADVideoOptions : GADAdLoaderOptions

  • The view that displays Ad Manager banner ads.

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

    Declaration

    Swift

    class AdManagerBannerView : BannerView

    Objective-C

    
@interface GAMBannerView : GADBannerView

  • Ad loader options for banner ads.

    Declaration

    Swift

    class AdManagerBannerViewOptions : GADAdLoaderOptions

    Objective-C

    
@interface GAMBannerViewOptions : GADAdLoaderOptions

  • 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 AdManagerInterstitialAd : InterstitialAd

    Objective-C

    
@interface GAMInterstitialAd : GADInterstitialAd

  • Specifies optional parameters for ad requests.

    Declaration

    Swift

    class AdManagerRequest : Request

    Objective-C

    
@interface GAMRequest : GADRequest

  • 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 MediatedUnifiedNativeAdNotificationSource : NSObject

    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

    Swift

    class MediationAdConfiguration : NSObject

    Objective-C

    
@interface GADMediationAdConfiguration : NSObject

  • App open ad configuration.

    Declaration

    Swift

    class GADMediationAppOpenAdConfiguration : MediationAdConfiguration

    Objective-C

    @interface GADMediationAppOpenAdConfiguration : GADMediationAdConfiguration

  • Banner ad configuration.

    Declaration

    Swift

    class MediationBannerAdConfiguration : MediationAdConfiguration

    Objective-C

    
@interface GADMediationBannerAdConfiguration : GADMediationAdConfiguration

  • Interstitial ad configuration.

    Declaration

    Swift

    class MediationInterstitialAdConfiguration : MediationAdConfiguration

    Objective-C

    
@interface GADMediationInterstitialAdConfiguration : GADMediationAdConfiguration

  • Native ad configuration.

    Declaration

    Swift

    class MediationNativeAdConfiguration : MediationAdConfiguration

    Objective-C

    
@interface GADMediationNativeAdConfiguration : GADMediationAdConfiguration

  • Rewarded ad configuration.

    Declaration

    Swift

    class MediationRewardedAdConfiguration : MediationAdConfiguration

    Objective-C

    
@interface GADMediationRewardedAdConfiguration : GADMediationAdConfiguration

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

    Declaration

    Swift

    class MediationCredentials : NSObject

    Objective-C

    
@interface GADMediationCredentials : NSObject

  • Third party SDK configuration.

    Declaration

    Swift

    class MediationServerConfiguration : NSObject

    Objective-C

    
@interface GADMediationServerConfiguration : NSObject

  • Mediation configuration for a particular ad request.

    Declaration

    Swift

    class RTBMediationSignalsConfiguration : NSObject

    Objective-C

    
@interface GADRTBMediationSignalsConfiguration : NSObject

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

    Declaration

    Swift

    class RTBRequestParameters : NSObject

    Objective-C

    
@interface GADRTBRequestParameters : NSObject

  • An app open signal request that can be used as input in server-to-server signal generation.

    Declaration

    Swift

    class AppOpenSignalRequest : SignalRequest

    Objective-C

    
@interface GADAppOpenSignalRequest : GADSignalRequest

  • A banner signal request that can be used as input in server-to-server signal generation.

    Declaration

    Swift

    class BannerSignalRequest : SignalRequest

    Objective-C

    
@interface GADBannerSignalRequest : GADSignalRequest

  • An interstitial signal request that can be used as input in server-to-server signal generation.

    Declaration

    Swift

    class InterstitialSignalRequest : SignalRequest

    Objective-C

    
@interface GADInterstitialSignalRequest : GADSignalRequest

  • A native signal request that can be used as input in server-to-server signal generation.

    Declaration

    Swift

    class NativeSignalRequest : SignalRequest

    Objective-C

    
@interface GADNativeSignalRequest : GADSignalRequest

  • A rewarded interstitial signal request that can be used as input in server-to-server signal generation.

    Declaration

    Swift

    class RewardedInterstitialSignalRequest : SignalRequest

    Objective-C

    
@interface GADRewardedInterstitialSignalRequest : GADSignalRequest

  • A rewarded signal request that can be used as input in server-to-server signal generation.

    Declaration

    Swift

    class RewardedSignalRequest : SignalRequest

    Objective-C

    
@interface GADRewardedSignalRequest : GADSignalRequest

  • A signal that can be used as input in a server-to-server ad request.

    Declaration

    Swift

    class Signal : NSObject

    Objective-C

    
@interface GADSignal : NSObject

  • A signal request that can be used as input in server-to-server signal generation.

    Declaration

    Swift

    class SignalRequest : NSObject, NSCopying

    Objective-C

    
@interface GADSignalRequest : NSObject <NSCopying>