FrequencyCap

  • Frequency capping settings determine how often a user sees the same ad within a specific timeframe.

  • These settings offer control over the maximum impressions or views a user receives within a defined period.

  • You can set frequency caps based on various time units (lifetime, months, weeks, days, hours, minutes) and limits.

  • The "unlimited" option bypasses other frequency cap settings, allowing for unlimited ad exposure.

  • For YouTube and Partner resources, you can set limits for both impressions (ad displays) and views (clicks 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.