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

Class Pacing

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

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

Settings that control the rate at which a budget is spent.

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

Method Summary

Modifier and Type	Method and Description
Pacing	clone()
Long	getDailyMaxImpressions() Maximum number of impressions to serve every day.
Long	getDailyMaxMicros() Maximum currency amount to spend every day in micros of advertiser's currency.
String	getPacingPeriod() Required.
String	getPacingType() Required.
Pacing	set(String fieldName, Object value)
Pacing	setDailyMaxImpressions(Long dailyMaxImpressions) Maximum number of impressions to serve every day.
Pacing	setDailyMaxMicros(Long dailyMaxMicros) Maximum currency amount to spend every day in micros of advertiser's currency.
Pacing	setPacingPeriod(String pacingPeriod) Required.
Pacing	setPacingType(String pacingType) 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

Pacing

public Pacing()

Method Detail

getDailyMaxImpressions

public Long getDailyMaxImpressions()

Maximum number of impressions to serve every day. Applicable when the budget is impression based. Must be greater than 0.

Returns:

value or null for none

setDailyMaxImpressions

public Pacing setDailyMaxImpressions(Long dailyMaxImpressions)

Maximum number of impressions to serve every day. Applicable when the budget is impression based. Must be greater than 0.

Parameters:

dailyMaxImpressions - dailyMaxImpressions or null for none

getDailyMaxMicros

public Long getDailyMaxMicros()

Maximum currency amount to spend every day in micros of advertiser's currency. Applicable when the budget is currency based. Must be greater than 0. For example, for 1.5 standard unit of the currency, set this field to 1500000. The value assigned will be rounded to whole billable units for the relevant currency by the following rules: any positive value less than a single billable unit will be rounded up to one billable unit and any value larger than a single billable unit will be rounded down to the nearest billable value. For example, if the currency's billable unit is 0.01, and this field is set to 10257770, it will round down to 10250000, a value of 10.25. If set to 505, it will round up to 10000, a value of 0.01.

Returns:

value or null for none

setDailyMaxMicros

public Pacing setDailyMaxMicros(Long dailyMaxMicros)

Maximum currency amount to spend every day in micros of advertiser's currency. Applicable when the budget is currency based. Must be greater than 0. For example, for 1.5 standard unit of the currency, set this field to 1500000. The value assigned will be rounded to whole billable units for the relevant currency by the following rules: any positive value less than a single billable unit will be rounded up to one billable unit and any value larger than a single billable unit will be rounded down to the nearest billable value. For example, if the currency's billable unit is 0.01, and this field is set to 10257770, it will round down to 10250000, a value of 10.25. If set to 505, it will round up to 10000, a value of 0.01.

Parameters:

dailyMaxMicros - dailyMaxMicros or null for none

getPacingPeriod

public String getPacingPeriod()

Required. The time period in which the pacing budget will be spent. When automatic budget allocation is enabled at the insertion order via automationType, this field is output only and defaults to `PACING_PERIOD_FLIGHT`.

Returns:

value or null for none

setPacingPeriod

public Pacing setPacingPeriod(String pacingPeriod)

Required. The time period in which the pacing budget will be spent. When automatic budget allocation is enabled at the insertion order via automationType, this field is output only and defaults to `PACING_PERIOD_FLIGHT`.

Parameters:

pacingPeriod - pacingPeriod or null for none

getPacingType

public String getPacingType()

Required. The type of pacing that defines how the budget amount will be spent across the pacing_period. `PACING_TYPE_ASAP` is not compatible with pacing_period `PACING_PERIOD_FLIGHT` for insertion orders.

Returns:

value or null for none

setPacingType

public Pacing setPacingType(String pacingType)

Required. The type of pacing that defines how the budget amount will be spent across the pacing_period. `PACING_TYPE_ASAP` is not compatible with pacing_period `PACING_PERIOD_FLIGHT` for insertion orders.

Parameters:

pacingType - pacingType or null for none

set

public Pacing set(String fieldName,
                  Object value)

Overrides:

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

clone

public Pacing clone()

Overrides:

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