SwipeableInterstitialAdRequest.Builder

@CanIgnoreReturnValue
fun addCategoryExclusion(categoryExclusion: String): SwipeableInterstitialAdRequest.Builder

Sets a slot-level ad category exclusion label.

This feature is only applicable for Ad Manager ad requests. Any category exclusions will be ignored on AdMob requests.

@CanIgnoreReturnValue
fun addKeyword(keyword: String): SwipeableInterstitialAdRequest.Builder

Adds a keyword for targeting purposes.

fun build(): SwipeableInterstitialAdRequest

Constructs an SwipeableInterstitialAdRequest with the specified attributes.

@CanIgnoreReturnValue
open fun enableCustomClickSwipeGesture(
    customClickSwipeGestureDirection: NativeAd.SwipeGestureDirection,
    customClickSwipeGestureTapsAllowed: Boolean
): SwipeableInterstitialAdRequest.Builder

Enables swipes as a custom click gesture.

Available for allowlisted publishers only. These settings will be ignored for publishers not allowlisted.

@CanIgnoreReturnValue
fun putAdSourceExtrasBundle(
    adapterClass: Class<MediationExtrasReceiver>,
    adSourceExtras: Bundle
): SwipeableInterstitialAdRequest.Builder

Adds extra parameters to pass to a specific ad source adapter.

@CanIgnoreReturnValue
fun putCustomTargeting(key: String, value: String): SwipeableInterstitialAdRequest.Builder

Adds a custom targeting parameter. Calling this a second time with the same key will overwrite the old values.

This feature is only applicable for Ad Manager ad requests. Any custom targeting will be ignored on AdMob requests.

@CanIgnoreReturnValue
fun putCustomTargeting(key: String, values: List<String>): SwipeableInterstitialAdRequest.Builder

Adds a custom targeting parameter with multiple values. Calling this a second time with the same key will overwrite the old values.

This feature is only applicable for Ad Manager ad requests. AdMob requests currently ignore custom targeting.

@CanIgnoreReturnValue
open fun setAdSize(width: Int, height: Int): SwipeableInterstitialAdRequest.Builder

Sets the size of the ad.

If this method is not called, the ad defaults to full-screen size dimensions.

Note: The ad size must be at least 60% of the screen size. Sizes smaller than this threshold will result in a load failure.

@CanIgnoreReturnValue
fun setContentUrl(contentUrl: String): SwipeableInterstitialAdRequest.Builder

Sets the content URL for a web site whose content matches the app's primary content. This web site content is used for targeting and brand safety purposes.

@CanIgnoreReturnValue
fun setGoogleExtrasBundle(extraBundle: Bundle): SwipeableInterstitialAdRequest.Builder

Set extra parameters to pass to AdMob or Ad Manager. Calling this a second time will overwrite the old values.

@CanIgnoreReturnValue
open fun setMaxScreenHoldDurationSeconds(maxScreenHoldDurationSeconds: Int): SwipeableInterstitialAdRequest.Builder

Specifies the maximum duration (in seconds) the app commits to holding the ad on screen before it is eligible for dismissal. The SDK only returns ads with a hold requirement that is less than or equal to this value. Defaults to 0.

Only set this property if your app implements logic to hold swipeable interstitial ads on screen.

@CanIgnoreReturnValue
fun setNeighboringContentUrls(neighboringContentUrls: Set<String>): SwipeableInterstitialAdRequest.Builder

Sets URLs representing web content near an ad. Promotes brand safety and allows displayed ads to have an app level rating (MA, T, PG, etc) that is more appropriate to neighboring content.

@CanIgnoreReturnValue
open fun setPlacementId(placementId: Long): SwipeableInterstitialAdRequest.Builder

Sets a default placement ID for the loaded ad.

@CanIgnoreReturnValue
fun setPublisherProvidedId(publisherProvidedId: String): SwipeableInterstitialAdRequest.Builder

Sets an identifier for use in frequency capping, audience segmentation and targeting, sequential ad rotation, and other audience-based ad delivery controls across devices.

This feature is only applicable for Ad Manager ad requests. Any ID will be ignored on AdMob requests.

@CanIgnoreReturnValue
fun setRequestAgent(requestAgent: String): SwipeableInterstitialAdRequest.Builder

Sets the request agent string to identify the ad request's origin. Third party libraries that implement the Mobile Ads SDK on behalf of publishers should call this method to denote the platform from which the ad request originated.

@ExperimentalApi
fun skipUninitializedAdapters(): SwipeableInterstitialAdRequest.Builder

Instructs the SDK to not collect bidding signals or execute waterfall elements for adapters that have not yet successfully initialized.

protected var adUnitId: String?

The ad unit ID.