AdView
class AdView : FrameLayout
| kotlin.Any | ||||
| ↳ | android.view.View | |||
| ↳ | android.view.ViewGroup | |||
| ↳ | android.widget.FrameLayout | |||
| ↳ | com.google.android.libraries.ads.mobile.sdk.banner.AdView | |||
A android.view.View to display BannerAd objects.
There are two ways to load and show ads using an AdView:
-
Call
loadAdorloadFromAdResponse. -
Call
registerBannerAdwith a banner ad loaded fromBannerAdPreloaderorBannerAd.load.
Summary
Public constructors |
|---|
|
Constructs an |
AdView(context: Context, attrs: AttributeSet?)Constructs an |
AdView(context: Context, attrs: AttributeSet?, defStyleAttr: Int)Constructs an |
AdView(Constructs an |
Public functions |
|
|---|---|
Unit |
Destroys the |
BannerAd? |
Gets the current |
Unit |
loadAd(Loads a |
suspend AdLoadResult<BannerAd> |
loadFromAdResponse(adResponse: String)Loads a |
Unit |
loadFromAdResponse(Loads a |
Unit |
@MainThreadPopulates this |
Unit |
@MainThread |
BannerAd? |
Public constructors
AdView
AdView(context: Context, attrs: AttributeSet?, defStyleAttr: Int)
Constructs an AdView from an XML layout.
Public functions
destroy
@MainThread
fun destroy(): Unit
Destroys the AdView and its associated BannerAd, and cancels any in-progress ad requests on this AdView.
Must be called on the main thread.
getBannerAd
@MainThread
fun getBannerAd(): BannerAd?
Gets the current BannerAd displayed in this AdView, if one exists.
Must be called on the main thread.
loadAd
fun loadAd(
adRequest: BannerAdRequest,
adLoadCallback: AdLoadCallback<BannerAd>
): Unit
Loads a BannerAd. Calls adLoadCallback when loading succeeds or fails.
Upon a successful load, the SDK automatically uses the loaded banner to call registerBannerAd and uses its size to call resize prior to invoking the ad load callback.
The SDK automatically issues a new ad request at the refresh rate configured for the ad unit in the AdMob or Ad Manager UI, regardless of the previous load's success or failure. If no refresh rate is configured for the ad unit, it will issue new ad requests at a regular interval until an ad successfully loads. The adLoadCallback is called after each request completes.
When you are finished using AdView, call destroy.
| Parameters | |
|---|---|
adRequest: BannerAdRequest |
An ad request with targeting information. |
adLoadCallback: AdLoadCallback<BannerAd> |
A callback to be invoked when loading completes. |
loadFromAdResponse
suspend fun loadFromAdResponse(adResponse: String): AdLoadResult<BannerAd>
Loads a BannerAd from a server-to-server ad response. Returns when loading succeeds or fails.
Upon a successful load, the SDK automatically uses the loaded banner to call registerBannerAd and uses its size to call resize.
| Parameters | |
|---|---|
adResponse: String |
An ad response from a server-to-server ad request. |
| Returns | |
|---|---|
AdLoadResult<BannerAd> |
|
loadFromAdResponse
fun loadFromAdResponse(
adResponse: String,
adLoadCallback: AdLoadCallback<BannerAd>
): Unit
Loads a BannerAd from a server-to-server ad response. Calls adLoadCallback when loading succeeds or fails.
Upon a successful load, the SDK automatically uses the loaded banner to call registerBannerAd and uses its size to call resize prior to invoking the ad load callback.
| Parameters | |
|---|---|
adResponse: String |
An ad response from a server-to-server ad request. |
adLoadCallback: AdLoadCallback<BannerAd> |
A callback to be invoked when loading completes. |
registerBannerAd
@MainThread
fun registerBannerAd(bannerAd: BannerAd, activity: Activity): Unit
Populates this AdView with the contents of the provided BannerAd. Resizes this AdView if necessary.
Calling this method cancels any in-progress ad requests initiated by a previous call to loadAd.
Must be called on the main thread.
resize
@MainThread
fun resize(newSize: AdSize): Unit
Adjusts the minimum size of this AdView to newSize.
For Google-rendered ads, the SDK will also attempt to adjust the minimum size of the underlying BannerAd's view. Web content may or may not choose to adjust to these size changes and may be either clipped or centered.
When a banner ad is associated with this AdView, it is automatically resized to BannerAd.getAdSize. Future calls to resize will override the size from the associated BannerAd.
Each ad refresh triggers a layout change, resizing the BannerAd view to match the size of the newly loaded ad.
Must be called on the main thread.
unregisterBannerAd
@MainThread
@CanIgnoreReturnValue
fun unregisterBannerAd(): BannerAd?
Unregisters the BannerAd displayed in this AdView. Cancels any in-progress ad requests started by loadAd or loadFromAdResponse.
This method is useful if you want to reuse this BannerAd in a different AdView. If you are finished using both the AdView and its associated BannerAd, call destroy instead.
Must be called on the main thread.