SignalRequest

Kotlin |Java

public abstract class SignalRequest

Known direct subclasses

AppOpenSignalRequest, BannerSignalRequest, IconSignalRequest, InterstitialSignalRequest, NativeSignalRequest, RewardedInterstitialSignalRequest, RewardedSignalRequest

AppOpenSignalRequest	An app open signal request.
BannerSignalRequest	A banner signal request.
IconSignalRequest	A signal request for icon ads.
InterstitialSignalRequest	An interstitial signal request.
NativeSignalRequest	A native signal request.
RewardedInterstitialSignalRequest	A rewarded interstitial signal request.
RewardedSignalRequest	A rewarded signal request.

---

A SignalRequest contains targeting information used to generate a Signal.

Summary

Protected constructors

SignalRequest(     @NonNull String signalType,     String adUnitId,     @NonNull Set<@NonNull String> categoryExclusions,     String contentUrl,     @NonNull Map<@NonNull String, @NonNull String> customTargeting,     @NonNull Bundle googleExtrasBundle,     @NonNull Set<@NonNull String> keywords,     @NonNull Set<@NonNull String> neighboringContentUrls,     @NonNull Map<@NonNull String, @NonNull Bundle> adSourceExtrasBundles,     String publisherProvidedId,     String requestAgent )

Public methods
final Bundle	getAdSourceExtrasBundle(     @NonNull Class<@NonNull MediationExtrasReceiver> adapterClass ) Gets the extras bundle associated with an ad source's adapter, if present.
String	getAdUnitId() The ad unit ID.
final @NonNull Set<@NonNull String>	getCategoryExclusions() The slot-level ad category exclusion labels.
final String	getContentUrl() The content URL targeting information.
final @NonNull Map<@NonNull String, @NonNull String>	getCustomTargeting() The custom targeting parameters.
final @NonNull Bundle	getGoogleExtrasBundle() The extra parameters to pass to Google ad network
final @NonNull Set<@NonNull String>	getKeywords() The targeting information keywords.
final @NonNull Set<@NonNull String>	getNeighboringContentUrls() The list of neighboring content URLs or an empty List if no URLs were set.
final long	getPlacementId() An identifier for a placement in reporting.
final String	getPublisherProvidedId() A publisher-provided identifier used for frequency capping, audience segmentation and targeting, sequential ad rotation, and other audience-based ad delivery controls across devices.
final String	getRequestAgent() The request agent string to identify the ad request's origin.
final @NonNull String	getSignalType() The signal type associated with the request.

Protected constructors

SignalRequest

protected SignalRequest(
    @NonNull String signalType,
    String adUnitId,
    @NonNull Set<@NonNull String> categoryExclusions,
    String contentUrl,
    @NonNull Map<@NonNull String, @NonNull String> customTargeting,
    @NonNull Bundle googleExtrasBundle,
    @NonNull Set<@NonNull String> keywords,
    @NonNull Set<@NonNull String> neighboringContentUrls,
    @NonNull Map<@NonNull String, @NonNull Bundle> adSourceExtrasBundles,
    String publisherProvidedId,
    String requestAgent
)

Public methods

getAdSourceExtrasBundle

public final Bundle getAdSourceExtrasBundle(
    @NonNull Class<@NonNull MediationExtrasReceiver> adapterClass
)

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

getAdUnitId

public String getAdUnitId()

The ad unit ID.

getCategoryExclusions

public final @NonNull Set<@NonNull String> getCategoryExclusions()

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

getContentUrl

public final String getContentUrl()

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

getCustomTargeting

public final @NonNull Map<@NonNull String, @NonNull String> getCustomTargeting()

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

getGoogleExtrasBundle

public final @NonNull Bundle getGoogleExtrasBundle()

The extra parameters to pass to Google ad network

getKeywords

public final @NonNull Set<@NonNull String> getKeywords()

The targeting information keywords.

getNeighboringContentUrls

public final @NonNull Set<@NonNull String> getNeighboringContentUrls()

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

getPlacementId

public final long getPlacementId()

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

getPublisherProvidedId

public final String getPublisherProvidedId()

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

getRequestAgent

public final String getRequestAgent()

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

getSignalType

public final @NonNull String getSignalType()

The signal type associated with the request.