BaseAdView

public abstract class BaseAdView 
extends 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, int adViewType)

Constructs a BaseAdView from code.

BaseAdView ( Context  context,  AttributeSet  attrs, int adViewType)

Constructs a BaseAdView from an XML layout.

BaseAdView (
Context  context,
AttributeSet  attrs,
    boolean allowMultipleAdSizes
)

Constructs a BaseAdView from an XML layout.

BaseAdView (
Context  context,
AttributeSet  attrs,
    int defStyle,
    int adViewType
)

Constructs a BaseAdView from an XML layout.

BaseAdView (
Context  context,
AttributeSet  attrs,
    int defStyle,
    int adViewType,
    boolean allowMultipleAdSizes
)

Constructs a BaseAdView from an XML layout.

Public methods

void
destroy ()

Destroys the ad view.

AdListener

Returns the AdListener for this ad view.

@ Nullable AdSize

Returns the size of the ad.

String

Returns the ad unit ID.

@ Nullable OnPaidEventListener

Gets the OnPaidEventListener for this ad view.

long

Gets the placement ID for this BaseAdView .

@ Nullable 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.

void
@ RequiresPermission (value = Manifest.permission.INTERNET)
loadAd ( AdRequest  adRequest)

Loads an ad.

void
pause ()

Pauses any extra processing associated with this ad view.

void
resume ()

Resumes an ad view after a previous call to pause .

void
setAdListener ( AdListener  adListener)

Sets an AdListener for this ad view.

void
setAdSize ( AdSize  adSize)

Sets the size of the ad.

void
setAdUnitId ( String  adUnitId)

Sets the ad unit ID.

void

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

void
setPlacementId (long placementId)

Sets a placement ID for this ad view.

Protected methods

void
onLayout (boolean changed, int left, int top, int right, int bottom)
void
onMeasure (int widthMeasureSpec, int heightMeasureSpec)

Inherited Constants

From android.view.View
static final int
static final int
static final int
static final int
static final int
static final int
static final Property < View Float >
static final int
static final String
AUTOFILL_HINT_CREDIT_CARD_EXPIRATION_DATE = "creditCardExpirationDate"
static final String
AUTOFILL_HINT_CREDIT_CARD_EXPIRATION_DAY = "creditCardExpirationDay"
static final String
AUTOFILL_HINT_CREDIT_CARD_EXPIRATION_MONTH = "creditCardExpirationMonth"
static final String
AUTOFILL_HINT_CREDIT_CARD_EXPIRATION_YEAR = "creditCardExpirationYear"
static final String
AUTOFILL_HINT_CREDIT_CARD_NUMBER = "creditCardNumber"
static final String
AUTOFILL_HINT_CREDIT_CARD_SECURITY_CODE = "creditCardSecurityCode"
static final String
AUTOFILL_HINT_EMAIL_ADDRESS = "emailAddress"
static final String
static final String
AUTOFILL_HINT_PASSWORD = "password"
static final String
static final String
AUTOFILL_HINT_POSTAL_ADDRESS = "postalAddress"
static final String
AUTOFILL_HINT_POSTAL_CODE = "postalCode"
static final String
AUTOFILL_HINT_USERNAME = "username"
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int

This field is deprecated.

static final int

This field is deprecated.

static final int

This field is deprecated.

static final int[]
static final int[]
static final int[]
static final int[]
static final int[]
static final int[]
static final int[]
static final int[]
static final int[]
static final int
static final int
static final int
FOCUSABLE = 1
static final int
static final int
static final int
static final int[]
static final int[]
static final int[]
static final int[]
static final int
static final int
FOCUS_DOWN = 130
static final int
static final int
FOCUS_LEFT = 17
static final int
static final int
FOCUS_UP = 33
static final int
GONE = 8
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
INVISIBLE = 4
static final int
KEEP_SCREEN_ON = 67108864
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
MEASURED_SIZE_MASK = 16777215
static final int
MEASURED_STATE_MASK = -16777216
static final int
static final int
static final int
NO_ID = -1
static final int
static final int
static final int
static final int[]
static final int[]
static final int[]
static final int[]
static final int[]
static final int[]
static final int[]
static final int[]
static final int[]
static final int[]
static final int[]
static final int[]
static final int[]
static final int[]
static final int[]
static final int[]
static final int
static final int
static final int
static final int
static final float
static final float
static final float
static final float
static final float
static final Property < View Float >
static final Property < View Float >
static final Property < View Float >
static final Property < View Float >
static final Property < View Float >
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int[]
static final int[]
static final int
SOUND_EFFECTS_ENABLED = 134217728
static final int

