com.google.api.ads.dfp.axis.v201203
Class InventoryServiceSoapBindingStub

java.lang.Object
  org.apache.axis.client.Stub
      com.google.api.ads.dfp.axis.v201203.InventoryServiceSoapBindingStub

All Implemented Interfaces:

InventoryServiceInterface, Remote, javax.xml.rpc.Stub

public class InventoryServiceSoapBindingStub
extends org.apache.axis.client.Stub
implements InventoryServiceInterface

Field Summary

Fields inherited from class org.apache.axis.client.Stub

_call, cachedEndpoint, cachedPassword, cachedPortName, cachedProperties, cachedTimeout, cachedUsername, maintainSession, maintainSessionSet, service

Fields inherited from interface javax.xml.rpc.Stub

ENDPOINT_ADDRESS_PROPERTY, PASSWORD_PROPERTY, SESSION_MAINTAIN_PROPERTY, USERNAME_PROPERTY

Constructor Summary

InventoryServiceSoapBindingStub()

InventoryServiceSoapBindingStub(javax.xml.rpc.Service service)

InventoryServiceSoapBindingStub(URL endpointURL, javax.xml.rpc.Service service)

Method Summary

AdUnit	createAdUnit(AdUnit adUnit) Creates a new AdUnit.
AdUnit[]	createAdUnits(AdUnit[] adUnits) Creates new AdUnit objects.
protected org.apache.axis.client.Call	createCall()
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[]	getAdUnitSizes() Retrieves the sorted set of sizes across all ad units.
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.

Methods inherited from class org.apache.axis.client.Stub

_createCall, _getCall, _getProperty, _getPropertyNames, _getService, _setProperty, addAttachment, clearAttachments, clearHeaders, extractAttachments, firstCall, getAttachments, getHeader, getHeaders, getPassword, getPortName, getResponseHeader, getResponseHeaders, getResponseHeaders, getTimeout, getUsername, removeProperty, setAttachments, setHeader, setHeader, setMaintainSession, setPassword, setPortName, setPortName, setRequestHeaders, setTimeout, setUsername

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

InventoryServiceSoapBindingStub

public InventoryServiceSoapBindingStub()
                                throws org.apache.axis.AxisFault

Throws:

org.apache.axis.AxisFault

InventoryServiceSoapBindingStub

public InventoryServiceSoapBindingStub(URL endpointURL,
                                       javax.xml.rpc.Service service)
                                throws org.apache.axis.AxisFault

Throws:

org.apache.axis.AxisFault

InventoryServiceSoapBindingStub

public InventoryServiceSoapBindingStub(javax.xml.rpc.Service service)
                                throws org.apache.axis.AxisFault

Throws:

org.apache.axis.AxisFault

Method Detail

createCall

protected org.apache.axis.client.Call createCall()
                                          throws RemoteException

Throws:

RemoteException

createAdUnit

public AdUnit createAdUnit(AdUnit adUnit)
                    throws RemoteException,
                           ApiException

Description copied from interface: InventoryServiceInterface

Creates a new AdUnit. The following fields are required:

• AdUnit.name
• AdUnit.parentId

Specified by:

createAdUnit in interface InventoryServiceInterface

Parameters:

adUnit - the ad unit to create

Returns:

the new ad unit with its ID set

Throws:

RemoteException

ApiException

createAdUnits

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

Description copied from interface: InventoryServiceInterface

Creates new AdUnit objects.

Specified by:

createAdUnits in interface InventoryServiceInterface

Parameters:

adUnits - the ad units to create

Returns:

the created ad units, with their IDs filled in

Throws:

RemoteException

ApiException

getAdUnit

public AdUnit getAdUnit(String adUnitId)
                 throws RemoteException,
                        ApiException

Description copied from interface: InventoryServiceInterface

Returns the AdUnit uniquely identified by the given ID.

Specified by:

getAdUnit in interface InventoryServiceInterface

Parameters:

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

Returns:

the AdUnit uniquely identified by the given ID

Throws:

RemoteException

ApiException

getAdUnitSizes

public AdUnitSize[] getAdUnitSizes()
                            throws RemoteException,
                                   ApiException

Description copied from interface: InventoryServiceInterface

Retrieves the sorted set of sizes across all ad units. Deprecated: use getAdUnitSizesByStatement with an empty Statement instead.

Specified by:

getAdUnitSizes in interface InventoryServiceInterface

Returns:

a set of sizes

Throws:

RemoteException

ApiException

getAdUnitSizesByStatement

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

Description copied from interface: InventoryServiceInterface

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.

Specified by:

getAdUnitSizesByStatement in interface InventoryServiceInterface

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

public AdUnitPage getAdUnitsByStatement(Statement filterStatement)
                                 throws RemoteException,
                                        ApiException

Description copied from interface: InventoryServiceInterface

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

Specified by:

getAdUnitsByStatement in interface InventoryServiceInterface

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

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

Description copied from interface: InventoryServiceInterface

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

Specified by:

performAdUnitAction in interface InventoryServiceInterface

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

public AdUnit updateAdUnit(AdUnit adUnit)
                    throws RemoteException,
                           ApiException

Description copied from interface: InventoryServiceInterface

Updates the specified AdUnit.

Specified by:

updateAdUnit in interface InventoryServiceInterface

Parameters:

adUnit - the ad unit to update

Returns:

the updated ad unit

Throws:

RemoteException

ApiException

updateAdUnits

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

Description copied from interface: InventoryServiceInterface

Updates the specified AdUnit objects.

Specified by:

updateAdUnits in interface InventoryServiceInterface

Parameters:

adUnits - the ad units to update

Returns:

the updated ad units

Throws:

RemoteException

ApiException