Starting
September 8, 2025, every new line item will need to declare whether or not they will serve Eurpoean Union (EU) political ads. Display & Video 360 API and SDF uploads that don't provide declarations will fail. See our
deprecations page for more details on how to update your integration to make this declaration.
FrequencyCap
Stay organized with collections
Save and categorize content based on your preferences.
Settings that control the number of times a user may be shown with the same ad during a given time period.
| JSON representation |
{
"unlimited": boolean,
"timeUnit": enum (TimeUnit),
"timeUnitCount": integer,
"maxImpressions": integer,
"maxViews": integer
} |
| Fields |
unlimited |
boolean
Whether unlimited frequency capping is applied. When this field is set to true, the remaining frequency cap fields are not applicable.
|
timeUnit |
enum (TimeUnit)
The time unit in which the frequency cap will be applied. Required when unlimited is false.
|
timeUnitCount |
integer
The number of timeUnit the frequency cap will last. Required when unlimited is false. The following restrictions apply based on the value of timeUnit:
TIME_UNIT_MONTHS - must be 1TIME_UNIT_WEEKS - must be between 1 and 4TIME_UNIT_DAYS - must be between 1 and 6TIME_UNIT_HOURS - must be between 1 and 23TIME_UNIT_MINUTES - must be between 1 and 59
|
maxImpressions |
integer
The maximum number of times a user may be shown the same ad during this period. Must be greater than 0. Required when unlimited is false and maxViews is not set.
|
maxViews |
integer
Optional. The maximum number of times a user may click-through or fully view an ad during this period until it is no longer served to them. Must be greater than 0. Only applicable to YouTube and Partners resources. Required when unlimited is false and maxImpressions is not set.
|
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-03-27 UTC.
[null,null,["Last updated 2025-03-27 UTC."],[],[],null,["# FrequencyCap\n\n- [JSON representation](#SCHEMA_REPRESENTATION)\n\nSettings that control the number of times a user may be shown with the same ad during a given time period.\n\n| JSON representation |\n|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"unlimited\": boolean, \"timeUnit\": enum (/display-video/api/reference/rest/v4/TimeUnit), \"timeUnitCount\": integer, \"maxImpressions\": integer, \"maxViews\": integer } ``` |\n\n| Fields ||\n|------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `unlimited` | `boolean` Whether unlimited frequency capping is applied. When this field is set to `true`, the remaining frequency cap fields are not applicable. |\n| `timeUnit` | `enum (`[TimeUnit](/display-video/api/reference/rest/v4/TimeUnit)`)` The time unit in which the frequency cap will be applied. Required when [unlimited](/display-video/api/reference/rest/v4/FrequencyCap#FIELDS.unlimited) is `false`. |\n| `timeUnitCount` | `integer` The number of [timeUnit](/display-video/api/reference/rest/v4/FrequencyCap#FIELDS.time_unit) the frequency cap will last. Required when [unlimited](/display-video/api/reference/rest/v4/FrequencyCap#FIELDS.unlimited) is `false`. The following restrictions apply based on the value of [timeUnit](/display-video/api/reference/rest/v4/FrequencyCap#FIELDS.time_unit): - `TIME_UNIT_MONTHS` - must be 1 - `TIME_UNIT_WEEKS` - must be between 1 and 4 - `TIME_UNIT_DAYS` - must be between 1 and 6 - `TIME_UNIT_HOURS` - must be between 1 and 23 - `TIME_UNIT_MINUTES` - must be between 1 and 59 |\n| `maxImpressions` | `integer` The maximum number of times a user may be shown the same ad during this period. Must be greater than 0. Required when [unlimited](/display-video/api/reference/rest/v4/FrequencyCap#FIELDS.unlimited) is `false` and [maxViews](/display-video/api/reference/rest/v4/FrequencyCap#FIELDS.max_views) is not set. |\n| `maxViews` | `integer` Optional. The maximum number of times a user may click-through or fully view an ad during this period until it is no longer served to them. Must be greater than 0. Only applicable to YouTube and Partners resources. Required when [unlimited](/display-video/api/reference/rest/v4/FrequencyCap#FIELDS.unlimited) is `false` and [maxImpressions](/display-video/api/reference/rest/v4/FrequencyCap#FIELDS.max_impressions) is not set. |"]]
