com.google.api.ads.dfp.axis.v201208
Interface SuggestedAdUnitServiceInterface

All Superinterfaces:

Remote

All Known Implementing Classes:

SuggestedAdUnitServiceSoapBindingStub

public interface SuggestedAdUnitServiceInterface
extends Remote

Method Summary

SuggestedAdUnit	getSuggestedAdUnit(String suggestedAdUnitId) Returns the SuggestedAdUnit uniquely identified by the given ID.
SuggestedAdUnitPage	getSuggestedAdUnitsByStatement(Statement filterStatement) Gets a SuggestedAdUnitPage of SuggestedAdUnit objects that satisfy the filter query.
SuggestedAdUnitUpdateResult	performSuggestedAdUnitAction(SuggestedAdUnitAction suggestedAdUnitAction, Statement filterStatement) Performs actions on SuggestedAdUnit objects that match the given Statement.query.

Method Detail

getSuggestedAdUnit

SuggestedAdUnit getSuggestedAdUnit(String suggestedAdUnitId)
                                   throws RemoteException,
                                          ApiException

Returns the SuggestedAdUnit uniquely identified by the given ID.

Parameters:

suggestedAdUnitId - the ID of the SuggestedAdUnit, which must already exist.

Throws:

RemoteException

ApiException

getSuggestedAdUnitsByStatement

SuggestedAdUnitPage getSuggestedAdUnitsByStatement(Statement filterStatement)
                                                   throws RemoteException,
                                                          ApiException

Gets a SuggestedAdUnitPage of SuggestedAdUnit objects that satisfy the filter query. There is a system-enforced limit of 1000 on the number of suggested ad units that are suggested at any one time.

PQL Property	Object Property
id	SuggestedAdUnit.id
numRequests	SuggestedAdUnit.numRequests

Parameters:

filterStatement - a Publisher Query Language statement used to filter a set of suggested ad units

Returns:

the suggested ad units that match the given filter

Throws:

RemoteException

ApiException

performSuggestedAdUnitAction

SuggestedAdUnitUpdateResult performSuggestedAdUnitAction(SuggestedAdUnitAction suggestedAdUnitAction,
                                                         Statement filterStatement)
                                                         throws RemoteException,
                                                                ApiException

Performs actions on SuggestedAdUnit objects that match the given Statement.query. The following fields are supported for filtering:

PQL Property	Object Property
id	SuggestedAdUnit.id
numRequests	SuggestedAdUnit.numRequests

Parameters:

suggestedAdUnitAction - the action to perform

filterStatement - a Publisher Query Language statement used to filter a set of suggested ad units

Returns:

the result of the action performed

Throws:

RemoteException

ApiException