Page Summary
-
FrequencyCaps provides access to and management of frequency caps.
-
You can retrieve the entity type of FrequencyCaps as a string.
-
Frequency caps can be retrieved for specific event types and time units.
-
A builder is available to create new frequency caps for a campaign.
-
Existing frequency caps can be removed based on event type and time unit.
Methods:
| Member | Type | Description |
|---|---|---|
String
|
Returns the type of this entity as a String
, in this case, "FrequencyCaps"
. |
|
AdsApp.FrequencyCap
|
Get the frequency cap for the chosen event type and time unit. | |
AdsApp.FrequencyCapBuilder
|
Returns a new frequency cap builder for the campaign that the frequency caps belong to. | |
void
|
Remove the frequency cap for the chosen event type and time unit. |
getEntityType()
Returns the type of this entity as a String
, in this case, "FrequencyCaps"
. Return values:
| Type | Description |
|---|---|
String
|
Type of this entity: "FrequencyCaps"
. |
getFrequencyCapFor(eventType, timeUnit)
Get the frequency cap for the chosen event type and time unit. Arguments:
| Name | Type | Description |
|---|---|---|
|
eventType
|
String
|
The type of event that the cap applies to. |
|
timeUnit
|
String
|
The unit of time that the cap applies to. If unspecified, the function returns the first frequency cap applied to the event type. |
Return values:
| Type | Description |
|---|---|
AdsApp.FrequencyCap
|
The corresponding frequency cap with the event type and time unit
or null
if one does not exist. |
newFrequencyCapBuilder()
Returns a new frequency cap builder for the campaign that the frequency
caps belong to. When FrequencyCapBuilder.build()
is called, a frequency cap will be added in this campaign. Return values:
| Type | Description |
|---|---|
AdsApp.FrequencyCapBuilder
|
Frequency cap builder used to create a new frequency cap in the campaign. |
removeFrequencyCapFor(eventType, timeUnit)
Remove the frequency cap for the chosen event type and time unit. Returns nothing.
Arguments:
| Name | Type | Description |
|---|---|---|
|
eventType
|
String
|
The type of event that the cap applies to. The value can
be either IMPRESSION
or VIDEO_VIEW
. |
|
timeUnit
|
String
|
The unit of time that the cap applies to. If unspecified, the function removes all frequency caps applied to the event type. |
