KeyedFrequencyCap

Artifact: androidx.privacysandbox.ads:ads-adservices

View Source

Added in 1.1.0-beta06

---

Kotlin |Java

@ExperimentalFeatures.Ext8OptIn
class KeyedFrequencyCap

---

A frequency cap for a specific ad counter key.

Frequency caps define the maximum rate an event can occur within a given time interval. If the frequency cap is exceeded, the associated ad will be filtered out of ad selection.

Summary

Public constructors
KeyedFrequencyCap(adCounterKey: Int, maxCount: Int, interval: Duration)

Public functions
open operator Boolean	equals(other: Any?) Checks whether two KeyedFrequencyCap objects contain the same information.
open Int	hashCode() Returns the hash of the KeyedFrequencyCap object's data.
open String	toString() Overrides the toString method.

Public properties
Int	adCounterKey The ad counter key that the frequency cap is applied to.
Duration	interval The caller adtech entity's AdTechIdentifier.
Int	maxCount A render URL for the winning ad.

Public constructors

KeyedFrequencyCap

Added in 1.1.0-beta06

KeyedFrequencyCap(adCounterKey: Int, maxCount: Int, interval: Duration)

Parameters
adCounterKey: Int	The ad counter key that the frequency cap is applied to.
maxCount: Int	A render URL for the winning ad.
interval: Duration	The caller adtech entity's AdTechIdentifier.

Public functions

equals

open operator fun equals(other: Any?): Boolean

Checks whether two KeyedFrequencyCap objects contain the same information.

hashCode

open fun hashCode(): Int

Returns the hash of the KeyedFrequencyCap object's data.

toString

open fun toString(): String

Overrides the toString method.

Public properties

adCounterKey

Added in 1.1.0-beta06

val adCounterKey: Int

The ad counter key that the frequency cap is applied to.

interval

Added in 1.1.0-beta06

val interval: Duration

The caller adtech entity's AdTechIdentifier.

maxCount

Added in 1.1.0-beta06

val maxCount: Int

A render URL for the winning ad.