com.google.api.ads.admanager.axis.v202005

Interface AdjustmentServiceInterface

All Superinterfaces:

Remote

All Known Implementing Classes:

AdjustmentServiceSoapBindingStub

public interface AdjustmentServiceInterface
extends Remote

Method Summary

Modifier and Type	Method and Description
ForecastAdjustment[]	createForecastAdjustments(ForecastAdjustment[] forecastAdjustments) Creates new ForecastAdjustment objects.
TrafficForecastSegment[]	createTrafficForecastSegments(TrafficForecastSegment[] trafficForecastSegments) Creates new TrafficForecastSegment objects.
ForecastAdjustmentPage	getForecastAdjustmentsByStatement(Statement filterStatement) Gets a ForecastAdjustmentPage of ForecastAdjustment objects that satisfy the given Statement.query.
TrafficForecastSegmentPage	getTrafficForecastSegmentsByStatement(Statement filterStatement) Gets a TrafficForecastSegmentPage of TrafficForecastSegment objects that satisfy the given Statement.query.
UpdateResult	performForecastAdjustmentAction(ForecastAdjustmentAction forecastAdjustmentAction, Statement filterStatement) Performs actions on ForecastAdjustment objects that match the given Statement.query.
ForecastAdjustment[]	updateForecastAdjustments(ForecastAdjustment[] forecastAdjustments) Updates the specified ForecastAdjustment objects.
TrafficForecastSegment[]	updateTrafficForecastSegments(TrafficForecastSegment[] trafficForecastSegments) Updates the specified TrafficForecastSegment objects.

Method Detail

createForecastAdjustments

ForecastAdjustment[] createForecastAdjustments(ForecastAdjustment[] forecastAdjustments)
                                        throws RemoteException,
                                               ApiException

Creates new ForecastAdjustment objects.

This method requires that use of traffic forecast segments and forecast adjustments is enabled for this network, and will throw an exception if it is not enabled.

Parameters:

forecastAdjustments - the forecast adjustments to create

Returns:

the created forecast adjustments with their IDs filled in

Throws:

ApiException - if there is an error creating the forecast adjustments

RemoteException

createTrafficForecastSegments

TrafficForecastSegment[] createTrafficForecastSegments(TrafficForecastSegment[] trafficForecastSegments)
                                                throws RemoteException,
                                                       ApiException

Creates new TrafficForecastSegment objects.

This method requires that use of traffic forecast segments and forecast adjustments is enabled for this network, and will throw an exception if it is not enabled.

Parameters:

trafficForecastSegments - the traffic forecast segments to create

Returns:

the created traffic forecast segments with their IDs filled in

Throws:

ApiException - if there is an error creating the traffic forecast segments

RemoteException

getForecastAdjustmentsByStatement

ForecastAdjustmentPage getForecastAdjustmentsByStatement(Statement filterStatement)
                                                  throws RemoteException,
                                                         ApiException

Gets a ForecastAdjustmentPage of ForecastAdjustment objects that satisfy the given Statement.query.

This method requires that use of traffic forecast segments and forecast adjustments is enabled for this network, and will throw an exception if it is not enabled.

The following fields are supported for filtering:

PQL Property	Object Property
id	ForecastAdjustment.id
trafficForecastSegmentId	ForecastAdjustment.trafficForecastSegmentId
name	ForecastAdjustment.name
startDate	ForecastAdjustment#startDate
endDate	ForecastAdjustment#endDate
status	ForecastAdjustment.status

Parameters:

filterStatement - a Publisher Query Language statement to filter a list of traffic forecast segments

Returns:

the forecast adjustments that match the filter

Throws:

RemoteException

ApiException

getTrafficForecastSegmentsByStatement

TrafficForecastSegmentPage getTrafficForecastSegmentsByStatement(Statement filterStatement)
                                                          throws RemoteException,
                                                                 ApiException

Gets a TrafficForecastSegmentPage of TrafficForecastSegment objects that satisfy the given Statement.query.

This method requires that use of traffic forecast segments and forecast adjustments is enabled for this network, and will throw an exception if it is not enabled.

The following fields are supported for filtering:

PQL Property	Object Property
id	TrafficForecastSegment.id
name	TrafficForecastSegment.name
creationTime	TrafficForecastSegment#creationTime

Parameters:

filterStatement - a Publisher Query Language statement to filter a list of traffic forecast segments

Returns:

the traffic forecast segments that match the filter

Throws:

RemoteException

ApiException

performForecastAdjustmentAction

UpdateResult performForecastAdjustmentAction(ForecastAdjustmentAction forecastAdjustmentAction,
                                             Statement filterStatement)
                                      throws RemoteException,
                                             ApiException

Performs actions on ForecastAdjustment objects that match the given Statement.query.

This method requires that use of traffic forecast segments and forecast adjustments is enabled for this network, and will throw an exception if it is not enabled.

Parameters:

forecastAdjustmentAction - the action to perform

filterStatement - a Publisher Query Language statement used to filter a set of forecast adjustments

Returns:

the result of the action performed

Throws:

RemoteException

ApiException

updateForecastAdjustments

ForecastAdjustment[] updateForecastAdjustments(ForecastAdjustment[] forecastAdjustments)
                                        throws RemoteException,
                                               ApiException

Updates the specified ForecastAdjustment objects.

This method requires that use of traffic forecast segments and forecast adjustments is enabled for this network, and will throw an exception if it is not enabled.

Parameters:

forecastAdjustments - the forecast adjustments to update

Returns:

the updated forecast adjustments

Throws:

ApiException - if there is an error updating the forecast adjustments

RemoteException

updateTrafficForecastSegments

TrafficForecastSegment[] updateTrafficForecastSegments(TrafficForecastSegment[] trafficForecastSegments)
                                                throws RemoteException,
                                                       ApiException

Updates the specified TrafficForecastSegment objects.

This method requires that use of traffic forecast segments and forecast adjustments is enabled for this network, and will throw an exception if it is not enabled.

Parameters:

trafficForecastSegments - the traffic forecast segments to update

Returns:

the updated traffic forecast segments

Throws:

ApiException - if there is an error updating the traffic forecast segments

RemoteException