Added in [API level 35](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  
Also in [Ad Services Extensions 8](https://developer.android.com/sdkExtensions)   
Deprecated in [API level
37](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) Summary: [Nested Classes](https://developer.android.com/reference/android/adservices/common/KeyedFrequencyCap#nestedclasses) \| [Inherited Constants](https://developer.android.com/reference/android/adservices/common/KeyedFrequencyCap#inhconstants) \| [Fields](https://developer.android.com/reference/android/adservices/common/KeyedFrequencyCap#lfields) \| [Methods](https://developer.android.com/reference/android/adservices/common/KeyedFrequencyCap#pubmethods) \| [Inherited Methods](https://developer.android.com/reference/android/adservices/common/KeyedFrequencyCap#inhmethods)

# KeyedFrequencyCap

*** ** * ** ***


`
public

final

class
KeyedFrequencyCap
`


`

extends https://developer.android.com/reference/java/lang/Object


`

`


implements

https://developer.android.com/reference/android/os/Parcelable


`

|---|---|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object) ||
| ↳ | android.adservices.common.KeyedFrequencyCap |

<br />

*** ** * ** ***


**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 ||
|---|---|
| ` class` | `https://developer.android.com/reference/android/adservices/common/KeyedFrequencyCap.Builder` *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/* |

| ### Inherited constants |
|---|
| From interface `https://developer.android.com/reference/android/os/Parcelable` |---|---| | `int` | `https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR` Descriptor bit used with `https://developer.android.com/reference/android/os/Parcelable#describeContents()`: indicates that the Parcelable object's flattened representation includes a file descriptor. | | `int` | `https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE` Flag for use with `https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int)`: 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 https://developer.android.com/reference/android/os/Parcelable.Creator<https://developer.android.com/reference/android/adservices/common/KeyedFrequencyCap>` | `https://developer.android.com/reference/android/adservices/common/KeyedFrequencyCap#CREATOR` |

| ### Public methods ||
|---|---|
| ` int` | ` https://developer.android.com/reference/android/adservices/common/KeyedFrequencyCap#describeContents()() ` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. |
| ` boolean` | ` https://developer.android.com/reference/android/adservices/common/KeyedFrequencyCap#equals(java.lang.Object)(https://developer.android.com/reference/java/lang/Object o) ` Checks whether the `https://developer.android.com/reference/android/adservices/common/KeyedFrequencyCap` objects contain the same information. |
| ` int` | ` https://developer.android.com/reference/android/adservices/common/KeyedFrequencyCap#getAdCounterKey()() ` Returns the ad counter key that the frequency cap is applied to. |
| ` https://developer.android.com/reference/java/time/Duration` | ` https://developer.android.com/reference/android/adservices/common/KeyedFrequencyCap#getInterval()() ` Returns the interval, as a `https://developer.android.com/reference/java/time/Duration` which will be truncated to the nearest second, over which the frequency cap is calculated. |
| ` int` | ` https://developer.android.com/reference/android/adservices/common/KeyedFrequencyCap#getMaxCount()() ` Returns the maximum count of event occurrences allowed within a given time interval. |
| ` int` | ` https://developer.android.com/reference/android/adservices/common/KeyedFrequencyCap#hashCode()() ` Returns the hash of the `https://developer.android.com/reference/android/adservices/common/KeyedFrequencyCap` object's data. |
| ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/android/adservices/common/KeyedFrequencyCap#toString()() ` Returns a string representation of the object. |
| ` void` | ` https://developer.android.com/reference/android/adservices/common/KeyedFrequencyCap#writeToParcel(android.os.Parcel,%20int)(https://developer.android.com/reference/android/os/Parcel dest, int flags) ` Flatten this object in to a Parcel. |

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

## Fields

### CREATOR

Added in [API level 35](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  
Also in [Ad Services Extensions 8](https://developer.android.com/sdkExtensions)   
Deprecated in [API level
37](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final Creator<KeyedFrequencyCap> CREATOR
```

<br />

<br />

## Public methods

### describeContents

Added in [API level 35](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)   
Deprecated in [API level
37](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public int describeContents ()
```

Describe the kinds of special objects contained in this Parcelable
instance's marshaled representation. For example, if the object will
include a file descriptor in the output of `https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int)`,
the return value of this method must include the
`https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR` bit.

<br />

| Returns ||
|---|---|
| `int` | a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either `0` or - `https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR` |

### equals

Added in [API level 35](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)   
Deprecated in [API level
37](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public boolean equals (Object o)
```

Checks whether the `https://developer.android.com/reference/android/adservices/common/KeyedFrequencyCap` objects contain the same information.

<br />

| Parameters ||
|---|---|
| `o` | `Object`: the reference object with which to compare. <br /> |

| Returns ||
|---|---|
| `boolean` | `true` if this object is the same as the obj argument; `false` otherwise. <br /> |

### getAdCounterKey

Added in [API level 35](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  
Also in [Ad Services Extensions 8](https://developer.android.com/sdkExtensions)   
Deprecated in [API level
37](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
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.

<br />

| Returns ||
|---|---|
| `int` | This value cannot be `null`. <br /> |

### getInterval

Added in [API level 35](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  
Also in [Ad Services Extensions 8](https://developer.android.com/sdkExtensions)   
Deprecated in [API level
37](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public Duration getInterval ()
```

Returns the interval, as a `https://developer.android.com/reference/java/time/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 `https://developer.android.com/reference/android/adservices/common/KeyedFrequencyCap#getMaxCount()`, the frequency cap has been
exceeded, and the ad will not be eligible for ad selection.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/time/Duration` | This value cannot be `null`. <br /> |

### getMaxCount

Added in [API level 35](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  
Also in [Ad Services Extensions 8](https://developer.android.com/sdkExtensions)   
Deprecated in [API level
37](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
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 `https://developer.android.com/reference/android/adservices/common/KeyedFrequencyCap#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.

<br />

| Returns ||
|---|---|
| `int` | <br /> |

### hashCode

Added in [API level 35](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)   
Deprecated in [API level
37](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public int hashCode ()
```

Returns the hash of the `https://developer.android.com/reference/android/adservices/common/KeyedFrequencyCap` object's data.

<br />

| Returns ||
|---|---|
| `int` | a hash code value for this object. <br /> |

### toString

Added in [API level 35](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)   
Deprecated in [API level
37](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public String toString ()
```

Returns a string representation of the object.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/String` | a string representation of the object. <br /> |

### writeToParcel

Added in [API level 35](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)   
Deprecated in [API level
37](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public void writeToParcel (Parcel dest, 
                int flags)
```

Flatten this object in to a Parcel.

<br />

| Parameters ||
|---|---|
| `dest` | `Parcel`: This value cannot be `null`. <br /> |
| `flags` | `int`: Additional flags about how the object should be written. May be 0 or `https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE`. Value is either `0` or a combination of the following: - `https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE` |