type FrequencyCap (v202411)

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

  • The maxImpressions field indicates the maximum impressions allowed per user in the specified time period.

  • numTimeUnits determines the total time period based on the timeUnit.

  • timeUnit defines the unit of time used for the frequency cap duration.

  • Available time units include MINUTE, HOUR, DAY, WEEK, MONTH, LIFETIME, POD, STREAM, and UNKNOWN.
Service
ForecastService InventoryService LineItemService ProposalLineItemService
Dependencies
LineItemSummary
▼
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.