NativeAdOptions

public final class NativeAdOptions

Used to configure native ad requests.

Summary

Nested types
@IntDef(value = [0, 1, 2, 3])
public annotation NativeAdOptions.AdChoicesPlacement

AdChoices icon placement.
public final class NativeAdOptions.Builder
@IntDef(value = [0, 1, 2, 3, 4])
public annotation NativeAdOptions.NativeMediaAspectRatio

Media aspect ratio.
@IntDef(value = [1, 2, 4, 8])
public annotation NativeAdOptions.SwipeGestureDirection

Custom click swipe gesture direction.

Constants
static final int
static final int
static final int
static final int
static final int

Any media aspect ratio.
static final int

Landscape media aspect ratio.
static final int

Portrait media aspect ratio.
static final int

Square media aspect ratio.
static final int

Unknown media aspect ratio.
static final int
static final int
static final int
static final int

The swipe direction is down.
static final int

The swipe direction is to the left.
static final int

The swipe direction is to the right.
static final int

The swipe direction is up.

Public methods
final int
final boolean
final int
final int
final boolean
final boolean
final boolean
final VideoOptions
final boolean

Returns true if multiple images are requested.
final boolean

Returns true if URLs will be returned for image assets instead of images themselves.

Constants

ADCHOICES_BOTTOM_LEFT

public static final int ADCHOICES_BOTTOM_LEFT = 3

ADCHOICES_BOTTOM_RIGHT

public static final int ADCHOICES_BOTTOM_RIGHT = 2

ADCHOICES_TOP_LEFT

public static final int ADCHOICES_TOP_LEFT = 0

ADCHOICES_TOP_RIGHT

public static final int ADCHOICES_TOP_RIGHT = 1

NATIVE_MEDIA_ASPECT_RATIO_ANY

public static final int NATIVE_MEDIA_ASPECT_RATIO_ANY = 1

Any media aspect ratio.

NATIVE_MEDIA_ASPECT_RATIO_LANDSCAPE

public static final int NATIVE_MEDIA_ASPECT_RATIO_LANDSCAPE = 2

Landscape media aspect ratio.

NATIVE_MEDIA_ASPECT_RATIO_PORTRAIT

public static final int NATIVE_MEDIA_ASPECT_RATIO_PORTRAIT = 3

Portrait media aspect ratio.

NATIVE_MEDIA_ASPECT_RATIO_SQUARE

public static final int NATIVE_MEDIA_ASPECT_RATIO_SQUARE = 4

Square media aspect ratio. This is not a strict 1:1 aspect ratio.

NATIVE_MEDIA_ASPECT_RATIO_UNKNOWN

public static final int NATIVE_MEDIA_ASPECT_RATIO_UNKNOWN = 0

Unknown media aspect ratio.

ORIENTATION_ANY

public static final int ORIENTATION_ANY = 0

ORIENTATION_LANDSCAPE

public static final int ORIENTATION_LANDSCAPE = 2

ORIENTATION_PORTRAIT

public static final int ORIENTATION_PORTRAIT = 1

SWIPE_GESTURE_DIRECTION_DOWN

public static final int SWIPE_GESTURE_DIRECTION_DOWN = 8

The swipe direction is down.

SWIPE_GESTURE_DIRECTION_LEFT

public static final int SWIPE_GESTURE_DIRECTION_LEFT = 2

The swipe direction is to the left.

SWIPE_GESTURE_DIRECTION_RIGHT

public static final int SWIPE_GESTURE_DIRECTION_RIGHT = 1

The swipe direction is to the right.

SWIPE_GESTURE_DIRECTION_UP

public static final int SWIPE_GESTURE_DIRECTION_UP = 4

The swipe direction is up.

Public methods

getAdChoicesPlacement

public final int getAdChoicesPlacement()

getCustomClickGestureAllowTaps

public final boolean getCustomClickGestureAllowTaps()

getCustomClickGestureDirection

public final int getCustomClickGestureDirection()

getMediaAspectRatio

public final int getMediaAspectRatio()

getShouldRequestMultipleImages

public final boolean getShouldRequestMultipleImages()

getShouldReturnUrls

public final boolean getShouldReturnUrls()

getUseCustomMuteThisAd

public final boolean getUseCustomMuteThisAd()

getVideoOptions

public final VideoOptions getVideoOptions()

shouldRequestMultipleImages

public final boolean shouldRequestMultipleImages()

Returns true if multiple images are requested.

shouldReturnUrlsForImageAssets

public final boolean shouldReturnUrlsForImageAssets()

Returns true if URLs will be returned for image assets instead of images themselves.