com.google.api.ads.dfp.jaxws.v201802

Interface PlacementServiceInterface

public interface PlacementServiceInterface

Provides methods for creating, updating and retrieving Placement objects.

You can use a placement to group ad units. For example, you might have a placement that focuses on sports sites, which may be spread across different branches of your inventory. You might also have a "fire sale" placement that includes ad units that have not been selling and are consequently priced very attractively. This class was generated by the JAX-WS RI. JAX-WS RI 2.2.9-b130926.1035 Generated source version: 2.1

Method Summary

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

Method Detail

createPlacements

@RequestWrapper(localName="createPlacements",
                targetNamespace="https://www.google.com/apis/ads/publisher/v201802",
                className="com.google.api.ads.dfp.jaxws.v201802.PlacementServiceInterfacecreatePlacements")
 @ResponseWrapper(localName="createPlacementsResponse",
                 targetNamespace="https://www.google.com/apis/ads/publisher/v201802",
                 className="com.google.api.ads.dfp.jaxws.v201802.PlacementServiceInterfacecreatePlacementsResponse")
List<Placement> createPlacements(List<Placement> placements)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            throws ApiException_Exception

Creates new Placement objects.

Parameters:

placements - the placements to create

placements -

Returns:

the new placements, with their IDs filled in

Throws:

ApiException_Exception

getPlacementsByStatement

@RequestWrapper(localName="getPlacementsByStatement",
                targetNamespace="https://www.google.com/apis/ads/publisher/v201802",
                className="com.google.api.ads.dfp.jaxws.v201802.PlacementServiceInterfacegetPlacementsByStatement")
 @ResponseWrapper(localName="getPlacementsByStatementResponse",
                 targetNamespace="https://www.google.com/apis/ads/publisher/v201802",
                 className="com.google.api.ads.dfp.jaxws.v201802.PlacementServiceInterfacegetPlacementsByStatementResponse")
PlacementPage getPlacementsByStatement(Statement filterStatement)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  throws ApiException_Exception

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

filterStatement -

Returns:

the placements that match the given filter

Throws:

ApiException_Exception

performPlacementAction

@RequestWrapper(localName="performPlacementAction",
                targetNamespace="https://www.google.com/apis/ads/publisher/v201802",
                className="com.google.api.ads.dfp.jaxws.v201802.PlacementServiceInterfaceperformPlacementAction")
 @ResponseWrapper(localName="performPlacementActionResponse",
                 targetNamespace="https://www.google.com/apis/ads/publisher/v201802",
                 className="com.google.api.ads.dfp.jaxws.v201802.PlacementServiceInterfaceperformPlacementActionResponse")
UpdateResult performPlacementAction(PlacementAction placementAction,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Statement filterStatement)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       throws ApiException_Exception

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

placementAction -

filterStatement -

Returns:

the result of the action performed

Throws:

ApiException_Exception

updatePlacements

@RequestWrapper(localName="updatePlacements",
                targetNamespace="https://www.google.com/apis/ads/publisher/v201802",
                className="com.google.api.ads.dfp.jaxws.v201802.PlacementServiceInterfaceupdatePlacements")
 @ResponseWrapper(localName="updatePlacementsResponse",
                 targetNamespace="https://www.google.com/apis/ads/publisher/v201802",
                 className="com.google.api.ads.dfp.jaxws.v201802.PlacementServiceInterfaceupdatePlacementsResponse")
List<Placement> updatePlacements(List<Placement> placements)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            throws ApiException_Exception

Updates the specified Placement objects.

Parameters:

placements - the placements to update

placements -

Returns:

the updated placements

Throws:

ApiException_Exception