Class: Google::Apis::DfareportingV3_4::CustomViewabilityMetricConfiguration

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

Overview

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

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) ⇒ CustomViewabilityMetricConfiguration

Returns a new instance of CustomViewabilityMetricConfiguration.



5058
5059
5060
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 5058

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) 


5035
5036
5037
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 5035

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) 


5043
5044
5045
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 5043

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) 


5050
5051
5052
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 5050

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) 


5056
5057
5058
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 5056

def viewability_percent
  @viewability_percent
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5063
5064
5065
5066
5067
5068
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 5063

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