# FrequencyCapFilters

# FrequencyCapFilters

Artifact:[androidx.privacysandbox.ads:ads-adservices](https://developer.android.com/jetpack/androidx/releases/privacysandbox-ads)  
[View Source](https://cs.android.com/search?q=file:androidx/privacysandbox/ads/adservices/common/FrequencyCapFilters.kt+class:androidx.privacysandbox.ads.adservices.common.FrequencyCapFilters)  
Added in[1.1.0-beta12](https://developer.android.com/jetpack/androidx/releases/privacysandbox-ads#1.1.0-beta12)

*** ** * ** ***

Kotlin\|[Java](https://developer.android.com/reference/androidx/privacysandbox/ads/adservices/common/FrequencyCapFilters "View this page in Java")

<br />

```
@ExperimentalFeatures.Ext8OptIn
class FrequencyCapFilters
```

<br />

*** ** * ** ***

A container for the ad filters that are based on frequency caps.

Frequency caps filters combine an event type with a list of[KeyedFrequencyCap](https://developer.android.com/reference/kotlin/androidx/privacysandbox/ads/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

|                                    ### Constants                                    |
|-------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `const `[Int](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html) | [AD_EVENT_TYPE_CLICK](https://developer.android.com/reference/kotlin/androidx/privacysandbox/ads/adservices/common/FrequencyCapFilters#AD_EVENT_TYPE_CLICK()) Represents the Click event type which correlate to a click as interpreted by an adtech.                      |
| `const `[Int](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html) | [AD_EVENT_TYPE_IMPRESSION](https://developer.android.com/reference/kotlin/androidx/privacysandbox/ads/adservices/common/FrequencyCapFilters#AD_EVENT_TYPE_IMPRESSION()) Represents the Impression event type which correlate to an impression as interpreted by an adtech. |
| `const `[Int](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html) | [AD_EVENT_TYPE_VIEW](https://developer.android.com/reference/kotlin/androidx/privacysandbox/ads/adservices/common/FrequencyCapFilters#AD_EVENT_TYPE_VIEW()) Represents the View event type which correlate to a view as interpreted by an adtech.                          |
| `const `[Int](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html) | [AD_EVENT_TYPE_WIN](https://developer.android.com/reference/kotlin/androidx/privacysandbox/ads/adservices/common/FrequencyCapFilters#AD_EVENT_TYPE_WIN()) Represents the Win event for ads that were selected as winners in ad selection.                                  |

|                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         ### Public constructors                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [FrequencyCapFilters](https://developer.android.com/reference/kotlin/androidx/privacysandbox/ads/adservices/common/FrequencyCapFilters#FrequencyCapFilters(kotlin.collections.List,kotlin.collections.List,kotlin.collections.List,kotlin.collections.List))`(` ` keyedFrequencyCapsForWinEvents: `[List](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html)`<`[KeyedFrequencyCap](https://developer.android.com/reference/kotlin/androidx/privacysandbox/ads/adservices/common/KeyedFrequencyCap)`>,` ` keyedFrequencyCapsForImpressionEvents: `[List](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html)`<`[KeyedFrequencyCap](https://developer.android.com/reference/kotlin/androidx/privacysandbox/ads/adservices/common/KeyedFrequencyCap)`>,` ` keyedFrequencyCapsForViewEvents: `[List](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html)`<`[KeyedFrequencyCap](https://developer.android.com/reference/kotlin/androidx/privacysandbox/ads/adservices/common/KeyedFrequencyCap)`>,` ` keyedFrequencyCapsForClickEvents: `[List](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html)`<`[KeyedFrequencyCap](https://developer.android.com/reference/kotlin/androidx/privacysandbox/ads/adservices/common/KeyedFrequencyCap)`>` `)` |

|                                        ### Public functions                                         |
|-----------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `open operator `[Boolean](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html) | [equals](https://developer.android.com/reference/kotlin/androidx/privacysandbox/ads/adservices/common/FrequencyCapFilters#equals(kotlin.Any))`(other: `[Any](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html)`?)` Checks whether two[FrequencyCapFilters](https://developer.android.com/reference/kotlin/androidx/privacysandbox/ads/adservices/common/FrequencyCapFilters)objects contain the same information. |
| `open `[Int](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html)                  | [hashCode](https://developer.android.com/reference/kotlin/androidx/privacysandbox/ads/adservices/common/FrequencyCapFilters#hashCode())`()` Returns the hash of the[FrequencyCapFilters](https://developer.android.com/reference/kotlin/androidx/privacysandbox/ads/adservices/common/FrequencyCapFilters)object's data.                                                                                                              |
| `open `[String](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)            | [toString](https://developer.android.com/reference/kotlin/androidx/privacysandbox/ads/adservices/common/FrequencyCapFilters#toString())`()` Overrides the toString method.                                                                                                                                                                                                                                                            |

|                                                                                                       ### Public properties                                                                                                        |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [List](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html)`<`[KeyedFrequencyCap](https://developer.android.com/reference/kotlin/androidx/privacysandbox/ads/adservices/common/KeyedFrequencyCap)`>` | [keyedFrequencyCapsForClickEvents](https://developer.android.com/reference/kotlin/androidx/privacysandbox/ads/adservices/common/FrequencyCapFilters#keyedFrequencyCapsForClickEvents()) The list of frequency caps applied to events which correlate to a click as interpreted by an adtech.                 |
| [List](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html)`<`[KeyedFrequencyCap](https://developer.android.com/reference/kotlin/androidx/privacysandbox/ads/adservices/common/KeyedFrequencyCap)`>` | [keyedFrequencyCapsForImpressionEvents](https://developer.android.com/reference/kotlin/androidx/privacysandbox/ads/adservices/common/FrequencyCapFilters#keyedFrequencyCapsForImpressionEvents()) The list of frequency caps applied to events which correlate to an impression as interpreted by an adtech. |
| [List](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html)`<`[KeyedFrequencyCap](https://developer.android.com/reference/kotlin/androidx/privacysandbox/ads/adservices/common/KeyedFrequencyCap)`>` | [keyedFrequencyCapsForViewEvents](https://developer.android.com/reference/kotlin/androidx/privacysandbox/ads/adservices/common/FrequencyCapFilters#keyedFrequencyCapsForViewEvents()) The list of frequency caps applied to events which correlate to a view as interpreted by an adtech.                    |
| [List](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html)`<`[KeyedFrequencyCap](https://developer.android.com/reference/kotlin/androidx/privacysandbox/ads/adservices/common/KeyedFrequencyCap)`>` | [keyedFrequencyCapsForWinEvents](https://developer.android.com/reference/kotlin/androidx/privacysandbox/ads/adservices/common/FrequencyCapFilters#keyedFrequencyCapsForWinEvents()) The list of frequency caps applied to events which correlate to a win as interpreted by an adtech.                       |

## Constants

### AD_EVENT_TYPE_CLICK

```
const val AD_EVENT_TYPE_CLICK: Int
```

Represents the Click event type which correlate to a click as interpreted by an adtech.  

### AD_EVENT_TYPE_IMPRESSION

```
const val AD_EVENT_TYPE_IMPRESSION: Int
```

Represents the Impression event type which correlate to an impression as interpreted by an adtech.  

### AD_EVENT_TYPE_VIEW

```
const val AD_EVENT_TYPE_VIEW: Int
```

Represents the View event type which correlate to a view as interpreted by an adtech.  

### AD_EVENT_TYPE_WIN

```
const val AD_EVENT_TYPE_WIN: Int
```

Represents the Win event for ads that were selected as winners in ad selection.

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.  

## Public constructors

### FrequencyCapFilters

Added in[1.1.0-beta12](https://developer.android.com/jetpack/androidx/releases/privacysandbox-ads#1.1.0-beta12)  

```
FrequencyCapFilters(
    keyedFrequencyCapsForWinEvents: List<KeyedFrequencyCap> = listOf(),
    keyedFrequencyCapsForImpressionEvents: List<KeyedFrequencyCap> = listOf(),
    keyedFrequencyCapsForViewEvents: List<KeyedFrequencyCap> = listOf(),
    keyedFrequencyCapsForClickEvents: List<KeyedFrequencyCap> = listOf()
)
```  

|                                                                                                                                       Parameters                                                                                                                                       |
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------|
| `keyedFrequencyCapsForWinEvents: `[List](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html)`<`[KeyedFrequencyCap](https://developer.android.com/reference/kotlin/androidx/privacysandbox/ads/adservices/common/KeyedFrequencyCap)`> = listOf()`        | The list of frequency caps applied to events which correlate to a win as interpreted by an adtech.         |
| `keyedFrequencyCapsForImpressionEvents: `[List](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html)`<`[KeyedFrequencyCap](https://developer.android.com/reference/kotlin/androidx/privacysandbox/ads/adservices/common/KeyedFrequencyCap)`> = listOf()` | The list of frequency caps applied to events which correlate to an impression as interpreted by an adtech. |
| `keyedFrequencyCapsForViewEvents: `[List](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html)`<`[KeyedFrequencyCap](https://developer.android.com/reference/kotlin/androidx/privacysandbox/ads/adservices/common/KeyedFrequencyCap)`> = listOf()`       | The list of frequency caps applied to events which correlate to a view as interpreted by an adtech.        |
| `keyedFrequencyCapsForClickEvents: `[List](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html)`<`[KeyedFrequencyCap](https://developer.android.com/reference/kotlin/androidx/privacysandbox/ads/adservices/common/KeyedFrequencyCap)`> = listOf()`      | The list of frequency caps applied to events which correlate to a click as interpreted by an adtech.       |

## Public functions

### equals

```
open operator fun equals(other: Any?): Boolean
```

Checks whether two[FrequencyCapFilters](https://developer.android.com/reference/kotlin/androidx/privacysandbox/ads/adservices/common/FrequencyCapFilters)objects contain the same information.  

### hashCode

```
open fun hashCode(): Int
```

Returns the hash of the[FrequencyCapFilters](https://developer.android.com/reference/kotlin/androidx/privacysandbox/ads/adservices/common/FrequencyCapFilters)object's data.  

### toString

```
open fun toString(): String
```

Overrides the toString method.  

## Public properties

### keyedFrequencyCapsForClickEvents

Added in[1.1.0-beta12](https://developer.android.com/jetpack/androidx/releases/privacysandbox-ads#1.1.0-beta12)  

```
val keyedFrequencyCapsForClickEvents: List<KeyedFrequencyCap>
```

The list of frequency caps applied to events which correlate to a click as interpreted by an adtech.  

### keyedFrequencyCapsForImpressionEvents

Added in[1.1.0-beta12](https://developer.android.com/jetpack/androidx/releases/privacysandbox-ads#1.1.0-beta12)  

```
val keyedFrequencyCapsForImpressionEvents: List<KeyedFrequencyCap>
```

The list of frequency caps applied to events which correlate to an impression as interpreted by an adtech.  

### keyedFrequencyCapsForViewEvents

Added in[1.1.0-beta12](https://developer.android.com/jetpack/androidx/releases/privacysandbox-ads#1.1.0-beta12)  

```
val keyedFrequencyCapsForViewEvents: List<KeyedFrequencyCap>
```

The list of frequency caps applied to events which correlate to a view as interpreted by an adtech.  

### keyedFrequencyCapsForWinEvents

Added in[1.1.0-beta12](https://developer.android.com/jetpack/androidx/releases/privacysandbox-ads#1.1.0-beta12)  

```
val keyedFrequencyCapsForWinEvents: List<KeyedFrequencyCap>
```

The list of frequency caps applied to events which correlate to a win as interpreted by an adtech.