com.google.api.ads.dfp.axis.v201201
Class Forecast

java.lang.Object
  com.google.api.ads.dfp.axis.v201201.Forecast

All Implemented Interfaces:

Serializable

public class Forecast
extends Object
implements Serializable

Describes predicted inventory availability for a line item with the specified properties.

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 overbook lower or equal priority line items.
• Possible units -- How many units can be booked without affecting any higher priority line items. Booking more than this number can overbook higher priority line items.
• Matched (forecast) units -- How many units satisfy all specified criteria.

The term "can overbook" is used, because if more impressions are served than are predicted, the extra available inventory might enable all inventory guarantees to be met without overbooking.

See Also:

Serialized Form

Constructor Summary

Forecast()

Forecast(Long id, Long orderId, UnitType unitType, Long availableUnits, Long deliveredUnits, Long matchedUnits, Long possibleUnits, Long reservedUnits)

Method Summary

boolean	equals(Object obj)
Long	getAvailableUnits() Gets the availableUnits value for this Forecast.
Long	getDeliveredUnits() Gets the deliveredUnits value for this Forecast.
static org.apache.axis.encoding.Deserializer	getDeserializer(String mechType, Class _javaType, QName _xmlType) Get Custom Deserializer
Long	getId() Gets the id value for this Forecast.
Long	getMatchedUnits() Gets the matchedUnits value for this Forecast.
Long	getOrderId() Gets the orderId value for this Forecast.
Long	getPossibleUnits() Gets the possibleUnits value for this Forecast.
Long	getReservedUnits() Gets the reservedUnits value for this Forecast.
static org.apache.axis.encoding.Serializer	getSerializer(String mechType, Class _javaType, QName _xmlType) Get Custom Serializer
static org.apache.axis.description.TypeDesc	getTypeDesc() Return type metadata object
UnitType	getUnitType() Gets the unitType value for this Forecast.
int	hashCode()
void	setAvailableUnits(Long availableUnits) Sets the availableUnits value for this Forecast.
void	setDeliveredUnits(Long deliveredUnits) Sets the deliveredUnits value for this Forecast.
void	setId(Long id) Sets the id value for this Forecast.
void	setMatchedUnits(Long matchedUnits) Sets the matchedUnits value for this Forecast.
void	setOrderId(Long orderId) Sets the orderId value for this Forecast.
void	setPossibleUnits(Long possibleUnits) Sets the possibleUnits value for this Forecast.
void	setReservedUnits(Long reservedUnits) Sets the reservedUnits value for this Forecast.
void	setUnitType(UnitType unitType) Sets the unitType value for this Forecast.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Forecast

public Forecast()

Forecast

public Forecast(Long id,
                Long orderId,
                UnitType unitType,
                Long availableUnits,
                Long deliveredUnits,
                Long matchedUnits,
                Long possibleUnits,
                Long reservedUnits)

Method Detail

getId

public Long getId()

Gets the id value for this Forecast.

Returns:

id * Uniquely identifies the Forecast. This value is read-only and is assigned by Google when the forecast is created. The attribute will be either the ID of the LineItem object it represents, or null if the forecast represents a prospective line item.

setId

public void setId(Long id)

Sets the id value for this Forecast.

Parameters:

id - * Uniquely identifies the Forecast. This value is read-only and is assigned by Google when the forecast is created. The attribute will be either the ID of the LineItem object it represents, or null if the forecast represents a prospective line item.

getOrderId

public Long getOrderId()

Gets the orderId value for this Forecast.

Returns:

orderId * The unique ID for the Order object that counts this reservation as a member, or null if the forecast represents a prospective line item without an LineItemSummary.orderId set.

setOrderId

public void setOrderId(Long orderId)

Sets the orderId value for this Forecast.

Parameters:

orderId - * The unique ID for the Order object that counts this reservation as a member, or null if the forecast represents a prospective line item without an LineItemSummary.orderId set.

getUnitType

public UnitType getUnitType()

Gets the unitType value for this Forecast.

Returns:

unitType * The unit with which the goal or cap of the LineItem is defined. Will be the same value as LineItemSummary.unitType for both a set line item or a prospective one.

setUnitType

public void setUnitType(UnitType unitType)

Sets the unitType value for this Forecast.

Parameters:

unitType - * The unit with which the goal or cap of the LineItem is defined. Will be the same value as LineItemSummary.unitType for both a set line item or a prospective one.

getAvailableUnits

public Long getAvailableUnits()

Gets the availableUnits value for this Forecast.

Returns:

availableUnits * The number of units, defined by unitType, that can be booked without affecting the delivery of any reserved line items. Exceeding this value will not cause an overbook, but lower-priority line items may not run.

setAvailableUnits

public void setAvailableUnits(Long availableUnits)

Sets the availableUnits value for this Forecast.

Parameters:

availableUnits - * The number of units, defined by unitType, that can be booked without affecting the delivery of any reserved line items. Exceeding this value will not cause an overbook, but lower-priority line items may not run.

getDeliveredUnits

public Long getDeliveredUnits()

Gets the deliveredUnits value for this Forecast.

Returns:

deliveredUnits * The number of units, defined by unitType, that have already been served if the reservation is already running.

setDeliveredUnits

public void setDeliveredUnits(Long deliveredUnits)

Sets the deliveredUnits value for this Forecast.

Parameters:

deliveredUnits - * The number of units, defined by unitType, that have already been served if the reservation is already running.

getMatchedUnits

public Long getMatchedUnits()

Gets the matchedUnits value for this Forecast.

Returns:

matchedUnits * The number of units, defined by unitType, that match the specified targeting and delivery settings.

setMatchedUnits

public void setMatchedUnits(Long matchedUnits)

Sets the matchedUnits value for this Forecast.

Parameters:

matchedUnits - * The number of units, defined by unitType, that match the specified targeting and delivery settings.

getPossibleUnits

public Long getPossibleUnits()

Gets the possibleUnits value for this Forecast.

Returns:

possibleUnits * The maximum number of units, defined by unitType, that could be booked by taking inventory away from lower-priority line items. (Please note: booking this number may cause lower-priority line items to under deliver.)

setPossibleUnits

public void setPossibleUnits(Long possibleUnits)

Sets the possibleUnits value for this Forecast.

Parameters:

possibleUnits - * The maximum number of units, defined by unitType, that could be booked by taking inventory away from lower-priority line items. (Please note: booking this number may cause lower-priority line items to under deliver.)

getReservedUnits

public Long getReservedUnits()

Gets the reservedUnits value for this Forecast.

Returns:

reservedUnits * The number of reserved units, defined by unitType, requested. This can be an absolute or percentage value.

setReservedUnits

public void setReservedUnits(Long reservedUnits)

Sets the reservedUnits value for this Forecast.

Parameters:

reservedUnits - * The number of reserved units, defined by unitType, requested. This can be an absolute or percentage value.

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getTypeDesc

public static org.apache.axis.description.TypeDesc getTypeDesc()

Return type metadata object

getSerializer

public static org.apache.axis.encoding.Serializer getSerializer(String mechType,
                                                                Class _javaType,
                                                                QName _xmlType)

Get Custom Serializer

getDeserializer

public static org.apache.axis.encoding.Deserializer getDeserializer(String mechType,
                                                                    Class _javaType,
                                                                    QName _xmlType)

Get Custom Deserializer