KeyedFrequencyCap

Artifact: androidx.privacysandbox.ads:ads-adservices

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 interval, as a `Duration` over which the frequency cap is calculated
`Int`	`maxCount` The maximum count of event occurrences allowed within a given time interval

Public constructors

KeyedFrequencyCap

Added in 1.1.0-beta11

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

Parameters
`adCounterKey: Int`	The ad counter key that the frequency cap is applied to
`maxCount: Int`	The maximum count of event occurrences allowed within a given time interval
`interval: Duration`	The interval, as a `Duration` over which the frequency cap is calculated

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-beta11

val adCounterKey: Int

The ad counter key that the frequency cap is applied to

interval

Added in 1.1.0-beta11

val interval: Duration

The interval, as a Duration over which the frequency cap is calculated

maxCount

Added in 1.1.0-beta11

val maxCount: Int

The maximum count of event occurrences allowed within a given time interval