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/FrequencyCapFilters#nestedclasses) \| [Constants](https://developer.android.com/reference/android/adservices/common/FrequencyCapFilters#constants) \| [Inherited Constants](https://developer.android.com/reference/android/adservices/common/FrequencyCapFilters#inhconstants) \| [Fields](https://developer.android.com/reference/android/adservices/common/FrequencyCapFilters#lfields) \| [Methods](https://developer.android.com/reference/android/adservices/common/FrequencyCapFilters#pubmethods) \| [Inherited Methods](https://developer.android.com/reference/android/adservices/common/FrequencyCapFilters#inhmethods)

# FrequencyCapFilters

*** ** * ** ***


`
public

final

class
FrequencyCapFilters
`


`

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

<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 container for the ad filters that are based on frequency caps.

No more than 20 frequency cap filters may be associated with a single ad.

Frequency caps filters combine an event type with a list of `https://developer.android.com/reference/android/adservices/common/KeyedFrequencyCap` objects
to define a collection of ad filters. If any of these frequency caps are exceeded for a given ad,
the ad will be removed from the group of ads submitted to a buyer adtech's bidding function.

## Summary

| ### Nested classes ||
|---|---|
| ` class` | `https://developer.android.com/reference/android/adservices/common/FrequencyCapFilters.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/* |

| ### Constants ||
|---|---|
| `int` | `https://developer.android.com/reference/android/adservices/common/FrequencyCapFilters#AD_EVENT_TYPE_CLICK` |
| `int` | `https://developer.android.com/reference/android/adservices/common/FrequencyCapFilters#AD_EVENT_TYPE_IMPRESSION` |
| `int` | `https://developer.android.com/reference/android/adservices/common/FrequencyCapFilters#AD_EVENT_TYPE_VIEW` |
| `int` | `https://developer.android.com/reference/android/adservices/common/FrequencyCapFilters#AD_EVENT_TYPE_WIN` The WIN ad event type is automatically populated within the Protected Audience service for any winning ad which is returned from Protected Audience ad selection. |

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

| ### Public methods ||
|---|---|
| ` int` | ` https://developer.android.com/reference/android/adservices/common/FrequencyCapFilters#describeContents()() ` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. |
| ` boolean` | ` https://developer.android.com/reference/android/adservices/common/FrequencyCapFilters#equals(java.lang.Object)(https://developer.android.com/reference/java/lang/Object o) ` Checks whether the `https://developer.android.com/reference/android/adservices/common/FrequencyCapFilters` objects contain the same information. |
| ` https://developer.android.com/reference/java/util/List<https://developer.android.com/reference/android/adservices/common/KeyedFrequencyCap>` | ` https://developer.android.com/reference/android/adservices/common/FrequencyCapFilters#getKeyedFrequencyCapsForClickEvents()() ` Gets the list of `https://developer.android.com/reference/android/adservices/common/KeyedFrequencyCap` objects that will filter on the `https://developer.android.com/reference/android/adservices/common/FrequencyCapFilters#AD_EVENT_TYPE_CLICK` event type. |
| ` https://developer.android.com/reference/java/util/List<https://developer.android.com/reference/android/adservices/common/KeyedFrequencyCap>` | ` https://developer.android.com/reference/android/adservices/common/FrequencyCapFilters#getKeyedFrequencyCapsForImpressionEvents()() ` Gets the list of `https://developer.android.com/reference/android/adservices/common/KeyedFrequencyCap` objects that will filter on the `https://developer.android.com/reference/android/adservices/common/FrequencyCapFilters#AD_EVENT_TYPE_IMPRESSION` event type. |
| ` https://developer.android.com/reference/java/util/List<https://developer.android.com/reference/android/adservices/common/KeyedFrequencyCap>` | ` https://developer.android.com/reference/android/adservices/common/FrequencyCapFilters#getKeyedFrequencyCapsForViewEvents()() ` Gets the list of `https://developer.android.com/reference/android/adservices/common/KeyedFrequencyCap` objects that will filter on the `https://developer.android.com/reference/android/adservices/common/FrequencyCapFilters#AD_EVENT_TYPE_VIEW` event type. |
| ` https://developer.android.com/reference/java/util/List<https://developer.android.com/reference/android/adservices/common/KeyedFrequencyCap>` | ` https://developer.android.com/reference/android/adservices/common/FrequencyCapFilters#getKeyedFrequencyCapsForWinEvents()() ` Gets the list of `https://developer.android.com/reference/android/adservices/common/KeyedFrequencyCap` objects that will filter on the `https://developer.android.com/reference/android/adservices/common/FrequencyCapFilters#AD_EVENT_TYPE_WIN` event type. |
| ` int` | ` https://developer.android.com/reference/android/adservices/common/FrequencyCapFilters#hashCode()() ` Returns the hash of the `https://developer.android.com/reference/android/adservices/common/FrequencyCapFilters` object's data. |
| ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/android/adservices/common/FrequencyCapFilters#toString()() ` Returns a string representation of the object. |
| ` void` | ` https://developer.android.com/reference/android/adservices/common/FrequencyCapFilters#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. | ||

## Constants

### AD_EVENT_TYPE_CLICK

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 int AD_EVENT_TYPE_CLICK
```

<br />

<br />

Constant Value:

3
(0x00000003)


