public final class AdSize extends Object

The size of a banner ad.

Constant Summary

int AUTO_HEIGHT Constant that will cause the height of the ad to scale based on the height of the device in the current orientation.
int FULL_WIDTH Constant that will cause the width of the ad to match the width of the device in the current orientation.

Field Summary

public static final AdSize BANNER Mobile Marketing Association (MMA) banner ad size (320x50 density-independent pixels).
public static final AdSize FLUID A dynamically sized banner that matches its parent's width and expands/contracts its height to match the ad's content after loading completes.
public static final AdSize FULL_BANNER Interactive Advertising Bureau (IAB) full banner ad size (468x60 density-independent pixels).
public static final AdSize INVALID An invalid AdSize that will cause the ad request to fail immediately.
public static final AdSize LARGE_BANNER Large banner ad size (320x100 density-independent pixels).
public static final AdSize LEADERBOARD Interactive Advertising Bureau (IAB) leaderboard ad size (728x90 density-independent pixels).
public static final AdSize MEDIUM_RECTANGLE Interactive Advertising Bureau (IAB) medium rectangle ad size (300x250 density-independent pixels).
public static final AdSize SEARCH A special variant of FLUID to be set on SearchAdView when loading a DynamicHeightSearchAdRequest.
public static final AdSize SMART_BANNER This field is deprecated. Use getCurrentOrientationAnchoredAdaptiveBannerAdSize(Context, int) instead.
public static final AdSize WIDE_SKYSCRAPER IAB wide skyscraper ad size (160x600 density-independent pixels).

Public Constructor Summary

AdSize(int width, int height)
Creates a new AdSize.

Public Method Summary

boolean
equals(Object other)
Compares this AdSize with the specified object and indicates if they are equal.
static AdSize
getCurrentOrientationAnchoredAdaptiveBannerAdSize(Context context, int width)
Returns an AdSize with the given width and a Google-optimized height to create a banner ad.
static AdSize
getCurrentOrientationInlineAdaptiveBannerAdSize(Context context, int width)
Returns an AdSize with the given width and a height that is always 0.
static AdSize
getCurrentOrientationInterscrollerAdSize(Context context, int width)
This method is deprecated. No replacement.
int
getHeight()
Returns the height of this AdSize in density-independent pixels.
int
getHeightInPixels(Context context)
Returns the height of this AdSize in physical pixels.
static AdSize
getInlineAdaptiveBannerAdSize(int width, int maxHeight)
Returns an AdSize with the given width and a height that is always 0.
static AdSize
getLandscapeAnchoredAdaptiveBannerAdSize(Context context, int width)
Returns an AdSize with the given width and a Google-optimized height to create a banner ad.
static AdSize
getLandscapeInlineAdaptiveBannerAdSize(Context context, int width)
Returns an AdSize with the given width and a height that is always 0.
static AdSize
getLandscapeInterscrollerAdSize(Context context, int width)
This method is deprecated. No replacement.
static AdSize
getPortraitAnchoredAdaptiveBannerAdSize(Context context, int width)
Returns an AdSize with the given width and a Google-optimized height to create a banner ad.
static AdSize
getPortraitInlineAdaptiveBannerAdSize(Context context, int width)
Returns an AdSize with the given width and a height that is always 0.
static AdSize
getPortraitInterscrollerAdSize(Context context, int width)
This method is deprecated. No replacement.
int
getWidth()
Returns the width of this AdSize in density-independent pixels.
int
getWidthInPixels(Context context)
Returns the width of this AdSize in physical pixels.
int
hashCode()
boolean
isAutoHeight()
Returns whether this AdSize is auto-height.
boolean
isFluid()
Returns whether this AdSize is of fluid size or not.
boolean
isFullWidth()
Returns whether this AdSize is full-width.
String
toString()

Inherited Method Summary

Constants

public static final int AUTO_HEIGHT

