GoogleMobileAds Framework Reference

  • GADInterstitialAd is a full-screen ad shown at natural transition points in your application.

  • Interstitial ads can be loaded using either an ad unit ID or a server-to-server ad response string.

  • You can check if an interstitial ad can be presented from a given root view controller using canPresentFromRootViewController:error:.

  • Interstitial ads are presented using presentFromRootViewController:.

  • The fullScreenContentDelegate is used for handling full screen content messages related to the ad.

GADInterstitialAd


@interface GADInterstitialAd : NSObject <GADFullScreenPresentingAd>

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.

  • The ad unit ID.

    Declaration

    Swift

    var adUnitID: String { get }

    Objective-C

    @property (nonatomic, readonly, nonnull) NSString *adUnitID;

  • Information about the ad response that returned the ad.

    Declaration

    Swift

    var responseInfo: ResponseInfo { get }

    Objective-C

    @property (nonatomic, readonly, nonnull) GADResponseInfo *responseInfo;

  • Delegate for handling full screen content messages.

    Declaration

    Swift

    weak var fullScreenContentDelegate: (any FullScreenContentDelegate)? { get set }

    Objective-C

    @property (nonatomic, weak, nullable) id<GADFullScreenContentDelegate> fullScreenContentDelegate;

  • Called when the ad is estimated to have earned money. Available for allowlisted accounts only.

    Declaration

    Swift

    var paidEventHandler: GADPaidEventHandler? { get set }

    Objective-C

    @property (nonatomic, copy, nullable) GADPaidEventHandler paidEventHandler;

  • An identifier for a placement in reporting. This property must be set prior to presenting the ad.

    Declaration

    Swift

    var placementID: Int64 { get set }

    Objective-C

    @property (nonatomic) int64_t placementID;

  • Loads an interstitial ad.

    Declaration

    Swift

    class func load(with adUnitID: String, request: Request?) async throws -> InterstitialAd

    Objective-C

    + (void)loadWithAdUnitID:(nonnull NSString *)adUnitID
                 request:(nullable GADRequest *)request
       completionHandler:
           (nonnull GADInterstitialAdLoadCompletionHandler)completionHandler;

    Parameters

    adUnitID

    An ad unit ID created in the AdMob or Ad Manager UI.
    request

    An ad request object. If nil, a default ad request object is used.
    completionHandler

    A handler to execute when the load operation finishes or times out.

  • Loads an interstitial ad.

    Declaration

    Swift

    class func load(with adResponseString: String) async throws -> InterstitialAd

    Objective-C

    + (void)loadWithAdResponseString:(nonnull NSString *)adResponseString
               completionHandler:
                   (nonnull GADInterstitialAdLoadCompletionHandler)
                       completionHandler;

    Parameters

    adResponseString

    A server-to-server ad response string.
    completionHandler

    A handler to execute when the load operation finishes or times out.

  • Indicates whether the interstitial ad can be presented from the provided root view controller. Must be called on the main thread.

    Declaration

    Swift

    @MainActor func canPresent(from rootViewController: UIViewController?) throws

    Objective-C

    - (BOOL)canPresentFromRootViewController:
            (nullable UIViewController *)rootViewController
                                   error:(NSError *_Nullable *_Nullable)error;

    Return Value

    YES if the interstitial ad can be presented from the provided root view controller, NO otherwise.

  • Presents the interstitial ad. Must be called on the main thread.

    Declaration

    Swift

    @MainActor func present(from rootViewController: UIViewController?)

    Objective-C

    - (void)presentFromRootViewController:
    (nullable UIViewController *)rootViewController;

    Parameters

    rootViewController

    A view controller to present the ad. If nil, attempts to present from the top view controller of the application’s main window.