com.google.api.ads.dfp.axis.v201203

Interface ForecastServiceInterface

All Superinterfaces:

Remote

All Known Implementing Classes:

ForecastServiceSoapBindingStub

public interface ForecastServiceInterface
extends Remote

Method Summary

Methods

Modifier and Type	Method and Description
Forecast	getForecast(LineItem lineItem) Gets a Forecast on a prospective LineItem object.
Forecast	getForecastById(Long lineItemId) Gets a Forecast for an existing LineItem object.

Method Detail

getForecast

Forecast getForecast(LineItem lineItem)
                     throws RemoteException,
                            ApiException

Gets a Forecast on a prospective LineItem object. Valid values for LineItemSummary.lineItemType are LineItemType.SPONSORSHIP and LineItemType.STANDARD. Other values will result in ReservationDetailsError.Reason#LINE_ITEM_TYPE_NOT_ALLOWED.

Parameters:

lineItem - the target of the forecast. Must be a prospective line item that has not yet been booked in the system. i.e. LineItemSummary.id must be null.

Returns:

the forecasted traffic estimates

Throws:

RemoteException

ApiException

getForecastById

Forecast getForecastById(Long lineItemId)
                         throws RemoteException,
                                ApiException

Gets a Forecast for an existing LineItem object. Only line items having type LineItemType.SPONSORSHIP or LineItemType.STANDARD are valid. Other types will result in ReservationDetailsError.Reason#LINE_ITEM_TYPE_NOT_ALLOWED.

Parameters:

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

Returns:

the forecasted traffic estimates

Throws:

RemoteException

ApiException