com.google.api.ads.admanager.axis.v202108

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.
TrafficDataResponse	getTrafficData(TrafficDataRequest trafficDataRequest) Returns forecasted and historical traffic data for the segment of traffic specified by the provided request.

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.

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.

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

getTrafficData

TrafficDataResponse getTrafficData(TrafficDataRequest trafficDataRequest)
                            throws RemoteException,
                                   ApiException

Returns forecasted and historical traffic data for the segment of traffic specified by the provided request.

Calling this endpoint programmatically is only available for Ad Manager 360 networks.

Parameters:

trafficDataRequest - the request specifying the segment of traffic for which data should be returned

Returns:

a dto containing forecasted and historical traffic data for the specified segment of traffic

Throws:

RemoteException

ApiException