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

Class LineItemBudget

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

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

Settings that control how budget is allocated.

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

Method Summary

Modifier and Type	Method and Description
LineItemBudget	clone()
String	getBudgetAllocationType() Required.
String	getBudgetUnit() Output only.
Long	getMaxAmount() The maximum budget amount the line item will spend.
LineItemBudget	set(String fieldName, Object value)
LineItemBudget	setBudgetAllocationType(String budgetAllocationType) Required.
LineItemBudget	setBudgetUnit(String budgetUnit) Output only.
LineItemBudget	setMaxAmount(Long maxAmount) The maximum budget amount the line item will spend.

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

LineItemBudget

public LineItemBudget()

Method Detail

getBudgetAllocationType

public String getBudgetAllocationType()

Required. The type of the budget allocation. `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC` is only applicable when automatic budget allocation is enabled for the parent insertion order. This field must be set to `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED` for Demand Gen line items.

Returns:

value or null for none

setBudgetAllocationType

public LineItemBudget setBudgetAllocationType(String budgetAllocationType)

Required. The type of the budget allocation. `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC` is only applicable when automatic budget allocation is enabled for the parent insertion order. This field must be set to `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED` for Demand Gen line items.

Parameters:

budgetAllocationType - budgetAllocationType or null for none

getBudgetUnit

public String getBudgetUnit()

Output only. The budget unit specifies whether the budget is currency based or impression based. This value is inherited from the parent insertion order.

Returns:

value or null for none

setBudgetUnit

public LineItemBudget setBudgetUnit(String budgetUnit)

Output only. The budget unit specifies whether the budget is currency based or impression based. This value is inherited from the parent insertion order.

Parameters:

budgetUnit - budgetUnit or null for none

getMaxAmount

public Long getMaxAmount()

The maximum budget amount the line item will spend. Must be greater than 0. When budget_allocation_type is: * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC`, this field is immutable and is set by the system. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`, if budget_unit is: - `BUDGET_UNIT_CURRENCY`, this field represents maximum budget amount to spend, in micros of the advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. - `BUDGET_UNIT_IMPRESSIONS`, this field represents the maximum number of impressions to serve. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNLIMITED`, this field is not applicable and will be ignored by the system.

Returns:

value or null for none

setMaxAmount

public LineItemBudget setMaxAmount(Long maxAmount)

The maximum budget amount the line item will spend. Must be greater than 0. When budget_allocation_type is: * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC`, this field is immutable and is set by the system. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`, if budget_unit is: - `BUDGET_UNIT_CURRENCY`, this field represents maximum budget amount to spend, in micros of the advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. - `BUDGET_UNIT_IMPRESSIONS`, this field represents the maximum number of impressions to serve. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNLIMITED`, this field is not applicable and will be ignored by the system.

Parameters:

maxAmount - maxAmount or null for none

set

public LineItemBudget set(String fieldName,
                          Object value)

Overrides:

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

clone

public LineItemBudget clone()

Overrides:

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