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

Class FrequencyCap

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

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

Settings that control the number of times a user may be shown with the same ad during a given time period.

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
FrequencyCap()

Method Summary

Modifier and Type	Method and Description
FrequencyCap	clone()
Integer	getMaxImpressions() The maximum number of times a user may be shown the same ad during this period.
Integer	getMaxViews() Optional.
String	getTimeUnit() The time unit in which the frequency cap will be applied.
Integer	getTimeUnitCount() The number of time_unit the frequency cap will last.
Boolean	getUnlimited() Whether unlimited frequency capping is applied.
FrequencyCap	set(String fieldName, Object value)
FrequencyCap	setMaxImpressions(Integer maxImpressions) The maximum number of times a user may be shown the same ad during this period.
FrequencyCap	setMaxViews(Integer maxViews) Optional.
FrequencyCap	setTimeUnit(String timeUnit) The time unit in which the frequency cap will be applied.
FrequencyCap	setTimeUnitCount(Integer timeUnitCount) The number of time_unit the frequency cap will last.
FrequencyCap	setUnlimited(Boolean unlimited) Whether unlimited frequency capping is applied.

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

FrequencyCap

public FrequencyCap()

Method Detail

getMaxImpressions

public Integer getMaxImpressions()

The maximum number of times a user may be shown the same ad during this period. Must be greater than 0. Required when unlimited is `false` and max_views is not set.

Returns:

value or null for none

setMaxImpressions

public FrequencyCap setMaxImpressions(Integer maxImpressions)

The maximum number of times a user may be shown the same ad during this period. Must be greater than 0. Required when unlimited is `false` and max_views is not set.

Parameters:

maxImpressions - maxImpressions or null for none

getMaxViews

public Integer getMaxViews()

Optional. The maximum number of times a user may click-through or fully view an ad during this period until it is no longer served to them. Must be greater than 0. Only applicable to YouTube and Partners resources. Required when unlimited is `false` and max_impressions is not set.

Returns:

value or null for none

setMaxViews

public FrequencyCap setMaxViews(Integer maxViews)

Optional. The maximum number of times a user may click-through or fully view an ad during this period until it is no longer served to them. Must be greater than 0. Only applicable to YouTube and Partners resources. Required when unlimited is `false` and max_impressions is not set.

Parameters:

maxViews - maxViews or null for none

getTimeUnit

public String getTimeUnit()

The time unit in which the frequency cap will be applied. Required when unlimited is `false`.

Returns:

value or null for none

setTimeUnit

public FrequencyCap setTimeUnit(String timeUnit)

The time unit in which the frequency cap will be applied. Required when unlimited is `false`.

Parameters:

timeUnit - timeUnit or null for none

getTimeUnitCount

public Integer getTimeUnitCount()

The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_MONTHS` - must be 1 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59

Returns:

value or null for none

setTimeUnitCount

public FrequencyCap setTimeUnitCount(Integer timeUnitCount)

The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_MONTHS` - must be 1 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59

Parameters:

timeUnitCount - timeUnitCount or null for none

getUnlimited

public Boolean getUnlimited()

Whether unlimited frequency capping is applied. When this field is set to `true`, the remaining frequency cap fields are not applicable.

Returns:

value or null for none

setUnlimited

public FrequencyCap setUnlimited(Boolean unlimited)

Whether unlimited frequency capping is applied. When this field is set to `true`, the remaining frequency cap fields are not applicable.

Parameters:

unlimited - unlimited or null for none

set

public FrequencyCap set(String fieldName,
                        Object value)

Overrides:

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

clone

public FrequencyCap clone()

Overrides:

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