type FrequencyCap (v202411)
Stay organized with collections
Save and categorize content based on your preferences.
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.
|
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-08-06 UTC.
[null,null,["Last updated 2025-08-06 UTC."],[[["\u003cp\u003eA FrequencyCap in Google Ad Manager limits the number of times a viewer sees the same LineItem within a specific timeframe.\u003c/p\u003e\n"],["\u003cp\u003eIt's defined by the maximum impressions (\u003ccode\u003emaxImpressions\u003c/code\u003e), the time period length (\u003ccode\u003enumTimeUnits\u003c/code\u003e), and the time unit (\u003ccode\u003etimeUnit\u003c/code\u003e like hours, days, etc.).\u003c/p\u003e\n"],["\u003cp\u003eFrequencyCaps are utilized within services like ForecastService, InventoryService, LineItemService, and ProposalLineItemService.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003etimeUnit\u003c/code\u003e allows for standard durations and also specialized options like "POD" and "STREAM" for video content.\u003c/p\u003e\n"]]],["The content defines `FrequencyCap`, which limits viewer exposure to a `LineItem` within a set timeframe. Key fields include `maxImpressions`, setting the maximum allowed impressions; `numTimeUnits`, defining the total time period; and `timeUnit`, specifying the unit of time (e.g., `MINUTE`, `HOUR`, `DAY`, `WEEK`, `MONTH`, `LIFETIME`, `POD`, `STREAM`). The time unit enumerations can be used for different time periods, `POD` and `STREAM` only valid for `EnvironmentType.VIDEO_PLAYER`.\n"],null,["# type FrequencyCap (v202411)\n\n**Service** \n[ForecastService](/ad-manager/api/reference/v202411/ForecastService.FrequencyCap) **InventoryService** [LineItemService](/ad-manager/api/reference/v202411/LineItemService.FrequencyCap) [ProposalLineItemService](/ad-manager/api/reference/v202411/ProposalLineItemService.FrequencyCap) **Dependencies** \n[LabelFrequencyCap](/ad-manager/api/reference/v202411/InventoryService.LabelFrequencyCap) \n▼\n**FrequencyCap**\n\nRepresents a limit on the number of times a single viewer can be exposed to the same [LineItem](/ad-manager/api/reference/v202411/ForecastService.LineItem) in a specified time period.\n\n*** ** * ** ***\n\nNamespace\n:\n `https://www.google.com/apis/ads/publisher/v202411`\n\n| Field ----- ||\n|----------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ### `maxImpressions` | ` `xsd:`int` The maximum number of impressions than can be served to a user within a specified time period. |\n| ### `numTimeUnits` | ` `xsd:`int` The number of `FrequencyCap#timeUnit` to represent the total time period. |\n| ### `timeUnit` | ` `[TimeUnit](/ad-manager/api/reference/v202411/InventoryService.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](/ad-manager/api/reference/v202411/InventoryService.EnvironmentType#VIDEO_PLAYER) environment. `STREAM` : Per video stream. Only valid for entities in a [EnvironmentType.VIDEO_PLAYER](/ad-manager/api/reference/v202411/InventoryService.EnvironmentType#VIDEO_PLAYER) environment. `UNKNOWN` : The value returned if the actual value is not exposed by the requested API version. \u003cbr /\u003e |"]]
