BaseAdView

abstract class BaseAdView : ViewGroup

Known direct subclasses
AdManagerAdView

The View to display banner ads for use with Google Ad Manager.

AdView

The android.view.View to display banner ads.


The base ad android.view.View for displaying banner ads.

Summary

Protected constructors

BaseAdView(context: Context!, adViewType: Int)

Constructs a BaseAdView from code.

BaseAdView(context: Context!, attrs: AttributeSet!, adViewType: Int)

Constructs a BaseAdView from an XML layout.

BaseAdView(
    context: Context!,
    attrs: AttributeSet!,
    allowMultipleAdSizes: Boolean
)

Constructs a BaseAdView from an XML layout.

BaseAdView(
    context: Context!,
    attrs: AttributeSet!,
    defStyle: Int,
    adViewType: Int
)

Constructs a BaseAdView from an XML layout.

BaseAdView(
    context: Context!,
    attrs: AttributeSet!,
    defStyle: Int,
    adViewType: Int,
    allowMultipleAdSizes: Boolean
)

Constructs a BaseAdView from an XML layout.

Public functions

Unit

Destroys the ad view.

AdListener!

Returns the AdListener for this ad view.

AdSize?

Returns the size of the ad.

String!

Returns the ad unit ID.

OnPaidEventListener?

Gets the OnPaidEventListener for this ad view.

ResponseInfo?

Returns the ResponseInfo object for the loaded ad.

Boolean

Returns true if the ad is a collapsible banner; returns false until an ad is loaded.

Boolean

Returns true if the ad is loading.

Unit
@RequiresPermission(value = Manifest.permission.INTERNET)
loadAd(adRequest: AdRequest!)

Loads an ad.

Unit

Pauses any extra processing associated with this ad view.

Unit

Resumes an ad view after a previous call to pause.

Unit
setAdListener(adListener: AdListener!)

Sets an AdListener for this ad view.

Unit
setAdSize(adSize: AdSize!)

Sets the size of the ad.

Unit
setAdUnitId(adUnitId: String!)

Sets the ad unit ID.

Unit

Registers a callback to be invoked when this ad is estimated to have earned money.

Protected functions

Unit
onLayout(changed: Boolean, left: Int, top: Int, right: Int, bottom: Int)
Unit
onMeasure(widthMeasureSpec: Int, heightMeasureSpec: Int)

Inherited Constants

From android.view.View
const Int
const Int
const Int
const Int
const Int
const Int
const Property<View!, Float!>!
const Int
const String!
AUTOFILL_HINT_CREDIT_CARD_EXPIRATION_DATE = "creditCardExpirationDate"
const String!
AUTOFILL_HINT_CREDIT_CARD_EXPIRATION_DAY = "creditCardExpirationDay"
const String!
AUTOFILL_HINT_CREDIT_CARD_EXPIRATION_MONTH = "creditCardExpirationMonth"
const String!
AUTOFILL_HINT_CREDIT_CARD_EXPIRATION_YEAR = "creditCardExpirationYear"
const String!
const String!
AUTOFILL_HINT_CREDIT_CARD_SECURITY_CODE = "creditCardSecurityCode"
const String!
const String!
const String!
const String!
const String!
const String!
const String!
const Int
const Int
const Int
const Int
const Int
const Int
const Int
const Int
const Int
const Int
const Int
const Int
const Int
const Int
const Int
const Int
const Int
const Int
const Int

This property is deprecated.

const Int

This property is deprecated.

const Int

This property is deprecated.

