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

Interface InventoryServiceInterface

public interface InventoryServiceInterface

Provides operations for creating, updating and retrieving AdUnit objects.

Line items connect a creative with its associated ad unit through targeting.

An ad unit represents a piece of inventory within a publisher. It contains all the settings that need to be associated with the inventory in order to serve ads. For example, the ad unit contains creative size restrictions and AdSense settings. 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<AdUnit>	createAdUnits(List<AdUnit> adUnits) Creates new AdUnit objects.
AdUnitPage	getAdUnitsByStatement(Statement filterStatement) Gets a AdUnitPage of AdUnit objects that satisfy the given Statement.query.
List<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.
List<AdUnit>	updateAdUnits(List<AdUnit> adUnits) Updates the specified AdUnit objects.

Method Detail

createAdUnits

@RequestWrapper(localName="createAdUnits",
                targetNamespace="https://www.google.com/apis/ads/publisher/v201802",
                className="com.google.api.ads.dfp.jaxws.v201802.CreateAdUnits")
 @ResponseWrapper(localName="createAdUnitsResponse",
                 targetNamespace="https://www.google.com/apis/ads/publisher/v201802",
                 className="com.google.api.ads.dfp.jaxws.v201802.CreateAdUnitsResponse")
List<AdUnit> createAdUnits(List<AdUnit> adUnits)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        throws ApiException_Exception

Creates new AdUnit objects.

Parameters:

adUnits - the ad units to create

adUnits -

Returns:

the created ad units, with their IDs filled in

Throws:

ApiException_Exception

getAdUnitSizesByStatement

@RequestWrapper(localName="getAdUnitSizesByStatement",
                targetNamespace="https://www.google.com/apis/ads/publisher/v201802",
                className="com.google.api.ads.dfp.jaxws.v201802.GetAdUnitSizesByStatement")
 @ResponseWrapper(localName="getAdUnitSizesByStatementResponse",
                 targetNamespace="https://www.google.com/apis/ads/publisher/v201802",
                 className="com.google.api.ads.dfp.jaxws.v201802.GetAdUnitSizesByStatementResponse")
List<AdUnitSize> getAdUnitSizesByStatement(Statement filterStatement)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        throws ApiException_Exception

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

filterStatement -

Returns:

the ad unit sizes that match the given filter

Throws:

ApiException_Exception

getAdUnitsByStatement

@RequestWrapper(localName="getAdUnitsByStatement",
                targetNamespace="https://www.google.com/apis/ads/publisher/v201802",
                className="com.google.api.ads.dfp.jaxws.v201802.GetAdUnitsByStatement")
 @ResponseWrapper(localName="getAdUnitsByStatementResponse",
                 targetNamespace="https://www.google.com/apis/ads/publisher/v201802",
                 className="com.google.api.ads.dfp.jaxws.v201802.GetAdUnitsByStatementResponse")
AdUnitPage getAdUnitsByStatement(Statement filterStatement)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              throws ApiException_Exception

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

filterStatement -

Returns:

the ad units that match the given filter

Throws:

ApiException_Exception

performAdUnitAction

@RequestWrapper(localName="performAdUnitAction",
                targetNamespace="https://www.google.com/apis/ads/publisher/v201802",
                className="com.google.api.ads.dfp.jaxws.v201802.PerformAdUnitAction")
 @ResponseWrapper(localName="performAdUnitActionResponse",
                 targetNamespace="https://www.google.com/apis/ads/publisher/v201802",
                 className="com.google.api.ads.dfp.jaxws.v201802.PerformAdUnitActionResponse")
UpdateResult performAdUnitAction(AdUnitAction adUnitAction,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             Statement filterStatement)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      throws ApiException_Exception

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

filterStatement -

adUnitAction -

Returns:

the result of the action performed

Throws:

ApiException_Exception

updateAdUnits

@RequestWrapper(localName="updateAdUnits",
                targetNamespace="https://www.google.com/apis/ads/publisher/v201802",
                className="com.google.api.ads.dfp.jaxws.v201802.UpdateAdUnits")
 @ResponseWrapper(localName="updateAdUnitsResponse",
                 targetNamespace="https://www.google.com/apis/ads/publisher/v201802",
                 className="com.google.api.ads.dfp.jaxws.v201802.UpdateAdUnitsResponse")
List<AdUnit> updateAdUnits(List<AdUnit> adUnits)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        throws ApiException_Exception

Updates the specified AdUnit objects.

Parameters:

adUnits - the ad units to update

adUnits -

Returns:

the updated ad units

Throws:

ApiException_Exception