com.google.api.services.displayvideo.v4.model

Class ActiveViewVideoViewabilityMetricConfig

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.displayvideo.v4.model.ActiveViewVideoViewabilityMetricConfig

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class ActiveViewVideoViewabilityMetricConfig
extends com.google.api.client.json.GenericJson

Configuration for custom Active View video viewability metrics.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Display & Video 360 API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
ActiveViewVideoViewabilityMetricConfig()

Method Summary

Modifier and Type	Method and Description
ActiveViewVideoViewabilityMetricConfig	clone()
String	getDisplayName() Required.
String	getMinimumDuration() The minimum visible video duration required (in seconds) in order for an impression to be recorded.
String	getMinimumQuartile() The minimum visible video duration required, based on the video quartiles, in order for an impression to be recorded.
String	getMinimumViewability() Required.
String	getMinimumVolume() Required.
ActiveViewVideoViewabilityMetricConfig	set(String fieldName, Object value)
ActiveViewVideoViewabilityMetricConfig	setDisplayName(String displayName) Required.
ActiveViewVideoViewabilityMetricConfig	setMinimumDuration(String minimumDuration) The minimum visible video duration required (in seconds) in order for an impression to be recorded.
ActiveViewVideoViewabilityMetricConfig	setMinimumQuartile(String minimumQuartile) The minimum visible video duration required, based on the video quartiles, in order for an impression to be recorded.
ActiveViewVideoViewabilityMetricConfig	setMinimumViewability(String minimumViewability) Required.
ActiveViewVideoViewabilityMetricConfig	setMinimumVolume(String minimumVolume) Required.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

ActiveViewVideoViewabilityMetricConfig

public ActiveViewVideoViewabilityMetricConfig()

Method Detail

getDisplayName

public String getDisplayName()

Required. The display name of the custom metric.

Returns:

value or null for none

setDisplayName

public ActiveViewVideoViewabilityMetricConfig setDisplayName(String displayName)

Required. The display name of the custom metric.

Parameters:

displayName - displayName or null for none

getMinimumDuration

public String getMinimumDuration()

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).

Returns:

value or null for none

setMinimumDuration

public ActiveViewVideoViewabilityMetricConfig setMinimumDuration(String minimumDuration)

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).

Parameters:

minimumDuration - minimumDuration or null for none

getMinimumQuartile

public String getMinimumQuartile()

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).

Returns:

value or null for none

setMinimumQuartile

public ActiveViewVideoViewabilityMetricConfig setMinimumQuartile(String minimumQuartile)

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).

Parameters:

minimumQuartile - minimumQuartile or null for none

getMinimumViewability

public String getMinimumViewability()

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

Returns:

value or null for none

setMinimumViewability

public ActiveViewVideoViewabilityMetricConfig setMinimumViewability(String minimumViewability)

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

Parameters:

minimumViewability - minimumViewability or null for none

getMinimumVolume

public String getMinimumVolume()

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

Returns:

value or null for none

setMinimumVolume

public ActiveViewVideoViewabilityMetricConfig setMinimumVolume(String minimumVolume)

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

Parameters:

minimumVolume - minimumVolume or null for none

set

public ActiveViewVideoViewabilityMetricConfig set(String fieldName,
                                                  Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public ActiveViewVideoViewabilityMetricConfig clone()

Overrides:

clone in class com.google.api.client.json.GenericJson