type FrequencyCap (v202508)

  • A FrequencyCap represents a limit on how many times a single viewer can see the same LineItem within a defined time period.

  • FrequencyCaps include fields for maxImpressions, the total number of impressions allowed, numTimeUnits, the quantity of time units, and timeUnit, the specific unit of time (e.g., MINUTE, HOUR, DAY).

  • Time units for FrequencyCaps can be standard time periods or specific video-related units like POD or STREAM.
Service
ForecastService InventoryService LineItemService ProposalLineItemService
Dependencies
ProposalLineItem
▼
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/v202508

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.