com.google.api.services.dfareporting.model

Class DeliverySchedule

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

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

Delivery Schedule.

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

Method Summary

Modifier and Type	Method and Description
DeliverySchedule	clone()
FrequencyCap	getFrequencyCap() Limit on the number of times an individual user can be served the ad within a specified period of time.
Boolean	getHardCutoff() Whether or not hard cutoff is enabled.
Long	getImpressionRatio() Impression ratio for this ad.
String	getPriority() Serving priority of an ad, with respect to other ads.
DeliverySchedule	set(String fieldName, Object value)
DeliverySchedule	setFrequencyCap(FrequencyCap frequencyCap) Limit on the number of times an individual user can be served the ad within a specified period of time.
DeliverySchedule	setHardCutoff(Boolean hardCutoff) Whether or not hard cutoff is enabled.
DeliverySchedule	setImpressionRatio(Long impressionRatio) Impression ratio for this ad.
DeliverySchedule	setPriority(String priority) Serving priority of an ad, with respect to other ads.

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

DeliverySchedule

public DeliverySchedule()

Method Detail

getFrequencyCap

public FrequencyCap getFrequencyCap()

Limit on the number of times an individual user can be served the ad within a specified period of time.

Returns:

value or null for none

setFrequencyCap

public DeliverySchedule setFrequencyCap(FrequencyCap frequencyCap)

Limit on the number of times an individual user can be served the ad within a specified period of time.

Parameters:

frequencyCap - frequencyCap or null for none

getHardCutoff

public Boolean getHardCutoff()

Whether or not hard cutoff is enabled. If true, the ad will not serve after the end date and time. Otherwise the ad will continue to be served until it has reached its delivery goals.

Returns:

value or null for none

setHardCutoff

public DeliverySchedule setHardCutoff(Boolean hardCutoff)

Whether or not hard cutoff is enabled. If true, the ad will not serve after the end date and time. Otherwise the ad will continue to be served until it has reached its delivery goals.

Parameters:

hardCutoff - hardCutoff or null for none

getImpressionRatio

public Long getImpressionRatio()

Impression ratio for this ad. This ratio determines how often each ad is served relative to the others. For example, if ad A has an impression ratio of 1 and ad B has an impression ratio of 3, then Campaign Manager will serve ad B three times as often as ad A. Acceptable values are 1 to 10, inclusive.

Returns:

value or null for none

setImpressionRatio

public DeliverySchedule setImpressionRatio(Long impressionRatio)

Impression ratio for this ad. This ratio determines how often each ad is served relative to the others. For example, if ad A has an impression ratio of 1 and ad B has an impression ratio of 3, then Campaign Manager will serve ad B three times as often as ad A. Acceptable values are 1 to 10, inclusive.

Parameters:

impressionRatio - impressionRatio or null for none

getPriority

public String getPriority()

Serving priority of an ad, with respect to other ads. The lower the priority number, the greater the priority with which it is served.

Returns:

value or null for none

setPriority

public DeliverySchedule setPriority(String priority)

Serving priority of an ad, with respect to other ads. The lower the priority number, the greater the priority with which it is served.

Parameters:

priority - priority or null for none

set

public DeliverySchedule set(String fieldName,
                            Object value)

Overrides:

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

clone

public DeliverySchedule clone()

Overrides:

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