com.google.api.ads.dfp.jaxws.v201508.BaseRateServiceInterface Maven / Gradle / Ivy
Show all versions of dfp-appengine Show documentation
package com.google.api.ads.dfp.jaxws.v201508;
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 BaseRate} 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 = "BaseRateServiceInterface", targetNamespace = "https://www.google.com/apis/ads/publisher/v201508")
@XmlSeeAlso({
ObjectFactory.class
})
public interface BaseRateServiceInterface {
/**
*
* Creates a list of new {@link BaseRate} objects.
*
* @param baseRates the base rates to be created
* @return the base rates with their IDs filled in
*
*
* @param baseRates
* @return
* returns java.util.List
* @throws ApiException_Exception
*/
@WebMethod
@WebResult(name = "rval", targetNamespace = "https://www.google.com/apis/ads/publisher/v201508")
@RequestWrapper(localName = "createBaseRates", targetNamespace = "https://www.google.com/apis/ads/publisher/v201508", className = "com.google.api.ads.dfp.jaxws.v201508.BaseRateServiceInterfacecreateBaseRates")
@ResponseWrapper(localName = "createBaseRatesResponse", targetNamespace = "https://www.google.com/apis/ads/publisher/v201508", className = "com.google.api.ads.dfp.jaxws.v201508.BaseRateServiceInterfacecreateBaseRatesResponse")
public List createBaseRates(
@WebParam(name = "baseRates", targetNamespace = "https://www.google.com/apis/ads/publisher/v201508")
List baseRates)
throws ApiException_Exception
;
/**
*
* Gets a {@link BaseRatePage} of {@link BaseRate} objects that satisfy the given
* {@link Statement#query}.
*
* The following fields are supported for filtering:
*
*
*
* PQL Property
* Object Property
*
*
* {@code rateCardId}
* {@link BaseRate#rateCardId}
*
*
* {@code id}
* {@link BaseRate#id}
*
*
* {@code productTemplateId}
* {@link ProductTemplateBaseRate#id}
Note: Cannot be
* combined with {@code productId}.
*
* {@code productId}
* {@link ProductBaseRate#id}
Note: Cannot be combined with
* {@code productTemplateId}.
*
*
* @param filterStatement a Publisher Query Language statement used to filter
* a set of base rates.
* @return the page of base rates that match the given filter
*
*
* @param filterStatement
* @return
* returns com.google.api.ads.dfp.jaxws.v201508.BaseRatePage
* @throws ApiException_Exception
*/
@WebMethod
@WebResult(name = "rval", targetNamespace = "https://www.google.com/apis/ads/publisher/v201508")
@RequestWrapper(localName = "getBaseRatesByStatement", targetNamespace = "https://www.google.com/apis/ads/publisher/v201508", className = "com.google.api.ads.dfp.jaxws.v201508.BaseRateServiceInterfacegetBaseRatesByStatement")
@ResponseWrapper(localName = "getBaseRatesByStatementResponse", targetNamespace = "https://www.google.com/apis/ads/publisher/v201508", className = "com.google.api.ads.dfp.jaxws.v201508.BaseRateServiceInterfacegetBaseRatesByStatementResponse")
public BaseRatePage getBaseRatesByStatement(
@WebParam(name = "filterStatement", targetNamespace = "https://www.google.com/apis/ads/publisher/v201508")
Statement filterStatement)
throws ApiException_Exception
;
/**
*
* Performs actions on {@link BaseRate} objects that satisfy the given
* {@link Statement#query}.
*
* @param baseRateAction the action to perform
* @param filterStatement a Publisher Query Language statement used to filter
* a set of base rates.
* @return the result of the action performed
*
*
* @param filterStatement
* @param baseRateAction
* @return
* returns com.google.api.ads.dfp.jaxws.v201508.UpdateResult
* @throws ApiException_Exception
*/
@WebMethod
@WebResult(name = "rval", targetNamespace = "https://www.google.com/apis/ads/publisher/v201508")
@RequestWrapper(localName = "performBaseRateAction", targetNamespace = "https://www.google.com/apis/ads/publisher/v201508", className = "com.google.api.ads.dfp.jaxws.v201508.BaseRateServiceInterfaceperformBaseRateAction")
@ResponseWrapper(localName = "performBaseRateActionResponse", targetNamespace = "https://www.google.com/apis/ads/publisher/v201508", className = "com.google.api.ads.dfp.jaxws.v201508.BaseRateServiceInterfaceperformBaseRateActionResponse")
public UpdateResult performBaseRateAction(
@WebParam(name = "baseRateAction", targetNamespace = "https://www.google.com/apis/ads/publisher/v201508")
BaseRateAction baseRateAction,
@WebParam(name = "filterStatement", targetNamespace = "https://www.google.com/apis/ads/publisher/v201508")
Statement filterStatement)
throws ApiException_Exception
;
/**
*
* Updates the specified {@link BaseRate} objects.
*
* @param baseRates the base rates to be updated
* @return the updated base rates
*
*
* @param baseRates
* @return
* returns java.util.List
* @throws ApiException_Exception
*/
@WebMethod
@WebResult(name = "rval", targetNamespace = "https://www.google.com/apis/ads/publisher/v201508")
@RequestWrapper(localName = "updateBaseRates", targetNamespace = "https://www.google.com/apis/ads/publisher/v201508", className = "com.google.api.ads.dfp.jaxws.v201508.BaseRateServiceInterfaceupdateBaseRates")
@ResponseWrapper(localName = "updateBaseRatesResponse", targetNamespace = "https://www.google.com/apis/ads/publisher/v201508", className = "com.google.api.ads.dfp.jaxws.v201508.BaseRateServiceInterfaceupdateBaseRatesResponse")
public List updateBaseRates(
@WebParam(name = "baseRates", targetNamespace = "https://www.google.com/apis/ads/publisher/v201508")
List baseRates)
throws ApiException_Exception
;
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy