com.google.api.ads.dfp.jaxws.v201605.PremiumRateServiceInterface 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.v201605;

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 managing {@link PremiumRate} 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 = "PremiumRateServiceInterface", targetNamespace = "https://www.google.com/apis/ads/publisher/v201605")
@XmlSeeAlso({
    ObjectFactory.class
})
public interface PremiumRateServiceInterface {


    /**
     * 
     *         Creates a list of new {@link PremiumRate} objects.
     *         
     *         @param premiumRates the premium rates to be created
     *         @return the premium rates with their IDs filled in
     *       
     * 
     * @param premiumRates
     * @return
     *     returns java.util.List
     * @throws ApiException_Exception
     */
    @WebMethod
    @WebResult(name = "rval", targetNamespace = "https://www.google.com/apis/ads/publisher/v201605")
    @RequestWrapper(localName = "createPremiumRates", targetNamespace = "https://www.google.com/apis/ads/publisher/v201605", className = "com.google.api.ads.dfp.jaxws.v201605.PremiumRateServiceInterfacecreatePremiumRates")
    @ResponseWrapper(localName = "createPremiumRatesResponse", targetNamespace = "https://www.google.com/apis/ads/publisher/v201605", className = "com.google.api.ads.dfp.jaxws.v201605.PremiumRateServiceInterfacecreatePremiumRatesResponse")
    public List createPremiumRates(
        @WebParam(name = "premiumRates", targetNamespace = "https://www.google.com/apis/ads/publisher/v201605")
        List premiumRates)
        throws ApiException_Exception
    ;

    /**
     * 
     *         Gets a {@link PremiumRatePage} of {@link PremiumRate} objects that
     *         satisfy the given {@link Statement#query}. The following fields are
     *         supported for filtering:
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         PQL Property  Object Property
{@code id} {@link PremiumRate#id}
{@code rateCardId} {@link PremiumRate#rateCardId}
{@code pricingMethod} {@link PremiumRate#pricingMethod}
     *         
     *         @param filterStatement a Publisher Query Language statement to filter a
     *         list of premium rates.
     *         @return the premium rates that match the filter
     *       
     * 
     * @param filterStatement
     * @return
     *     returns com.google.api.ads.dfp.jaxws.v201605.PremiumRatePage
     * @throws ApiException_Exception
     */
    @WebMethod
    @WebResult(name = "rval", targetNamespace = "https://www.google.com/apis/ads/publisher/v201605")
    @RequestWrapper(localName = "getPremiumRatesByStatement", targetNamespace = "https://www.google.com/apis/ads/publisher/v201605", className = "com.google.api.ads.dfp.jaxws.v201605.PremiumRateServiceInterfacegetPremiumRatesByStatement")
    @ResponseWrapper(localName = "getPremiumRatesByStatementResponse", targetNamespace = "https://www.google.com/apis/ads/publisher/v201605", className = "com.google.api.ads.dfp.jaxws.v201605.PremiumRateServiceInterfacegetPremiumRatesByStatementResponse")
    public PremiumRatePage getPremiumRatesByStatement(
        @WebParam(name = "filterStatement", targetNamespace = "https://www.google.com/apis/ads/publisher/v201605")
        Statement filterStatement)
        throws ApiException_Exception
    ;

    /**
     * 
     *         Updates the specified {@link PremiumRate} objects.
     *         
     *         @param premiumRates the premium rates to be updated
     *         @return the updated premium rates
     *       
     * 
     * @param premiumRates
     * @return
     *     returns java.util.List
     * @throws ApiException_Exception
     */
    @WebMethod
    @WebResult(name = "rval", targetNamespace = "https://www.google.com/apis/ads/publisher/v201605")
    @RequestWrapper(localName = "updatePremiumRates", targetNamespace = "https://www.google.com/apis/ads/publisher/v201605", className = "com.google.api.ads.dfp.jaxws.v201605.PremiumRateServiceInterfaceupdatePremiumRates")
    @ResponseWrapper(localName = "updatePremiumRatesResponse", targetNamespace = "https://www.google.com/apis/ads/publisher/v201605", className = "com.google.api.ads.dfp.jaxws.v201605.PremiumRateServiceInterfaceupdatePremiumRatesResponse")
    public List updatePremiumRates(
        @WebParam(name = "premiumRates", targetNamespace = "https://www.google.com/apis/ads/publisher/v201605")
        List premiumRates)
        throws ApiException_Exception
    ;

}
PQL Property	Object Property
{@code id}	{@link PremiumRate#id}
{@code rateCardId}	{@link PremiumRate#rateCardId}
{@code pricingMethod}	{@link PremiumRate#pricingMethod}