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

Class ForecastServiceSoapBindingStub

java.lang.Object

org.apache.axis.client.Stub

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

All Implemented Interfaces:

ForecastServiceInterface, Remote, javax.xml.rpc.Stub

public class ForecastServiceSoapBindingStub
extends org.apache.axis.client.Stub
implements ForecastServiceInterface

Field Summary

Fields inherited from class org.apache.axis.client.Stub

_call, cachedEndpoint, cachedPassword, cachedPortName, cachedProperties, cachedTimeout, cachedUsername, maintainSession, maintainSessionSet, service

Fields inherited from interface javax.xml.rpc.Stub

ENDPOINT_ADDRESS_PROPERTY, PASSWORD_PROPERTY, SESSION_MAINTAIN_PROPERTY, USERNAME_PROPERTY

Constructor Summary

Constructors

Constructor and Description
ForecastServiceSoapBindingStub()
ForecastServiceSoapBindingStub(javax.xml.rpc.Service service)
ForecastServiceSoapBindingStub(URL endpointURL, javax.xml.rpc.Service service)

Method Summary

Modifier and Type	Method and Description
protected org.apache.axis.client.Call	createCall()
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.

Methods inherited from class org.apache.axis.client.Stub

_createCall, _getCall, _getProperty, _getPropertyNames, _getService, _setProperty, addAttachment, clearAttachments, clearHeaders, extractAttachments, firstCall, getAttachments, getHeader, getHeaders, getPassword, getPortName, getResponseHeader, getResponseHeaders, getResponseHeaders, getTimeout, getUsername, removeProperty, setAttachments, setHeader, setHeader, setMaintainSession, setPassword, setPortName, setPortName, setRequestHeaders, setTimeout, setUsername

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ForecastServiceSoapBindingStub

public ForecastServiceSoapBindingStub()
                               throws org.apache.axis.AxisFault

Throws:

org.apache.axis.AxisFault

ForecastServiceSoapBindingStub

public ForecastServiceSoapBindingStub(URL endpointURL,
                                      javax.xml.rpc.Service service)
                               throws org.apache.axis.AxisFault

Throws:

org.apache.axis.AxisFault

ForecastServiceSoapBindingStub

public ForecastServiceSoapBindingStub(javax.xml.rpc.Service service)
                               throws org.apache.axis.AxisFault

Throws:

org.apache.axis.AxisFault

Method Detail

createCall

protected org.apache.axis.client.Call createCall()
                                          throws RemoteException

Throws:

RemoteException

getAvailabilityForecast

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

Description copied from interface: ForecastServiceInterface

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.

Specified by:

getAvailabilityForecast in interface ForecastServiceInterface

Parameters:

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

forecastOptions - options controlling the forecast

Throws:

RemoteException

ApiException

getAvailabilityForecastById

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

Description copied from interface: ForecastServiceInterface

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.

Specified by:

getAvailabilityForecastById in interface ForecastServiceInterface

Parameters:

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

forecastOptions - options controlling the forecast

Throws:

RemoteException

ApiException

getDeliveryForecast

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

Description copied from interface: ForecastServiceInterface

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.

Specified by:

getDeliveryForecast in interface ForecastServiceInterface

Parameters:

lineItems - line items to be forecasted for delivery

forecastOptions - options controlling the forecast

Throws:

RemoteException

ApiException

getDeliveryForecastByIds

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

Description copied from interface: ForecastServiceInterface

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.

Specified by:

getDeliveryForecastByIds in interface ForecastServiceInterface

Parameters:

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

forecastOptions - options controlling the forecast

Throws:

RemoteException

ApiException