Constant that will cause the height of the ad to scale based on the height of the device in the current orientation. An AUTO_HEIGHT ad determines its height during initialization of the AdView and never changes after that.

Constant Value: -2

public static final int FULL_WIDTH

Constant that will cause the width of the ad to match the width of the device in the current orientation. A FULL_WIDTH ad determines its width during initialization of the AdView and never changes after that.

Constant Value: -1

Fields

public static final AdSize BANNER

Mobile Marketing Association (MMA) banner ad size (320x50 density-independent pixels).

public static final AdSize FLUID

A dynamically sized banner that matches its parent's width and expands/contracts its height to match the ad's content after loading completes.

public static final AdSize FULL_BANNER

Interactive Advertising Bureau (IAB) full banner ad size (468x60 density-independent pixels).

public static final AdSize INVALID

An invalid AdSize that will cause the ad request to fail immediately.

public static final AdSize LARGE_BANNER

Large banner ad size (320x100 density-independent pixels).

public static final AdSize LEADERBOARD

Interactive Advertising Bureau (IAB) leaderboard ad size (728x90 density-independent pixels).

public static final AdSize MEDIUM_RECTANGLE

Interactive Advertising Bureau (IAB) medium rectangle ad size (300x250 density-independent pixels).

public static final AdSize SEARCH

A special variant of FLUID to be set on SearchAdView when loading a DynamicHeightSearchAdRequest.

public static final AdSize SMART_BANNER

This field is deprecated.
Use getCurrentOrientationAnchoredAdaptiveBannerAdSize(Context, int) instead.

A dynamically sized banner that is full-width and auto-height.

public static final AdSize WIDE_SKYSCRAPER

IAB wide skyscraper ad size (160x600 density-independent pixels). This size is currently not supported by the Google Mobile Ads network; this is intended for mediation ad networks only.

Public Constructors

public AdSize (int width, int height)

Creates a new AdSize.

Parameters
width The width of the ad in density-independent pixels.
height The height of the ad in density-independent pixels.
Throws
IllegalArgumentException If the width or height is negative.

Public Methods

public boolean equals (Object other)

Compares this AdSize with the specified object and indicates if they are equal.

public static AdSize getCurrentOrientationAnchoredAdaptiveBannerAdSize (Context context, int width)

Returns an AdSize with the given width and a Google-optimized height to create a banner ad. The size returned will have an aspect ratio similar to AdSize, suitable for anchoring near the top or bottom of your app. The height will never be larger than 15% of the device's current orientation height and never smaller than 50px. This function always returns the same height for any width / device combination. If the context is null or the device height cannot be determined from the context, INVALID is returned.

Returns
  • An AdSize object. Returns INVALID if the context is null or the device height cannot be determined from the context.

public static AdSize getCurrentOrientationInlineAdaptiveBannerAdSize (Context context, int width)

Returns an AdSize with the given width and a height that is always 0. This ad size allows Google servers to choose an optimal ad size with a height less than or equal to the height of the screen in the requested orientation. The exact size of the ad returned can be retrieved by calling BaseAdView.getAdSize() inside the AdListener.onAdLoaded() callback. This ad size is most suitable for ads intended to be displayed inside scrollable content.

public static AdSize getCurrentOrientationInterscrollerAdSize (Context context, int width)

This method is deprecated.
No replacement.

Returns an interscroller AdSize with the given width and a height that is always 0. This ad size allows Google servers to choose an optimal ad height less than or equal to the device's height of current orientation. The exact size of the ad returned can be retrieved by calling BaseAdView.getAdSize() inside the AdListener.onAdLoaded() callback. This ad size is intended for ads displayed inside scrollable content and below the fold.

public int getHeight ()

Returns the height of this AdSize in density-independent pixels.

public int getHeightInPixels (Context context)

Returns the height of this AdSize in physical pixels. For fluid size, it returns -1.

public static AdSize getInlineAdaptiveBannerAdSize (int width, int maxHeight)