This field is deprecated.

static final int

This field is deprecated.

static final int

This field is deprecated.

static final int

This field is deprecated.

static final int

This field is deprecated.

static final int

This field is deprecated.

static final int

This field is deprecated.

static final int

This field is deprecated.

static final int

This field is deprecated.

static final int

This field is deprecated.

static final int

This field is deprecated.

static final int

This field is deprecated.

static final int

This field is deprecated.

static final int

This field is deprecated.

static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final Property < View Float >
static final Property < View Float >
static final Property < View Float >
static final String
VIEW_LOG_TAG = "View"
static final int
VISIBLE = 0
static final int[]
static final Property < View Float >
X
static final Property < View Float >
Y
static final Property < View Float >
Z
From android.view.ViewGroup
static final int
static final int
static final int
static final int
static final int
static final int
static final int

This field is deprecated.

static final int

This field is deprecated.

static final int

This field is deprecated.

static final int

This field is deprecated.

Inherited methods

From android.view.View
void
void
void
ViewPropertyAnimator
animate ()
void

This method is deprecated.

void
boolean
void
void

This method is deprecated.

void
boolean
boolean
boolean
boolean
boolean
boolean
final void
void
final void
boolean
void
void
void
static int
combineMeasuredStates (int p, int p1)
int
int
int
void
WindowInsets
int
int
int
AccessibilityNodeInfo
void
void

This method is deprecated.

boolean
boolean
dispatchNestedFling (float p, float p1, boolean p2)
boolean
dispatchNestedPreFling (float p, float p1)
boolean
boolean
dispatchNestedPreScroll (int p, int p1, int[] p2, int[] p3)
boolean
dispatchNestedScroll (int p, int p1, int p2, int p3, int[] p4)
boolean
void
draw ( Canvas  p)
void
drawableHotspotChanged (float p, float p1)
final OnBackInvokedDispatcher
final T
<T extends  View > findViewById (int p)
final T
<T extends  View > findViewWithTag ( Object  p)
boolean

This method is deprecated.

void
void
void
static int
View.AccessibilityDelegate
int
AccessibilityNodeProvider
CharSequence
int
int
String
String
float
Animation
Matrix
IBinder
int[]
Map < Integer Integer >
String[]
final AutofillId
int
AutofillValue
Drawable
BlendMode
ColorStateList
PorterDuff.Mode
int
final int
float
int
float
Rect
boolean
final boolean
final ContentCaptureSession
CharSequence
final int
final Context
ContextMenu.ContextMenuInfo
final boolean
static int
getDefaultSize (int p, int p1)
Display
final int[]
Bitmap

This method is deprecated.

int

This method is deprecated.

int

This method is deprecated.

void
long
float
int
boolean
boolean
int
ArrayList < View >
getFocusables (int p)
void
Drawable
int
BlendMode
ColorStateList
PorterDuff.Mode
float
final boolean
Handler
float
float
float
float
int
Runnable
final boolean
final int
void
getHitRect ( Rect  p)
int
int
Drawable
Drawable
int
getId ()
int
int
int
boolean
KeyEvent.DispatcherState
int
int
int
ViewGroup.LayoutParams
final int
getLeft ()
float
int
final boolean
void
void
getLocationInWindow (int[] p)
void
getLocationOnScreen (int[] p)
Matrix
final int
final int
final int
final int
final int
int
int
int
int
int
int
int
int
View.OnFocusChangeListener
int
ViewOutlineProvider
int
int
ViewOverlay
int
int
int
int
int
int
final ViewParent
ViewParent
final OutcomeReceiver < GetCredentialResponse GetCredentialException >
final GetCredentialRequest
float
float
PointerIcon
final List < Rect >
String[]
float
Resources
final boolean
final int
float
int
AttachedSurfaceControl
View
WindowInsets
float
float
float
float
float
int
int
int
int
int
int
final int
final int
int
int
final CharSequence
StateListAnimator
int
int
CharSequence
List < Rect >
int

This method is deprecated.

Object
getTag ()
int
int
CharSequence
final int
getTop ()
float
int
TouchDelegate
ArrayList < View >
float
String
float
float
float
long
int
int
Drawable
Drawable
int
ViewTranslationResponse
ViewTreeObserver
int
final int
int
WindowId
WindowInsetsController
int

This method is deprecated.

IBinder
int
void
float
getX ()
float
getY ()
float
getZ ()
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
static View
inflate ( Context  p, int p1,  ViewGroup  p2)
void
void
void
boolean
boolean
boolean
boolean
boolean
boolean
boolean
final boolean
boolean
boolean
boolean
isDirty ()
boolean

