com.google.api.ads.dfp.jaxws.v201805

Interface LineItemCreativeAssociationServiceInterface

public interface LineItemCreativeAssociationServiceInterface

Provides operations for creating, updating and retrieving LineItemCreativeAssociation objects.

A line item creative association (LICA) associates a Creative with a 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 LineItem#creativeSizes.

Each LICA has a start and end date and time that defines when the creative should be displayed.

To read more about associating creatives with line items, see this DFP Help Center article. This class was generated by the JAX-WS RI. JAX-WS RI 2.2.9-b130926.1035 Generated source version: 2.1

Method Summary

Modifier and Type	Method and Description
List<LineItemCreativeAssociation>	createLineItemCreativeAssociations(List<LineItemCreativeAssociation> lineItemCreativeAssociations) Creates new LineItemCreativeAssociation objects
LineItemCreativeAssociationPage	getLineItemCreativeAssociationsByStatement(Statement filterStatement) Gets a LineItemCreativeAssociationPage of LineItemCreativeAssociation objects that satisfy the given Statement.query.
String	getPreviewUrl(Long lineItemId, Long creativeId, String siteUrl) Returns an insite preview URL that references the specified site URL with the specified creative from the association served to it.
List<CreativeNativeStylePreview>	getPreviewUrlsForNativeStyles(Long lineItemId, Long creativeId, String siteUrl) Returns a list of URLs that reference the specified site URL with the specified creative from the association served to it.
UpdateResult	performLineItemCreativeAssociationAction(LineItemCreativeAssociationAction lineItemCreativeAssociationAction, Statement filterStatement) Performs actions on LineItemCreativeAssociation objects that match the given Statement.query.
List<LineItemCreativeAssociation>	updateLineItemCreativeAssociations(List<LineItemCreativeAssociation> lineItemCreativeAssociations) Updates the specified LineItemCreativeAssociation objects

Method Detail

createLineItemCreativeAssociations

@RequestWrapper(localName="createLineItemCreativeAssociations",
                targetNamespace="https://www.google.com/apis/ads/publisher/v201805",
                className="com.google.api.ads.dfp.jaxws.v201805.LineItemCreativeAssociationServiceInterfacecreateLineItemCreativeAssociations")
 @ResponseWrapper(localName="createLineItemCreativeAssociationsResponse",
                 targetNamespace="https://www.google.com/apis/ads/publisher/v201805",
                 className="com.google.api.ads.dfp.jaxws.v201805.LineItemCreativeAssociationServiceInterfacecreateLineItemCreativeAssociationsResponse")
List<LineItemCreativeAssociation> createLineItemCreativeAssociations(List<LineItemCreativeAssociation> lineItemCreativeAssociations)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            throws ApiException_Exception

Creates new LineItemCreativeAssociation objects

Parameters:

lineItemCreativeAssociations - the line item creative associations to create

lineItemCreativeAssociations -

Returns:

the created line item creative associations with their IDs filled in

Throws:

ApiException_Exception

getLineItemCreativeAssociationsByStatement

@RequestWrapper(localName="getLineItemCreativeAssociationsByStatement",
                targetNamespace="https://www.google.com/apis/ads/publisher/v201805",
                className="com.google.api.ads.dfp.jaxws.v201805.LineItemCreativeAssociationServiceInterfacegetLineItemCreativeAssociationsByStatement")
 @ResponseWrapper(localName="getLineItemCreativeAssociationsByStatementResponse",
                 targetNamespace="https://www.google.com/apis/ads/publisher/v201805",
                 className="com.google.api.ads.dfp.jaxws.v201805.LineItemCreativeAssociationServiceInterfacegetLineItemCreativeAssociationsByStatementResponse")
LineItemCreativeAssociationPage getLineItemCreativeAssociationsByStatement(Statement filterStatement)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  throws ApiException_Exception

Gets a LineItemCreativeAssociationPage of LineItemCreativeAssociation objects that satisfy the given Statement.query. The following fields are supported for filtering:

PQL Property	Object Property
creativeId	LineItemCreativeAssociation.creativeId
manualCreativeRotationWeight	LineItemCreativeAssociation.manualCreativeRotationWeight
destinationUrl	LineItemCreativeAssociation.destinationUrl
lineItemId	LineItemCreativeAssociation.lineItemId
status	LineItemCreativeAssociation.status
lastModifiedDateTime	LineItemCreativeAssociation.lastModifiedDateTime

Parameters:

filterStatement - a Publisher Query Language statement used to filter a set of line item creative associations

filterStatement -

Returns:

the line item creative associations that match the given filter

Throws:

ApiException_Exception

getPreviewUrl

