AdsApp.​FrequencyCapBuilder

Stay organized with collections Save and categorize content based on your preferences.
Builder for FrequencyCap objects.

Methods:

MemberTypeDescription
build void Builds the frequency cap.
withEventType AdsApp.FrequencyCapBuilder Set the event type to the new frequency cap.
withLimit AdsApp.FrequencyCapBuilder Set the cap number to the new frequency cap.
withTimeUnit AdsApp.FrequencyCapBuilder Set the time unit to the new frequency cap.

build()

Builds the frequency cap.

Returns nothing.

withEventType(eventType)

Set the event type to the new frequency cap.

Arguments:

NameTypeDescription
eventType String The type of event that the cap applies to. The value can be either IMPRESSION or VIDEO_VIEW.

Return values:

TypeDescription
AdsApp.FrequencyCapBuilder The frequency cap builder with the specified event type.

withLimit(limit)

Set the cap number to the new frequency cap.

Arguments:

NameTypeDescription
limit long Number of time units the cap lasts.

Return values:

TypeDescription
AdsApp.FrequencyCapBuilder The frequency cap builder with the specified cap number.

withTimeUnit(timeUnit)

Set the time unit to the new frequency cap.

Arguments:

NameTypeDescription
timeUnit String Unit of time the cap is defined at. The value can be DAY, WEEK or MONTH.

Return values:

TypeDescription
AdsApp.FrequencyCapBuilder The frequency cap builder with the specified time unit.