type FrequencyCap (v202402)
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/v202402
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 2024-02-13 UTC.
[null,null,["Last updated 2024-02-13 UTC."],[[["The `FrequencyCap` object in Google Ad Manager is used to limit the number of times an ad is shown to a single viewer within a given timeframe."],["It's defined by three main properties: `maxImpressions`, `numTimeUnits`, and `timeUnit`, which together determine the frequency limit."],["`timeUnit` offers various options like minutes, hours, days, weeks, and even lifetime or per video stream for video ads."],["Frequency caps are applicable to Line Items, Proposal Line Items, and can be accessed via services like ForecastService, InventoryService, LineItemService, and ProposalLineItemService."]]],["The core content describes the `FrequencyCap`, which limits a viewer's exposure to a specific `LineItem` within a set timeframe. Key fields include `maxImpressions` (maximum impressions allowed), `numTimeUnits` (quantity of time units), and `timeUnit` (the time unit itself). Enumerated `timeUnit` values include `MINUTE`, `HOUR`, `DAY`, `WEEK`, `MONTH`, `LIFETIME`, `POD`, `STREAM`, and `UNKNOWN`, which provide different temporal granularities for frequency capping. The service `ForecastService` includes this information and how it relates to `LineItemSummary` and `ProposalLineItem`.\n"]]
