FrequencyCap

  • Frequency cap settings control how many times a user can see the same ad within a specific timeframe.

  • The frequency cap can be set to unlimited, in which case other settings are not applicable.

  • When not unlimited, the frequency cap is defined by a time unit, a count of that unit, and a maximum number of impressions or views allowed within that period.

  • The maximum number of impressions specifies how many times a user can be shown an ad, while max views applies specifically to YouTube and Partners resources for click-throughs or full views.

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 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

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.