type FrequencyCap (v202411)

  • FrequencyCap limits how many times a single viewer sees the same LineItem within a specific timeframe.

  • It uses maxImpressions for the maximum view count, numTimeUnits for the duration's length, and timeUnit for the time unit (like MINUTE, HOUR, DAY, etc.).

  • FrequencyCap is used by ForecastService, InventoryService, LineItemService, and ProposalLineItemService.

  • The timeUnit enumeration includes options like MINUTE, HOUR, DAY, WEEK, MONTH, LIFETIME, POD (for video streams), and STREAM (for video streams).
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.

Namespace
https://www.google.com/apis/ads/publisher/v202411

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.