org.mule.modules.google.dfp.premium.services

Class ForecastService

java.lang.Object

org.mule.modules.google.dfp.premium.services.ForecastService

public class ForecastService
extends Object

Service containing Forecast helper methods.

Constructor Summary

Constructors

Constructor and Description
ForecastService()

Method Summary

Modifier and Type	Method and Description
protected com.google.api.ads.admanager.axis.v201902.ForecastServiceInterface	createForecastService(com.google.api.ads.admanager.lib.client.AdManagerSession session)
com.google.api.ads.admanager.axis.v201902.AvailabilityForecast	getAvailabilityForecast(com.google.api.ads.admanager.lib.client.AdManagerSession session, com.google.api.ads.admanager.axis.v201902.ProspectiveLineItem prospectiveLineItem, Boolean includeTargetingCriteriaBreakdown, Boolean includeContendingLineItems, com.google.api.ads.admanager.axis.v201902.ForecastBreakdownOptions breakdown) Retrieves an AvailabilityForecast.
com.google.api.ads.admanager.axis.v201902.AvailabilityForecast	getAvailabilityForecastById(com.google.api.ads.admanager.lib.client.AdManagerSession session, Long lineItemId, Boolean includeTargetingCriteriaBreakdown, Boolean includeContendingLineItems, com.google.api.ads.admanager.axis.v201902.ForecastBreakdownOptions breakdown) Retrieves the AvailabilityForecast by the specified ID.
com.google.api.ads.admanager.axis.v201902.DeliveryForecast	getDeliveryForecast(com.google.api.ads.admanager.lib.client.AdManagerSession session, List<com.google.api.ads.admanager.axis.v201902.ProspectiveLineItem> prospectiveLineItems, String ignoredLineItems) Retrieves the Delivery Forecast.
com.google.api.ads.admanager.axis.v201902.DeliveryForecast	getDeliveryForecastByIds(com.google.api.ads.admanager.lib.client.AdManagerSession session, String lineItemIds, String ignoredLineItems) Retrieves the DeliveryForecast by the specified IDs.

Methods inherited from class java.lang.Object

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

Constructor Detail

ForecastService

public ForecastService()

Method Detail

createForecastService

protected com.google.api.ads.admanager.axis.v201902.ForecastServiceInterface createForecastService(com.google.api.ads.admanager.lib.client.AdManagerSession session)

getAvailabilityForecast

public com.google.api.ads.admanager.axis.v201902.AvailabilityForecast getAvailabilityForecast(com.google.api.ads.admanager.lib.client.AdManagerSession session,
                                                                                              com.google.api.ads.admanager.axis.v201902.ProspectiveLineItem prospectiveLineItem,
                                                                                              Boolean includeTargetingCriteriaBreakdown,
                                                                                              Boolean includeContendingLineItems,
                                                                                              com.google.api.ads.admanager.axis.v201902.ForecastBreakdownOptions breakdown)
                                                                                       throws AdManagerApiException,
                                                                                              AdManagerCommunicationException

Retrieves an AvailabilityForecast.

Parameters:

session - the API session

prospectiveLineItem - the prospectiveLineItem

includeTargetingCriteriaBreakdown - whether to include the targeting

includeContendingLineItems - whether to include the contending line items

breakdown - the forecast breakdown options

Returns:

AvailabilityForecast the availability forecast

Throws:

AdManagerApiException - if there is a problem with the request made to the API.

AdManagerCommunicationException - if there is a communication problem with the API (such as timeouts etc.)

getAvailabilityForecastById

public com.google.api.ads.admanager.axis.v201902.AvailabilityForecast getAvailabilityForecastById(com.google.api.ads.admanager.lib.client.AdManagerSession session,
                                                                                                  Long lineItemId,
                                                                                                  Boolean includeTargetingCriteriaBreakdown,
                                                                                                  Boolean includeContendingLineItems,
                                                                                                  com.google.api.ads.admanager.axis.v201902.ForecastBreakdownOptions breakdown)
                                                                                           throws AdManagerApiException,
                                                                                                  AdManagerCommunicationException

Retrieves the AvailabilityForecast by the specified ID.

Parameters:

session - the API session

lineItemId - the line item ID

includeTargetingCriteriaBreakdown - whether to include targeting

includeContendingLineItems - whether to include contending line items

breakdown - the forecast breakdown options

Returns:

AvailabilityForecast the availability forecast

Throws:

AdManagerApiException - if there is a problem with the request made to the API.

AdManagerCommunicationException - if there is a communication problem with the API (such as timeouts etc.)

getDeliveryForecast

public com.google.api.ads.admanager.axis.v201902.DeliveryForecast getDeliveryForecast(com.google.api.ads.admanager.lib.client.AdManagerSession session,
                                                                                      List<com.google.api.ads.admanager.axis.v201902.ProspectiveLineItem> prospectiveLineItems,
                                                                                      String ignoredLineItems)
                                                                               throws AdManagerApiException,
                                                                                      AdManagerCommunicationException

Retrieves the Delivery Forecast.

Parameters:

session - the API session

prospectiveLineItems - a list of ProspectiveLineItems

ignoredLineItems - list of ignored comma separated line item IDs

Returns:

DeliveryForecast the delivery forecast

Throws:

AdManagerApiException - if there is a problem with the request made to the API.

AdManagerCommunicationException - if there is a communication problem with the API (such as timeouts etc.)

getDeliveryForecastByIds

public com.google.api.ads.admanager.axis.v201902.DeliveryForecast getDeliveryForecastByIds(com.google.api.ads.admanager.lib.client.AdManagerSession session,
                                                                                           String lineItemIds,
                                                                                           String ignoredLineItems)
                                                                                    throws AdManagerApiException,
                                                                                           AdManagerCommunicationException,
                                                                                           AdManagerUserException

Retrieves the DeliveryForecast by the specified IDs.

Parameters:

session - the API session

lineItemIds - list of comma separated line item IDs

ignoredLineItems - list of ignored comma separated line item IDs

Returns:

DeliveryForecast the delivery forecast

Throws:

AdManagerApiException - if there is a problem with the request made to the API.

AdManagerCommunicationException - if there is a communication problem with the API (such as timeouts etc.)

AdManagerUserException - if there is a user error when using the operation.