Added in API level 35
Also in Ad Services Extensions 8

Summary: Nested Classes | Inherited Constants | Fields | Methods | Inherited Methods

KeyedFrequencyCap

---

Kotlin |Java

public final class KeyedFrequencyCap
extends Object implements Parcelable

java.lang.Object
↳	android.adservices.common.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

Nested classes
class	KeyedFrequencyCap.Builder Builder for creating KeyedFrequencyCap objects.

Inherited constants

From interface android.os.Parcelable int CONTENTS_FILE_DESCRIPTOR Descriptor bit used with describeContents(): indicates that the Parcelable object's flattened representation includes a file descriptor. int PARCELABLE_WRITE_RETURN_VALUE Flag for use with writeToParcel(Parcel, int): the object being written is a return value, that is the result of a function such as "Parcelable someFunction()", "void someFunction(out Parcelable)", or "void someFunction(inout Parcelable)".

Fields
public static final Creator<KeyedFrequencyCap>	CREATOR

Public methods
boolean	equals(Object o) Checks whether the KeyedFrequencyCap objects contain the same information.
int	getAdCounterKey() Returns the ad counter key that the frequency cap is applied to.
Duration	getInterval() Returns the interval, as a Duration which will be truncated to the nearest second, over which the frequency cap is calculated.
int	getMaxCount() Returns the maximum count of event occurrences allowed within a given time interval.
int	hashCode() Returns the hash of the KeyedFrequencyCap object's data.
String	toString() Returns a string representation of the object.
void	writeToParcel(Parcel dest, int flags) Flatten this object in to a Parcel.

Inherited methods
From class java.lang.Object Object clone() Creates and returns a copy of this object. boolean equals(Object obj) Indicates whether some other object is "equal to" this one. void finalize() Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. final Class<?> getClass() Returns the runtime class of this Object. int hashCode() Returns a hash code value for the object. final void notify() Wakes up a single thread that is waiting on this object's monitor. final void notifyAll() Wakes up all threads that are waiting on this object's monitor. String toString() Returns a string representation of the object. final void wait(long timeoutMillis, int nanos) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. final void wait(long timeoutMillis) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. final void wait() Causes the current thread to wait until it is awakened, typically by being notified or interrupted.
From interface android.os.Parcelable abstract int describeContents() Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. abstract void writeToParcel(Parcel dest, int flags) Flatten this object in to a Parcel.

Fields

CREATOR

Added in API level 35
Also in Ad Services Extensions 8

public static final Creator<KeyedFrequencyCap> CREATOR

Public methods

equals

Added in API level 35

public boolean equals (Object o)

Checks whether the KeyedFrequencyCap objects contain the same information.

Parameters
o	Object: the reference object with which to compare.

Returns
boolean	true if this object is the same as the obj argument; false otherwise.

getAdCounterKey

Added in API level 35
Also in Ad Services Extensions 8

public int getAdCounterKey ()

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

The ad counter key is defined by an adtech and is an arbitrary numeric identifier which defines any criteria which may have previously been counted and persisted on the device. If the on-device count exceeds the maximum count within a certain time interval, the frequency cap has been exceeded.

Returns
int	This value cannot be null.

getInterval

Added in API level 35
Also in Ad Services Extensions 8

public Duration getInterval ()

Returns the interval, as a Duration which will be truncated to the nearest second, over which the frequency cap is calculated.

When this frequency cap is computed, the number of persisted events is counted in the most recent time interval. If the count of previously occurring matching events for an adtech is greater than the number returned by getMaxCount(), the frequency cap has been exceeded, and the ad will not be eligible for ad selection.

Returns
Duration	This value cannot be null.

getMaxCount

Added in API level 35
Also in Ad Services Extensions 8

public int getMaxCount ()

Returns the maximum count of event occurrences allowed within a given time interval.

If there are more events matching the ad counter key and ad event type counted on the device within the time interval defined by getInterval(), the frequency cap has been exceeded, and the ad will not be eligible for ad selection.

For example, an ad that specifies a filter for a max count of two within one hour will not be eligible for ad selection if the event has been counted two or more times within the hour preceding the ad selection process.

Returns
int

hashCode

Added in API level 35

public int hashCode ()

Returns the hash of the KeyedFrequencyCap object's data.

Returns
int	a hash code value for this object.

toString

Added in API level 35

public String toString ()

Returns a string representation of the object.

Returns
String	a string representation of the object.

writeToParcel

Added in API level 35

public void writeToParcel (Parcel dest, 
                int flags)

Flatten this object in to a Parcel.

Parameters
dest	Parcel: This value cannot be null.
flags	int: Additional flags about how the object should be written. May be 0 or Parcelable.PARCELABLE_WRITE_RETURN_VALUE. Value is either 0 or a combination of Parcelable.PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES