GoogleMobileAds Framework Reference

GADRewardedAd

@interface GADRewardedAd : NSObject

The GADRewardedAd class is used for requesting and presenting a rewarded ad.

  • Initializes a rewarded ad with the provided ad unit ID. Create ad unit IDs using the AdMob website for each unique ad placement in your app. Unique ad units improve targeting and statistics.

    Example AdMob ad unit ID: @ca-app-pub-3940256099942544/1712485313

    Declaration

    Objective-C

    - (nonnull instancetype)initWithAdUnitID:(nonnull NSString *)adUnitID;

  • Requests an rewarded ad and calls the provided completion handler when the request finishes.

    Declaration

    Objective-C

    - (void)loadRequest:(nullable GADRequest *)request
    completionHandler:
        (nullable GADRewardedAdLoadCompletionHandler)completionHandler;

  • The ad unit ID.

    Declaration

    Objective-C

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

  • Indicates whether the rewarded ad is ready to be presented.

    Declaration

    Objective-C

    @property (readonly, getter=isReady, nonatomic) BOOL ready;

  • The ad network class name that fetched the current ad. Is nil while the ready property is NO. For both standard and mediated Google AdMob ads, this property is @GADMAdapterGoogleAdMobAds. For ads fetched via mediation custom events, this property is the mediated custom event adapter.

    Declaration

    Objective-C

    @property (readonly, copy, nonatomic, nullable) NSString *adNetworkClassName;

  • The reward earned by the user for interacting with a rewarded ad. Is nil until the ad has successfully loaded.

    Declaration

    Objective-C

    @property (readonly, nonatomic, nullable) GADAdReward *reward;

  • Options specified for server-to-server user reward verification.

    Declaration

    Objective-C

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

  • The loaded ad’s metadata. Is nil if no ad is loaded or the loaded ad doesn’t have metadata. Ad metadata may update after loading. Use the rewardedAdMetadataDidChange: delegate method on GADRewardedAdMetadataDelegate to listen for updates.

    Declaration

    Objective-C

    @property (readonly, nonatomic, nullable)
    NSDictionary<GADAdMetadataKey, id> *adMetadata;

  • Delegate for ad metadata changes.

    Declaration

    Objective-C

    @property (readwrite, nonatomic, nullable) id<GADRewardedAdMetadataDelegate>
    adMetadataDelegate;

  • Presents the rewarded ad with the provided view controller and rewarded delegate to call back on various intermission events. The delegate is strongly retained by the receiver until a terminal delegate method is called. Terminal methods are -rewardedAd:didFailToPresentWithError: and -rewardedAdDidClose: of GADRewardedAdDelegate.

    Declaration

    Objective-C

    - (void)presentFromRootViewController:(nonnull UIViewController *)viewController
                             delegate:
                                 (nonnull id<GADRewardedAdDelegate>)delegate;