com.google.api.ads.dfp.jaxws.v201602.PackageServiceInterface Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of dfp-appengine Show documentation
DFP specific AppEngine components.
There is a newer version: 5.8.0

package com.google.api.ads.dfp.jaxws.v201602;

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 methods for creating, updating and retrieving {@link Package} objects.
 *       
 *       To use this service, you need to have the new sales management solution
 *       enabled on your network. If you do not see a "Sales" tab in
 *       DoubleClick for Publishers (DFP),
 *       you will not be able to use this service.
 *       
 *     
 * 
 * This class was generated by the JAX-WS RI.
 * JAX-WS RI 2.2.9-b130926.1035
 * Generated source version: 2.1
 * 
 */
@WebService(name = "PackageServiceInterface", targetNamespace = "https://www.google.com/apis/ads/publisher/v201602")
@XmlSeeAlso({
    ObjectFactory.class
})
public interface PackageServiceInterface {


    /**
     * 
     *         Creates new {@link Package} objects.
     *         
     *         For each package, the following fields are required:
     *         
     *         {@link Package#proposalId}
     *         {@link Package#productPackageId}
     *         {@link Package#name}
     *         
     *         
     *         @param packages the packages to create
     *         @return the created packages with their IDs filled in
     *       
     * 
     * @param packages
     * @return
     *     returns java.util.List
     * @throws ApiException_Exception
     */
    @WebMethod
    @WebResult(name = "rval", targetNamespace = "https://www.google.com/apis/ads/publisher/v201602")
    @RequestWrapper(localName = "createPackages", targetNamespace = "https://www.google.com/apis/ads/publisher/v201602", className = "com.google.api.ads.dfp.jaxws.v201602.PackageServiceInterfacecreatePackages")
    @ResponseWrapper(localName = "createPackagesResponse", targetNamespace = "https://www.google.com/apis/ads/publisher/v201602", className = "com.google.api.ads.dfp.jaxws.v201602.PackageServiceInterfacecreatePackagesResponse")
    public List createPackages(
        @WebParam(name = "packages", targetNamespace = "https://www.google.com/apis/ads/publisher/v201602")
        List packages)
        throws ApiException_Exception
    ;

    /**
     * 
     *         Gets a {@link PackagePage} of {@link Package} objects
     *         that satisfy the given {@link Statement#query}.  The following fields are supported for
     *         filtering:
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         PQL Property  Object Property
{@code id} {@link Package#id}
{@code name} {@link Package#name}
{@code proposalId} {@link Package#proposalId}
{@code productPackageId} {@link Package#productPackageId}
{@code isArchived} {@link Package#isArchived}
{@code lastModifiedDateTime} {@link Package#lastModifiedDateTime}
     *         
     *         @param filterStatement a Publisher Query Language statement used to filter
     *         a set of packages
     *         @return the packages that match the given filter
     *       
     * 
     * @param filterStatement
     * @return
     *     returns com.google.api.ads.dfp.jaxws.v201602.PackagePage
     * @throws ApiException_Exception
     */
    @WebMethod
    @WebResult(name = "rval", targetNamespace = "https://www.google.com/apis/ads/publisher/v201602")
    @RequestWrapper(localName = "getPackagesByStatement", targetNamespace = "https://www.google.com/apis/ads/publisher/v201602", className = "com.google.api.ads.dfp.jaxws.v201602.PackageServiceInterfacegetPackagesByStatement")
    @ResponseWrapper(localName = "getPackagesByStatementResponse", targetNamespace = "https://www.google.com/apis/ads/publisher/v201602", className = "com.google.api.ads.dfp.jaxws.v201602.PackageServiceInterfacegetPackagesByStatementResponse")
    public PackagePage getPackagesByStatement(
        @WebParam(name = "filterStatement", targetNamespace = "https://www.google.com/apis/ads/publisher/v201602")
        Statement filterStatement)
        throws ApiException_Exception
    ;

    /**
     * 
     *         Performs actions on {@link Package} objects that match the given {@link Statement}.
     *         
     *         @param packageAction the action to perform
     *         @param filterStatement a Publisher Query Language statement used to filter a set of packages
     *         @return the result of the action performed
     *       
     * 
     * @param filterStatement
     * @param packageAction
     * @return
     *     returns com.google.api.ads.dfp.jaxws.v201602.UpdateResult
     * @throws ApiException_Exception
     */
    @WebMethod
    @WebResult(name = "rval", targetNamespace = "https://www.google.com/apis/ads/publisher/v201602")
    @RequestWrapper(localName = "performPackageAction", targetNamespace = "https://www.google.com/apis/ads/publisher/v201602", className = "com.google.api.ads.dfp.jaxws.v201602.PackageServiceInterfaceperformPackageAction")
    @ResponseWrapper(localName = "performPackageActionResponse", targetNamespace = "https://www.google.com/apis/ads/publisher/v201602", className = "com.google.api.ads.dfp.jaxws.v201602.PackageServiceInterfaceperformPackageActionResponse")
    public UpdateResult performPackageAction(
        @WebParam(name = "packageAction", targetNamespace = "https://www.google.com/apis/ads/publisher/v201602")
        PackageAction packageAction,
        @WebParam(name = "filterStatement", targetNamespace = "https://www.google.com/apis/ads/publisher/v201602")
        Statement filterStatement)
        throws ApiException_Exception
    ;

    /**
     * 
     *         Updates the specified {@link Package} objects.
     *         
     *         @param packages the packages to update
     *         @return the updated packages
     *       
     * 
     * @param packages
     * @return
     *     returns java.util.List
     * @throws ApiException_Exception
     */
    @WebMethod
    @WebResult(name = "rval", targetNamespace = "https://www.google.com/apis/ads/publisher/v201602")
    @RequestWrapper(localName = "updatePackages", targetNamespace = "https://www.google.com/apis/ads/publisher/v201602", className = "com.google.api.ads.dfp.jaxws.v201602.PackageServiceInterfaceupdatePackages")
    @ResponseWrapper(localName = "updatePackagesResponse", targetNamespace = "https://www.google.com/apis/ads/publisher/v201602", className = "com.google.api.ads.dfp.jaxws.v201602.PackageServiceInterfaceupdatePackagesResponse")
    public List updatePackages(
        @WebParam(name = "packages", targetNamespace = "https://www.google.com/apis/ads/publisher/v201602")
        List packages)
        throws ApiException_Exception
    ;

}
PQL Property	Object Property
{@code id}	{@link Package#id}
{@code name}	{@link Package#name}
{@code proposalId}	{@link Package#proposalId}
{@code productPackageId}	{@link Package#productPackageId}
{@code isArchived}	{@link Package#isArchived}
{@code lastModifiedDateTime}	{@link Package#lastModifiedDateTime}