# 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)

*** ** * ** ***


```
@ExperimentalFeatures.Ext8OptIn
public final 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 `https://developer.android.com/reference/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 |
|---|---|
| `static final int` | `https://developer.android.com/reference/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. |
| `static final int` | `https://developer.android.com/reference/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. |
| `static final int` | `https://developer.android.com/reference/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. |
| `static final int` | `https://developer.android.com/reference/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 |
|---|
| `https://developer.android.com/reference/androidx/privacysandbox/ads/adservices/common/FrequencyCapFilters#FrequencyCapFilters(kotlin.collections.List,kotlin.collections.List,kotlin.collections.List,kotlin.collections.List)( @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/util/List.html<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/privacysandbox/ads/adservices/common/KeyedFrequencyCap> keyedFrequencyCapsForWinEvents, @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/util/List.html<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/privacysandbox/ads/adservices/common/KeyedFrequencyCap> keyedFrequencyCapsForImpressionEvents, @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/util/List.html<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/privacysandbox/ads/adservices/common/KeyedFrequencyCap> keyedFrequencyCapsForViewEvents, @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/util/List.html<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/privacysandbox/ads/adservices/common/KeyedFrequencyCap> keyedFrequencyCapsForClickEvents )` |

| ### Public methods |
|---|---|
| `boolean` | `https://developer.android.com/reference/androidx/privacysandbox/ads/adservices/common/FrequencyCapFilters#equals(kotlin.Any)(https://developer.android.com/reference/java/lang/Object.html other)` Checks whether two `https://developer.android.com/reference/androidx/privacysandbox/ads/adservices/common/FrequencyCapFilters` objects contain the same information. |
| `final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/util/List.html<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/privacysandbox/ads/adservices/common/KeyedFrequencyCap>` | `https://developer.android.com/reference/androidx/privacysandbox/ads/adservices/common/FrequencyCapFilters#getKeyedFrequencyCapsForClickEvents()()` The list of frequency caps applied to events which correlate to a click as interpreted by an adtech. |
| `final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/util/List.html<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/privacysandbox/ads/adservices/common/KeyedFrequencyCap>` | `https://developer.android.com/reference/androidx/privacysandbox/ads/adservices/common/FrequencyCapFilters#getKeyedFrequencyCapsForImpressionEvents()()` The list of frequency caps applied to events which correlate to an impression as interpreted by an adtech. |
| `final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/util/List.html<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/privacysandbox/ads/adservices/common/KeyedFrequencyCap>` | `https://developer.android.com/reference/androidx/privacysandbox/ads/adservices/common/FrequencyCapFilters#getKeyedFrequencyCapsForViewEvents()()` The list of frequency caps applied to events which correlate to a view as interpreted by an adtech. |
| `final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/util/List.html<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/privacysandbox/ads/adservices/common/KeyedFrequencyCap>` | `https://developer.android.com/reference/androidx/privacysandbox/ads/adservices/common/FrequencyCapFilters#getKeyedFrequencyCapsForWinEvents()()` The list of frequency caps applied to events which correlate to a win as interpreted by an adtech. |
| `int` | `https://developer.android.com/reference/androidx/privacysandbox/ads/adservices/common/FrequencyCapFilters#hashCode()()` Returns the hash of the `https://developer.android.com/reference/androidx/privacysandbox/ads/adservices/common/FrequencyCapFilters` object's data. |
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/privacysandbox/ads/adservices/common/FrequencyCapFilters#toString()()` Overrides the toString method. |

## Constants

### AD_EVENT_TYPE_CLICK

```
public static final int AD_EVENT_TYPE_CLICK
```

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

### AD_EVENT_TYPE_IMPRESSION

```
public static final int AD_EVENT_TYPE_IMPRESSION
```

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

### AD_EVENT_TYPE_VIEW

```
public static final int AD_EVENT_TYPE_VIEW
```

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

### AD_EVENT_TYPE_WIN

```
public static final int AD_EVENT_TYPE_WIN
```

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)

```
public FrequencyCapFilters(
    @NonNull List<@NonNull KeyedFrequencyCap> keyedFrequencyCapsForWinEvents,
    @NonNull List<@NonNull KeyedFrequencyCap> keyedFrequencyCapsForImpressionEvents,
    @NonNull List<@NonNull KeyedFrequencyCap> keyedFrequencyCapsForViewEvents,
    @NonNull List<@NonNull KeyedFrequencyCap> keyedFrequencyCapsForClickEvents
)
```

| Parameters |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/util/List.html<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/privacysandbox/ads/adservices/common/KeyedFrequencyCap> keyedFrequencyCapsForWinEvents` | The list of frequency caps applied to events which correlate to a win as interpreted by an adtech. |
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/util/List.html<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/privacysandbox/ads/adservices/common/KeyedFrequencyCap> keyedFrequencyCapsForImpressionEvents` | The list of frequency caps applied to events which correlate to an impression as interpreted by an adtech. |
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/util/List.html<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/privacysandbox/ads/adservices/common/KeyedFrequencyCap> keyedFrequencyCapsForViewEvents` | The list of frequency caps applied to events which correlate to a view as interpreted by an adtech. |
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/util/List.html<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/privacysandbox/ads/adservices/common/KeyedFrequencyCap> keyedFrequencyCapsForClickEvents` | The list of frequency caps applied to events which correlate to a click as interpreted by an adtech. |

## Public methods

### equals

```
public boolean equals(Object other)
```

Checks whether two `https://developer.android.com/reference/androidx/privacysandbox/ads/adservices/common/FrequencyCapFilters` objects contain the same information.

### getKeyedFrequencyCapsForClickEvents

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

```
public final @NonNull List<@NonNull KeyedFrequencyCap> getKeyedFrequencyCapsForClickEvents()
```

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

### getKeyedFrequencyCapsForImpressionEvents

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

```
public final @NonNull List<@NonNull KeyedFrequencyCap> getKeyedFrequencyCapsForImpressionEvents()
```

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

### getKeyedFrequencyCapsForViewEvents

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

```
public final @NonNull List<@NonNull KeyedFrequencyCap> getKeyedFrequencyCapsForViewEvents()
```

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

### getKeyedFrequencyCapsForWinEvents

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

```
public final @NonNull List<@NonNull KeyedFrequencyCap> getKeyedFrequencyCapsForWinEvents()
```

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

### hashCode

```
public int hashCode()
```

Returns the hash of the `https://developer.android.com/reference/androidx/privacysandbox/ads/adservices/common/FrequencyCapFilters` object's data.

### toString

```
public @NonNull String toString()
```

Overrides the toString method.