Looking for a REST API? The Ad Manager API (Beta) is now available.

type FrequencyCap (v202408)

Service

ForecastService InventoryService LineItemService ProposalLineItemService

Dependencies

LabelFrequencyCap

▼

FrequencyCap

Represents a limit on the number of times a single viewer can be exposed to the same LineItem in a specified time period.

Field
`maxImpressions`	`xsd:int` The maximum number of impressions than can be served to a user within a specified time period.
`numTimeUnits`	`xsd:int` The number of `FrequencyCap#timeUnit` to represent the total time period.
`timeUnit`	`TimeUnit` The unit of time for specifying the time period. Enumerations `MINUTE` `HOUR` `DAY` `WEEK` `MONTH` `LIFETIME` `POD` Per pod of ads in a video stream. Only valid for entities in a EnvironmentType.VIDEO_PLAYER environment. `STREAM` Per video stream. Only valid for entities in a EnvironmentType.VIDEO_PLAYER environment. `UNKNOWN` The value returned if the actual value is not exposed by the requested API version.

Field

xsd:int

The maximum number of impressions than can be served to a user within a specified time period.

xsd:int

The number of FrequencyCap#timeUnit to represent the total time period.

The unit of time for specifying the time period.

Enumerations

MINUTE
HOUR
DAY
WEEK
MONTH
LIFETIME
POD: Per pod of ads in a video stream. Only valid for entities in a EnvironmentType.VIDEO_PLAYER environment.
STREAM: Per video stream. Only valid for entities in a EnvironmentType.VIDEO_PLAYER environment.
UNKNOWN: The value returned if the actual value is not exposed by the requested API version.