GADRewardedAd
@interface GADRewardedAd
: NSObject <GADAdMetadataProvider, GADFullScreenPresentingAd>
A rewarded ad. Rewarded ads are ads that users have the option of interacting with in exchange for in-app rewards.
-
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: GADResponseInfo { get }
Objective-C
@property (nonatomic, readonly, nonnull) GADResponseInfo *responseInfo;
-
The reward earned by the user for interacting with the ad.
Declaration
Swift
var adReward: GADAdReward { get }
Objective-C
@property (nonatomic, readonly, nonnull) GADAdReward *adReward;
-
Options specified for server-side user reward verification. Must be set before presenting this ad.
Declaration
Swift
@NSCopying var serverSideVerificationOptions: GADServerSideVerificationOptions? { get set }
Objective-C
@property (nonatomic, copy, nullable) GADServerSideVerificationOptions *serverSideVerificationOptions;
-
Delegate for handling full screen content messages.
Declaration
Swift
weak var fullScreenContentDelegate: (any GADFullScreenContentDelegate)? { 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;
-
Loads a rewarded ad.
Declaration
Swift
class func load(withAdUnitID adUnitID: String, request: GADRequest?) async throws -> GADRewardedAd
Objective-C
+ (void)loadWithAdUnitID:(nonnull NSString *)adUnitID request:(nullable GADRequest *)request completionHandler: (nonnull GADRewardedAdLoadCompletionHandler)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 a rewarded ad.
Declaration
Swift
class func load(withAdResponseString adResponseString: String) async throws -> GADRewardedAd
Objective-C
+ (void)loadWithAdResponseString:(nonnull NSString *)adResponseString completionHandler:(nonnull GADRewardedAdLoadCompletionHandler) completionHandler;
Parameters
adResponseString
A server-to-server ad response string.
completionHandler
A handler to execute when the load operation finishes or times out.
-
Returns whether the rewarded ad can be presented from the provided root view controller. Sets the error out parameter if the ad can’t be presented. Must be called on the main thread. If rootViewController is nil, uses the top view controller of the application’s main window.
Declaration
Swift
func canPresent(fromRootViewController rootViewController: UIViewController?) throws
Objective-C
- (BOOL)canPresentFromRootViewController: (nullable UIViewController *)rootViewController error:(NSError *_Nullable *_Nullable)error;
-
Presents the rewarded ad. Must be called on the main thread.
Declaration
Swift
func present(fromRootViewController rootViewController: UIViewController?, userDidEarnRewardHandler: @escaping GADUserDidEarnRewardHandler)
Objective-C
- (void)presentFromRootViewController: (nullable UIViewController *)rootViewController userDidEarnRewardHandler: (nonnull GADUserDidEarnRewardHandler)userDidEarnRewardHandler;
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.
userDidEarnRewardHandler
A handler to execute when the user earns a reward.