### AD_EVENT_TYPE_IMPRESSION

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 int AD_EVENT_TYPE_IMPRESSION
```

<br />

<br />

Constant Value:

1
(0x00000001)


### AD_EVENT_TYPE_VIEW

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 int AD_EVENT_TYPE_VIEW
```

<br />

<br />

Constant Value:

2
(0x00000002)


### AD_EVENT_TYPE_WIN

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 int AD_EVENT_TYPE_WIN
```

The WIN ad event type is automatically populated within the Protected Audience service for
any winning ad which is returned from Protected Audience ad selection.

It should not be used to manually update an ad counter histogram.

<br />

Constant Value:

0
(0x00000000)


## 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<FrequencyCapFilters> 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/FrequencyCapFilters` 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 /> |

### getKeyedFrequencyCapsForClickEvents

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 List<KeyedFrequencyCap> getKeyedFrequencyCapsForClickEvents ()
```

Gets the list of `https://developer.android.com/reference/android/adservices/common/KeyedFrequencyCap` objects that will filter on the `https://developer.android.com/reference/android/adservices/common/FrequencyCapFilters#AD_EVENT_TYPE_CLICK` event type.

These frequency caps apply to events which correlate to a click as interpreted by an
adtech. Click events are counted when the `https://developer.android.com/reference/android/adservices/adselection/AdSelectionManager#updateAdCounterHistogram(android.adservices.adselection.UpdateAdCounterHistogramRequest,%20java.util.concurrent.Executor,%20android.os.OutcomeReceiver<java.lang.Object,java.lang.Exception>)` API is invoked with the `https://developer.android.com/reference/android/adservices/common/FrequencyCapFilters#AD_EVENT_TYPE_CLICK` event type.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/util/List<https://developer.android.com/reference/android/adservices/common/KeyedFrequencyCap>` | This value cannot be `null`. <br /> |

### getKeyedFrequencyCapsForImpressionEvents

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 List<KeyedFrequencyCap> getKeyedFrequencyCapsForImpressionEvents ()
```

Gets the list of `https://developer.android.com/reference/android/adservices/common/KeyedFrequencyCap` objects that will filter on the `https://developer.android.com/reference/android/adservices/common/FrequencyCapFilters#AD_EVENT_TYPE_IMPRESSION` event type.

These frequency caps apply to events which correlate to an impression as interpreted by an
adtech.

Note that events are not automatically counted when calling `https://developer.android.com/reference/android/adservices/adselection/AdSelectionManager#reportImpression(android.adservices.adselection.ReportImpressionRequest,%20java.util.concurrent.Executor,%20android.os.OutcomeReceiver<java.lang.Object,java.lang.Exception>)`. Instead, the `https://developer.android.com/reference/android/adservices/common/FrequencyCapFilters#AD_EVENT_TYPE_IMPRESSION` event type must
be updated using the `https://developer.android.com/reference/android/adservices/adselection/AdSelectionManager#updateAdCounterHistogram(android.adservices.adselection.UpdateAdCounterHistogramRequest,%20java.util.concurrent.Executor,%20android.os.OutcomeReceiver<java.lang.Object,java.lang.Exception>)` API.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/util/List<https://developer.android.com/reference/android/adservices/common/KeyedFrequencyCap>` | This value cannot be `null`. <br /> |

### getKeyedFrequencyCapsForViewEvents

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 List<KeyedFrequencyCap> getKeyedFrequencyCapsForViewEvents ()
```

Gets the list of `https://developer.android.com/reference/android/adservices/common/KeyedFrequencyCap` objects that will filter on the `https://developer.android.com/reference/android/adservices/common/FrequencyCapFilters#AD_EVENT_TYPE_VIEW` event type.

These frequency caps apply to events which correlate to a view as interpreted by an
adtech. View events are counted when the `https://developer.android.com/reference/android/adservices/adselection/AdSelectionManager#updateAdCounterHistogram(android.adservices.adselection.UpdateAdCounterHistogramRequest,%20java.util.concurrent.Executor,%20android.os.OutcomeReceiver<java.lang.Object,java.lang.Exception>)` API is invoked with the `https://developer.android.com/reference/android/adservices/common/FrequencyCapFilters#AD_EVENT_TYPE_VIEW` event type.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/util/List<https://developer.android.com/reference/android/adservices/common/KeyedFrequencyCap>` | This value cannot be `null`. <br /> |

### getKeyedFrequencyCapsForWinEvents

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 List<KeyedFrequencyCap> getKeyedFrequencyCapsForWinEvents ()
```

Gets the list of `https://developer.android.com/reference/android/adservices/common/KeyedFrequencyCap` objects that will filter on the `https://developer.android.com/reference/android/adservices/common/FrequencyCapFilters#AD_EVENT_TYPE_WIN` event type.

These frequency caps apply to events for ads that were selected as winners in ad
selection. Winning ads are used to automatically increment the associated counter keys on the
win event type.

Note that the `https://developer.android.com/reference/android/adservices/common/FrequencyCapFilters#AD_EVENT_TYPE_WIN` event type cannot be updated manually using the
`https://developer.android.com/reference/android/adservices/adselection/AdSelectionManager#updateAdCounterHistogram(android.adservices.adselection.UpdateAdCounterHistogramRequest,%20java.util.concurrent.Executor,%20android.os.OutcomeReceiver<java.lang.Object,java.lang.Exception>)` API.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/util/List<https://developer.android.com/reference/android/adservices/common/KeyedFrequencyCap>` | This value cannot be `null`. <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/FrequencyCapFilters` 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` |