type FrequencyCap (v202411)

  • The FrequencyCap object represents a limit on the number of times a viewer can see the same ad within a specific timeframe.

  • It utilizes maxImpressions, numTimeUnits, and timeUnit to define the frequency cap.

  • timeUnit offers various options like MINUTE, HOUR, DAY, WEEK, MONTH, LIFETIME, POD, STREAM, and UNKNOWN for flexibility in setting the desired timeframe.

  • This object is relevant to ForecastService, InventoryService, LineItemService, and ProposalLineItemService.
Service
ForecastService InventoryService LineItemService ProposalLineItemService
Dependencies
LineItemSummary 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/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.