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

Interface InventoryServiceInterface

All Superinterfaces:

Remote

All Known Implementing Classes:

InventoryServiceSoapBindingStub

public interface InventoryServiceInterface
extends Remote

Method Summary

Methods

Modifier and Type	Method and Description
AdUnit	createAdUnit(AdUnit adUnit) Creates a new AdUnit.
AdUnit[]	createAdUnits(AdUnit[] adUnits) Creates new AdUnit objects.
AdUnit	getAdUnit(String adUnitId) Returns the AdUnit uniquely identified by the given ID.
AdUnitPage	getAdUnitsByStatement(Statement filterStatement) Gets a AdUnitPage of AdUnit objects that satisfy the given Statement.query.
AdUnitSize[]	getAdUnitSizesByStatement(Statement filterStatement) Gets a set of AdUnitSize objects that satisfy the given Statement.query.
UpdateResult	performAdUnitAction(AdUnitAction adUnitAction, Statement filterStatement) Performs actions on AdUnit objects that match the given Statement.query.
AdUnit	updateAdUnit(AdUnit adUnit) Updates the specified AdUnit.
AdUnit[]	updateAdUnits(AdUnit[] adUnits) Updates the specified AdUnit objects.

Method Detail

createAdUnit

AdUnit createAdUnit(AdUnit adUnit)
                    throws RemoteException,
                           ApiException

Creates a new AdUnit. The following fields are required:

• AdUnit.name
• AdUnit.parentId

Parameters:

adUnit - the ad unit to create

Returns:

the new ad unit with its ID set

Throws:

RemoteException

ApiException

createAdUnits

AdUnit[] createAdUnits(AdUnit[] adUnits)
                       throws RemoteException,
                              ApiException

Creates new AdUnit objects.

Parameters:

adUnits - the ad units to create

Returns:

the created ad units, with their IDs filled in

Throws:

RemoteException

ApiException

getAdUnit

AdUnit getAdUnit(String adUnitId)
                 throws RemoteException,
                        ApiException

Returns the AdUnit uniquely identified by the given ID.

Parameters:

adUnitId - ID of the ad unit, which must already exist

Returns:

the AdUnit uniquely identified by the given ID

Throws:

RemoteException

ApiException

getAdUnitSizesByStatement

AdUnitSize[] getAdUnitSizesByStatement(Statement filterStatement)
                                       throws RemoteException,
                                              ApiException

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

PQL Property	Object Property
targetPlatform	TargetPlatform

An exception will be thrown for queries with unsupported fields. Paging is not supported, as aren't the LIMIT and OFFSET PQL keywords. Only "=" operator is supported.

Parameters:

filterStatement - a Publisher Query Language statement used to filter a set of ad unit sizes

Returns:

the ad unit sizes that match the given filter

Throws:

RemoteException

ApiException

getAdUnitsByStatement

AdUnitPage getAdUnitsByStatement(Statement filterStatement)
                                 throws RemoteException,
                                        ApiException

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

PQL Property	Object Property
adUnitCode	AdUnit.adUnitCode
id	AdUnit.id
name	AdUnit.name
parentId	AdUnit.parentId
status	AdUnit.status
lastModifiedDateTime	AdUnit.lastModifiedDateTime

Parameters:

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

Returns:

the ad units that match the given filter

Throws:

RemoteException

ApiException

performAdUnitAction

UpdateResult performAdUnitAction(AdUnitAction adUnitAction,
                               Statement filterStatement)
                                 throws RemoteException,
                                        ApiException

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

Parameters:

adUnitAction - the action to perform

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

Returns:

the result of the action performed

Throws:

RemoteException

ApiException

updateAdUnit

AdUnit updateAdUnit(AdUnit adUnit)
                    throws RemoteException,
                           ApiException

Updates the specified AdUnit.

Parameters:

adUnit - the ad unit to update

Returns:

the updated ad unit

Throws:

RemoteException

ApiException

updateAdUnits

AdUnit[] updateAdUnits(AdUnit[] adUnits)
                       throws RemoteException,
                              ApiException

Updates the specified AdUnit objects.

Parameters:

adUnits - the ad units to update

Returns:

the updated ad units

Throws:

RemoteException

ApiException