AdMob Banner

Category	Requires	Version
Monetization > Advertising	API 21, Android 5.0 Lollipop	4

Overview

A component for displaying banner advertisements from Google AdMob. Banner ads are rectangular image or text ads that occupy a spot within an app''s layout. They are designed to stay on screen while users are interacting with the app, typically anchored to the top or bottom of the screen. To use this component, you must provide a valid Ads App ID (inside Project settings > Monetization > Google Ads App ID) and Ad Unit ID from your AdMob account. It is recommended to use Test Mode during development to avoid generating invalid ad traffic.

Permissions

• com.google.android.gms.permission.AD_ID
• android.permission.INTERNET
• android.permission.ACCESS_NETWORK_STATE
• android.permission.ACCESS_ADSERVICES_AD_ID
• android.permission.ACCESS_ADSERVICES_ATTRIBUTION
• android.permission.ACCESS_ADSERVICES_TOPICS

Commission

Type: Fixed Rate Value: 7%

Events

Ad Clicked

Called when the user clicks on the ad.

Ad Closed

Called when the ad is closed, and the user is returned to the app.

Ad Failed To Load

Called when an ad request fails to load. The error code and message provide more details on the failure.

Params
error Code	Number
error Message	Text

Ad Impression

Called when an ad impression has been recorded.

Ad Loaded

Called when an ad has been successfully loaded.

Ad Opened

Called when the ad is displayed on the screen, covering the app's content.

Ad Swipe Gesture Clicked

Called when the user performs a swipe gesture click on the ad.

Methods

Load Ad

Initiates a request to load a new banner ad. This will not do anything if an ad is already loading or if ads are disabled.

Properties

Ad Enabled

Boolean Default: True Read Write - Designer Blocks

Specifies whether ads should be enabled. If set to false, no ads will be loaded.

Ad Unit Id

Text Read Write - Designer Blocks

The Ad Unit ID for this banner ad. It can be found in your AdMob account.

Test Mode

Boolean Default: False Write - Designer

If enabled, test ads will be shown. This should be used during development to avoid generating false impressions. Always enabled when in companion.

Visible

Boolean Default: True Read Write - Designer Blocks

Returns true iff the component is visible.