InsertionOrder (Display & Video 360 API v2-rev20260505-2.0.0)

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.v2.model.InsertionOrder

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class InsertionOrder
extends com.google.api.client.json.GenericJson
```
A single insertion order.
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

InsertionOrder()

Constructors
Constructor and Description
`InsertionOrder()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`InsertionOrder`	`clone()`
`Long`	`getAdvertiserId()` Output only.
`BiddingStrategy`	`getBidStrategy()` Optional.
`String`	`getBillableOutcome()` Immutable.
`InsertionOrderBudget`	`getBudget()` Required.
`Long`	`getCampaignId()` Required.
`String`	`getDisplayName()` Required.
`String`	`getEntityStatus()` Required.
`FrequencyCap`	`getFrequencyCap()` Required.
`Long`	`getInsertionOrderId()` Output only.
`String`	`getInsertionOrderType()` Optional.
`IntegrationDetails`	`getIntegrationDetails()` Optional.
`String`	`getName()` Output only.
`Pacing`	`getPacing()` Required.
`List<PartnerCost>`	`getPartnerCosts()` Optional.
`PerformanceGoal`	`getPerformanceGoal()` Required.
`String`	`getReservationType()` Output only.
`String`	`getUpdateTime()` Output only.
`InsertionOrder`	`set(String fieldName, Object value)`
`InsertionOrder`	`setAdvertiserId(Long advertiserId)` Output only.
`InsertionOrder`	`setBidStrategy(BiddingStrategy bidStrategy)` Optional.
`InsertionOrder`	`setBillableOutcome(String billableOutcome)` Immutable.
`InsertionOrder`	`setBudget(InsertionOrderBudget budget)` Required.
`InsertionOrder`	`setCampaignId(Long campaignId)` Required.
`InsertionOrder`	`setDisplayName(String displayName)` Required.
`InsertionOrder`	`setEntityStatus(String entityStatus)` Required.
`InsertionOrder`	`setFrequencyCap(FrequencyCap frequencyCap)` Required.
`InsertionOrder`	`setInsertionOrderId(Long insertionOrderId)` Output only.
`InsertionOrder`	`setInsertionOrderType(String insertionOrderType)` Optional.
`InsertionOrder`	`setIntegrationDetails(IntegrationDetails integrationDetails)` Optional.
`InsertionOrder`	`setName(String name)` Output only.
`InsertionOrder`	`setPacing(Pacing pacing)` Required.
`InsertionOrder`	`setPartnerCosts(List<PartnerCost> partnerCosts)` Optional.
`InsertionOrder`	`setPerformanceGoal(PerformanceGoal performanceGoal)` Required.
`InsertionOrder`	`setReservationType(String reservationType)` Output only.
`InsertionOrder`	`setUpdateTime(String updateTime)` Output only.

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
  - InsertionOrder
```
public InsertionOrder()
```
- Method Detail
  - getAdvertiserId
```
public Long getAdvertiserId()
```
    Output only. The unique ID of the advertiser the insertion order belongs to.
    
    Returns:
    
    value or null for none
  - setAdvertiserId
```
public InsertionOrder setAdvertiserId(Long advertiserId)
```
    Output only. The unique ID of the advertiser the insertion order belongs to.
    
    Parameters:
    
    advertiserId - advertiserId or null for none
  - getBidStrategy
```
public BiddingStrategy getBidStrategy()
```
    Optional. The bidding strategy of the insertion order. By default, fixed_bid is set. If the budget field automationType is set to `INSERTION_ORDER_AUTOMATION_TYPE_BUDGET` or `INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET`, the insertion order will impose this bidding strategy on its line items. If an imposed bidding strategy is not compatible with a line item's enableOptimizedTargeting setting, the optimized targeting setting will be updated.
    
    Returns:
    
    value or null for none
  - setBidStrategy
```
public InsertionOrder setBidStrategy(BiddingStrategy bidStrategy)
```
    Optional. The bidding strategy of the insertion order. By default, fixed_bid is set. If the budget field automationType is set to `INSERTION_ORDER_AUTOMATION_TYPE_BUDGET` or `INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET`, the insertion order will impose this bidding strategy on its line items. If an imposed bidding strategy is not compatible with a line item's enableOptimizedTargeting setting, the optimized targeting setting will be updated.
    
    Parameters:
    
    bidStrategy - bidStrategy or null for none
  - getBillableOutcome
