IconSignalRequest

Kotlin |Java

public final class IconSignalRequest extends SignalRequest

java.lang.Object
↳	com.google.android.libraries.ads.mobile.sdk.signal.SignalRequest
	↳	com.google.android.libraries.ads.mobile.sdk.iconad.IconSignalRequest

---

A signal request for icon ads. See Builder for how to construct an IconSignalRequest. This should be used with MobileAds.generateSignal() to generate signals for server-to-server requests.

Summary

Nested types
public final class IconSignalRequest.Builder A builder for creating IconSignalRequests.

Public methods
@NonNull AdChoicesPlacement	getAdChoicesPlacement() The AdChoicesPlacement for the AdChoices view.
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.
@NonNull String	getCorrelator() Identifier used to group ad requests together.
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
@NonNull IconAdPlacement	getIconAdPlacement() The IconAdPlacement for the request.
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.
boolean	isImageLoadingDisabled() Whether the SDK returns urls for image assets instead of downloading them.

Inherited methods
From com.google.android.libraries.ads.mobile.sdk.signal.SignalRequest final @NonNull String getSignalType() The signal type associated with the request.

Public methods

getAdChoicesPlacement

public @NonNull AdChoicesPlacement getAdChoicesPlacement()

The AdChoicesPlacement for the AdChoices view.

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.

getCorrelator

public @NonNull String getCorrelator()

Identifier used to group ad requests together.

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

getIconAdPlacement

public @NonNull IconAdPlacement getIconAdPlacement()

The IconAdPlacement for the request.

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.

isImageLoadingDisabled

public boolean isImageLoadingDisabled()

Whether the SDK returns urls for image assets instead of downloading them.