KeyedFrequencyCap
@ExperimentalFeatures.Ext8OptIn
public final 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( |
Public methods |
|
|---|---|
boolean |
Checks whether two |
final int |
The ad counter key that the frequency cap is applied to |
final @NonNull Duration |
The interval, as a |
final int |
The maximum count of event occurrences allowed within a given time interval |
int |
hashCode()Returns the hash of the |
@NonNull String |
toString()Overrides the toString method. |
Public constructors
KeyedFrequencyCap
public KeyedFrequencyCap(
int adCounterKey,
int maxCount,
@NonNull Duration interval
)
Public methods
equals
public boolean equals(Object other)
Checks whether two KeyedFrequencyCap objects contain the same information.
getAdCounterKey
public final int getAdCounterKey()
The ad counter key that the frequency cap is applied to
getInterval
public final @NonNull Duration getInterval()
The interval, as a Duration over which the frequency cap is calculated
getMaxCount
public final int getMaxCount()
The maximum count of event occurrences allowed within a given time interval