com.google.api.ads.dfp.axis.v201403

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. If LineItemSummary.id is null or no line item exists with that ID, a forecast is computed for the the subject, predicting what would happen if it were added to the system. If a line item already exists with LineItemSummary.id, the forecast is computed for the subject, predicting what would happen if the existing line item's settings were modified to match the subject.

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