Class: Google::Apis::Adexchangebuyer2V2beta1::FrequencyCap
- Inherits:
 - 
      Object
      
        
- Object
 - Google::Apis::Adexchangebuyer2V2beta1::FrequencyCap
 
 
- Includes:
 - Core::Hashable, Core::JsonObjectSupport
 
- Defined in:
 - generated/google/apis/adexchangebuyer2_v2beta1/classes.rb,
generated/google/apis/adexchangebuyer2_v2beta1/representations.rb,
generated/google/apis/adexchangebuyer2_v2beta1/representations.rb 
Overview
Frequency cap.
Instance Attribute Summary collapse
- 
  
    
      #max_impressions  ⇒ Fixnum 
    
    
  
  
  
  
    
    
  
  
  
  
  
  
    
The maximum number of impressions that can be served to a user within the specified time period.
 - 
  
    
      #num_time_units  ⇒ Fixnum 
    
    
  
  
  
  
    
    
  
  
  
  
  
  
    
The amount of time, in the units specified by time_unit_type.
 - 
  
    
      #time_unit_type  ⇒ String 
    
    
  
  
  
  
    
    
  
  
  
  
  
  
    
The time unit.
 
Instance Method Summary collapse
- 
  
    
      #initialize(**args)  ⇒ FrequencyCap 
    
    
  
  
  
    constructor
  
  
  
  
  
  
  
    
A new instance of FrequencyCap.
 - 
  
    
      #update!(**args)  ⇒ Object 
    
    
  
  
  
  
  
  
  
  
  
    
Update properties of this object.
 
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ FrequencyCap
Returns a new instance of FrequencyCap
      1846 1847 1848  | 
    
      # File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 1846 def initialize(**args) update!(**args) end  | 
  
Instance Attribute Details
#max_impressions ⇒ Fixnum
The maximum number of impressions that can be served to a user within the
specified time period.
Corresponds to the JSON property maxImpressions
      1832 1833 1834  | 
    
      # File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 1832 def max_impressions @max_impressions end  | 
  
#num_time_units ⇒ Fixnum
The amount of time, in the units specified by time_unit_type. Defines the
amount of time over which impressions per user are counted and capped.
Corresponds to the JSON property numTimeUnits
      1838 1839 1840  | 
    
      # File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 1838 def num_time_units @num_time_units end  | 
  
#time_unit_type ⇒ String
The time unit. Along with num_time_units defines the amount of time over
which impressions per user are counted and capped.
Corresponds to the JSON property timeUnitType
      1844 1845 1846  | 
    
      # File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 1844 def time_unit_type @time_unit_type end  | 
  
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
      1851 1852 1853 1854 1855  | 
    
      # File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 1851 def update!(**args) @max_impressions = args[:max_impressions] if args.key?(:max_impressions) @num_time_units = args[:num_time_units] if args.key?(:num_time_units) @time_unit_type = args[:time_unit_type] if args.key?(:time_unit_type) end  |