This method is deprecated.

boolean
boolean
final boolean
final boolean
boolean
final boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
final boolean
final boolean
boolean
boolean
boolean
final boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
final boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
final boolean
boolean
isShown ()
boolean
final boolean
boolean
boolean
boolean
boolean
boolean
View
final void
measure (int p, int p1)
static int[]
mergeDrawableStates (int[] p, int[] p1)
void
void
void
void
WindowInsets
void
boolean
boolean
void
void
InputConnection
void
void
onCreateVirtualViewTranslationRequests (
    long[] p,
    int[] p1,
Consumer < ViewTranslationRequest > p2
)
void
onDisplayHint (int p)
boolean
void
onDraw ( Canvas  p)
void
final void
boolean
void
void
void
onFocusChanged (boolean p, int p1,  Rect  p2)
boolean
void
onHoverChanged (boolean p)
boolean
void
void
boolean
onKeyDown (int p,  KeyEvent  p1)
boolean
onKeyLongPress (int p,  KeyEvent  p1)
boolean
onKeyMultiple (int p, int p1,  KeyEvent  p2)
boolean
onKeyPreIme (int p,  KeyEvent  p1)
boolean
onKeyShortcut (int p,  KeyEvent  p1)
boolean
onKeyUp (int p,  KeyEvent  p1)
void
onOverScrolled (int p, int p1, boolean p2, boolean p3)
void
onPointerCaptureChange (boolean p)
void
void
void
void
void
void
ContentInfo
void
void
Parcelable
void
void
void
onScrollChanged (int p, int p1, int p2, int p3)
boolean
onSetAlpha (int p)
void
onSizeChanged (int p, int p1, int p2, int p3)
void
boolean
boolean
void
void
void
onVisibilityAggregated (boolean p)
void
onVisibilityChanged ( View  p, int p1)
void
onWindowFocusChanged (boolean p)
void

This method is deprecated.

void
boolean
overScrollBy (
    int p,
    int p1,
    int p2,
    int p3,
    int p4,
    int p5,
    int p6,
    int p7,
    boolean p8
)
boolean
boolean
boolean
boolean
boolean
ContentInfo
void
playSoundEffect (int p)
boolean
post ( Runnable  p)
boolean
postDelayed ( Runnable  p, long p1)
void
void
void
void
void
postOnAnimationDelayed ( Runnable  p, long p1)
void
void
boolean
void
void
void
void
void
void

This method is deprecated.

final boolean
void
void
boolean
final void
final T
<T extends  View > requireViewById (int p)
void
static int
resolveSize (int p, int p1)
static int
resolveSizeAndState (int p, int p1, int p2)
void
final void
saveAttributeDataForStyleable (
Context  p,
    int[] p1,
AttributeSet  p2,
TypedArray  p3,
    int p4,
    int p5
)
void
void
scheduleDrawable ( Drawable  p,  Runnable  p1, long p2)
void
scrollBy (int p, int p1)
void
scrollTo (int p, int p1)
void
void
void
void
void
void
void
void
void
void
setActivated (boolean p)
void
void
void
void
setAlpha (float p)
void
void
void
void
setAutofillHints (String[] p)
void
void
void
void

This method is deprecated.

void
void
void
void
final void
setBottom (int p)
void
setCameraDistance (float p)
void
setClickable (boolean p)
void
void
setClipToOutline (boolean p)
void
void
final void
void
setContextClickable (boolean p)
void
void

This method is deprecated.

void
setDrawingCacheEnabled (boolean p)

This method is deprecated.

void

This method is deprecated.

void
void
setElevation (float p)
void
setEnabled (boolean p)
void
void
void
setFitsSystemWindows (boolean p)
void
setFocusable (boolean p)
void
void
setFocusedByDefault (boolean p)
void
setForceDarkAllowed (boolean p)
void
void
void
void
void
void
void
setHandwritingBoundsOffsets (float p, float p1, float p2, float p3)
void
void
void
void
setHasTransientState (boolean p)
void
void
void
void
void
setHovered (boolean p)
void
setId (int p)
void
void
void
void
setIsCredential (boolean p)
void
void
setKeepScreenOn (boolean p)
void
void
setLabelFor (int p)
void
void
setLayerType (int p,  Paint  p1)
void
void
final void
setLeft (int p)
final void
setLeftTopRightBottom (int p, int p1, int p2, int p3)
void
setLongClickable (boolean p)
final void
setMeasuredDimension (int p, int p1)
void
setMinimumHeight (int p)
void
setMinimumWidth (int p)
void
void
void
void
void
void
void
setNextFocusUpId (int p)
void
void
void
void
void
void
void
void
void
void
void
void
void
void

