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\u003eThe FrequencyCap object represents a limit on the number of times a viewer can see the same ad within a specific timeframe.\u003c/p\u003e\n"],["\u003cp\u003eIt utilizes \u003ccode\u003emaxImpressions\u003c/code\u003e, \u003ccode\u003enumTimeUnits\u003c/code\u003e, and \u003ccode\u003etimeUnit\u003c/code\u003e to define the frequency cap.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003etimeUnit\u003c/code\u003e offers various options like \u003ccode\u003eMINUTE\u003c/code\u003e, \u003ccode\u003eHOUR\u003c/code\u003e, \u003ccode\u003eDAY\u003c/code\u003e, \u003ccode\u003eWEEK\u003c/code\u003e, \u003ccode\u003eMONTH\u003c/code\u003e, \u003ccode\u003eLIFETIME\u003c/code\u003e, \u003ccode\u003ePOD\u003c/code\u003e, \u003ccode\u003eSTREAM\u003c/code\u003e, and \u003ccode\u003eUNKNOWN\u003c/code\u003e for flexibility in setting the desired timeframe.\u003c/p\u003e\n"],["\u003cp\u003eThis object is relevant to \u003ccode\u003eForecastService\u003c/code\u003e, \u003ccode\u003eInventoryService\u003c/code\u003e, \u003ccode\u003eLineItemService\u003c/code\u003e, and \u003ccode\u003eProposalLineItemService\u003c/code\u003e.\u003c/p\u003e\n"]]],["The core content describes the `FrequencyCap`, which limits a viewer's exposure to a specific `LineItem` over time. Key information includes: `maxImpressions` (the maximum impressions allowed), `numTimeUnits` (the duration of the time period), and `timeUnit` (the unit of time, such as `MINUTE`, `HOUR`, `DAY`, `WEEK`, `MONTH`, or `LIFETIME`). Other enumerated time units, applicable for video streams are: `POD` and `STREAM`. `UNKNOWN` is also a possible value.\n"],null,["# type FrequencyCap (v202411)\n\n**Service** \n**ForecastService** [InventoryService](/ad-manager/api/reference/v202411/InventoryService.FrequencyCap) [LineItemService](/ad-manager/api/reference/v202411/LineItemService.FrequencyCap) [ProposalLineItemService](/ad-manager/api/reference/v202411/ProposalLineItemService.FrequencyCap) **Dependencies** \n[LineItemSummary](/ad-manager/api/reference/v202411/ForecastService.LineItemSummary) [ProposalLineItem](/ad-manager/api/reference/v202411/ForecastService.ProposalLineItem) \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/ForecastService.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/ForecastService.EnvironmentType#VIDEO_PLAYER) environment. `STREAM` : Per video stream. Only valid for entities in a [EnvironmentType.VIDEO_PLAYER](/ad-manager/api/reference/v202411/ForecastService.EnvironmentType#VIDEO_PLAYER) environment. `UNKNOWN` : The value returned if the actual value is not exposed by the requested API version. \u003cbr /\u003e |"]]
