Class: Google::Apis::Adexchangebuyer2V2beta1::FrequencyCap

Inherits:
Object
  • Object
show all
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

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ FrequencyCap

Returns a new instance of FrequencyCap.


1814
1815
1816
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 1814

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#max_impressionsFixnum

The maximum number of impressions that can be served to a user within the specified time period. Corresponds to the JSON property maxImpressions

Returns:

  • (Fixnum)

1800
1801
1802
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 1800

def max_impressions
  @max_impressions
end

#num_time_unitsFixnum

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

Returns:

  • (Fixnum)

1806
1807
1808
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 1806

def num_time_units
  @num_time_units
end

#time_unit_typeString

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

Returns:

  • (String)

1812
1813
1814
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 1812

def time_unit_type
  @time_unit_type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


1819
1820
1821
1822
1823
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 1819

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