com.google.api.services.dfareporting.model

Class CustomViewabilityMetricConfiguration

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.dfareporting.model.CustomViewabilityMetricConfiguration

All Implemented Interfaces:

Cloneable, Map<String,Object>

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

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

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 Campaign Manager 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
CustomViewabilityMetricConfiguration()

Method Summary

Modifier and Type	Method and Description
CustomViewabilityMetricConfiguration	clone()
Boolean	getAudible() Whether the video must be audible to count an impression.
Integer	getTimeMillis() The time in milliseconds the video must play for the Custom Viewability Metric to count an impression.
Integer	getTimePercent() The percentage of video that must play for the Custom Viewability Metric to count an impression.
Integer	getViewabilityPercent() The percentage of video that must be on screen for the Custom Viewability Metric to count an impression.
CustomViewabilityMetricConfiguration	set(String fieldName, Object value)
CustomViewabilityMetricConfiguration	setAudible(Boolean audible) Whether the video must be audible to count an impression.
CustomViewabilityMetricConfiguration	setTimeMillis(Integer timeMillis) The time in milliseconds the video must play for the Custom Viewability Metric to count an impression.
CustomViewabilityMetricConfiguration	setTimePercent(Integer timePercent) The percentage of video that must play for the Custom Viewability Metric to count an impression.
CustomViewabilityMetricConfiguration	setViewabilityPercent(Integer viewabilityPercent) The percentage of video that must be on screen for the Custom Viewability Metric to count an impression.

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

CustomViewabilityMetricConfiguration

public CustomViewabilityMetricConfiguration()

Method Detail

getAudible

public Boolean getAudible()

Whether the video must be audible to count an impression.

Returns:

value or null for none

setAudible

public CustomViewabilityMetricConfiguration setAudible(Boolean audible)

Whether the video must be audible to count an impression.

Parameters:

audible - audible or null for none

getTimeMillis

public Integer getTimeMillis()

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.

Returns:

value or null for none

setTimeMillis

public CustomViewabilityMetricConfiguration setTimeMillis(Integer timeMillis)

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.

Parameters:

timeMillis - timeMillis or null for none

getTimePercent

public Integer getTimePercent()

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.

Returns:

value or null for none

setTimePercent

public CustomViewabilityMetricConfiguration setTimePercent(Integer timePercent)

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.

Parameters:

timePercent - timePercent or null for none

getViewabilityPercent

public Integer getViewabilityPercent()

The percentage of video that must be on screen for the Custom Viewability Metric to count an impression.

Returns:

value or null for none

setViewabilityPercent

public CustomViewabilityMetricConfiguration setViewabilityPercent(Integer viewabilityPercent)

The percentage of video that must be on screen for the Custom Viewability Metric to count an impression.

Parameters:

viewabilityPercent - viewabilityPercent or null for none

set

public CustomViewabilityMetricConfiguration set(String fieldName,
                                                Object value)

Overrides:

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

clone

public CustomViewabilityMetricConfiguration clone()

Overrides:

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