com.google.api.ads.dfp.jaxws.v201505.LineItemCreativeAssociationServiceInterface 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
Show all versions of dfp-appengine Show documentation
DFP specific AppEngine components.
package com.google.api.ads.dfp.jaxws.v201505;
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 LineItemCreativeAssociation} objects.
*
* A line item creative association (LICA) associates a {@link Creative} with a
* {@link LineItem}. When a line item is selected to serve, the LICAs specify which
* creatives can appear for the ad units that are targeted by the line item. In
* order to be associated with a line item, the creative must have a size that
* exists within the attribute {@link LineItem#creativeSizes}.
*
*
* Each LICA has a start and end date and time that defines when the creative
* should be displayed.
*
*
*
* This class was generated by the JAX-WS RI.
* JAX-WS RI 2.2.9-b130926.1035
* Generated source version: 2.1
*
*/
@WebService(name = "LineItemCreativeAssociationServiceInterface", targetNamespace = "https://www.google.com/apis/ads/publisher/v201505")
@XmlSeeAlso({
ObjectFactory.class
})
public interface LineItemCreativeAssociationServiceInterface {
/**
*
* Creates new {@link LineItemCreativeAssociation} objects
*
* @param lineItemCreativeAssociations the line item creative associations to
* create
* @return the created line item creative associations with their IDs filled
* in
*
*
* @param lineItemCreativeAssociations
* @return
* returns java.util.List
* @throws ApiException_Exception
*/
@WebMethod
@WebResult(name = "rval", targetNamespace = "https://www.google.com/apis/ads/publisher/v201505")
@RequestWrapper(localName = "createLineItemCreativeAssociations", targetNamespace = "https://www.google.com/apis/ads/publisher/v201505", className = "com.google.api.ads.dfp.jaxws.v201505.LineItemCreativeAssociationServiceInterfacecreateLineItemCreativeAssociations")
@ResponseWrapper(localName = "createLineItemCreativeAssociationsResponse", targetNamespace = "https://www.google.com/apis/ads/publisher/v201505", className = "com.google.api.ads.dfp.jaxws.v201505.LineItemCreativeAssociationServiceInterfacecreateLineItemCreativeAssociationsResponse")
public List createLineItemCreativeAssociations(
@WebParam(name = "lineItemCreativeAssociations", targetNamespace = "https://www.google.com/apis/ads/publisher/v201505")
List lineItemCreativeAssociations)
throws ApiException_Exception
;
/**
*
* Gets a {@link LineItemCreativeAssociationPage} of
* {@link LineItemCreativeAssociation} objects that satisfy the given
* {@link Statement#query}. The following fields are supported for filtering:
*
*
*
* PQL Property Object Property
*
*
* {@code creativeId}
* {@link LineItemCreativeAssociation#creativeId}
*
*
* {@code manualCreativeRotationWeight}
* {@link LineItemCreativeAssociation#manualCreativeRotationWeight}
*
*
* {@code destinationUrl}
* {@link LineItemCreativeAssociation#destinationUrl}
*
*
* {@code lineItemId}
* {@link LineItemCreativeAssociation#lineItemId}
*
*
* {@code status}
* {@link LineItemCreativeAssociation#status}
*
*
* {@code lastModifiedDateTime}
* {@link LineItemCreativeAssociation#lastModifiedDateTime}
*
*
*
* @param filterStatement a Publisher Query Language statement used to filter
* a set of line item creative associations
* @return the line item creative associations that match the given filter
*
*
* @param filterStatement
* @return
* returns com.google.api.ads.dfp.jaxws.v201505.LineItemCreativeAssociationPage
* @throws ApiException_Exception
*/
@WebMethod
@WebResult(name = "rval", targetNamespace = "https://www.google.com/apis/ads/publisher/v201505")
@RequestWrapper(localName = "getLineItemCreativeAssociationsByStatement", targetNamespace = "https://www.google.com/apis/ads/publisher/v201505", className = "com.google.api.ads.dfp.jaxws.v201505.LineItemCreativeAssociationServiceInterfacegetLineItemCreativeAssociationsByStatement")
@ResponseWrapper(localName = "getLineItemCreativeAssociationsByStatementResponse", targetNamespace = "https://www.google.com/apis/ads/publisher/v201505", className = "com.google.api.ads.dfp.jaxws.v201505.LineItemCreativeAssociationServiceInterfacegetLineItemCreativeAssociationsByStatementResponse")
public LineItemCreativeAssociationPage getLineItemCreativeAssociationsByStatement(
@WebParam(name = "filterStatement", targetNamespace = "https://www.google.com/apis/ads/publisher/v201505")
Statement filterStatement)
throws ApiException_Exception
;
/**
*
* Returns an insite preview URL that references the specified site URL with
* the specified creative from the association served to it. For Creative Set
* previewing you may specify the master creative Id.
*
* @param lineItemId the ID of the line item, which must already exist
* @param creativeId the ID of the creative, which must already exist
* @param siteUrl the URL of the site that the creative should be previewed in
* @return a URL that references the specified site URL with the specified
* creative served to it
*
*
* @param siteUrl
* @param lineItemId
* @param creativeId
* @return
* returns java.lang.String
* @throws ApiException_Exception
*/
@WebMethod
@WebResult(name = "rval", targetNamespace = "https://www.google.com/apis/ads/publisher/v201505")
@RequestWrapper(localName = "getPreviewUrl", targetNamespace = "https://www.google.com/apis/ads/publisher/v201505", className = "com.google.api.ads.dfp.jaxws.v201505.LineItemCreativeAssociationServiceInterfacegetPreviewUrl")
@ResponseWrapper(localName = "getPreviewUrlResponse", targetNamespace = "https://www.google.com/apis/ads/publisher/v201505", className = "com.google.api.ads.dfp.jaxws.v201505.LineItemCreativeAssociationServiceInterfacegetPreviewUrlResponse")
public String getPreviewUrl(
@WebParam(name = "lineItemId", targetNamespace = "https://www.google.com/apis/ads/publisher/v201505")
Long lineItemId,
@WebParam(name = "creativeId", targetNamespace = "https://www.google.com/apis/ads/publisher/v201505")
Long creativeId,
@WebParam(name = "siteUrl", targetNamespace = "https://www.google.com/apis/ads/publisher/v201505")
String siteUrl)
throws ApiException_Exception
;
/**
*
* Performs actions on {@link LineItemCreativeAssociation} objects that match
* the given {@link Statement#query}.
*
* @param lineItemCreativeAssociationAction the action to perform
* @param filterStatement a Publisher Query Language statement used to filter
* a set of line item creative associations
* @return the result of the action performed
*
*
* @param lineItemCreativeAssociationAction
* @param filterStatement
* @return
* returns com.google.api.ads.dfp.jaxws.v201505.UpdateResult
* @throws ApiException_Exception
*/
@WebMethod
@WebResult(name = "rval", targetNamespace = "https://www.google.com/apis/ads/publisher/v201505")
@RequestWrapper(localName = "performLineItemCreativeAssociationAction", targetNamespace = "https://www.google.com/apis/ads/publisher/v201505", className = "com.google.api.ads.dfp.jaxws.v201505.LineItemCreativeAssociationServiceInterfaceperformLineItemCreativeAssociationAction")
@ResponseWrapper(localName = "performLineItemCreativeAssociationActionResponse", targetNamespace = "https://www.google.com/apis/ads/publisher/v201505", className = "com.google.api.ads.dfp.jaxws.v201505.LineItemCreativeAssociationServiceInterfaceperformLineItemCreativeAssociationActionResponse")
public UpdateResult performLineItemCreativeAssociationAction(
@WebParam(name = "lineItemCreativeAssociationAction", targetNamespace = "https://www.google.com/apis/ads/publisher/v201505")
LineItemCreativeAssociationAction lineItemCreativeAssociationAction,
@WebParam(name = "filterStatement", targetNamespace = "https://www.google.com/apis/ads/publisher/v201505")
Statement filterStatement)
throws ApiException_Exception
;
/**
*
* Updates the specified {@link LineItemCreativeAssociation} objects
*
* @param lineItemCreativeAssociations the line item creative associations to
* update
* @return the updated line item creative associations
*
*
* @param lineItemCreativeAssociations
* @return
* returns java.util.List
* @throws ApiException_Exception
*/
@WebMethod
@WebResult(name = "rval", targetNamespace = "https://www.google.com/apis/ads/publisher/v201505")
@RequestWrapper(localName = "updateLineItemCreativeAssociations", targetNamespace = "https://www.google.com/apis/ads/publisher/v201505", className = "com.google.api.ads.dfp.jaxws.v201505.LineItemCreativeAssociationServiceInterfaceupdateLineItemCreativeAssociations")
@ResponseWrapper(localName = "updateLineItemCreativeAssociationsResponse", targetNamespace = "https://www.google.com/apis/ads/publisher/v201505", className = "com.google.api.ads.dfp.jaxws.v201505.LineItemCreativeAssociationServiceInterfaceupdateLineItemCreativeAssociationsResponse")
public List updateLineItemCreativeAssociations(
@WebParam(name = "lineItemCreativeAssociations", targetNamespace = "https://www.google.com/apis/ads/publisher/v201505")
List lineItemCreativeAssociations)
throws ApiException_Exception
;
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy