com.google.api.ads.dfp.axis.v201411

Interface SharedAdUnitServiceInterface

All Superinterfaces:

Remote

All Known Implementing Classes:

SharedAdUnitServiceSoapBindingStub

public interface SharedAdUnitServiceInterface
extends Remote

Method Summary

Modifier and Type	Method and Description
SharedAdUnitPage	getSharedAdUnitsByStatement(Statement filterStatement) Gets a SharedAdUnitPage of SharedAdUnit objects that satisfy the given Statement.query.
UpdateResult	performSharedAdUnitAction(SharedAdUnitAction sharedAdUnitAction, Statement filterStatement) Performs actions on shared ad unit objects that match the given Statement.query.

Method Detail

getSharedAdUnitsByStatement

SharedAdUnitPage getSharedAdUnitsByStatement(Statement filterStatement)
                                      throws RemoteException,
                                             ApiException

Gets a SharedAdUnitPage of SharedAdUnit objects that satisfy the given Statement.query. The following fields are supported for filtering:

PQL Property	Object Property
id	SharedAdUnit.id
name	SharedAdUnit.name

Parameters:

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

Returns:

the shared ad units that match the given filter

Throws:

RemoteException

ApiException

performSharedAdUnitAction

UpdateResult performSharedAdUnitAction(SharedAdUnitAction sharedAdUnitAction,
                                       Statement filterStatement)
                                throws RemoteException,
                                       ApiException

Performs actions on shared ad unit objects that match the given Statement.query.

Parameters:

sharedAdUnitAction - the action to perform

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

Returns:

the result of the update action, which contains the number of shared ad units on which the action was performed.

Throws:

RemoteException

ApiException