const IntArray<Int>!
const IntArray<Int>!
const IntArray<Int>!
const IntArray<Int>!
const IntArray<Int>!
const IntArray<Int>!
const IntArray<Int>!
const IntArray<Int>!
const IntArray<Int>!
const Int
const Int
const Int
const Int
const Int
const Int
const IntArray<Int>!
const IntArray<Int>!
const IntArray<Int>!
const IntArray<Int>!
const Int
const Int
const Int
const Int
const Int
const Int
const Int
GONE = 8
const Int
const Int
const Int
const Int
const Int
const Int
const Int
const Int
const Int
const Int
const Int
const Int
const Int
const Int
const Int
const Int
const Int
KEEP_SCREEN_ON = 67108864
const Int
const Int
const Int
const Int
const Int
const Int
const Int
const Int
const Int
const Int
const Int
const Int
const Int
NO_ID = -1
const Int
const Int
const Int
const IntArray<Int>!
const IntArray<Int>!
const IntArray<Int>!
const IntArray<Int>!
const IntArray<Int>!
const IntArray<Int>!
const IntArray<Int>!
const IntArray<Int>!
const IntArray<Int>!
const IntArray<Int>!
const IntArray<Int>!
const IntArray<Int>!
const IntArray<Int>!
const IntArray<Int>!
const IntArray<Int>!
const IntArray<Int>!
const Int
const Int
const Int
const Int
const Float
const Float
const Float
const Float
const Float
const Property<View!, Float!>!
const Property<View!, Float!>!
const Property<View!, Float!>!
const Property<View!, Float!>!
const Property<View!, Float!>!
const Int
const Int
const Int
const Int
const Int
const Int
const Int
const Int
const Int
const Int
const Int
const Int
const Int
const Int
const Int
const Int
const Int
const Int
const Int
const Int
const Int
const Int
const IntArray<Int>!
const IntArray<Int>!
const Int
const Int

This property is deprecated.

const Int

This property is deprecated.

const Int

This property is deprecated.

const Int

This property is deprecated.

const Int

This property is deprecated.

const Int

This property is deprecated.

const Int

This property is deprecated.

const Int

This property is deprecated.

const Int

This property is deprecated.

const Int

This property is deprecated.

const Int

This property is deprecated.

const Int

This property is deprecated.

const Int

This property is deprecated.

const Int

This property is deprecated.

const Int
const Int
const Int
const Int
const Int
const Int
const Int
const Int
const Int
const Int
const Int
const Int
const Int
const Int
const Int
const Property<View!, Float!>!
const Property<View!, Float!>!
const Property<View!, Float!>!
const String!
VIEW_LOG_TAG = "View"
const Int
const IntArray<Int>!
const Property<View!, Float!>!
const Property<View!, Float!>!
const Property<View!, Float!>!
From android.view.ViewGroup
const Int
const Int
const Int
const Int
const Int
const Int
const Int

This property is deprecated.

const Int

This property is deprecated.

const Int

This property is deprecated.

const Int

This property is deprecated.

Inherited functions

From android.view.View
Unit
Unit
Unit
ViewPropertyAnimator!
Unit

This function is deprecated.

Unit
Boolean
Unit
Unit

This function is deprecated.

Unit
Boolean
Boolean
Boolean
Boolean
Boolean
Boolean
Unit
Unit
Unit
Boolean
Unit
Unit
Unit
java-static Int
Int
Int
Int
Unit
WindowInsets!
Int
Int
Int
AccessibilityNodeInfo!
Unit
Unit

This function is deprecated.

Boolean
Boolean
Boolean
Boolean
Boolean
dispatchNestedPreScroll(p: Int, p1: Int, p2: IntArray!, p3: IntArray!)
Boolean
dispatchNestedScroll(p: Int, p1: Int, p2: Int, p3: Int, p4: IntArray!)
Boolean
Unit
draw(p: Canvas!)
Unit
OnBackInvokedDispatcher!
T!
<T : View?> findViewById(p: Int)
T!
<T : View?> findViewWithTag(p: Any!)
Boolean

This function is deprecated.

Unit
Unit
Unit
generateDisplayHash(
    p: String!,
    p1: Rect!,
    p2: Executor!,
    p3: DisplayHashResultCallback!
)
java-static Int
View.AccessibilityDelegate!
Int
AccessibilityNodeProvider!
CharSequence!
Int
Int
String!
String!
Float
Animation!
Matrix!
IBinder!
IntArray<Int>!
(Mutable)Map<Int!, Int!>!
Array<String!>!
AutofillId!
Int
AutofillValue!
Drawable!
BlendMode!
ColorStateList!
PorterDuff.Mode!
Int
Int
Float
Int
Float
Rect!
Boolean
Boolean
ContentCaptureSession!
CharSequence!
Int
Context!
ContextMenu.ContextMenuInfo!
Boolean
java-static Int
getDefaultSize(p: Int, p1: Int)
Display!
IntArray<Int>!
Bitmap!

