Page Summary
-
The FrequencyCapBuilder is used to create FrequencyCap objects.
-
You can set the event type, the cap limit, and the time unit for the frequency cap using the builder's methods.
-
The
build()method finalizes and creates the frequency cap object.
Methods:
| Member | Type | Description |
|---|---|---|
void
|
Builds the frequency cap. | |
AdsApp.FrequencyCapBuilder
|
Set the event type to the new frequency cap. | |
AdsApp.FrequencyCapBuilder
|
Set the cap number to the new frequency cap. | |
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:
| Name | Type | Description |
|---|---|---|
|
eventType
|
String
|
The type of event that the cap applies to. The value can
be either IMPRESSION
or VIDEO_VIEW
. |
Return values:
| Type | Description |
|---|---|
AdsApp.FrequencyCapBuilder
|
The frequency cap builder with the specified event type. |
withLimit(limit)
Set the cap number to the new frequency cap. Arguments:
| Name | Type | Description |
|---|---|---|
|
limit
|
long
|
Number of time units the cap lasts. |
Return values:
| Type | Description |
|---|---|
AdsApp.FrequencyCapBuilder
|
The frequency cap builder with the specified cap number. |
withTimeUnit(timeUnit)
Set the time unit to the new frequency cap. Arguments:
| Name | Type | Description |
|---|---|---|
|
timeUnit
|
String
|
Unit of time the cap is defined at. The value can be DAY
, WEEK
or MONTH
. |
Return values:
| Type | Description |
|---|---|
AdsApp.FrequencyCapBuilder
|
The frequency cap builder with the specified time unit. |
