GoogleMobileAds Framework Reference
Stay organized with collections
Save and categorize content based on your preferences.
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 GADAdChoicesView : UIView
Objective-C
@interface GADAdChoicesView : UIView
-
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
-
Loads ads. See GADAdLoaderAdTypes.h for available ad types.
Declaration
Swift
class GADAdLoader : NSObject
Objective-C
@interface GADAdLoader : NSObject
-
Declaration
Swift
class GADAdReward : NSObject
Objective-C
@interface GADAdReward : NSObject
-
The monetary value earned from an ad.
Declaration
Swift
class GADAdValue : NSObject, NSCopying
Objective-C
@interface GADAdValue : NSObject <NSCopying>
-
An app open ad. Used to monetize app load screens.
-
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
-
Declaration
Swift
class GADBannerView : 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.
-
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
-
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 GADCustomNativeAd : NSObject
Objective-C
@interface GADCustomNativeAd : NSObject
-
Displays debug options to the user.
Declaration
Swift
class GADDebugOptionsViewController : UIViewController
Objective-C
@interface GADDebugOptionsViewController : UIViewController
-
Measurement used for display custom native ad formats.
Declaration
Swift
class GADDisplayAdMeasurement : NSObject
Objective-C
@interface GADDisplayAdMeasurement : NSObject
-
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. 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
-
Ad network extras sent to Google networks.
-
An immutable snapshot of a mediation adapter’s initialization status.
Declaration
Swift
class GADAdapterStatus : 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 GADInitializationStatus : NSObject, NSCopying
Objective-C
@interface GADInitializationStatus : NSObject <NSCopying>
-
-
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
-
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 GADMediaView : UIView
Objective-C
@interface GADMediaView : UIView
-
Google Mobile Ads SDK settings.
Declaration
Swift
class GADMobileAds : 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.
-
Reason for muting the ad.
Declaration
Swift
class GADMuteThisAdReason : 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 GADNativeAd : NSObject
Objective-C
@interface GADNativeAd : NSObject
-
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 GADNativeAdView : 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 GADNativeAdImage : NSObject
Objective-C
@interface GADNativeAdImage : NSObject
-
Ad loader options for native ad image settings.
-
Ad loader options for native ad media settings.
-
Ad loader options for configuring the view of native ads.
-
-
Query info used in requests.
Declaration
Swift
class GADQueryInfo : NSObject
Objective-C
@interface GADQueryInfo : NSObject
-
Specifies optional parameters for ad requests.
Declaration
Swift
class GADRequest : NSObject, NSCopying
Objective-C
@interface GADRequest : NSObject <NSCopying>
-
Request configuration. The settings in this class will apply to all ad requests.
Declaration
Swift
class GADRequestConfiguration : NSObject
Objective-C
@interface GADRequestConfiguration : NSObject
-
Response metadata for an individual ad network in an ad response.
Declaration
Swift
class GADAdNetworkResponseInfo : NSObject
Objective-C
@interface GADAdNetworkResponseInfo : NSObject
-
Information about a response to an ad request.
Declaration
Swift
class GADResponseInfo : 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.
-
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.
-
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.
-
Options for server-side verification callbacks for a rewarded ad.
Declaration
Swift
class GADServerSideVerificationOptions : 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 GADVideoController : NSObject
Objective-C
@interface GADVideoController : NSObject
-
-
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.
-
Ad loader options for banner ads.
-
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.
-
Specifies optional parameters for ad requests.
-
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
-
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
-
App open ad configuration.
-
-
Interstitial ad configuration.
-
-
Rewarded ad configuration.
-
Mediation configuration set by the publisher on the AdMob UI.
Declaration
Swift
class GADMediationCredentials : NSObject
Objective-C
@interface GADMediationCredentials : NSObject
-
Third party SDK configuration.
Declaration
Swift
class GADMediationServerConfiguration : NSObject
Objective-C
@interface GADMediationServerConfiguration : NSObject
-
Mediation configuration for a particular ad request.
Declaration
Swift
class GADRTBMediationSignalsConfiguration : NSObject
Objective-C
@interface GADRTBMediationSignalsConfiguration : NSObject
-
Request parameters provided by the publisher and Google Mobile Ads SDK.
Declaration
Swift
class GADRTBRequestParameters : NSObject
Objective-C
@interface GADRTBRequestParameters : NSObject
Except as otherwise noted, the content of this page is licensed under the
Creative Commons Attribution 4.0 License
, and code samples are licensed under the
Apache 2.0 License
. For details, see the
Google Developers Site Policies
. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2022-11-30 UTC.
[{
"type": "thumb-down",
"id": "missingTheInformationINeed",
"label":"Missing the information I need"
},{
"type": "thumb-down",
"id": "tooComplicatedTooManySteps",
"label":"Too complicated / too many steps"
},{
"type": "thumb-down",
"id": "outOfDate",
"label":"Out of date"
},{
"type": "thumb-down",
"id": "samplesCodeIssue",
"label":"Samples / code issue"
},{
"type": "thumb-down",
"id": "otherDown",
"label":"Other"
}]
[{
"type": "thumb-up",
"id": "easyToUnderstand",
"label":"Easy to understand"
},{
"type": "thumb-up",
"id": "solvedMyProblem",
"label":"Solved my problem"
},{
"type": "thumb-up",
"id": "otherUp",
"label":"Other"
}]