This function is deprecated.

Int

This function is deprecated.

Int

This function is deprecated.

Unit
Long
Float
Int
Boolean
Boolean
Int
ArrayList<View!>!
Unit
Drawable!
Int
BlendMode!
ColorStateList!
PorterDuff.Mode!
Float
Boolean
Handler!
Float
Float
Float
Float
Int
Runnable!
Boolean
Int
Unit
Int
Int
Drawable!
Drawable!
Int
Int
Int
Int
Boolean
KeyEvent.DispatcherState!
Int
Int
Int
ViewGroup.LayoutParams!
Int
Float
Int
Boolean
Unit
Unit
Unit
Matrix!
Int
Int
Int
Int
Int
Int
Int
Int
Int
Int
Int
Int
Int
View.OnFocusChangeListener!
Int
ViewOutlineProvider!
Int
Int
ViewOverlay!
Int
Int
Int
Int
Int
Int
ViewParent!
ViewParent!
OutcomeReceiver<GetCredentialResponse!, GetCredentialException!>!
GetCredentialRequest!
Float
Float
PointerIcon!
(Mutable)List<Rect!>!
Array<String!>!
Float
Resources!
Boolean
Int
Float
Int
AttachedSurfaceControl!
View!
WindowInsets!
Float
Float
Float
Float
Float
Int
Int
Int
Int
Int
Int
Int
Int
Int
Int
CharSequence!
StateListAnimator!
Int
Int
CharSequence!
(Mutable)List<Rect!>!
Int

This function is deprecated.

Any!
Int
Int
CharSequence!
Int
Float
Int
TouchDelegate!
ArrayList<View!>!
Float
String!
Float
Float
Float
Long
Int
Int
Drawable!
Drawable!
Int
ViewTranslationResponse!
ViewTreeObserver!
Int
Int
Int
WindowId!
WindowInsetsController!
Int

This function is deprecated.

IBinder!
Int
Unit
Float
Float
Float
Boolean
Boolean
Boolean
Boolean
Boolean
Boolean
Boolean
Boolean
java-static View!
inflate(p: Context!, p1: Int, p2: ViewGroup!)
Unit
Unit
Unit
Boolean
Boolean
Boolean
Boolean
Boolean
Boolean
Boolean
Boolean
Boolean
Boolean
Boolean
Boolean

This function is deprecated.

Boolean
Boolean
Boolean
Boolean
Boolean
Boolean
Boolean
Boolean
Boolean
Boolean
Boolean
Boolean
Boolean
Boolean
Boolean
Boolean
Boolean
Boolean
Boolean
Boolean
Boolean
Boolean
Boolean
Boolean
Boolean
Boolean
Boolean
Boolean
Boolean
Boolean
Boolean
Boolean
Boolean
Boolean
Boolean
Boolean
Boolean
Boolean
Boolean
Boolean
Boolean
Boolean
Boolean
Boolean
Boolean
Boolean
View!
Unit
measure(p: Int, p1: Int)
java-static IntArray<Int>!
Unit
Unit
Unit
Unit
WindowInsets!
Unit
Boolean
Boolean
Unit
Unit
InputConnection!
Unit
Unit
Unit
Boolean
Unit
Unit
Unit
Boolean
Unit
Unit
Unit
onFocusChanged(p: Boolean, p1: Int, p2: Rect!)
Boolean
Unit
Boolean
Unit
Unit
Boolean
onKeyDown(p: Int, p1: KeyEvent!)
Boolean
Boolean
onKeyMultiple(p: Int, p1: Int, p2: KeyEvent!)
Boolean
onKeyPreIme(p: Int, p1: KeyEvent!)
Boolean
Boolean
onKeyUp(p: Int, p1: KeyEvent!)
Unit
onOverScrolled(p: Int, p1: Int, p2: Boolean, p3: Boolean)
Unit
Unit
Unit
Unit
Unit
Unit
Unit
ContentInfo!
Unit
Unit
Parcelable!
Unit
Unit
onScrollCaptureSearch(
    p: Rect!,
    p1: Point!,
    p2: Consumer<ScrollCaptureTarget!>!
)
Unit
onScrollChanged(p: Int, p1: Int, p2: Int, p3: Int)
Boolean
Unit
onSizeChanged(p: Int, p1: Int, p2: Int, p3: Int)
Unit
Boolean
Boolean
Unit
Unit
Unit
Unit
Unit
Unit

