Class: Google::Apis::DfareportingV3_3::CustomViewabilityMetricConfiguration

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/dfareporting_v3_3/classes.rb,
generated/google/apis/dfareporting_v3_3/representations.rb,
generated/google/apis/dfareporting_v3_3/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.



4700
4701
4702
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 4700

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) 


4677
4678
4679
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 4677

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) 


4685
4686
4687
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 4685

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) 


4692
4693
4694
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 4692

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) 


4698
4699
4700
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 4698

def viewability_percent
  @viewability_percent
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4705
4706
4707
4708
4709
4710
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 4705

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