Added in API level 35
Also in Ad Services Extensions 8
Deprecated in API level 37

KeyedFrequencyCap

---

Kotlin |Java

class KeyedFrequencyCap : Parcelable

kotlin.Any
↳	android.adservices.common.KeyedFrequencyCap

---

This class was deprecated in API level 37.

The Rubidium (Rb) Relevance APIs, including those in android.adservices.common, are being deprecated. Relevance APIs have no direct replacement. Developers should stop using them, as calls will be rejected in future Android releases. Please refer to official Privacy Sandbox documentation for deprecation and roadmap details: https://privacysandbox.com/news/update-on-plans-for-privacy-sandbox-technologies/

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
	Builder Builder for creating KeyedFrequencyCap objects.

Inherited constants

From class 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: 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)". Some implementations may want to release resources at this point.

Public methods
Int	describeContents()
Boolean	equals(other: Any?) 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.
Unit	writeToParcel(dest: Parcel, flags: Int) Flatten this object in to a Parcel.

Properties
static Parcelable.Creator<KeyedFrequencyCap!>	CREATOR

Public methods

describeContents

Added in API level 35
Deprecated in API level 37

fun describeContents(): Int

Deprecated: Deprecated in Java.

Return
Int	a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or CONTENTS_FILE_DESCRIPTOR

equals

Added in API level 35
Deprecated in API level 37

fun equals(other: Any?): Boolean

Deprecated: Deprecated in Java.

Checks whether the KeyedFrequencyCap objects contain the same information.

Parameters
obj	the reference object with which to compare.

Return
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
Deprecated in API level 37

fun getAdCounterKey(): Int

Deprecated: Deprecated in Java.

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.

Return
Int	This value cannot be null.

getInterval

Added in API level 35
Also in Ad Services Extensions 8
Deprecated in API level 37

fun getInterval(): Duration

Deprecated: Deprecated in Java.

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.

Return
Duration	This value cannot be null.

getMaxCount

Added in API level 35
Also in Ad Services Extensions 8
Deprecated in API level 37

fun getMaxCount(): Int

Deprecated: Deprecated in Java.

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.

hashCode

Added in API level 35
Deprecated in API level 37

fun hashCode(): Int

Deprecated: Deprecated in Java.

Returns the hash of the KeyedFrequencyCap object's data.

Return
Int	a hash code value for this object.

toString

Added in API level 35
Deprecated in API level 37

fun toString(): String

Deprecated: Deprecated in Java.

Returns a string representation of the object.

Return
String	a string representation of the object.

writeToParcel

Added in API level 35
Deprecated in API level 37

fun writeToParcel(
    dest: Parcel, 
    flags: Int
): Unit

Deprecated: Deprecated in Java.

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_WRITE_RETURN_VALUE. Value is either 0 or a combination of the following: PARCELABLE_WRITE_RETURN_VALUE

Properties

CREATOR

Added in API level 35
Also in Ad Services Extensions 8
Deprecated in API level 37

static val CREATOR: Parcelable.Creator<KeyedFrequencyCap!>

Deprecated: Deprecated in Java.