This method is deprecated.

void
void
void
void
void
void
setPadding (int p, int p1, int p2, int p3)
void
setPaddingRelative (int p, int p1, int p2, int p3)
void
void
setPivotX (float p)
void
setPivotY (float p)
void
final void
setPreferKeepClear (boolean p)
final void
void
setPressed (boolean p)
void
final void
setRevealOnFocusHint (boolean p)
final void
setRight (int p)
void
setRotation (float p)
void
setRotationX (float p)
void
setRotationY (float p)
void
setSaveEnabled (boolean p)
void
void
setScaleX (float p)
void
setScaleY (float p)
void
void
void
void
setScrollBarSize (int p)
void
final void
void
void
setScrollContainer (boolean p)
void
void
setScrollX (int p)
void
setScrollY (int p)
void
void
setSelected (boolean p)
void
setSoundEffectsEnabled (boolean p)
void
void
void
void
void

This method is deprecated.

void
setTag (int p,  Object  p1)
void
setTextAlignment (int p)
void
setTextDirection (int p)
void
final void
setTop (int p)
void
void
setTransitionAlpha (float p)
final void
void
void
setTranslationX (float p)
void
setTranslationY (float p)
void
setTranslationZ (float p)
void
void
void
void
void
void
void
setVisibility (int p)
void
setWillNotCacheDrawing (boolean p)

This method is deprecated.

void
setWillNotDraw (boolean p)
void
setX (float p)
void
setY (float p)
void
setZ (float p)
boolean
ActionMode
void
final boolean
startDrag ( ClipData  p,  View.DragShadowBuilder  p1,  Object  p2, int p3)

This method is deprecated.

final boolean
startDragAndDrop (
ClipData  p,
View.DragShadowBuilder  p1,
Object  p2,
    int p3
)
boolean
void
String
void
void
void
final void
boolean
boolean

This method is deprecated.

boolean
From android.view.ViewGroup
void
void
void
addFocusables ( ArrayList < View > p, int p1, int p2)
void
boolean
void
void
addView ( View  p)
boolean
addViewInLayout ( View  p, int p1,  ViewGroup.LayoutParams  p2)
void
attachLayoutAnimationParameters (
View  p,
ViewGroup.LayoutParams  p1,
    int p2,
    int p3
)
void
void
boolean
boolean
void
void
childHasTransientStateChanged ( View  p, boolean p1)
void
void
void
void
void
debug (int p)
void
void
void
detachViewsFromParent (int p, int p1)
WindowInsets
boolean
void
void
void
boolean
void
void
dispatchDrawableHotspotChanged (float p, float p1)
void
void
boolean
boolean
boolean
boolean
boolean
boolean
void
void
void
void
void
void
void
dispatchSetActivated (boolean p)
void
dispatchSetPressed (boolean p)
void
dispatchSetSelected (boolean p)
void
void

This method is deprecated.

void
boolean
boolean
boolean
dispatchUnhandledMove ( View  p, int p1)
void
dispatchVisibilityChanged ( View  p, int p1)
void
void
void
WindowInsets
WindowInsetsAnimation.Bounds
void

This method is deprecated.

void
boolean
drawChild ( Canvas  p,  View  p1, long p2)
void
void
View
OnBackInvokedDispatcher
void
findViewsWithText ( ArrayList < View > p,  CharSequence  p1, int p2)
View
focusSearch ( View  p, int p1)
void
boolean
ViewGroup.LayoutParams
ViewGroup.LayoutParams
CharSequence
View
getChildAt (int p)
int
final int
static int
getChildMeasureSpec (int p, int p1, int p2)
boolean
boolean
getChildVisibleRect ( View  p,  Rect  p1,  Point  p2)
boolean
boolean
int
View
LayoutAnimationController
Animation.AnimationListener
int
LayoutTransition
int
ViewGroupOverlay
int

This method is deprecated.

boolean
boolean
boolean
int
final void
invalidateChild ( View  p,  Rect  p1)

This method is deprecated.

ViewParent
invalidateChildInParent (int[] p,  Rect  p1)

This method is deprecated.

boolean

This method is deprecated.

boolean

This method is deprecated.

boolean
boolean

This method is deprecated.

