Class AppOpenAd

Extends FullScreenAd
Represents a full-screen app open ad.

App open ads completely cover the screen of the host application when the app starts or is foregrounded.
Properties
adEventCallback?
The callback to receive ad event notifications.
adUnitId
The unique ad unit ID used to request and load this specific ad.
Methods
destroy
Destroys the ad, stopping any extra processing and destroying resources associated with it.
getResponseInfo
Gets information about the ad response for this ad.
setPlacementId
Sets the placement ID for this ad.
show
Shows the full-screen ad.
load
Loads an app open ad.

Properties


Optional adEventCallback

adEventCallback?: AdEventCallback
The callback to receive ad event notifications.

Readonly adUnitId

adUnitId: string
The unique ad unit ID used to request and load this specific ad.

Methods


destroy

destroy(): void
Destroys the ad, stopping any extra processing and destroying resources associated with it. Do not call any other methods after this.

getResponseInfo

getResponseInfo(): ResponseInfo
Gets information about the ad response for this ad.
Returns
ResponseInfo A ResponseInfo object containing metadata about the loaded ad.

setPlacementId

setPlacementId(placementId): void
Sets the placement ID for this ad. Before presenting the ad, you must set this property.
Parameters
placementId: bigint The identifier for the placement in reporting.

show

show(): void
Shows the full-screen ad.

Static load

load(request): Promise<AppOpenAd>
Loads an app open ad.
Parameters
request: AdRequest The ad request configuration.
Returns
Promise<AppOpenAd> A Promise that resolves to the loaded AppOpenAd instance.