This function is deprecated.

Unit
Boolean
overScrollBy(
    p: Int,
    p1: Int,
    p2: Int,
    p3: Int,
    p4: Int,
    p5: Int,
    p6: Int,
    p7: Int,
    p8: Boolean
)
Boolean
Boolean
Boolean
Boolean
Boolean
ContentInfo!
Unit
Boolean
Boolean
Unit
Unit
Unit
Unit
Unit
Unit
Unit
Boolean
Unit
Unit
Unit
Unit
Unit
Unit

This function is deprecated.

Boolean
Unit
Unit
Boolean
Unit
T!
<T : View?> requireViewById(p: Int)
Unit
java-static Int
resolveSize(p: Int, p1: Int)
java-static Int
resolveSizeAndState(p: Int, p1: Int, p2: Int)
Unit
Unit
saveAttributeDataForStyleable(
    p: Context!,
    p1: IntArray!,
    p2: AttributeSet!,
    p3: TypedArray!,
    p4: Int,
    p5: Int
)
Unit
Unit
scheduleDrawable(p: Drawable!, p1: Runnable!, p2: Long)
Unit
scrollBy(p: Int, p1: Int)
Unit
scrollTo(p: Int, p1: Int)
Unit
Unit
Unit
Unit
Unit
Unit
Unit
Unit
Unit
Unit
Unit
Unit
Unit
Unit
Unit
Unit
Unit
Unit
Unit
Unit
Unit
Unit

This function is deprecated.

Unit
Unit
Unit
Unit
Unit
Unit
Unit
Unit
Unit
Unit
Unit
Unit
Unit
Unit
Unit

This function is deprecated.

Unit

This function is deprecated.

Unit

This function is deprecated.

Unit
Unit
Unit
Unit
Unit
Unit
Unit
Unit
Unit
Unit
Unit
Unit
Unit
Unit
Unit
Unit
Unit
Unit
Unit
Unit
Unit
Unit
Unit
Unit
Unit
Unit
Unit
setId(p: Int)
Unit
Unit
Unit
Unit
Unit
Unit
Unit
Unit
Unit
Unit
setLayerType(p: Int, p1: Paint!)
Unit
Unit
Unit
Unit
setLeftTopRightBottom(p: Int, p1: Int, p2: Int, p3: Int)
Unit
Unit
Unit
Unit
Unit
Unit
Unit
Unit
Unit
Unit
Unit
Unit
Unit
Unit
Unit
Unit
Unit
Unit
Unit
Unit
Unit
Unit
Unit
Unit
Unit

This function is deprecated.

Unit
Unit
Unit
Unit
Unit
Unit
setPadding(p: Int, p1: Int, p2: Int, p3: Int)
Unit
setPaddingRelative(p: Int, p1: Int, p2: Int, p3: Int)
Unit
Unit
Unit
Unit
Unit
Unit
Unit
Unit
Unit
Unit
Unit
Unit
Unit
Unit
Unit
Unit
Unit
Unit
Unit
Unit
Unit
Unit
Unit
Unit
Unit
Unit
Unit
Unit
Unit
Unit
Unit
Unit
Unit
Unit
Unit
Unit

This function is deprecated.

Unit
setTag(p: Int, p1: Any!)
Unit
Unit
Unit
Unit
setTop(p: Int)
Unit
Unit
Unit
Unit
Unit
Unit
Unit
Unit
Unit
Unit
Unit
Unit
Unit
Unit
Unit

This function is deprecated.