boolean
boolean
boolean
void
final void
layout (int p, int p1, int p2, int p3)
void
measureChild ( View  p, int p1, int p2)
void
measureChildWithMargins ( View  p, int p1, int p2, int p3, int p4)
void
measureChildren (int p, int p1)
void
final void
final void
void
int[]
void
void
boolean
boolean
boolean
onNestedFling ( View  p, float p1, float p2, boolean p3)
boolean
onNestedPreFling ( View  p, float p1, float p2)
boolean
void
onNestedPreScroll ( View  p, int p1, int p2, int[] p3)
void
onNestedScroll ( View  p, int p1, int p2, int p3, int p4)
void
onNestedScrollAccepted ( View  p,  View  p1, int p2)
boolean
boolean
PointerIcon
boolean
onStartNestedScroll ( View  p,  View  p1, int p2)
void
void
onViewAdded ( View  p)
void
void
propagateRequestedFrameRate (float p, boolean p1)
void
void
void
void
removeDetachedView ( View  p, boolean p1)
void
removeView ( View  p)
void
removeViewAt (int p)
void
void
removeViews (int p, int p1)
void
removeViewsInLayout (int p, int p1)
void
requestChildFocus ( View  p,  View  p1)
boolean
requestChildRectangleOnScreen ( View  p,  Rect  p1, boolean p2)
void
boolean
requestFocus (int p,  Rect  p1)
boolean
void
boolean
void
void
void

This method is deprecated.

void

This method is deprecated.

void

This method is deprecated.

void
void

This method is deprecated.

void
setClipChildren (boolean p)
void
setClipToPadding (boolean p)
void
void
void
void
setLayoutMode (int p)
void
void
void
void

This method is deprecated.

void
void
void
void
setTransitionGroup (boolean p)
void
boolean
boolean
ActionMode
void
void
void
suppressLayout (boolean p)
void

Protected constructors

BaseAdView

protected  BaseAdView 
( Context 
 context, int adViewType)

Constructs a BaseAdView from code.

Parameters
Context  context

The Context the BaseAdView is running in.

BaseAdView

protected  BaseAdView 
( Context 
 context,  AttributeSet 
 attrs, int adViewType)

Constructs a BaseAdView from an XML layout.

BaseAdView

protected  BaseAdView 
(
Context  context,
AttributeSet  attrs,
    boolean allowMultipleAdSizes
)

Constructs a BaseAdView from an XML layout.

BaseAdView

protected  BaseAdView 
(
Context  context,
AttributeSet  attrs,
    int defStyle,
    int adViewType
)

Constructs a BaseAdView from an XML layout.

BaseAdView

protected  BaseAdView 
(
Context  context,
AttributeSet  attrs,
    int defStyle,
    int adViewType,
    boolean allowMultipleAdSizes
)

Constructs a BaseAdView from an XML layout.

Public methods

destroy

public void  destroy 
()

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

public  AdListener 
 getAdListener 
()

Returns the AdListener for this ad view.

getAdSize

public @ Nullable 
 AdSize 
 getAdSize 
()

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

public  String 
 getAdUnitId 
()

Returns the ad unit ID.

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

getOnPaidEventListener

public @ Nullable 
 OnPaidEventListener 
 getOnPaidEventListener 
()

Gets the OnPaidEventListener for this ad view.

getPlacementId

public long  getPlacementId 
()

Gets the placement ID for this BaseAdView .

getResponseInfo

public @ Nullable 
 ResponseInfo 
 getResponseInfo 
()

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

isCollapsible

public boolean  isCollapsible 
()

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

isLoading

public boolean  isLoading 
()

Returns true if the ad is loading.

loadAd

@ RequiresPermission 
(value = Manifest.permission.INTERNET)
public void  loadAd ( AdRequest  adRequest)

Loads an ad.

Throws
java.lang.IllegalStateException

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

pause

public void  pause 
()

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

resume

public void  resume 
()

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

setAdListener

public void  setAdListener 
( AdListener 
 adListener)

Sets an AdListener for this ad view.

setAdSize

public void  setAdSize 
( AdSize 
 adSize)

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

public void  setAdUnitId 
( String 
 adUnitId)

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

public void  setOnPaidEventListener 
(@ Nullable 
 OnPaidEventListener 
 listener)

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

setPlacementId

public void  setPlacementId 
(long placementId)

Sets a placement ID for this ad view.

To ensure this placement ID is included in reporting, call this method before displaying the ad.

Parameters
long placementId

A long integer provided by the AdMob UI for the configured placement.

Protected methods

onLayout

protected void  onLayout 
(boolean changed, int left, int top, int right, int bottom)

onMeasure

protected void  onMeasure 
(int widthMeasureSpec, int heightMeasureSpec)
Create a Mobile Website
View Site in Mobile | Classic
Share by: