AvailabilityForecast (DFP AppEngine components 3.14.2 API)

java.lang.Object
- com.google.api.ads.dfp.jaxws.v201802.AvailabilityForecast

public class AvailabilityForecast
extends Object

Describes predicted inventory availability for a ProspectiveLineItem.

Inventory has three threshold values along a line of possible inventory. From least to most, these are:

Available units -- How many units can be booked without affecting any other line items. Booking more than this number can cause lower and same priority line items to underdeliver.

Possible units -- How many units can be booked without affecting any higher priority line items. Booking more than this number can cause the line item to underdeliver.

Matched (forecast) units -- How many units satisfy all specified criteria.

Underdelivery is caused by overbooking. However, if more impressions are served than are predicted, the extra available inventory might enable all inventory guarantees to be met without overbooking.

Java class for AvailabilityForecast complex type.

The following schema fragment specifies the expected content contained within this class.

 <complexType name="AvailabilityForecast">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element name="lineItemId" type="{http://www.w3.org/2001/XMLSchema}long" minOccurs="0"/>
         <element name="orderId" type="{http://www.w3.org/2001/XMLSchema}long" minOccurs="0"/>
         <element name="unitType" type="{https://www.google.com/apis/ads/publisher/v201802}UnitType" minOccurs="0"/>
         <element name="availableUnits" type="{http://www.w3.org/2001/XMLSchema}long" minOccurs="0"/>
         <element name="deliveredUnits" type="{http://www.w3.org/2001/XMLSchema}long" minOccurs="0"/>
         <element name="matchedUnits" type="{http://www.w3.org/2001/XMLSchema}long" minOccurs="0"/>
         <element name="possibleUnits" type="{http://www.w3.org/2001/XMLSchema}long" minOccurs="0"/>
         <element name="reservedUnits" type="{http://www.w3.org/2001/XMLSchema}long" minOccurs="0"/>
         <element name="targetingCriteriaBreakdowns" type="{https://www.google.com/apis/ads/publisher/v201802}TargetingCriteriaBreakdown" maxOccurs="unbounded" minOccurs="0"/>
         <element name="contendingLineItems" type="{https://www.google.com/apis/ads/publisher/v201802}ContendingLineItem" maxOccurs="unbounded" minOccurs="0"/>
         <element name="alternativeUnitTypeForecasts" type="{https://www.google.com/apis/ads/publisher/v201802}AlternativeUnitTypeForecast" maxOccurs="unbounded" minOccurs="0"/>
         <element name="demographicBreakdowns" type="{https://www.google.com/apis/ads/publisher/v201802}GrpDemographicBreakdown" maxOccurs="unbounded" minOccurs="0"/>
       </sequence>
     </restriction>
   </complexContent>
 </complexType>

Field Summary

Fields
Modifier and Type	Field and Description
`protected List<AlternativeUnitTypeForecast>`	`alternativeUnitTypeForecasts`
`protected Long`	`availableUnits`
`protected List<ContendingLineItem>`	`contendingLineItems`
`protected Long`	`deliveredUnits`
`protected List<GrpDemographicBreakdown>`	`demographicBreakdowns`
`protected Long`	`lineItemId`
`protected Long`	`matchedUnits`
`protected Long`	`orderId`
`protected Long`	`possibleUnits`
`protected Long`	`reservedUnits`
`protected List<TargetingCriteriaBreakdown>`	`targetingCriteriaBreakdowns`
`protected UnitType`	`unitType`

Constructor Summary

Constructors
Constructor and Description

AvailabilityForecast()

Constructors
Constructor and Description
`AvailabilityForecast()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`List<AlternativeUnitTypeForecast>`	`getAlternativeUnitTypeForecasts()` Gets the value of the alternativeUnitTypeForecasts property.
`Long`	`getAvailableUnits()` Gets the value of the availableUnits property.
`List<ContendingLineItem>`	`getContendingLineItems()` Gets the value of the contendingLineItems property.
`Long`	`getDeliveredUnits()` Gets the value of the deliveredUnits property.
`List<GrpDemographicBreakdown>`	`getDemographicBreakdowns()` Gets the value of the demographicBreakdowns property.
`Long`	`getLineItemId()` Gets the value of the lineItemId property.
`Long`	`getMatchedUnits()` Gets the value of the matchedUnits property.
`Long`	`getOrderId()` Gets the value of the orderId property.
`Long`	`getPossibleUnits()` Gets the value of the possibleUnits property.
`Long`	`getReservedUnits()` Gets the value of the reservedUnits property.
`List<TargetingCriteriaBreakdown>`	`getTargetingCriteriaBreakdowns()` Gets the value of the targetingCriteriaBreakdowns property.
`UnitType`	`getUnitType()` Gets the value of the unitType property.
`void`	`setAvailableUnits(Long value)` Sets the value of the availableUnits property.
`void`	`setDeliveredUnits(Long value)` Sets the value of the deliveredUnits property.
`void`	`setLineItemId(Long value)` Sets the value of the lineItemId property.
`void`	`setMatchedUnits(Long value)` Sets the value of the matchedUnits property.
`void`	`setOrderId(Long value)` Sets the value of the orderId property.
`void`	`setPossibleUnits(Long value)` Sets the value of the possibleUnits property.
`void`	`setReservedUnits(Long value)` Sets the value of the reservedUnits property.
`void`	`setUnitType(UnitType value)` Sets the value of the unitType property.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - lineItemId
```
protected Long lineItemId
```
  - orderId
```
protected Long orderId
```
  - unitType
```
protected UnitType unitType
```
  - availableUnits
```
protected Long availableUnits
```
  - deliveredUnits
```
protected Long deliveredUnits
```
  - matchedUnits
```
protected Long matchedUnits
```
  - possibleUnits
```
protected Long possibleUnits
```
  - reservedUnits
```
protected Long reservedUnits
```
  - targetingCriteriaBreakdowns
```
protected List<TargetingCriteriaBreakdown> targetingCriteriaBreakdowns
```
  - contendingLineItems
```
protected List<ContendingLineItem> contendingLineItems
```
  - alternativeUnitTypeForecasts
```
protected List<AlternativeUnitTypeForecast> alternativeUnitTypeForecasts
```
  - demographicBreakdowns
```
protected List<GrpDemographicBreakdown> demographicBreakdowns
```
- Constructor Detail
  - AvailabilityForecast
```
public AvailabilityForecast()
```
- Method Detail
  - getLineItemId
```
public Long getLineItemId()
```
    Gets the value of the lineItemId property.
    
    Returns:
    
    possible object is Long
  - setLineItemId
```
public void setLineItemId(Long value)
```
    Sets the value of the lineItemId property.
    
    Parameters:
    
    value - allowed object is Long
  - getOrderId
```
public Long getOrderId()
```
    Gets the value of the orderId property.
    
    Returns:
    
    possible object is Long
  - setOrderId
```
public void setOrderId(Long value)
```
    Sets the value of the orderId property.
    
    Parameters:
    
    value - allowed object is Long
  - getUnitType
```
public UnitType getUnitType()
```
    Gets the value of the unitType property.
    
    Returns:
    
    possible object is UnitType
  - setUnitType
```
public void setUnitType(UnitType value)
```
    Sets the value of the unitType property.
    
    Parameters:
    
    value - allowed object is UnitType
  - getAvailableUnits
```
public Long getAvailableUnits()
```
    Gets the value of the availableUnits property.
    
    Returns:
    
    possible object is Long
  - setAvailableUnits
```
public void setAvailableUnits(Long value)
```
    Sets the value of the availableUnits property.
    
    Parameters:
    
    value - allowed object is Long
  - getDeliveredUnits
```
public Long getDeliveredUnits()
```
    Gets the value of the deliveredUnits property.
    
    Returns:
    
    possible object is Long
  - setDeliveredUnits
```
public void setDeliveredUnits(Long value)
```
    Sets the value of the deliveredUnits property.
    
    Parameters:
    
    value - allowed object is Long
  - getMatchedUnits
```
public Long getMatchedUnits()
```
    Gets the value of the matchedUnits property.
    
    Returns:
    
    possible object is Long
  - setMatchedUnits
```
public void setMatchedUnits(Long value)
```
    Sets the value of the matchedUnits property.
    
    Parameters:
    
    value - allowed object is Long
  - getPossibleUnits
```
public Long getPossibleUnits()
```
    Gets the value of the possibleUnits property.
    
    Returns:
    
    possible object is Long
  - setPossibleUnits
```
public void setPossibleUnits(Long value)
```
    Sets the value of the possibleUnits property.
    
    Parameters:
    
    value - allowed object is Long
  - getReservedUnits
```
public Long getReservedUnits()
```
    Gets the value of the reservedUnits property.
    
    Returns:
    
    possible object is Long
  - setReservedUnits
```
public void setReservedUnits(Long value)
```
    Sets the value of the reservedUnits property.
    
    Parameters:
    
    value - allowed object is Long
  - getTargetingCriteriaBreakdowns
```
public List<TargetingCriteriaBreakdown> getTargetingCriteriaBreakdowns()
```
    Gets the value of the targetingCriteriaBreakdowns property.
    This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the targetingCriteriaBreakdowns property.
    For example, to add a new item, do as follows:
```
    getTargetingCriteriaBreakdowns().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list TargetingCriteriaBreakdown
  - getContendingLineItems
```
public List<ContendingLineItem> getContendingLineItems()
```
    Gets the value of the contendingLineItems property.
    This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the contendingLineItems property.
    For example, to add a new item, do as follows:
```
    getContendingLineItems().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list ContendingLineItem
  - getAlternativeUnitTypeForecasts
```
public List<AlternativeUnitTypeForecast> getAlternativeUnitTypeForecasts()
```
    Gets the value of the alternativeUnitTypeForecasts property.
    This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the alternativeUnitTypeForecasts property.
    For example, to add a new item, do as follows:
```
    getAlternativeUnitTypeForecasts().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list AlternativeUnitTypeForecast
  - getDemographicBreakdowns
```
public List<GrpDemographicBreakdown> getDemographicBreakdowns()
```
    Gets the value of the demographicBreakdowns property.
    This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the demographicBreakdowns property.
    For example, to add a new item, do as follows:
```
    getDemographicBreakdowns().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list GrpDemographicBreakdown

Class AvailabilityForecast

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

lineItemId

orderId

unitType

availableUnits

deliveredUnits

matchedUnits

possibleUnits

reservedUnits

targetingCriteriaBreakdowns

contendingLineItems

alternativeUnitTypeForecasts

demographicBreakdowns

Constructor Detail

AvailabilityForecast

Method Detail

getLineItemId

setLineItemId

getOrderId

setOrderId

getUnitType

setUnitType

getAvailableUnits

setAvailableUnits

getDeliveredUnits

setDeliveredUnits

getMatchedUnits

setMatchedUnits

getPossibleUnits

setPossibleUnits

getReservedUnits

setReservedUnits

getTargetingCriteriaBreakdowns

getContendingLineItems

getAlternativeUnitTypeForecasts

getDemographicBreakdowns