Unit
Unit
setX(p: Float)
Unit
setY(p: Float)
Unit
setZ(p: Float)
Boolean
ActionMode!
Unit
Boolean
startDrag(p: ClipData!, p1: View.DragShadowBuilder!, p2: Any!, p3: Int)

This function is deprecated.

Boolean
Boolean
Unit
String!
Unit
Unit
Unit
Unit
Boolean
Boolean

This function is deprecated.

Boolean
From android.view.ViewGroup
Unit
Unit
Unit
addFocusables(p: ArrayList<View!>!, p1: Int, p2: Int)
Unit
Boolean
Unit
Unit
Boolean
Unit
attachLayoutAnimationParameters(
    p: View!,
    p1: ViewGroup.LayoutParams!,
    p2: Int,
    p3: Int
)
Unit
Unit
Boolean
Boolean
Unit
Unit
Unit
Unit
Unit
Unit
Unit
debug(p: Int)
Unit
Unit
Unit
WindowInsets!
Boolean
Unit
Unit
Unit
Boolean
Unit
Unit
Unit
Unit
Boolean
Boolean
Boolean
Boolean
Boolean
Boolean
Unit
Unit
Unit
Unit
Unit
Unit
dispatchScrollCaptureSearch(
    p: Rect!,
    p1: Point!,
    p2: Consumer<ScrollCaptureTarget!>!
)
Unit
Unit
Unit
Unit
Unit

This function is deprecated.

Unit
Boolean
Boolean
Boolean
Unit
Unit
Unit
Unit
WindowInsets!
WindowInsetsAnimation.Bounds!
Unit

This function is deprecated.

Unit
Boolean
drawChild(p: Canvas!, p1: View!, p2: Long)
Unit
Unit
View!
OnBackInvokedDispatcher!
Unit
View!
focusSearch(p: View!, p1: Int)
Unit
Boolean
ViewGroup.LayoutParams!
ViewGroup.LayoutParams!
CharSequence!
View!
Int
Int
java-static Int
getChildMeasureSpec(p: Int, p1: Int, p2: Int)
Boolean
Boolean
getChildVisibleRect(p: View!, p1: Rect!, p2: Point!)
Boolean
Boolean
Int
View!
LayoutAnimationController!
Animation.AnimationListener!
Int
LayoutTransition!
Int
ViewGroupOverlay!
Int

This function is deprecated.

Boolean
Boolean
Boolean
Int
Unit
invalidateChild(p: View!, p1: Rect!)

This function is deprecated.

ViewParent!

This function is deprecated.

Boolean

This function is deprecated.

Boolean

This function is deprecated.

Boolean
Boolean

This function is deprecated.

Boolean
Boolean
Boolean
Unit
Unit
layout(p: Int, p1: Int, p2: Int, p3: Int)
Unit
measureChild(p: View!, p1: Int, p2: Int)
Unit
measureChildWithMargins(p: View!, p1: Int, p2: Int, p3: Int, p4: Int)
Unit
measureChildren(p: Int, p1: Int)
Unit
Unit
Unit
Unit
IntArray<Int>!
Unit
Unit
Boolean
Boolean
Boolean
onNestedFling(p: View!, p1: Float, p2: Float, p3: Boolean)
Boolean
onNestedPreFling(p: View!, p1: Float, p2: Float)
Boolean
Unit
onNestedPreScroll(p: View!, p1: Int, p2: Int, p3: IntArray!)
Unit
onNestedScroll(p: View!, p1: Int, p2: Int, p3: Int, p4: Int)
Unit
onNestedScrollAccepted(p: View!, p1: View!, p2: Int)
Boolean
Boolean
PointerIcon!
Boolean
onStartNestedScroll(p: View!, p1: View!, p2: Int)
Unit
Unit
Unit
Unit
Unit
Unit
Unit
Unit
Unit
Unit
Unit
Unit
removeViews(p: Int, p1: Int)
Unit
Unit
Boolean
Unit
Boolean
requestFocus(p: Int, p1: Rect!)
Boolean
Unit
Boolean
Unit
Unit
Unit