```
public String getBillableOutcome()
```
    Immutable. The billable outcome of the insertion order. Outcome based buying is deprecated. `BILLABLE_OUTCOME_PAY_PER_IMPRESSION` is the only valid value.
    
    Returns:
    
    value or null for none
  - setBillableOutcome
```
public InsertionOrder setBillableOutcome(String billableOutcome)
```
    Immutable. The billable outcome of the insertion order. Outcome based buying is deprecated. `BILLABLE_OUTCOME_PAY_PER_IMPRESSION` is the only valid value.
    
    Parameters:
    
    billableOutcome - billableOutcome or null for none
  - getBudget
```
public InsertionOrderBudget getBudget()
```
    Required. The budget allocation settings of the insertion order.
    
    Returns:
    
    value or null for none
  - setBudget
```
public InsertionOrder setBudget(InsertionOrderBudget budget)
```
    Required. The budget allocation settings of the insertion order.
    
    Parameters:
    
    budget - budget or null for none
  - getCampaignId
```
public Long getCampaignId()
```
    Required. Immutable. The unique ID of the campaign that the insertion order belongs to.
    
    Returns:
    
    value or null for none
  - setCampaignId
```
public InsertionOrder setCampaignId(Long campaignId)
```
    Required. Immutable. The unique ID of the campaign that the insertion order belongs to.
    
    Parameters:
    
    campaignId - campaignId or null for none
  - getDisplayName
```
public String getDisplayName()
```
    Required. The display name of the insertion order. Must be UTF-8 encoded with a maximum size of 240 bytes.
    
    Returns:
    
    value or null for none
  - setDisplayName
```
public InsertionOrder setDisplayName(String displayName)
```
    Required. The display name of the insertion order. Must be UTF-8 encoded with a maximum size of 240 bytes.
    
    Parameters:
    
    displayName - displayName or null for none
  - getEntityStatus
```
public String getEntityStatus()
```
    Required. Controls whether or not the insertion order can spend its budget and bid on inventory. * For CreateInsertionOrder method, only `ENTITY_STATUS_DRAFT` is allowed. To activate an insertion order, use UpdateInsertionOrder method and update the status to `ENTITY_STATUS_ACTIVE` after creation. * An insertion order cannot be changed back to `ENTITY_STATUS_DRAFT` status from any other status. * An insertion order cannot be set to `ENTITY_STATUS_ACTIVE` if its parent campaign is not active.
    
    Returns:
    
    value or null for none
  - setEntityStatus
```
public InsertionOrder setEntityStatus(String entityStatus)
```
    Required. Controls whether or not the insertion order can spend its budget and bid on inventory. * For CreateInsertionOrder method, only `ENTITY_STATUS_DRAFT` is allowed. To activate an insertion order, use UpdateInsertionOrder method and update the status to `ENTITY_STATUS_ACTIVE` after creation. * An insertion order cannot be changed back to `ENTITY_STATUS_DRAFT` status from any other status. * An insertion order cannot be set to `ENTITY_STATUS_ACTIVE` if its parent campaign is not active.
    
    Parameters:
    
    entityStatus - entityStatus or null for none
  - getFrequencyCap
```
public FrequencyCap getFrequencyCap()
```
    Required. The frequency capping setting of the insertion order.
    
    Returns:
    
    value or null for none
  - setFrequencyCap
```
public InsertionOrder setFrequencyCap(FrequencyCap frequencyCap)
```
    Required. The frequency capping setting of the insertion order.
    
    Parameters:
    
    frequencyCap - frequencyCap or null for none
  - getInsertionOrderId
```
public Long getInsertionOrderId()
```
    Output only. The unique ID of the insertion order. Assigned by the system.
    
    Returns:
    
    value or null for none
  - setInsertionOrderId
```
public InsertionOrder setInsertionOrderId(Long insertionOrderId)
```
    Output only. The unique ID of the insertion order. Assigned by the system.
    
    Parameters:
    
    insertionOrderId - insertionOrderId or null for none
  - getInsertionOrderType
```
public String getInsertionOrderType()
```
    Optional. The type of insertion order. If this field is unspecified in creation, the value defaults to `RTB`.
    
    Returns:
    
    value or null for none
  - setInsertionOrderType
