NativeAdOptions.Builder

Kotlin |Java

class NativeAdOptions.Builder

Summary

Public constructors
`Builder()`

Public functions
`NativeAdOptions`	`build()` Constructs a `NativeAdOptions` object with the specified attributes.
`NativeAdOptions.Builder`	`@CanIgnoreReturnValue setAdChoicesPlacement( @NativeAdOptions.AdChoicesPlacement adChoicesPlacement: Int )` Sets the placement of AdChoices icon (if present).
`NativeAdOptions.Builder`	`@CanIgnoreReturnValue setImageOrientation(orientation: Int)`
`NativeAdOptions.Builder`	`@CanIgnoreReturnValue setMediaAspectRatio( @NativeAdOptions.NativeMediaAspectRatio aspectRatio: Int )`
`NativeAdOptions.Builder`	`@CanIgnoreReturnValue setRequestCustomMuteThisAd(requestCustomMuteThisAd: Boolean)` Set this boolean to `true` to request a custom implementation for the Mute This Ad feature.
`NativeAdOptions.Builder`	`@CanIgnoreReturnValue setRequestMultipleImages(shouldRequestMultipleImages: Boolean)` Sets whether multiple images should be requested or not.
`NativeAdOptions.Builder`	`@CanIgnoreReturnValue setReturnUrlsForImageAssets(shouldReturnUrls: Boolean)` Sets whether URLs alone should be returned for image assets.
`NativeAdOptions.Builder`	`@CanIgnoreReturnValue setVideoOptions(videoOptions: VideoOptions?)` Sets the `VideoOptions` object.

Public constructors

Builder

Builder()

Public functions

build

fun build(): NativeAdOptions

Constructs a NativeAdOptions object with the specified attributes.

setAdChoicesPlacement

@CanIgnoreReturnValue
fun setAdChoicesPlacement(
    @NativeAdOptions.AdChoicesPlacement adChoicesPlacement: Int
): NativeAdOptions.Builder

Sets the placement of AdChoices icon (if present). The value should be one of ADCHOICES_TOP_LEFT, ADCHOICES_TOP_RIGHT, ADCHOICES_BOTTOM_RIGHT or ADCHOICES_BOTTOM_LEFT. The default value is ADCHOICES_TOP_RIGHT.

setImageOrientation

@CanIgnoreReturnValue
fun setImageOrientation(orientation: Int): NativeAdOptions.Builder

setMediaAspectRatio

@CanIgnoreReturnValue
fun setMediaAspectRatio(
    @NativeAdOptions.NativeMediaAspectRatio aspectRatio: Int
): NativeAdOptions.Builder

setRequestCustomMuteThisAd

@CanIgnoreReturnValue
fun setRequestCustomMuteThisAd(requestCustomMuteThisAd: Boolean): NativeAdOptions.Builder

Set this boolean to true to request a custom implementation for the Mute This Ad feature. Default value is false.

setRequestMultipleImages

@CanIgnoreReturnValue
fun setRequestMultipleImages(shouldRequestMultipleImages: Boolean): NativeAdOptions.Builder

Sets whether multiple images should be requested or not. Default value is false.

setReturnUrlsForImageAssets

@CanIgnoreReturnValue
fun setReturnUrlsForImageAssets(shouldReturnUrls: Boolean): NativeAdOptions.Builder

Sets whether URLs alone should be returned for image assets. If true, the SDK will not download image assets and instead return a NativeAd.Image with just the URI and Scale properties populated. If false, the SDK will automatically download image assets and return a NativeAd.Image with all three properties (URI, Scale, and Drawable) populated. The default value is false.

setVideoOptions

@CanIgnoreReturnValue
fun setVideoOptions(videoOptions: VideoOptions?): NativeAdOptions.Builder

Sets the VideoOptions object.