com.google.api.ads.dfp.axis.v201802

Class AvailabilityForecast

java.lang.Object

com.google.api.ads.dfp.axis.v201802.AvailabilityForecast

All Implemented Interfaces:

Serializable

public class AvailabilityForecast
extends Object
implements Serializable

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.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AvailabilityForecast()
AvailabilityForecast(Long lineItemId, Long orderId, UnitType unitType, Long availableUnits, Long deliveredUnits, Long matchedUnits, Long possibleUnits, Long reservedUnits, TargetingCriteriaBreakdown[] targetingCriteriaBreakdowns, ContendingLineItem[] contendingLineItems, AlternativeUnitTypeForecast[] alternativeUnitTypeForecasts, GrpDemographicBreakdown[] demographicBreakdowns)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
AlternativeUnitTypeForecast[]	getAlternativeUnitTypeForecasts() Gets the alternativeUnitTypeForecasts value for this AvailabilityForecast.
AlternativeUnitTypeForecast	getAlternativeUnitTypeForecasts(int i)
Long	getAvailableUnits() Gets the availableUnits value for this AvailabilityForecast.
ContendingLineItem[]	getContendingLineItems() Gets the contendingLineItems value for this AvailabilityForecast.
ContendingLineItem	getContendingLineItems(int i)
Long	getDeliveredUnits() Gets the deliveredUnits value for this AvailabilityForecast.
GrpDemographicBreakdown[]	getDemographicBreakdowns() Gets the demographicBreakdowns value for this AvailabilityForecast.
GrpDemographicBreakdown	getDemographicBreakdowns(int i)
static org.apache.axis.encoding.Deserializer	getDeserializer(String mechType, Class _javaType, QName _xmlType) Get Custom Deserializer
Long	getLineItemId() Gets the lineItemId value for this AvailabilityForecast.
Long	getMatchedUnits() Gets the matchedUnits value for this AvailabilityForecast.
Long	getOrderId() Gets the orderId value for this AvailabilityForecast.
Long	getPossibleUnits() Gets the possibleUnits value for this AvailabilityForecast.
Long	getReservedUnits() Gets the reservedUnits value for this AvailabilityForecast.
static org.apache.axis.encoding.Serializer	getSerializer(String mechType, Class _javaType, QName _xmlType) Get Custom Serializer
TargetingCriteriaBreakdown[]	getTargetingCriteriaBreakdowns() Gets the targetingCriteriaBreakdowns value for this AvailabilityForecast.
TargetingCriteriaBreakdown	getTargetingCriteriaBreakdowns(int i)
static org.apache.axis.description.TypeDesc	getTypeDesc() Return type metadata object
UnitType	getUnitType() Gets the unitType value for this AvailabilityForecast.
int	hashCode()
void	setAlternativeUnitTypeForecasts(AlternativeUnitTypeForecast[] alternativeUnitTypeForecasts) Sets the alternativeUnitTypeForecasts value for this AvailabilityForecast.
void	setAlternativeUnitTypeForecasts(int i, AlternativeUnitTypeForecast _value)
void	setAvailableUnits(Long availableUnits) Sets the availableUnits value for this AvailabilityForecast.
void	setContendingLineItems(ContendingLineItem[] contendingLineItems) Sets the contendingLineItems value for this AvailabilityForecast.
void	setContendingLineItems(int i, ContendingLineItem _value)
void	setDeliveredUnits(Long deliveredUnits) Sets the deliveredUnits value for this AvailabilityForecast.
void	setDemographicBreakdowns(GrpDemographicBreakdown[] demographicBreakdowns) Sets the demographicBreakdowns value for this AvailabilityForecast.
void	setDemographicBreakdowns(int i, GrpDemographicBreakdown _value)
void	setLineItemId(Long lineItemId) Sets the lineItemId value for this AvailabilityForecast.
void	setMatchedUnits(Long matchedUnits) Sets the matchedUnits value for this AvailabilityForecast.
void	setOrderId(Long orderId) Sets the orderId value for this AvailabilityForecast.
void	setPossibleUnits(Long possibleUnits) Sets the possibleUnits value for this AvailabilityForecast.
void	setReservedUnits(Long reservedUnits) Sets the reservedUnits value for this AvailabilityForecast.
void	setTargetingCriteriaBreakdowns(int i, TargetingCriteriaBreakdown _value)
void	setTargetingCriteriaBreakdowns(TargetingCriteriaBreakdown[] targetingCriteriaBreakdowns) Sets the targetingCriteriaBreakdowns value for this AvailabilityForecast.
void	setUnitType(UnitType unitType) Sets the unitType value for this AvailabilityForecast.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

AvailabilityForecast

public AvailabilityForecast()

AvailabilityForecast

public AvailabilityForecast(Long lineItemId,
                            Long orderId,
                            UnitType unitType,
                            Long availableUnits,
                            Long deliveredUnits,
                            Long matchedUnits,
                            Long possibleUnits,
                            Long reservedUnits,
                            TargetingCriteriaBreakdown[] targetingCriteriaBreakdowns,
                            ContendingLineItem[] contendingLineItems,
                            AlternativeUnitTypeForecast[] alternativeUnitTypeForecasts,
                            GrpDemographicBreakdown[] demographicBreakdowns)

Method Detail

toString

public String toString()

Overrides:

toString in class Object

getLineItemId

public Long getLineItemId()

Gets the lineItemId value for this AvailabilityForecast.

Returns:

lineItemId * Uniquely identifies this availability 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.

setLineItemId

public void setLineItemId(Long lineItemId)

