com.google.api.ads.dfp.axis.v201306

Interface PlacementServiceInterface

All Superinterfaces:

Remote

All Known Implementing Classes:

PlacementServiceSoapBindingStub

public interface PlacementServiceInterface
extends Remote

Method Summary

Methods

Modifier and Type	Method and Description
Placement	createPlacement(Placement placement) Creates a new Placement.
Placement[]	createPlacements(Placement[] placements) Creates new Placement objects.
Placement	getPlacement(Long placementId) Returns the Placement uniquely identified by the given ID.
PlacementPage	getPlacementsByStatement(Statement filterStatement) Gets a PlacementPage of Placement objects that satisfy the given Statement.query.
UpdateResult	performPlacementAction(PlacementAction placementAction, Statement filterStatement) Performs actions on Placement objects that match the given Statement.query.
Placement	updatePlacement(Placement placement) Updates the specified Placement.
Placement[]	updatePlacements(Placement[] placements) Updates the specified Placement objects.

Method Detail

createPlacement

Placement createPlacement(Placement placement)
                          throws RemoteException,
                                 ApiException

Creates a new Placement. The following fields are required:

• Placement.name
• Placement.description

Parameters:

placement - the placement to create

Returns:

the new placement with its ID set

Throws:

RemoteException

ApiException

createPlacements

Placement[] createPlacements(Placement[] placements)
                             throws RemoteException,
                                    ApiException

Creates new Placement objects.

Parameters:

placements - the placements to create

Returns:

the new placements, with their IDs filled in

Throws:

RemoteException

ApiException

getPlacement

Placement getPlacement(Long placementId)
                       throws RemoteException,
                              ApiException

Returns the Placement uniquely identified by the given ID.

Parameters:

placementId - ID of the placement, which must already exist

Returns:

the Placement uniquely identified by the given ID

Throws:

RemoteException

ApiException

getPlacementsByStatement

PlacementPage getPlacementsByStatement(Statement filterStatement)
                                       throws RemoteException,
                                              ApiException

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

PQL Property	Object Property
description	Placement.description
id	Placement.id
isAdSenseTargetingEnabled	Placement.isAdSenseTargetingEnabled
name	Placement.name
placementCode	Placement.placementCode
status	Placement.status
lastModifiedDateTime	Placement.lastModifiedDateTime

Parameters:

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

Returns:

the placements that match the given filter

Throws:

RemoteException

ApiException

performPlacementAction

UpdateResult performPlacementAction(PlacementAction placementAction,
                                  Statement filterStatement)
                                    throws RemoteException,
                                           ApiException

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

Parameters:

placementAction - the action to perform

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

Returns:

the result of the action performed

Throws:

RemoteException

ApiException

updatePlacement

Placement updatePlacement(Placement placement)
                          throws RemoteException,
                                 ApiException

Updates the specified Placement.

Parameters:

placement - the placement to update

Returns:

the updated placement

Throws:

RemoteException

ApiException

updatePlacements

Placement[] updatePlacements(Placement[] placements)
                             throws RemoteException,
                                    ApiException

Updates the specified Placement objects.

Parameters:

placements - the placements to update

Returns:

the updated placements

Throws:

RemoteException

ApiException