GoogleMobileAds Framework Reference

  • GADCustomEventInterstitial is deprecated and should be replaced with GADMediationInterstitialAd and GADMediationAdapter.

  • The protocol defines methods for handling interstitial custom events in mediation, including requesting and presenting the ad.

  • The delegate property is used to inform the mediation layer about the results of custom event execution.

  • Implementations of this protocol are responsible for retrieving and displaying the interstitial ad when instructed.

GADCustomEventInterstitial

Deprecated

Use GADMediationInterstitialAd and GADMediationAdapter instead.

@protocol GADCustomEventInterstitial <NSObject>

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

  • Deprecated

    Use GADMediationInterstitialAd and GADMediationAdapter instead.

    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: (any GADCustomEventInterstitialDelegate)? { get set }

    Objective-C

    @property (nonatomic, weak, nullable) id<GADCustomEventInterstitialDelegate> delegate;

  • Deprecated

    Use GADMediationInterstitialAd and GADMediationAdapter instead.

    Returns an initialized custom event interstitial.

    Declaration

    Swift

    init()

    Objective-C

    - (nonnull instancetype)init;

  • Deprecated

    Use GADMediationInterstitialAd and GADMediationAdapter instead.

    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: CustomEventRequest)

    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.

  • Deprecated

    Use GADMediationInterstitialAd and GADMediationAdapter instead.

    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;