```
public InsertionOrder setInsertionOrderType(String insertionOrderType)
```
    Optional. The type of insertion order. If this field is unspecified in creation, the value defaults to `RTB`.
    
    Parameters:
    
    insertionOrderType - insertionOrderType or null for none
  - getIntegrationDetails
```
public IntegrationDetails getIntegrationDetails()
```
    Optional. Additional integration details of the insertion order.
    
    Returns:
    
    value or null for none
  - setIntegrationDetails
```
public InsertionOrder setIntegrationDetails(IntegrationDetails integrationDetails)
```
    Optional. Additional integration details of the insertion order.
    
    Parameters:
    
    integrationDetails - integrationDetails or null for none
  - getName
```
public String getName()
```
    Output only. The resource name of the insertion order.
    
    Returns:
    
    value or null for none
  - setName
```
public InsertionOrder setName(String name)
```
    Output only. The resource name of the insertion order.
    
    Parameters:
    
    name - name or null for none
  - getPacing
```
public Pacing getPacing()
```
    Required. The budget spending speed setting of the insertion order. pacing_type `PACING_TYPE_ASAP` is not compatible with pacing_period `PACING_PERIOD_FLIGHT`.
    
    Returns:
    
    value or null for none
  - setPacing
```
public InsertionOrder setPacing(Pacing pacing)
```
    Required. The budget spending speed setting of the insertion order. pacing_type `PACING_TYPE_ASAP` is not compatible with pacing_period `PACING_PERIOD_FLIGHT`.
    
    Parameters:
    
    pacing - pacing or null for none
  - getPartnerCosts
```
public List<PartnerCost> getPartnerCosts()
```
    Optional. The partner costs associated with the insertion order. If absent or empty in CreateInsertionOrder method, the newly created insertion order will inherit partner costs from the partner settings.
    
    Returns:
    
    value or null for none
  - setPartnerCosts
```
public InsertionOrder setPartnerCosts(List<PartnerCost> partnerCosts)
```
    Optional. The partner costs associated with the insertion order. If absent or empty in CreateInsertionOrder method, the newly created insertion order will inherit partner costs from the partner settings.
    
    Parameters:
    
    partnerCosts - partnerCosts or null for none
  - getPerformanceGoal
```
public PerformanceGoal getPerformanceGoal()
```
    Required. Performance goal of the insertion order.
    
    Returns:
    
    value or null for none
  - setPerformanceGoal
```
public InsertionOrder setPerformanceGoal(PerformanceGoal performanceGoal)
```
    Required. Performance goal of the insertion order.
    
    Parameters:
    
    performanceGoal - performanceGoal or null for none
  - getReservationType
```
public String getReservationType()
```
    Output only. The reservation type of the insertion order.
    
    Returns:
    
    value or null for none
  - setReservationType
```
public InsertionOrder setReservationType(String reservationType)
```
    Output only. The reservation type of the insertion order.
    
    Parameters:
    
    reservationType - reservationType or null for none
  - getUpdateTime
```
public String getUpdateTime()
```
    Output only. The timestamp when the insertion order was last updated. Assigned by the system.
    
    Returns:
    
    value or null for none
  - setUpdateTime
```
public InsertionOrder setUpdateTime(String updateTime)
```
    Output only. The timestamp when the insertion order was last updated. Assigned by the system.
    
    Parameters:
    
    updateTime - updateTime or null for none
  - set
```
public InsertionOrder set(String fieldName,
                          Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public InsertionOrder clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Class InsertionOrder

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class com.google.api.client.json.GenericJson

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

InsertionOrder

Method Detail

getAdvertiserId

setAdvertiserId

getBidStrategy

setBidStrategy

getBillableOutcome

setBillableOutcome

getBudget

setBudget

getCampaignId

setCampaignId

getDisplayName

setDisplayName

getEntityStatus

setEntityStatus

getFrequencyCap

setFrequencyCap

getInsertionOrderId

setInsertionOrderId

getInsertionOrderType

setInsertionOrderType

getIntegrationDetails

setIntegrationDetails

getName

setName

getPacing

setPacing

getPartnerCosts

setPartnerCosts

getPerformanceGoal

setPerformanceGoal

getReservationType

setReservationType

getUpdateTime

setUpdateTime

set

clone