@RequestWrapper(localName="getPreviewUrl",
                targetNamespace="https://www.google.com/apis/ads/publisher/v201805",
                className="com.google.api.ads.dfp.jaxws.v201805.LineItemCreativeAssociationServiceInterfacegetPreviewUrl")
 @ResponseWrapper(localName="getPreviewUrlResponse",
                 targetNamespace="https://www.google.com/apis/ads/publisher/v201805",
                 className="com.google.api.ads.dfp.jaxws.v201805.LineItemCreativeAssociationServiceInterfacegetPreviewUrlResponse")
String getPreviewUrl(Long lineItemId,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               Long creativeId,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               String siteUrl)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        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.

Parameters:

lineItemId - the ID of the line item, which must already exist

creativeId - the ID of the creative, which must already exist

siteUrl - the URL of the site that the creative should be previewed in

siteUrl -

lineItemId -

creativeId -

Returns:

a URL that references the specified site URL with the specified creative served to it

Throws:

ApiException_Exception

getPreviewUrlsForNativeStyles

@RequestWrapper(localName="getPreviewUrlsForNativeStyles",
                targetNamespace="https://www.google.com/apis/ads/publisher/v201805",
                className="com.google.api.ads.dfp.jaxws.v201805.LineItemCreativeAssociationServiceInterfacegetPreviewUrlsForNativeStyles")
 @ResponseWrapper(localName="getPreviewUrlsForNativeStylesResponse",
                 targetNamespace="https://www.google.com/apis/ads/publisher/v201805",
                 className="com.google.api.ads.dfp.jaxws.v201805.LineItemCreativeAssociationServiceInterfacegetPreviewUrlsForNativeStylesResponse")
List<CreativeNativeStylePreview> getPreviewUrlsForNativeStyles(Long lineItemId,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         Long creativeId,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         String siteUrl)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  throws ApiException_Exception

Returns a list of URLs that reference 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. Each URL corresponds to one available native style for previewing the specified creative.

Parameters:

lineItemId - the ID of the line item, which must already exist

creativeId - the ID of the creative, which must already exist and must be a native creative

siteUrl - the URL of the site that the creative should be previewed in

siteUrl -

lineItemId -

creativeId -

Returns:

the URLs that references the specified site URL and can be used to preview the specified creative with the available native styles

Throws:

ApiException_Exception

performLineItemCreativeAssociationAction

@RequestWrapper(localName="performLineItemCreativeAssociationAction",
                targetNamespace="https://www.google.com/apis/ads/publisher/v201805",
                className="com.google.api.ads.dfp.jaxws.v201805.LineItemCreativeAssociationServiceInterfaceperformLineItemCreativeAssociationAction")
 @ResponseWrapper(localName="performLineItemCreativeAssociationActionResponse",
                 targetNamespace="https://www.google.com/apis/ads/publisher/v201805",
                 className="com.google.api.ads.dfp.jaxws.v201805.LineItemCreativeAssociationServiceInterfaceperformLineItemCreativeAssociationActionResponse")
UpdateResult performLineItemCreativeAssociationAction(LineItemCreativeAssociationAction lineItemCreativeAssociationAction,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Statement filterStatement)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     throws ApiException_Exception

Performs actions on LineItemCreativeAssociation objects that match the given Statement.query.

Parameters:

lineItemCreativeAssociationAction - the action to perform

filterStatement - a Publisher Query Language statement used to filter a set of line item creative associations

lineItemCreativeAssociationAction -

filterStatement -

Returns:

the result of the action performed

Throws:

ApiException_Exception

updateLineItemCreativeAssociations

@RequestWrapper(localName="updateLineItemCreativeAssociations",
                targetNamespace="https://www.google.com/apis/ads/publisher/v201805",
                className="com.google.api.ads.dfp.jaxws.v201805.LineItemCreativeAssociationServiceInterfaceupdateLineItemCreativeAssociations")
 @ResponseWrapper(localName="updateLineItemCreativeAssociationsResponse",
                 targetNamespace="https://www.google.com/apis/ads/publisher/v201805",
                 className="com.google.api.ads.dfp.jaxws.v201805.LineItemCreativeAssociationServiceInterfaceupdateLineItemCreativeAssociationsResponse")
List<LineItemCreativeAssociation> updateLineItemCreativeAssociations(List<LineItemCreativeAssociation> lineItemCreativeAssociations)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            throws ApiException_Exception

Updates the specified LineItemCreativeAssociation objects

Parameters:

lineItemCreativeAssociations - the line item creative associations to update

lineItemCreativeAssociations -

Returns:

the updated line item creative associations

Throws:

ApiException_Exception