com.google.api.ads.admanager.axis.v201808

Interface PlacementServiceInterface

All Superinterfaces:

Remote

All Known Implementing Classes:

PlacementServiceSoapBindingStub

public interface PlacementServiceInterface
extends Remote

Method Summary

Modifier and Type	Method and Description
Placement[]	createPlacements(Placement[] placements) Creates new Placement objects.
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[]	updatePlacements(Placement[] placements) Updates the specified Placement objects.

Method Detail

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

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
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

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