com.google.api.ads.dfp.jaxws.v201511.ContentBundleServiceInterface 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 methods for creating, updating and retrieving {@link ContentBundle} objects.
*
* A {@code ContentBundle} is a grouping of {@link Content} that match filter rules as well as
* taking into account explicitly included or excluded {@code Content}.
*
*
* This class was generated by the JAX-WS RI.
* JAX-WS RI 2.2.9-b130926.1035
* Generated source version: 2.1
*
*/
@WebService(name = "ContentBundleServiceInterface", targetNamespace = "https://www.google.com/apis/ads/publisher/v201511")
@XmlSeeAlso({
ObjectFactory.class
})
public interface ContentBundleServiceInterface {
/**
*
* Creates new {@link ContentBundle} objects.
*
* @param contentBundles the content bundles to create
* @return the created content bundles with their IDs filled in
*
*
* @param contentBundles
* @return
* returns java.util.List
* @throws ApiException_Exception
*/
@WebMethod
@WebResult(name = "rval", targetNamespace = "https://www.google.com/apis/ads/publisher/v201511")
@RequestWrapper(localName = "createContentBundles", targetNamespace = "https://www.google.com/apis/ads/publisher/v201511", className = "com.google.api.ads.dfp.jaxws.v201511.ContentBundleServiceInterfacecreateContentBundles")
@ResponseWrapper(localName = "createContentBundlesResponse", targetNamespace = "https://www.google.com/apis/ads/publisher/v201511", className = "com.google.api.ads.dfp.jaxws.v201511.ContentBundleServiceInterfacecreateContentBundlesResponse")
public List createContentBundles(
@WebParam(name = "contentBundles", targetNamespace = "https://www.google.com/apis/ads/publisher/v201511")
List contentBundles)
throws ApiException_Exception
;
/**
*
* Gets a {@link ContentBundlePage} of {@link ContentBundle} objects that satisfy the
* given {@link Statement#query}. The following fields are supported for filtering:
*
*
*
* PQL Property Object Property
*
*
* {@code id}
* {@link ContentBundle#id}
*
*
* {@code name}
* {@link ContentBundle#name}
*
*
* {@code status}
* {@link ContentBundle#status}
*
*
*
* @param filterStatement a Publisher Query Language statement used to filter
* a set of content bundles
* @return the content bundles that match the given filter
*
*
* @param filterStatement
* @return
* returns com.google.api.ads.dfp.jaxws.v201511.ContentBundlePage
* @throws ApiException_Exception
*/
@WebMethod
@WebResult(name = "rval", targetNamespace = "https://www.google.com/apis/ads/publisher/v201511")
@RequestWrapper(localName = "getContentBundlesByStatement", targetNamespace = "https://www.google.com/apis/ads/publisher/v201511", className = "com.google.api.ads.dfp.jaxws.v201511.ContentBundleServiceInterfacegetContentBundlesByStatement")
@ResponseWrapper(localName = "getContentBundlesByStatementResponse", targetNamespace = "https://www.google.com/apis/ads/publisher/v201511", className = "com.google.api.ads.dfp.jaxws.v201511.ContentBundleServiceInterfacegetContentBundlesByStatementResponse")
public ContentBundlePage getContentBundlesByStatement(
@WebParam(name = "filterStatement", targetNamespace = "https://www.google.com/apis/ads/publisher/v201511")
Statement filterStatement)
throws ApiException_Exception
;
/**
*
* Performs actions on {@link ContentBundle} objects that match the given
* {@link Statement#query}.
*
* @param contentBundleAction the action to perform
* @param filterStatement a Publisher Query Language statement used to filter
* a set of content bundles
* @return the result of the action performed
*
*
* @param filterStatement
* @param contentBundleAction
* @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 = "performContentBundleAction", targetNamespace = "https://www.google.com/apis/ads/publisher/v201511", className = "com.google.api.ads.dfp.jaxws.v201511.ContentBundleServiceInterfaceperformContentBundleAction")
@ResponseWrapper(localName = "performContentBundleActionResponse", targetNamespace = "https://www.google.com/apis/ads/publisher/v201511", className = "com.google.api.ads.dfp.jaxws.v201511.ContentBundleServiceInterfaceperformContentBundleActionResponse")
public UpdateResult performContentBundleAction(
@WebParam(name = "contentBundleAction", targetNamespace = "https://www.google.com/apis/ads/publisher/v201511")
ContentBundleAction contentBundleAction,
@WebParam(name = "filterStatement", targetNamespace = "https://www.google.com/apis/ads/publisher/v201511")
Statement filterStatement)
throws ApiException_Exception
;
/**
*
* Updates the specified {@link ContentBundle} objects.
*
* @param contentBundles the content bundles to update
* @return the updated content bundles
*
*
* @param contentBundles
* @return
* returns java.util.List
* @throws ApiException_Exception
*/
@WebMethod
@WebResult(name = "rval", targetNamespace = "https://www.google.com/apis/ads/publisher/v201511")
@RequestWrapper(localName = "updateContentBundles", targetNamespace = "https://www.google.com/apis/ads/publisher/v201511", className = "com.google.api.ads.dfp.jaxws.v201511.ContentBundleServiceInterfaceupdateContentBundles")
@ResponseWrapper(localName = "updateContentBundlesResponse", targetNamespace = "https://www.google.com/apis/ads/publisher/v201511", className = "com.google.api.ads.dfp.jaxws.v201511.ContentBundleServiceInterfaceupdateContentBundlesResponse")
public List updateContentBundles(
@WebParam(name = "contentBundles", targetNamespace = "https://www.google.com/apis/ads/publisher/v201511")
List contentBundles)
throws ApiException_Exception
;
}