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.


4586
4587
4588
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 4586

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

Instance Attribute Details

#audibleBoolean Also known as: audible?

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

Returns:

  • (Boolean)

4563
4564
4565
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 4563

def audible
  @audible
end

#time_millisFixnum

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)

4571
4572
4573
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 4571

def time_millis
  @time_millis
end

#time_percentFixnum

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)

4578
4579
4580
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 4578

def time_percent
  @time_percent
end

#viewability_percentFixnum

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)

4584
4585
4586
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 4584

def viewability_percent
  @viewability_percent
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


4591
4592
4593
4594
4595
4596
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 4591

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