FrequencyCap

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 
 } 
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_LIFETIME - this field is output only and will default to 1
  • TIME_UNIT_MONTHS - must be between 1 and 2
  • 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 .

TimeUnit

Possible time units.

Enums
TIME_UNIT_UNSPECIFIED Time unit value is not specified or is unknown in this version.
TIME_UNIT_LIFETIME The frequency cap will be applied to the whole life time of the line item.
TIME_UNIT_MONTHS The frequency cap will be applied to a number of months.
TIME_UNIT_WEEKS The frequency cap will be applied to a number of weeks.
TIME_UNIT_DAYS The frequency cap will be applied to a number of days.
TIME_UNIT_HOURS The frequency cap will be applied to a number of hours.
TIME_UNIT_MINUTES The frequency cap will be applied to a number of minutes.
Design a Mobile Site
View Site in Mobile | Classic
Share by: