GoogleMobileAds Framework Reference

GADRewardedInterstitialAd

@interface GADRewardedInterstitialAd
    : 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.

• adUnitID

  The ad unit ID.

  Declaration

  Swift

  var adUnitID: String { get }

  Objective-C

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

• responseInfo

  Information about the ad response that returned the ad.

  Declaration

  Swift

  var responseInfo: ResponseInfo { get }

  Objective-C

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

• adReward

  The reward earned by the user for interacting with the ad.

  Declaration

  Swift

  var adReward: AdReward { get }

  Objective-C

  @property (nonatomic, readonly, nonnull) GADAdReward *adReward;

• serverSideVerificationOptions

  Options specified for server-side user reward verification. Must be set before presenting this ad.

  Declaration

  Swift

  @NSCopying var serverSideVerificationOptions: ServerSideVerificationOptions? { get set }

  Objective-C

  @property (nonatomic, copy, nullable) GADServerSideVerificationOptions *serverSideVerificationOptions;

• fullScreenContentDelegate

  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;

• paidEventHandler

  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;

• placementID

  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;

• +loadWithAdUnitID:request:completionHandler:

  Loads a rewarded interstitial ad.

  Declaration

  Swift

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

  Objective-C

  + (void)loadWithAdUnitID:(nonnull NSString *)adUnitID
                   request:(nullable GADRequest *)request
         completionHandler:
             (nonnull GADRewardedInterstitialAdLoadCompletionHandler)
                 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.

• +loadWithAdResponseString:completionHandler:

  Loads a rewarded interstitial ad.

  Declaration

  Swift

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

  Objective-C

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

  Parameters

  adResponseString	A server-to-server ad response string.
  completionHandler	A handler to execute when the load operation finishes or times out.

• -canPresentFromRootViewController:error:

  Indicates whether the rewarded 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 rewarded interstitial ad can be presented from the provided root view controller, NO otherwise.

• -presentFromRootViewController:userDidEarnRewardHandler:

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

  Declaration

  Swift

  @MainActor func present(from viewController: UIViewController?, userDidEarnRewardHandler: @escaping GADUserDidEarnRewardHandler)

  Objective-C

  - (void)presentFromRootViewController:
              (nullable UIViewController *)viewController
               userDidEarnRewardHandler:
                   (nonnull GADUserDidEarnRewardHandler)userDidEarnRewardHandler;

  Parameters

  viewController	A view controller to present the ad. If nil, attempts to present from the top view controller of the application’s main window.
  userDidEarnRewardHandler	A handler to execute when the user earns a reward. adReward contains the reward information.