This function is deprecated.

Unit

This function is deprecated.

Unit

This function is deprecated.

Unit
Unit

This function is deprecated.

Unit
Unit
Unit
Unit
Unit
Unit
Unit
Unit
Unit
Unit

This function is deprecated.

Unit
Unit
Unit
Unit
Unit
Boolean
Boolean
ActionMode!
Unit
Unit
Unit
Unit

Protected constructors

BaseAdView

protected BaseAdView(context: Context!, adViewType: Int)

Constructs a BaseAdView from code.

Parameters
context: Context!

The Context the BaseAdView is running in.

BaseAdView

protected BaseAdView(context: Context!, attrs: AttributeSet!, adViewType: Int)

Constructs a BaseAdView from an XML layout.

BaseAdView

protected BaseAdView(
    context: Context!,
    attrs: AttributeSet!,
    allowMultipleAdSizes: Boolean
)

Constructs a BaseAdView from an XML layout.

BaseAdView

protected BaseAdView(
    context: Context!,
    attrs: AttributeSet!,
    defStyle: Int,
    adViewType: Int
)

Constructs a BaseAdView from an XML layout.

BaseAdView

protected BaseAdView(
    context: Context!,
    attrs: AttributeSet!,
    defStyle: Int,
    adViewType: Int,
    allowMultipleAdSizes: Boolean
)

Constructs a BaseAdView from an XML layout.

Public functions

destroy

fun destroy(): Unit

Destroys the ad view. This method should be called in the parent Activity's onDestroy method. No other methods should be called on the ad view after destroy is called.

getAdListener

fun getAdListener(): AdListener!

Returns the AdListener for this ad view.

getAdSize

fun getAdSize(): AdSize?

Returns the size of the ad. Returns null if setAdSize hasn't been called yet.

ref com.google.android.gms.ads.R.styleable#AdsAttrs_adSize

getAdUnitId

fun getAdUnitId(): String!

Returns the ad unit ID.

ref com.google.android.gms.ads.R.styleable#AdsAttrs_adUnitId

getOnPaidEventListener

fun getOnPaidEventListener(): OnPaidEventListener?

Gets the OnPaidEventListener for this ad view.

getResponseInfo

fun getResponseInfo(): ResponseInfo?

Returns the ResponseInfo object for the loaded ad. Returns null until the ad successfully loads.

isCollapsible

fun isCollapsible(): Boolean

Returns true if the ad is a collapsible banner; returns false until an ad is loaded.

isLoading

fun isLoading(): Boolean

Returns true if the ad is loading.

loadAd

@RequiresPermission(value = Manifest.permission.INTERNET)
fun loadAd(adRequest: AdRequest!): Unit

Loads an ad.

Throws
java.lang.IllegalStateException

If the size of the ad or the ad unit ID have not been set.

pause

fun pause(): Unit

Pauses any extra processing associated with this ad view. This method should be called in the parent Activity's onPause method.

resume

fun resume(): Unit

Resumes an ad view after a previous call to pause. This method should be called in the parent Activity's onResume method.

setAdListener

fun setAdListener(adListener: AdListener!): Unit

Sets an AdListener for this ad view.

setAdSize

fun setAdSize(adSize: AdSize!): Unit

Sets the size of the ad.

ref com.google.android.gms.ads.R.styleable#AdsAttrs_adSize

Throws
java.lang.IllegalStateException

If the size of the ad was already set.

setAdUnitId

fun setAdUnitId(adUnitId: String!): Unit

Sets the ad unit ID.

ref com.google.android.gms.ads.R.styleable#AdsAttrs_adUnitId

Throws
java.lang.IllegalStateException

If the ad unit ID was already set.

setOnPaidEventListener

fun setOnPaidEventListener(listener: OnPaidEventListener?): Unit

Registers a callback to be invoked when this ad is estimated to have earned money.

Protected functions

onLayout

protected fun onLayout(changed: Boolean, left: Int, top: Int, right: Int, bottom: Int): Unit

onMeasure

protected fun onMeasure(widthMeasureSpec: Int, heightMeasureSpec: Int): Unit