com.google.api.ads.dfp.jaxws.v201511.InventoryServiceInterface Maven / Gradle / Ivy
Show all versions of dfp-appengine Show documentation
package com.google.api.ads.dfp.jaxws.v201511;
import java.util.List;
import javax.jws.WebMethod;
import javax.jws.WebParam;
import javax.jws.WebResult;
import javax.jws.WebService;
import javax.xml.bind.annotation.XmlSeeAlso;
import javax.xml.ws.RequestWrapper;
import javax.xml.ws.ResponseWrapper;
/**
*
* Provides operations for creating, updating and retrieving {@link 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
*
*/
@WebService(name = "InventoryServiceInterface", targetNamespace = "https://www.google.com/apis/ads/publisher/v201511")
@XmlSeeAlso({
ObjectFactory.class
})
public interface InventoryServiceInterface {
/**
*
* Creates new {@link AdUnit} objects.
*
* @param adUnits the ad units to create
* @return the created ad units, with their IDs filled in
*
*
* @param adUnits
* @return
* returns java.util.List
* @throws ApiException_Exception
*/
@WebMethod
@WebResult(name = "rval", targetNamespace = "https://www.google.com/apis/ads/publisher/v201511")
@RequestWrapper(localName = "createAdUnits", targetNamespace = "https://www.google.com/apis/ads/publisher/v201511", className = "com.google.api.ads.dfp.jaxws.v201511.CreateAdUnits")
@ResponseWrapper(localName = "createAdUnitsResponse", targetNamespace = "https://www.google.com/apis/ads/publisher/v201511", className = "com.google.api.ads.dfp.jaxws.v201511.CreateAdUnitsResponse")
public List createAdUnits(
@WebParam(name = "adUnits", targetNamespace = "https://www.google.com/apis/ads/publisher/v201511")
List adUnits)
throws ApiException_Exception
;
/**
*
* Gets a set of {@link AdUnitSize} objects that satisfy the given
* {@link Statement#query}. The following fields are supported for filtering:
*
*
*
* PQL Property Object Property
*
*
* {@code targetPlatform}
* {@link 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.
*
* @param filterStatement a Publisher Query Language statement used to filter
* a set of ad unit sizes
* @return the ad unit sizes that match the given filter
*
*
* @param filterStatement
* @return
* returns java.util.List
* @throws ApiException_Exception
*/
@WebMethod
@WebResult(name = "rval", targetNamespace = "https://www.google.com/apis/ads/publisher/v201511")
@RequestWrapper(localName = "getAdUnitSizesByStatement", targetNamespace = "https://www.google.com/apis/ads/publisher/v201511", className = "com.google.api.ads.dfp.jaxws.v201511.GetAdUnitSizesByStatement")
@ResponseWrapper(localName = "getAdUnitSizesByStatementResponse", targetNamespace = "https://www.google.com/apis/ads/publisher/v201511", className = "com.google.api.ads.dfp.jaxws.v201511.GetAdUnitSizesByStatementResponse")
public List getAdUnitSizesByStatement(
@WebParam(name = "filterStatement", targetNamespace = "https://www.google.com/apis/ads/publisher/v201511")
Statement filterStatement)
throws ApiException_Exception
;
/**
*
* Gets a {@link AdUnitPage} of {@link AdUnit} objects that satisfy the given
* {@link Statement#query}. The following fields are supported for filtering:
*
*
*
* PQL Property Object Property
*
*
* {@code adUnitCode}
* {@link AdUnit#adUnitCode}
*
*
* {@code id}
* {@link AdUnit#id}
*
*
* {@code name}
* {@link AdUnit#name}
*
*
* {@code parentId}
* {@link AdUnit#parentId}
*
*
* {@code status}
* {@link AdUnit#status}
*
*
* {@code lastModifiedDateTime}
* {@link AdUnit#lastModifiedDateTime}
*
*
*
* @param filterStatement a Publisher Query Language statement used to filter
* a set of ad units
* @return the ad units that match the given filter
*
*
* @param filterStatement
* @return
* returns com.google.api.ads.dfp.jaxws.v201511.AdUnitPage
* @throws ApiException_Exception
*/
@WebMethod
@WebResult(name = "rval", targetNamespace = "https://www.google.com/apis/ads/publisher/v201511")
@RequestWrapper(localName = "getAdUnitsByStatement", targetNamespace = "https://www.google.com/apis/ads/publisher/v201511", className = "com.google.api.ads.dfp.jaxws.v201511.GetAdUnitsByStatement")
@ResponseWrapper(localName = "getAdUnitsByStatementResponse", targetNamespace = "https://www.google.com/apis/ads/publisher/v201511", className = "com.google.api.ads.dfp.jaxws.v201511.GetAdUnitsByStatementResponse")
public AdUnitPage getAdUnitsByStatement(
@WebParam(name = "filterStatement", targetNamespace = "https://www.google.com/apis/ads/publisher/v201511")
Statement filterStatement)
throws ApiException_Exception
;
/**
*
* Performs actions on {@link AdUnit} objects that match the given
* {@link Statement#query}.
*
* @param adUnitAction the action to perform
* @param filterStatement a Publisher Query Language statement used to filter
* a set of ad units
* @return the result of the action performed
*
*
* @param filterStatement
* @param adUnitAction
* @return
* returns com.google.api.ads.dfp.jaxws.v201511.UpdateResult
* @throws ApiException_Exception
*/
@WebMethod
@WebResult(name = "rval", targetNamespace = "https://www.google.com/apis/ads/publisher/v201511")
@RequestWrapper(localName = "performAdUnitAction", targetNamespace = "https://www.google.com/apis/ads/publisher/v201511", className = "com.google.api.ads.dfp.jaxws.v201511.PerformAdUnitAction")
@ResponseWrapper(localName = "performAdUnitActionResponse", targetNamespace = "https://www.google.com/apis/ads/publisher/v201511", className = "com.google.api.ads.dfp.jaxws.v201511.PerformAdUnitActionResponse")
public UpdateResult performAdUnitAction(
@WebParam(name = "adUnitAction", targetNamespace = "https://www.google.com/apis/ads/publisher/v201511")
AdUnitAction adUnitAction,
@WebParam(name = "filterStatement", targetNamespace = "https://www.google.com/apis/ads/publisher/v201511")
Statement filterStatement)
throws ApiException_Exception
;
/**
*
* Updates the specified {@link AdUnit} objects.
*
* @param adUnits the ad units to update
* @return the updated ad units
*
*
* @param adUnits
* @return
* returns java.util.List
* @throws ApiException_Exception
*/
@WebMethod
@WebResult(name = "rval", targetNamespace = "https://www.google.com/apis/ads/publisher/v201511")
@RequestWrapper(localName = "updateAdUnits", targetNamespace = "https://www.google.com/apis/ads/publisher/v201511", className = "com.google.api.ads.dfp.jaxws.v201511.UpdateAdUnits")
@ResponseWrapper(localName = "updateAdUnitsResponse", targetNamespace = "https://www.google.com/apis/ads/publisher/v201511", className = "com.google.api.ads.dfp.jaxws.v201511.UpdateAdUnitsResponse")
public List updateAdUnits(
@WebParam(name = "adUnits", targetNamespace = "https://www.google.com/apis/ads/publisher/v201511")
List adUnits)
throws ApiException_Exception
;
}