com.google.api.ads.dfp.axis.v201608

Interface ForecastServiceInterface

All Superinterfaces:

Remote

All Known Implementing Classes:

ForecastServiceSoapBindingStub

public interface ForecastServiceInterface
extends Remote

Method Summary

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(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(long[] lineItemIds, DeliveryForecastOptions forecastOptions) Gets the delivery forecast for a list of existing LineItem objects in a single delivery simulation with line items potentially contending with each other.

Method Detail

getAvailabilityForecast

AvailabilityForecast getAvailabilityForecast(ProspectiveLineItem lineItem,
                                             AvailabilityForecastOptions forecastOptions)
                                      throws RemoteException,
                                             ApiException

Gets the availability forecast for a 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.

Note: Beginning in v201502, this replaces the previous getForecast method.

Parameters:

lineItem - the prospective line item (new or existing) to be forecasted for availability

forecastOptions - options controlling the forecast

Throws:

RemoteException

ApiException

getAvailabilityForecastById

AvailabilityForecast getAvailabilityForecastById(Long lineItemId,
                                                 AvailabilityForecastOptions forecastOptions)
                                          throws RemoteException,
                                                 ApiException

Gets an 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.

Note: Beginning in v201502, this replaces the previous getForecastById method.

Parameters:

lineItemId - the ID of a LineItem to run the forecast on.

forecastOptions - options controlling the forecast

Throws:

RemoteException

ApiException

getDeliveryForecast

DeliveryForecast getDeliveryForecast(ProspectiveLineItem[] lineItems,
                                     DeliveryForecastOptions forecastOptions)
                              throws RemoteException,
                                     ApiException

Gets the delivery forecast for a list of 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.

Parameters:

lineItems - line items to be forecasted for delivery

forecastOptions - options controlling the forecast

Throws:

RemoteException

ApiException

getDeliveryForecastByIds

DeliveryForecast getDeliveryForecastByIds(long[] lineItemIds,
                                          DeliveryForecastOptions forecastOptions)
                                   throws RemoteException,
                                          ApiException

Gets the delivery forecast for a list of existing LineItem 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.

Parameters:

lineItemIds - the IDs of line items to be forecasted for delivery

forecastOptions - options controlling the forecast

Throws:

RemoteException

ApiException