Class: Google::Apis::DfareportingV4::CustomViewabilityMetricConfiguration

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/dfareporting_v4/classes.rb,
lib/google/apis/dfareporting_v4/representations.rb,
lib/google/apis/dfareporting_v4/representations.rb

Overview

The attributes, like playtime and percent onscreen, that define the Custom Viewability Metric.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ CustomViewabilityMetricConfiguration

Returns a new instance of CustomViewabilityMetricConfiguration.



5119
5120
5121
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 5119

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

Instance Attribute Details

#audible ⇒ Boolean Also known as: audible?

Whether the video must be audible to count an impression. Corresponds to the JSON property audible

Returns:

  • (Boolean) 


5096
5097
5098
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 5096

def audible
  @audible
end

#time_millis ⇒ Fixnum

The time in milliseconds the video must play for the Custom Viewability Metric to count an impression. If both this and timePercent are specified, the earlier of the two will be used. Corresponds to the JSON property timeMillis

Returns:

  • (Fixnum) 


5104
5105
5106
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 5104

def time_millis
  @time_millis
end

#time_percent ⇒ Fixnum

The percentage of video that must play for the Custom Viewability Metric to count an impression. If both this and timeMillis are specified, the earlier of the two will be used. Corresponds to the JSON property timePercent

Returns:

  • (Fixnum) 


5111
5112
5113
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 5111

def time_percent
  @time_percent
end

#viewability_percent ⇒ Fixnum

The percentage of video that must be on screen for the Custom Viewability Metric to count an impression. Corresponds to the JSON property viewabilityPercent

Returns:

  • (Fixnum) 


5117
5118
5119
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 5117

def viewability_percent
  @viewability_percent
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5124
5125
5126
5127
5128
5129
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 5124

def update!(**args)
  @audible = args[:audible] if args.key?(:audible)
  @time_millis = args[:time_millis] if args.key?(:time_millis)
  @time_percent = args[:time_percent] if args.key?(:time_percent)
  @viewability_percent = args[:viewability_percent] if args.key?(:viewability_percent)
end