Returns an AdSize with the given width and a height that is always 0. This ad size allows Google servers to choose an optimal ad size with a height less than or equal to the max height given in the maxHeight parameter. The exact size of the ad returned can be retrieved by calling BaseAdView.getAdSize() inside the AdListener.onAdLoaded() callback. This ad size is most suitable for ads intended to be displayed inside scrollable content.

Parameters
width
maxHeight The maximum height that a loaded ad will have. Must be at least 32 dp, but a maxHeight of 50 dp or higher is recommended.

public static AdSize getLandscapeAnchoredAdaptiveBannerAdSize (Context context, int width)

Returns an AdSize with the given width and a Google-optimized height to create a banner ad. The size returned will have an aspect ratio similar to BANNER, suitable for anchoring near the top or bottom of your app. The height will never be larger than 15% of the device's height in landscape mode and never smaller than 50px. This function always returns the same height for any width / device combination. If the context is null or the device height cannot be determined from the context, INVALID is returned.

Returns
  • An AdSize object. Returns INVALID if the context is null or the device height cannot be determined from the context.

public static AdSize getLandscapeInlineAdaptiveBannerAdSize (Context context, int width)

Returns an AdSize with the given width and a height that is always 0. This ad size allows Google servers to choose an optimal ad size with a height less than or equal to the height of the screen in landscape orientation. The exact size of the ad returned can be retrieved by calling BaseAdView.getAdSize() inside the AdListener.onAdLoaded() callback. This ad size is most suitable for ads intended to be displayed inside scrollable content.

public static AdSize getLandscapeInterscrollerAdSize (Context context, int width)

This method is deprecated.
No replacement.

Returns an interscroller AdSize with the given width and a height that is always 0. This ad size allows Google servers to choose an optimal ad height less than or equal to the device's landscape height. The exact size of the ad returned can be retrieved by calling BaseAdView.getAdSize() inside the AdListener.onAdLoaded() callback. This ad size is intended for ads displayed inside scrollable content and below the fold.

public static AdSize getPortraitAnchoredAdaptiveBannerAdSize (Context context, int width)

Returns an AdSize with the given width and a Google-optimized height to create a banner ad. The size returned will have an aspect ratio similar to BANNER, suitable for anchoring near the top or bottom of your app. The height will never be larger than 15% of the device's portrait height and never smaller than 50px. This function always returns the same height for any width / device combination.

Returns
  • An AdSize object. Returns INVALID if the context is null or the device height cannot be determined from the context.

public static AdSize getPortraitInlineAdaptiveBannerAdSize (Context context, int width)

Returns an AdSize with the given width and a height that is always 0. This ad size allows Google servers to choose an optimal ad size less than or equal to the height of the screen in portrait orientation. The exact size of the ad returned can be retrieved by calling BaseAdView.getAdSize() inside the AdListener.onAdLoaded() callback. This ad size is most suitable for ads intended to be displayed inside scrollable content.

public static AdSize getPortraitInterscrollerAdSize (Context context, int width)

This method is deprecated.
No replacement.

Returns an interscroller AdSize with the given width and a height that is always 0. This ad size allows Google servers to choose an optimal ad height less than or equal to the device's portrait height. The exact size of the ad returned can be retrieved by calling BaseAdView.getAdSize() inside the AdListener.onAdLoaded() callback. This ad size is intended for ads displayed inside scrollable content and below the fold.

public int getWidth ()

Returns the width of this AdSize in density-independent pixels.

public int getWidthInPixels (Context context)

Returns the width of this AdSize in physical pixels. For fluid size, it returns -1.

public int hashCode ()

public boolean isAutoHeight ()

Returns whether this AdSize is auto-height.

public boolean isFluid ()

Returns whether this AdSize is of fluid size or not.

public boolean isFullWidth ()

Returns whether this AdSize is full-width.

public String toString ()