NativeSignalRequest

class NativeSignalRequest : SignalRequest

kotlin.Any
   ↳ com.google.android.libraries.ads.mobile.sdk.signal.SignalRequest
     ↳ com.google.android.libraries.ads.mobile.sdk.nativead.NativeSignalRequest

A native signal request. See Builder for how to construct a NativeSignalRequest.

Summary

Nested types

A builder class for creating NativeSignalRequest.

Public functions
Bundle?

Gets the extras bundle associated with an ad source's adapter, if present.

Public properties
open AdChoicesPlacement

The AdChoices placement.
open AdSize?
open List<AdSize>
open String?

The ad unit ID.
Set<String>

The slot-level ad category exclusion labels.
String?

The content URL targeting information.
open Boolean

Whether tap to click is enabled with custom click gesture.
open NativeAd.SwipeGestureDirection?

The requested custom click gesture direction.
open List<String>

A list of custom native ad format IDs defined in the Ad Manager UI.
open Boolean

Whether custom mute this ad is requested.
Map<String, String>

The custom targeting parameters.
Bundle

The extra parameters to pass to Google ad network
open Boolean

Whether image downloading is disabled.
Set<String>

The targeting information keywords.
open Boolean
open NativeAd.NativeMediaAspectRatio

The aspect ratio of the media to be returned.
open List<NativeAd.NativeAdType>

A list of native ad types for the request.
Set<String>

The list of neighboring content URLs or an empty List if no URLs were set.
Long

An identifier for a placement in reporting.
String?

A publisher-provided identifier used for frequency capping, audience segmentation and targeting, sequential ad rotation, and other audience-based ad delivery controls across devices.
String?

The request agent string to identify the ad request's origin.
open VideoOptions?

The VideoOptions for the request.

Inherited properties
From com.google.android.libraries.ads.mobile.sdk.signal.SignalRequest
String

The signal type associated with the request.

Public functions

getAdSourceExtrasBundle

fun getAdSourceExtrasBundle(adapterClass: Class<MediationExtrasReceiver>): Bundle?

Gets the extras bundle associated with an ad source's adapter, if present.

Public properties

adChoicesPlacement

open val adChoicesPlacement: AdChoicesPlacement

The AdChoices placement.

adSize

open val adSize: AdSize?

adSizes

open val adSizes: List<AdSize>

adUnitId

open val adUnitId: String?

The ad unit ID.

categoryExclusions

val categoryExclusions: Set<String>

The slot-level ad category exclusion labels. Default to an empty Set if not set.

contentUrl

val contentUrl: String?

The content URL targeting information. Default to null if not set.

customClickGestureAllowTaps

open val customClickGestureAllowTaps: Boolean

Whether tap to click is enabled with custom click gesture.

customClickGestureDirection

open val customClickGestureDirection: NativeAd.SwipeGestureDirection?

The requested custom click gesture direction.

customFormatIds

open val customFormatIds: List<String>

A list of custom native ad format IDs defined in the Ad Manager UI. Used to load native ads of type NativeAdType.CUSTOM_NATIVE.

customMuteThisAdRequested

open val customMuteThisAdRequested: Boolean

Whether custom mute this ad is requested.

customTargeting

val customTargeting: Map<String, String>

The custom targeting parameters. Default to an empty Map if not set.

googleExtrasBundle

val googleExtrasBundle: Bundle

The extra parameters to pass to Google ad network

isImageLoadingDisabled

open val isImageLoadingDisabled: Boolean

Whether image downloading is disabled.

keywords

val keywords: Set<String>

The targeting information keywords.

manualImpressionRequested

open val manualImpressionRequested: Boolean

mediaAspectRatio

open val mediaAspectRatio: NativeAd.NativeMediaAspectRatio

The aspect ratio of the media to be returned.

nativeAdTypes

open val nativeAdTypes: List<NativeAd.NativeAdType>

A list of native ad types for the request.

neighboringContentUrls

val neighboringContentUrls: Set<String>

The list of neighboring content URLs or an empty List if no URLs were set.

placementId

val placementId: Long

An identifier for a placement in reporting. A value set here will be set onto any ad returned by this request.

publisherProvidedId

val publisherProvidedId: String?

A publisher-provided identifier used for frequency capping, audience segmentation and targeting, sequential ad rotation, and other audience-based ad delivery controls across devices.

requestAgent

val requestAgent: String?

The request agent string to identify the ad request's origin.

videoOptions

open val videoOptions: VideoOptions?

The VideoOptions for the request.