com.google.api.ads.admanager.jaxws.v202405.AvailabilityForecast Maven / Gradle / Ivy
Show all versions of dfp-appengine Show documentation
// Copyright 2024 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package com.google.api.ads.admanager.jaxws.v202405;
import java.util.ArrayList;
import java.util.List;
import javax.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlSchemaType;
import javax.xml.bind.annotation.XmlType;
/**
*
* Describes predicted inventory availability for a {@link 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/v202405}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="breakdowns" type="{https://www.google.com/apis/ads/publisher/v202405}ForecastBreakdown" maxOccurs="unbounded" minOccurs="0"/>
* <element name="targetingCriteriaBreakdowns" type="{https://www.google.com/apis/ads/publisher/v202405}TargetingCriteriaBreakdown" maxOccurs="unbounded" minOccurs="0"/>
* <element name="contendingLineItems" type="{https://www.google.com/apis/ads/publisher/v202405}ContendingLineItem" maxOccurs="unbounded" minOccurs="0"/>
* <element name="alternativeUnitTypeForecasts" type="{https://www.google.com/apis/ads/publisher/v202405}AlternativeUnitTypeForecast" maxOccurs="unbounded" minOccurs="0"/>
* </sequence>
* </restriction>
* </complexContent>
* </complexType>
*
*
*
*/
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "AvailabilityForecast", propOrder = {
"lineItemId",
"orderId",
"unitType",
"availableUnits",
"deliveredUnits",
"matchedUnits",
"possibleUnits",
"reservedUnits",
"breakdowns",
"targetingCriteriaBreakdowns",
"contendingLineItems",
"alternativeUnitTypeForecasts"
})
public class AvailabilityForecast {
protected Long lineItemId;
protected Long orderId;
@XmlSchemaType(name = "string")
protected UnitType unitType;
protected Long availableUnits;
protected Long deliveredUnits;
protected Long matchedUnits;
protected Long possibleUnits;
protected Long reservedUnits;
protected List breakdowns;
protected List targetingCriteriaBreakdowns;
protected List contendingLineItems;
protected List alternativeUnitTypeForecasts;
/**
* Gets the value of the lineItemId property.
*
* @return
* possible object is
* {@link Long }
*
*/
public Long getLineItemId() {
return lineItemId;
}
/**
* Sets the value of the lineItemId property.
*
* @param value
* allowed object is
* {@link Long }
*
*/
public void setLineItemId(Long value) {
this.lineItemId = value;
}
/**
* Gets the value of the orderId property.
*
* @return
* possible object is
* {@link Long }
*
*/
public Long getOrderId() {
return orderId;
}
/**
* Sets the value of the orderId property.
*
* @param value
* allowed object is
* {@link Long }
*
*/
public void setOrderId(Long value) {
this.orderId = value;
}
/**
* Gets the value of the unitType property.
*
* @return
* possible object is
* {@link UnitType }
*
*/
public UnitType getUnitType() {
return unitType;
}
/**
* Sets the value of the unitType property.
*
* @param value
* allowed object is
* {@link UnitType }
*
*/
public void setUnitType(UnitType value) {
this.unitType = value;
}
/**
* Gets the value of the availableUnits property.
*
* @return
* possible object is
* {@link Long }
*
*/
public Long getAvailableUnits() {
return availableUnits;
}
/**
* Sets the value of the availableUnits property.
*
* @param value
* allowed object is
* {@link Long }
*
*/
public void setAvailableUnits(Long value) {
this.availableUnits = value;
}
/**
* Gets the value of the deliveredUnits property.
*
* @return
* possible object is
* {@link Long }
*
*/
public Long getDeliveredUnits() {
return deliveredUnits;
}
/**
* Sets the value of the deliveredUnits property.
*
* @param value
* allowed object is
* {@link Long }
*
*/
public void setDeliveredUnits(Long value) {
this.deliveredUnits = value;
}
/**
* Gets the value of the matchedUnits property.
*
* @return
* possible object is
* {@link Long }
*
*/
public Long getMatchedUnits() {
return matchedUnits;
}
/**
* Sets the value of the matchedUnits property.
*
* @param value
* allowed object is
* {@link Long }
*
*/
public void setMatchedUnits(Long value) {
this.matchedUnits = value;
}
/**
* Gets the value of the possibleUnits property.
*
* @return
* possible object is
* {@link Long }
*
*/
public Long getPossibleUnits() {
return possibleUnits;
}
/**
* Sets the value of the possibleUnits property.
*
* @param value
* allowed object is
* {@link Long }
*
*/
public void setPossibleUnits(Long value) {
this.possibleUnits = value;
}
/**
* Gets the value of the reservedUnits property.
*
* @return
* possible object is
* {@link Long }
*
*/
public Long getReservedUnits() {
return reservedUnits;
}
/**
* Sets the value of the reservedUnits property.
*
* @param value
* allowed object is
* {@link Long }
*
*/
public void setReservedUnits(Long value) {
this.reservedUnits = value;
}
/**
* Gets the value of the breakdowns 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 breakdowns property.
*
*
* For example, to add a new item, do as follows:
*
* getBreakdowns().add(newItem);
*
*
*
*
* Objects of the following type(s) are allowed in the list
* {@link ForecastBreakdown }
*
*
*/
public List getBreakdowns() {
if (breakdowns == null) {
breakdowns = new ArrayList();
}
return this.breakdowns;
}
/**
* 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
* {@link TargetingCriteriaBreakdown }
*
*
*/
public List getTargetingCriteriaBreakdowns() {
if (targetingCriteriaBreakdowns == null) {
targetingCriteriaBreakdowns = new ArrayList();
}
return this.targetingCriteriaBreakdowns;
}
/**
* 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
* {@link ContendingLineItem }
*
*
*/
public List getContendingLineItems() {
if (contendingLineItems == null) {
contendingLineItems = new ArrayList();
}
return this.contendingLineItems;
}
/**
* 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
* {@link AlternativeUnitTypeForecast }
*
*
*/
public List getAlternativeUnitTypeForecasts() {
if (alternativeUnitTypeForecasts == null) {
alternativeUnitTypeForecasts = new ArrayList();
}
return this.alternativeUnitTypeForecasts;
}
}