FrequencyCapFilters

Artifact: androidx.privacysandbox.ads:ads-adservices

Kotlin |Java

@ExperimentalFeatures.Ext8OptIn
class FrequencyCapFilters

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

Frequency caps filters combine an event type with a list of 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`	`AD_EVENT_TYPE_CLICK` Represents the Click event type which correlate to a click as interpreted by an adtech.
`const Int`	`AD_EVENT_TYPE_IMPRESSION` Represents the Impression event type which correlate to an impression as interpreted by an adtech.
`const Int`	`AD_EVENT_TYPE_VIEW` Represents the View event type which correlate to a view as interpreted by an adtech.
`const Int`	`AD_EVENT_TYPE_WIN` Represents the Win event for ads that were selected as winners in ad selection.

Public constructors
`FrequencyCapFilters( keyedFrequencyCapsForWinEvents: List<KeyedFrequencyCap>, keyedFrequencyCapsForImpressionEvents: List<KeyedFrequencyCap>, keyedFrequencyCapsForViewEvents: List<KeyedFrequencyCap>, keyedFrequencyCapsForClickEvents: List<KeyedFrequencyCap> )`

Public functions
`open operator Boolean`	`equals(other: Any?)` Checks whether two `FrequencyCapFilters` objects contain the same information.
`open Int`	`hashCode()` Returns the hash of the `FrequencyCapFilters` object's data.
`open String`	`toString()` Overrides the toString method.

Public properties
`List<KeyedFrequencyCap>`	`keyedFrequencyCapsForClickEvents` The list of frequency caps applied to events which correlate to a click as interpreted by an adtech.
`List<KeyedFrequencyCap>`	`keyedFrequencyCapsForImpressionEvents` The list of frequency caps applied to events which correlate to an impression as interpreted by an adtech.
`List<KeyedFrequencyCap>`	`keyedFrequencyCapsForViewEvents` The list of frequency caps applied to events which correlate to a view as interpreted by an adtech.
`List<KeyedFrequencyCap>`	`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-beta07

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

Parameters
`keyedFrequencyCapsForWinEvents: List<KeyedFrequencyCap> = listOf()`	The list of frequency caps applied to events which correlate to a win as interpreted by an adtech.
`keyedFrequencyCapsForImpressionEvents: List<KeyedFrequencyCap> = listOf()`	The list of frequency caps applied to events which correlate to an impression as interpreted by an adtech.
`keyedFrequencyCapsForViewEvents: List<KeyedFrequencyCap> = listOf()`	The list of frequency caps applied to events which correlate to a view as interpreted by an adtech.
`keyedFrequencyCapsForClickEvents: List<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 objects contain the same information.

hashCode

open fun hashCode(): Int

Returns the hash of the FrequencyCapFilters object's data.

toString

open fun toString(): String

Overrides the toString method.

Public properties

keyedFrequencyCapsForClickEvents

Added in 1.1.0-beta07

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-beta07

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-beta07

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-beta07

val keyedFrequencyCapsForWinEvents: List<KeyedFrequencyCap>

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