public interface ForecastServiceInterface
LineItem objects that exist in the system or which have not had an ID set
yet.
Test networks are unable to provide forecasts that would be comparable to the production environment because forecasts require traffic history. For test networks, a consistent behavior can be expected for forecast requests, according to the following rules:
| Inputs ( LineItem Fields) |
Outputs ( Forecast Fields) |
||||
|---|---|---|---|---|---|
lineItemType |
unitsBought |
availableUnits |
forecastUnits (matchedUnits) |
deliveredUnits |
Exception |
| Sponsorship | 13 | –– | –– | –– |
NO_FORECAST_YET
|
| Sponsorship | 20 | –– | –– | –– |
SERVER_NOT_AVAILABLE
|
| Sponsorship | 50 | 1,200,000 | 6,000,000 | 600,000 For prospective: 0 |
–– |
| Sponsorship | != 20 and != 50 |
1,200,000 | 1,200,000 | 600,000 For prospective: 0 |
–– |
| Not Sponsorship | <= 500,000 | 3 * unitsBought / 2 | unitsBought * 6 | 600,000 For prospective: 0 |
–– |
| Not Sponsorship | > 500,000 and <= 1,000,000 | unitsBought / 2 | unitsBought * 6 | 600,000 For prospective: 0 |
–– |
| Not Sponsorship | > 1,000,000 and <= 1,500,000 | unitsBought / 2 | 3 * unitsBought / 2 | 600,000 For prospective: 0 |
–– |
| Not Sponsorship | > 1,500,000 | unitsBought / 4 | 3 * unitsBought / 2 | 600,000 For prospective: 0 |
–– |
| Modifier and Type | Method and Description |
|---|---|
AvailabilityForecast |
getAvailabilityForecast(ProspectiveLineItem lineItem,
AvailabilityForecastOptions forecastOptions)
Gets the availability forecast for a
ProspectiveLineItem. |
AvailabilityForecast |
getAvailabilityForecastById(Long lineItemId,
AvailabilityForecastOptions forecastOptions)
Gets an
AvailabilityForecast for an existing LineItem object. |
DeliveryForecast |
getDeliveryForecast(List<ProspectiveLineItem> lineItems,
DeliveryForecastOptions forecastOptions)
Gets the delivery forecast for a list of
ProspectiveLineItem objects in a single
delivery simulation with line items potentially contending with each other. |
DeliveryForecast |
getDeliveryForecastByIds(List<Long> lineItemIds,
DeliveryForecastOptions forecastOptions)
Gets the delivery forecast for a list of existing
LineItem objects in a single
delivery simulation. |
@RequestWrapper(localName="getAvailabilityForecast", targetNamespace="https://www.google.com/apis/ads/publisher/v201708", className="com.google.api.ads.dfp.jaxws.v201708.ForecastServiceInterfacegetAvailabilityForecast") @ResponseWrapper(localName="getAvailabilityForecastResponse", targetNamespace="https://www.google.com/apis/ads/publisher/v201708", className="com.google.api.ads.dfp.jaxws.v201708.ForecastServiceInterfacegetAvailabilityForecastResponse") AvailabilityForecast getAvailabilityForecast(ProspectiveLineItem lineItem, AvailabilityForecastOptions forecastOptions) throws ApiException_Exception
ProspectiveLineItem. An availability forecast
reports the maximum number of available units that the line item can book, and the total number
of units matching the line item's targeting.lineItem - the prospective line item (new or existing) to be forecasted for availabilityforecastOptions - options controlling the forecastlineItem - forecastOptions - ApiException_Exception@RequestWrapper(localName="getAvailabilityForecastById", targetNamespace="https://www.google.com/apis/ads/publisher/v201708", className="com.google.api.ads.dfp.jaxws.v201708.ForecastServiceInterfacegetAvailabilityForecastById") @ResponseWrapper(localName="getAvailabilityForecastByIdResponse", targetNamespace="https://www.google.com/apis/ads/publisher/v201708", className="com.google.api.ads.dfp.jaxws.v201708.ForecastServiceInterfacegetAvailabilityForecastByIdResponse") AvailabilityForecast getAvailabilityForecastById(Long lineItemId, AvailabilityForecastOptions forecastOptions) throws ApiException_Exception
AvailabilityForecast for an existing LineItem object. An availability
forecast reports the maximum number of available units that the line item can be booked with,
and also the total number of units matching the line item's targeting.
Only line items having type LineItemType.SPONSORSHIP or LineItemType.STANDARD are valid. Other types will result in ReservationDetailsError.Reason#LINE_ITEM_TYPE_NOT_ALLOWED.
lineItemId - the ID of a LineItem to run the forecast on.forecastOptions - options controlling the forecastforecastOptions - lineItemId - ApiException_Exception@RequestWrapper(localName="getDeliveryForecast", targetNamespace="https://www.google.com/apis/ads/publisher/v201708", className="com.google.api.ads.dfp.jaxws.v201708.ForecastServiceInterfacegetDeliveryForecast") @ResponseWrapper(localName="getDeliveryForecastResponse", targetNamespace="https://www.google.com/apis/ads/publisher/v201708", className="com.google.api.ads.dfp.jaxws.v201708.ForecastServiceInterfacegetDeliveryForecastResponse") DeliveryForecast getDeliveryForecast(List<ProspectiveLineItem> lineItems, DeliveryForecastOptions forecastOptions) throws ApiException_Exception
ProspectiveLineItem objects in a single
delivery simulation with line items potentially contending with each other. A delivery forecast
reports the number of units that will be delivered to each line item given the line item goals
and contentions from other line items.lineItems - line items to be forecasted for deliveryforecastOptions - options controlling the forecastlineItems - forecastOptions - ApiException_Exception@RequestWrapper(localName="getDeliveryForecastByIds", targetNamespace="https://www.google.com/apis/ads/publisher/v201708", className="com.google.api.ads.dfp.jaxws.v201708.ForecastServiceInterfacegetDeliveryForecastByIds") @ResponseWrapper(localName="getDeliveryForecastByIdsResponse", targetNamespace="https://www.google.com/apis/ads/publisher/v201708", className="com.google.api.ads.dfp.jaxws.v201708.ForecastServiceInterfacegetDeliveryForecastByIdsResponse") DeliveryForecast getDeliveryForecastByIds(List<Long> lineItemIds, DeliveryForecastOptions forecastOptions) throws ApiException_Exception
LineItem objects in a single
delivery simulation. A delivery forecast reports the number of units that will be delivered
to each line item given the line item goals and contentions from other line items.lineItemIds - the IDs of line items to be forecasted for deliveryforecastOptions - options controlling the forecastforecastOptions - lineItemIds - ApiException_ExceptionCopyright © 2018. All Rights Reserved.