AI-generated Key Takeaways
-
Display & Video 360 API v3 has sunset and users should use v4 instead.
-
Frequency Cap settings control how often a user sees the same ad within a time period.
-
The JSON representation includes fields such as
unlimited,timeUnit,timeUnitCount,maxImpressions, andmaxViews. -
The
unlimitedfield is a boolean that, when true, makes other frequency cap fields inapplicable. -
The
timeUnit,timeUnitCount,maxImpressions, andmaxViewsfields are used to define specific frequency limits whenunlimitedis false.
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 (
|
unlimited
boolean
Whether unlimited frequency capping is applied. When this field is set to true
, the remaining frequency cap fields are not applicable.
timeUnit
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 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
maxImpressions
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.
