Builder

class Builder
kotlin.Any
   ↳ android.adservices.common.FrequencyCapFilters.Builder

Builder for creating FrequencyCapFilters objects.

Summary

Public constructors

Public methods
FrequencyCapFilters

Builds and returns a FrequencyCapFilters instance.
FrequencyCapFilters.Builder

Sets the list of KeyedFrequencyCap objects that will filter on the AD_EVENT_TYPE_CLICK event type.
FrequencyCapFilters.Builder

Sets the list of KeyedFrequencyCap objects that will filter on the AD_EVENT_TYPE_IMPRESSION event type.
FrequencyCapFilters.Builder

Sets the list of KeyedFrequencyCap objects that will filter on the AD_EVENT_TYPE_VIEW event type.
FrequencyCapFilters.Builder

Sets the list of KeyedFrequencyCap objects that will filter on the AD_EVENT_TYPE_WIN event type.

Public constructors

Builder

Added in API level 35
Also in Ad Services Extensions 8
Builder()

Public methods

build

Added in API level 35
Also in Ad Services Extensions 8
fun build(): FrequencyCapFilters

Builds and returns a FrequencyCapFilters instance.

No more than 20 frequency cap filters may be associated with a single ad. If more total filters than the limit have been set, an IllegalArgumentException will be thrown.

Return
FrequencyCapFilters This value cannot be null.

setKeyedFrequencyCapsForClickEvents

Added in API level 35
Also in Ad Services Extensions 8
fun setKeyedFrequencyCapsForClickEvents(keyedFrequencyCapsForClickEvents: MutableList<KeyedFrequencyCap!>): FrequencyCapFilters.Builder

Sets the list of KeyedFrequencyCap objects that will filter on the AD_EVENT_TYPE_CLICK event type.

See getKeyedFrequencyCapsForClickEvents() for more information.

Parameters
keyedFrequencyCapsForClickEvents MutableList<KeyedFrequencyCap!>: This value cannot be null.
Return
FrequencyCapFilters.Builder This value cannot be null.

setKeyedFrequencyCapsForImpressionEvents

Added in API level 35
Also in Ad Services Extensions 8
fun setKeyedFrequencyCapsForImpressionEvents(keyedFrequencyCapsForImpressionEvents: MutableList<KeyedFrequencyCap!>): FrequencyCapFilters.Builder

Sets the list of KeyedFrequencyCap objects that will filter on the AD_EVENT_TYPE_IMPRESSION event type.

See getKeyedFrequencyCapsForImpressionEvents() for more information.

Parameters
keyedFrequencyCapsForImpressionEvents MutableList<KeyedFrequencyCap!>: This value cannot be null.
Return
FrequencyCapFilters.Builder This value cannot be null.

setKeyedFrequencyCapsForViewEvents

Added in API level 35
Also in Ad Services Extensions 8
fun setKeyedFrequencyCapsForViewEvents(keyedFrequencyCapsForViewEvents: MutableList<KeyedFrequencyCap!>): FrequencyCapFilters.Builder

Sets the list of KeyedFrequencyCap objects that will filter on the AD_EVENT_TYPE_VIEW event type.

See getKeyedFrequencyCapsForViewEvents() for more information.

Parameters
keyedFrequencyCapsForViewEvents MutableList<KeyedFrequencyCap!>: This value cannot be null.
Return
FrequencyCapFilters.Builder This value cannot be null.

setKeyedFrequencyCapsForWinEvents

Added in API level 35
Also in Ad Services Extensions 8
fun setKeyedFrequencyCapsForWinEvents(keyedFrequencyCapsForWinEvents: MutableList<KeyedFrequencyCap!>): FrequencyCapFilters.Builder

Sets the list of KeyedFrequencyCap objects that will filter on the AD_EVENT_TYPE_WIN event type.

See getKeyedFrequencyCapsForWinEvents() for more information.

Parameters
keyedFrequencyCapsForWinEvents MutableList<KeyedFrequencyCap!>: This value cannot be null.
Return
FrequencyCapFilters.Builder This value cannot be null.