This extension helps you to add Google AdMob ads to your app.
Extension Info
| SDK Version | 25.0.0 (17 Feb 2026) |
| Size | 862 KB |
Note: If you are using platforms like Kodular, Niotron, or similar app builders that require a paid subscription to enable ads, you must purchase their subscription separately. The cost of this extension does not include or cover any platform subscription fees, as it is an independent product.
Events
OnConsentGranted
Triggered when the user consent has been successfully granted or is not required.
OnConsentGatheringFailed
Triggered when an error occurs during the consent gathering process.
| Parameter | Type |
|---|---|
| errorCode | number |
| message | text |
OnSDKInitialised
Triggered when the AdMob Mobile Ads SDK has been successfully initialized and is ready to load ads.
OnBannerClicked
Triggered when the user clicks on the banner ad.
OnBannerFailToLoad
Triggered when the banner ad fails to load. Returns the error message.
| Parameter | Type |
|---|---|
| error | text |
OnBannerFailToShow
Triggered when the banner ad fails to display. Returns the error message.
| Parameter | Type |
|---|---|
| error | text |
OnBannerClose
Triggered when the user closes the banner ad.
OnBannerImpression
Triggered when an impression has been recorded for the banner ad.
OnBannerLoaded
Triggered when the banner ad has been successfully loaded.
OnBannerOpen
Triggered when the banner ad is opened, covering the screen.
OnInterstitialLoaded
Triggered when the Interstitial ad has been successfully loaded and is ready to be shown.
OnInterstitialFailedToLoad
Triggered when the Interstitial ad fails to load. Returns the error message.
| Parameter | Type |
|---|---|
| error | text |
OnInterstitialClicked
Triggered when the user clicks on the Interstitial ad.
OnInterstitialDismissed
Triggered when the Interstitial ad is dismissed by the user.
OnInterstitialFailToShow
Triggered when the Interstitial ad fails to display. Returns the error message.
| Parameter | Type |
|---|---|
| error | text |
OnInterstitialImpression
Triggered when an impression has been recorded for the Interstitial ad.
OnInterstitialShowed
Triggered when the Interstitial ad is successfully shown to the user.
OnUserEarnedReward
Triggered when the user has successfully earned a reward. Provides the reward amount and reward type.
| Parameter | Type |
|---|---|
| amount | number |
| type | text |
OnRewardedAdLoaded
Triggered when the Rewarded ad has been successfully loaded and is ready to be shown.
OnRewardedAdFailedToLoad
Triggered when the Rewarded ad fails to load. Returns the error message.
| Parameter | Type |
|---|---|
| error | text |
OnRewardedAdClicked
Triggered when the user clicks on the Rewarded ad.
OnRewardedAdDismissed
Triggered when the Rewarded ad is dismissed by the user.
OnRewardedAdFailToShow
Triggered when the Rewarded ad fails to display. Returns the error message.
| Parameter | Type |
|---|---|
| error | text |
OnRewardedAdImpression
Triggered when an impression has been recorded for the Rewarded ad.
OnRewardedAdShowed
Triggered when the Rewarded ad is successfully shown to the user.
OnUserEarnedRewardedInterstital
Triggered when the user has successfully earned a reward from a Rewarded Interstitial ad. Provides the reward amount and type.
| Parameter | Type |
|---|---|
| amount | number |
| type | text |
OnRewardedInterstitialAdLoaded
Triggered when the Rewarded Interstitial ad has been successfully loaded and is ready to be shown.
OnRewardedInterstitialAdFailedToLoad
Triggered when the Rewarded Interstitial ad fails to load. Returns the error message.
| Parameter | Type |
|---|---|
| error | text |
OnRewardedInterstitialAdClicked
Triggered when the user clicks on the Rewarded Interstitial ad.
OnRewardedInterstitialAdDismissed
Triggered when the Rewarded Interstitial ad is dismissed by the user.
OnRewardedInterstitialAdFailToShow
Triggered when the Rewarded Interstitial ad fails to display. Returns the error message.
| Parameter | Type |
|---|---|
| error | text |
OnRewardedInterstitialAdImpression
Triggered when an impression has been recorded for the Rewarded Interstitial ad.
OnRewardedInterstitialAdShowed
Triggered when the Rewarded Interstitial ad is successfully shown to the user.
NativeAdClosed
Triggered when the Native ad is closed by the user.
NativeAdImpression
Triggered when an impression has been recorded for the Native ad.
NativeAdOpened
Triggered when the Native ad is opened, covering the screen.
NativeAdFailedToLoad
Triggered when the Native ad fails to load. Returns the error code and message.
| Parameter | Type |
|---|---|
| errorCode | number |
| domain | text |
| errorMessage | text |
| response | text |
NativeAdPaidEvent
Triggered when a paid event is recorded for the Native ad. Provides revenue details.
| Parameter | Type |
|---|---|
| currencyCode | text |
| precisionType | number |
| value | number |
NativeAdVideoStarted
Triggered when the video content within the Native ad starts playing.
NativeAdVideoPlayed
Triggered when the video content within the Native ad begins playing.
NativeAdVideoPaused
Triggered when the video content within the Native ad is paused.
NativeAdVideoEnded
Triggered when the video content within the Native ad finishes playing.
NativeAdVideoMuted
Triggered when the video content within the Native ad is muted.
NativeAdUnmuted
Triggered when the video content within the Native ad is unmuted.
NativeAdMuteStateChanged
Triggered when the mute state of the Native ad video changes.
| Parameter | Type |
|---|---|
| isMuted | boolean |
NativeAdLoaded
Triggered when the Native ad is loaded, providing all ad asset details.
| Parameter | Type |
|---|---|
| placementId | text |
| advertiser | text |
| callToAction | text |
| headline | text |
| body | text |
| iconUrl | text |
| icon | any |
| images | list |
| price | text |
| starRating | number |
| store | text |
| mediaContent | any |
| nativeAd | any |
| isCustomClickGestureEnabled | boolean |
| isCustomMuteThisAdEnabled | boolean |
NativeAdUnconfirmedClickCancelled
Triggered when an unconfirmed click on the Native ad is cancelled by the user.
NativeAdClicked
Triggered when the user clicks on the Native ad.
NativeAdUnconfirmedClickReceived
Triggered when an unconfirmed click is recorded for the Native ad.
| Parameter | Type |
|---|---|
| assetId | text |
OnAppopenAdLoaded
Triggered when the App Open ad has been successfully loaded and is ready to be shown.
OnAppopenAdFailedToLoad
Triggered when the App Open ad fails to load. Returns the error message.
| Parameter | Type |
|---|---|
| error | text |
OnAppopenAdClicked
Triggered when the user clicks on the App Open ad.
OnAppopenAdDismissed
Triggered when the App Open ad is dismissed by the user.
OnAppopenAdFailToShow
Triggered when the App Open ad fails to display. Returns the error message.
| Parameter | Type |
|---|---|
| error | text |
OnAppopenAdImpression
Triggered when an impression has been recorded for the App Open ad.
OnAppopenAdShowed
Triggered when the App Open ad is successfully shown to the user.
AdInspectorClosed
Triggered when the AdMob Ad Inspector is closed. Provides error details if it failed to open.
| Parameter | Type |
|---|---|
| errorCode | number |
| domain | text |
| errorMessage | text |
| response | text |
Methods
LoadConsentForm
Loads the User Messaging Platform (UMP) consent form. This is required to request user consent for personalized ads, especially in the EEA and UK.
| Parameter | Type |
|---|---|
| admobAppId | text |
| isUnderAgeConsent | boolean |
| isTestmode | boolean |
| deviceHashId | text |
IsConsentFormAvailable
Checks if a consent form is available to be shown to the user.
Return Type: boolean
GetConsentStatus
Returns the current consent status. 0: UNKNOWN; 1: NOT_REQUIRED; 2: REQUIRED; 3: OBTAINED.
Return Type: number
CanRequestAds
Checks whether ads can be requested based on the user’s current consent status.
Return Type: boolean
Initialise
Initializes the AdMob Mobile Ads SDK. This should be called once at the start of the application before loading any ads.
isSDKInitialised
Returns true if the AdMob Mobile Ads SDK has already been initialized.
Return Type: boolean
LoadBannerAd
Loads a Banner ad into the specified layout with the given ad unit ID and size.
| Parameter | Type |
|---|---|
| in | component |
| adUnitID | text |
| adSize | any |
isBannerLoaded
Checks if a banner ad has been successfully loaded and is ready to be shown.
Return Type: boolean
ShowBannerAd
Displays the loaded banner ad within the assigned layout. This should only be called after the ad has been loaded.
AdSizeBanner
Returns the standard Banner ad size (320×50 dp).
Return Type: any
AdSizeAnchorAdaptive
Returns the Anchor Adaptive Banner ad size, which automatically adjusts to the device screen width.
Return Type: any
AdSizeBottomCollapsible
Returns the Bottom Collapsible Banner ad size. This ad appears at the bottom and can be expanded or collapsed.
Return Type: any
AdSizeTopCollapsible
Returns the Top Collapsible Banner ad size. This ad appears at the top and can be expanded or collapsed.
Return Type: any
AdSizeInlineAdaptiveBanner
Returns the Inline Adaptive Banner ad size, suitable for placement within scrolling content.
Return Type: any
AdSizeFullBanner
Returns the Full Banner ad size (468×60 dp).
Return Type: any
AdSizeWideSkyScraperBanner
Returns the Wide Skyscraper Banner ad size (160×600 dp).
Return Type: any
AdSizeLargeBanner
Returns the Large Banner ad size (320×100 dp).
Return Type: any
AdSizeLeaderBoardBanner
Returns the Leaderboard Banner ad size (728×90 dp).
Return Type: any
AdSizeMediumRectangleBanner
Returns the Medium Rectangle Banner ad size (300×250 dp).
Return Type: any
AdSizeCustom
Returns a custom banner ad size with the specified width and height in dp.
| Parameter | Type |
|---|---|
| width | number |
| height | number |
Return Type: any
LoadInterstitialAd
Loads an Interstitial ad with the specified ad unit ID. This is a full-screen ad format.
| Parameter | Type |
|---|---|
| adUnitID | text |
ShowInterstitialAd
Displays the loaded Interstitial ad. This should be called after receiving the OnInterstitialLoaded event.
LoadRewardedAd
Loads a Rewarded ad with the specified ad unit ID. These ads reward users for watching a video.
| Parameter | Type |
|---|---|
| adUnitID | text |
ShowRewardedAd
Displays the loaded Rewarded ad. This should be called after receiving the OnRewardedAdLoaded event.
LoadRewardedInterstitialAd
Loads a Rewarded Interstitial ad with the specified ad unit ID. This format provides rewards without requiring a full video view.
| Parameter | Type |
|---|---|
| adUnitID | text |
ShowRewardedInterstitialAd
Displays the loaded Rewarded Interstitial ad. This should be called after receiving the OnRewardedInterstitialAdLoaded event.
LoadNativeAd
Loads a Native ad with the specified placement ID. Native ads can be customized to match the look and feel of your app.
| Parameter | Type |
|---|---|
| placementId | text |
| isVideoAd | boolean |
DestroyNativeAd
Destroys the Native ad and frees up associated resources.
CancelUnconfirmedClickForNativeAd
Cancels an unconfirmed click on the Native ad, if applicable.
EnableCustomClickGestureForNativeAd
Enables custom click gestures for the Native ad, allowing for more flexible interaction handling.
PerformNativeAdClick
Programmatically performs a click on the Native ad.
RecordCustomNativeAdClickGesture
Records a custom click gesture for the Native ad.
IsNativeAdLoading
Returns true if a Native ad is currently in the process of loading.
Return Type: boolean
RegisterNativeLayout
Registers the main layout container for the Native ad.
| Parameter | Type |
|---|---|
| arrangement | component |
RegisterNativeMediaLayout
Registers the layout for displaying media (images or video) within the Native ad.
| Parameter | Type |
|---|---|
| arrangement | component |
RegisterNativeIconImageView
Registers the image view that will display the Native ad’s icon.
| Parameter | Type |
|---|---|
| image | component |
RegisterNativeHeadlineView
Registers the label that will display the Native ad’s headline.
| Parameter | Type |
|---|---|
| label | component |
RegisterNativeBodyView
Registers the label that will display the Native ad’s body text.
| Parameter | Type |
|---|---|
| label | component |
RegisterNativeActionButton
Registers the button that will serve as the call-to-action for the Native ad.
| Parameter | Type |
|---|---|
| button | component |
RegisterNativeRatingView
Registers the label that will display the Native ad’s star rating.
| Parameter | Type |
|---|---|
| label | component |
RegisterNativePriceView
Registers the label that will display the Native ad’s price information.
| Parameter | Type |
|---|---|
| label | component |
LoadAppOpen
Loads an App Open ad with the specified ad unit ID. This format is typically shown when the app is launched or foregrounded.
| Parameter | Type |
|---|---|
| adUnitID | text |
ShowAppOpen
Displays the loaded App Open ad. This should be called after receiving the OnAppopenAdLoaded event.
OpenAdInspector
Opens the AdMob Ad Inspector, a powerful in-app tool to test and debug your ad implementations.
DestroyBannerAd
Destroys the banner ad and removes it from its container layout to free up resources.
Usage
