GoogleMobileAds Framework Reference

GADAppOpenAd

@interface GADAppOpenAd : NSObject <GADFullScreenPresentingAd>

An app open ad. Used to monetize app load screens.

• +loadWithAdUnitID:request:completionHandler:

  Loads an app open ad.

  Declaration

  Swift

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

  Objective-C

  + (void)loadWithAdUnitID:(nonnull NSString *)adUnitID
                   request:(nullable GADRequest *)request
         completionHandler:
             (nonnull GADAppOpenAdLoadCompletionHandler)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 an app open ad.

  Declaration

  Swift

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

  Objective-C

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

  Parameters

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

• fullScreenContentDelegate

  Optional delegate object that receives notifications about presentation and dismissal of full screen content from this ad. Full screen content covers your application’s content. The delegate may want to pause animations and time sensitive interactions. Set this delegate before presenting the ad.

  Declaration

  Swift

  weak var fullScreenContentDelegate: (any FullScreenContentDelegate)? { get set }

  Objective-C

  @property (nonatomic, weak, nullable) id<GADFullScreenContentDelegate> fullScreenContentDelegate;

• 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;

• 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;

• -canPresentFromRootViewController:error:

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

• -presentFromRootViewController:

  Presents the app open ad with the provided view controller. Must be called on the main thread. If rootViewController is nil, attempts to present from the top view controller of the application’s main window.

  Declaration

  Swift

  @MainActor func present(from rootViewController: UIViewController?)

  Objective-C

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