Sets the lineItemId value for this AvailabilityForecast.

Parameters:

lineItemId - * Uniquely identifies this availability 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 AvailabilityForecast.

Returns:

orderId * The unique ID for the Order object that this line item belongs to, 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 AvailabilityForecast.

Parameters:

orderId - * The unique ID for the Order object that this line item belongs to, 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 AvailabilityForecast.

Returns:

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

setUnitType

public void setUnitType(UnitType unitType)

Sets the unitType value for this AvailabilityForecast.

Parameters:

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

getAvailableUnits

public Long getAvailableUnits()

Gets the availableUnits value for this AvailabilityForecast.

Returns:

availableUnits * The number of units, defined by Goal.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 AvailabilityForecast.

Parameters:

availableUnits - * The number of units, defined by Goal.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 AvailabilityForecast.

Returns:

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

setDeliveredUnits

public void setDeliveredUnits(Long deliveredUnits)

Sets the deliveredUnits value for this AvailabilityForecast.

Parameters:

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

getMatchedUnits

public Long getMatchedUnits()

Gets the matchedUnits value for this AvailabilityForecast.

Returns:

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

setMatchedUnits

public void setMatchedUnits(Long matchedUnits)

Sets the matchedUnits value for this AvailabilityForecast.

Parameters:

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

getPossibleUnits

public Long getPossibleUnits()

Gets the possibleUnits value for this AvailabilityForecast.

Returns:

possibleUnits * The maximum number of units, defined by Goal.unitType, that could be booked by taking inventory away from lower priority line items and some same priority line items.

Please note: booking this number may cause lower priority line items and some same priority line items to underdeliver.

setPossibleUnits

public void setPossibleUnits(Long possibleUnits)

Sets the possibleUnits value for this AvailabilityForecast.

Parameters:

possibleUnits - * The maximum number of units, defined by Goal.unitType, that could be booked by taking inventory away from lower priority line items and some same priority line items.

Please note: booking this number may cause lower priority line items and some same priority line items to underdeliver.

getReservedUnits

public Long getReservedUnits()

Gets the reservedUnits value for this AvailabilityForecast.

Returns:

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

setReservedUnits

public void setReservedUnits(Long reservedUnits)

Sets the reservedUnits value for this AvailabilityForecast.

Parameters:

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

getTargetingCriteriaBreakdowns

public TargetingCriteriaBreakdown[] getTargetingCriteriaBreakdowns()

Gets the targetingCriteriaBreakdowns value for this AvailabilityForecast.

Returns:

targetingCriteriaBreakdowns * The forecast result broken down by the targeting of the forecasted line item.

setTargetingCriteriaBreakdowns

public void setTargetingCriteriaBreakdowns(TargetingCriteriaBreakdown[] targetingCriteriaBreakdowns)

Sets the targetingCriteriaBreakdowns value for this AvailabilityForecast.

Parameters:

targetingCriteriaBreakdowns - * The forecast result broken down by the targeting of the forecasted line item.

getTargetingCriteriaBreakdowns

public TargetingCriteriaBreakdown getTargetingCriteriaBreakdowns(int i)

setTargetingCriteriaBreakdowns

public void setTargetingCriteriaBreakdowns(int i,
                                           TargetingCriteriaBreakdown _value)

getContendingLineItems

public ContendingLineItem[] getContendingLineItems()

Gets the contendingLineItems value for this AvailabilityForecast.

Returns:

contendingLineItems * List of contending line items for this forecast.

setContendingLineItems

public void setContendingLineItems(ContendingLineItem[] contendingLineItems)

Sets the contendingLineItems value for this AvailabilityForecast.

Parameters:

contendingLineItems - * List of contending line items for this forecast.

getContendingLineItems

public ContendingLineItem getContendingLineItems(int i)

setContendingLineItems

public void setContendingLineItems(int i,
                                   ContendingLineItem _value)

getAlternativeUnitTypeForecasts

public AlternativeUnitTypeForecast[] getAlternativeUnitTypeForecasts()

Gets the alternativeUnitTypeForecasts value for this AvailabilityForecast.

Returns:

alternativeUnitTypeForecasts * Views of this forecast, with alternative unit types.

setAlternativeUnitTypeForecasts

public void setAlternativeUnitTypeForecasts(AlternativeUnitTypeForecast[] alternativeUnitTypeForecasts)

Sets the alternativeUnitTypeForecasts value for this AvailabilityForecast.

Parameters:

alternativeUnitTypeForecasts - * Views of this forecast, with alternative unit types.

getAlternativeUnitTypeForecasts

public AlternativeUnitTypeForecast getAlternativeUnitTypeForecasts(int i)

setAlternativeUnitTypeForecasts

public void setAlternativeUnitTypeForecasts(int i,
                                            AlternativeUnitTypeForecast _value)

getDemographicBreakdowns

public GrpDemographicBreakdown[] getDemographicBreakdowns()

Gets the demographicBreakdowns value for this AvailabilityForecast.

Returns:

demographicBreakdowns * The forecast result broken down by demographics.

setDemographicBreakdowns

public void setDemographicBreakdowns(GrpDemographicBreakdown[] demographicBreakdowns)

Sets the demographicBreakdowns value for this AvailabilityForecast.

Parameters:

demographicBreakdowns - * The forecast result broken down by demographics.

getDemographicBreakdowns

public GrpDemographicBreakdown getDemographicBreakdowns(int i)

setDemographicBreakdowns

public void setDemographicBreakdowns(int i,
                                     GrpDemographicBreakdown _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