Class: Google::Apis::DisplayvideoV1::ActiveViewVideoViewabilityMetricConfig

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

Overview

Configuration for custom Active View video viewability metrics.

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

Returns a new instance of ActiveViewVideoViewabilityMetricConfig.



70
71
72
# File 'generated/google/apis/displayvideo_v1/classes.rb', line 70

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

Instance Attribute Details

#display_nameString

Required. The display name of the custom metric. Corresponds to the JSON property displayName

Returns:

  • (String)


32
33
34
# File 'generated/google/apis/displayvideo_v1/classes.rb', line 32

def display_name
  @display_name
end

#minimum_durationString

The minimum visible video duration required (in seconds) in order for an impression to be recorded. You must specify minimum_duration, minimum_quartile or both. If both are specified, an impression meets the metric criteria if either requirement is met (whichever happens first). Corresponds to the JSON property minimumDuration

Returns:

  • (String)


43
44
45
# File 'generated/google/apis/displayvideo_v1/classes.rb', line 43

def minimum_duration
  @minimum_duration
end

#minimum_quartileString

The minimum visible video duration required, based on the video quartiles, in order for an impression to be recorded. You must specify minimum_duration, minimum_quartile or both. If both are specified, an impression meets the metric criteria if either requirement is met (whichever happens first). Corresponds to the JSON property minimumQuartile

Returns:

  • (String)


54
55
56
# File 'generated/google/apis/displayvideo_v1/classes.rb', line 54

def minimum_quartile
  @minimum_quartile
end

#minimum_viewabilityString

Required. The minimum percentage of the video ad's pixels visible on the screen in order for an impression to be recorded. Corresponds to the JSON property minimumViewability

Returns:

  • (String)


61
62
63
# File 'generated/google/apis/displayvideo_v1/classes.rb', line 61

def minimum_viewability
  @minimum_viewability
end

#minimum_volumeString

Required. The minimum percentage of the video ad's volume required in order for an impression to be recorded. Corresponds to the JSON property minimumVolume

Returns:

  • (String)


68
69
70
# File 'generated/google/apis/displayvideo_v1/classes.rb', line 68

def minimum_volume
  @minimum_volume
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



75
76
77
78
79
80
81
# File 'generated/google/apis/displayvideo_v1/classes.rb', line 75

def update!(**args)
  @display_name = args[:display_name] if args.key?(:display_name)
  @minimum_duration = args[:minimum_duration] if args.key?(:minimum_duration)
  @minimum_quartile = args[:minimum_quartile] if args.key?(:minimum_quartile)
  @minimum_viewability = args[:minimum_viewability] if args.key?(:minimum_viewability)
  @minimum_volume = args[:minimum_volume] if args.key?(:minimum_volume)
end