Share your feedback and help shape the Google Mobile Ads SDK roadmap. Take the Google Mobile Ads SDK Annual Survey for 2023 before it closes on May 5th, 2023.

GoogleMobileAds Framework Reference

Stay organized with collections Save and categorize content based on your preferences.

GADCustomEventInterstitial

@protocol GADCustomEventInterstitial <NSObject>

The interstitial custom event protocol. Your interstitial custom event handler must implement this protocol.

  • Inform |delegate| with the custom event execution results to ensure mediation behaves correctly.

    In your class, define the -delegate and -setDelegate: methods or use “@synthesize delegate”. The Google Mobile Ads SDK sets this property on instances of your class.

    Declaration

    Swift

    weak var delegate: GADCustomEventInterstitialDelegate? { get set }

    Objective-C

    @property (nonatomic, weak, nullable) id<GADCustomEventInterstitialDelegate> delegate;
  • Returns an initialized custom event interstitial.

    Declaration

    Swift

    init()

    Objective-C

    - (nonnull instancetype)init;
  • Called by mediation when your custom event is scheduled to be executed. Your implementation should start retrieving the interstitial ad. Report execution results to the delegate. You must wait until -presentFromRootViewController is called before displaying the interstitial ad.

    Declaration

    Swift

    func requestAd(withParameter serverParameter: String?, label serverLabel: String?, request: GADCustomEventRequest)

    Objective-C

    - (void)requestInterstitialAdWithParameter:(nullable NSString *)serverParameter
                                         label:(nullable NSString *)serverLabel
                                       request:
                                           (nonnull GADCustomEventRequest *)request;

    Parameters

    serverParameter

    Parameter configured in the mediation UI.

    serverLabel

    Label configured in the mediation UI.

    request

    Contains ad request information.

  • Present the interstitial ad as a modal view using the provided view controller. Called only after your class calls -customEventInterstitialDidReceiveAd: on its custom event delegate.

    Declaration

    Swift

    func present(fromRootViewController rootViewController: UIViewController)

    Objective-C

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