@ExperimentalFeatures.Ext8OptIn
public final 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
static final int
static final int
static final int
static final int

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.

Public constructors
FrequencyCapFilters(
    @NonNull List<@NonNull KeyedFrequencyCap> keyedFrequencyCapsForWinEvents,
    @NonNull List<@NonNull KeyedFrequencyCap> keyedFrequencyCapsForImpressionEvents,
    @NonNull List<@NonNull KeyedFrequencyCap> keyedFrequencyCapsForViewEvents,
    @NonNull List<@NonNull KeyedFrequencyCap> keyedFrequencyCapsForClickEvents
)

Public methods
boolean
equals(Object other)

Checks whether two FrequencyCapFilters objects contain the same information.
final @NonNull List<@NonNull KeyedFrequencyCap>

The list of frequency caps applied to events which correlate to a click as interpreted by an adtech.
final @NonNull List<@NonNull KeyedFrequencyCap>

The list of frequency caps applied to events which correlate to an impression as interpreted by an adtech.
final @NonNull List<@NonNull KeyedFrequencyCap>

The list of frequency caps applied to events which correlate to a view as interpreted by an adtech.
final @NonNull List<@NonNull KeyedFrequencyCap>

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

Returns the hash of the FrequencyCapFilters object's data.
@NonNull String

Overrides the toString method.

Constants

AD_EVENT_TYPE_CLICK

public static final int AD_EVENT_TYPE_CLICK

AD_EVENT_TYPE_IMPRESSION

public static final int AD_EVENT_TYPE_IMPRESSION

AD_EVENT_TYPE_VIEW

public static final int AD_EVENT_TYPE_VIEW

AD_EVENT_TYPE_WIN

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.

Public constructors

FrequencyCapFilters

Added in 1.1.0-beta06
public FrequencyCapFilters(
    @NonNull List<@NonNull KeyedFrequencyCap> keyedFrequencyCapsForWinEvents,
    @NonNull List<@NonNull KeyedFrequencyCap> keyedFrequencyCapsForImpressionEvents,
    @NonNull List<@NonNull KeyedFrequencyCap> keyedFrequencyCapsForViewEvents,
    @NonNull List<@NonNull KeyedFrequencyCap> keyedFrequencyCapsForClickEvents
)
Parameters
@NonNull List<@NonNull KeyedFrequencyCap> keyedFrequencyCapsForWinEvents

The list of frequency caps applied to events which correlate to a win as interpreted by an adtech.
@NonNull List<@NonNull KeyedFrequencyCap> keyedFrequencyCapsForImpressionEvents

The list of frequency caps applied to events which correlate to an impression as interpreted by an adtech.
@NonNull List<@NonNull KeyedFrequencyCap> keyedFrequencyCapsForViewEvents

The list of frequency caps applied to events which correlate to a view as interpreted by an adtech.
@NonNull List<@NonNull 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 FrequencyCapFilters objects contain the same information.

getKeyedFrequencyCapsForClickEvents

Added in 1.1.0-beta06
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-beta06
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-beta06
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-beta06
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 FrequencyCapFilters object's data.

toString

public @NonNull String toString()

Overrides the toString method.