com.google.api.ads.dfp.axis.v201201

Interface LineItemCreativeAssociationServiceInterface

All Superinterfaces:

Remote

All Known Implementing Classes:

LineItemCreativeAssociationServiceSoapBindingStub

public interface LineItemCreativeAssociationServiceInterface
extends Remote

Method Summary

Methods

Modifier and Type	Method and Description
LineItemCreativeAssociation	createLineItemCreativeAssociation(LineItemCreativeAssociation lineItemCreativeAssociation) Creates a new LineItemCreativeAssociation.
LineItemCreativeAssociation[]	createLineItemCreativeAssociations(LineItemCreativeAssociation[] lineItemCreativeAssociations) Creates new LineItemCreativeAssociation objects
LineItemCreativeAssociation	getLineItemCreativeAssociation(Long lineItemId, Long creativeId) Returns the LineItemCreativeAssociation uniquely identified by the given line item and creative IDs.
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.
UpdateResult	performLineItemCreativeAssociationAction(LineItemCreativeAssociationAction lineItemCreativeAssociationAction, Statement filterStatement) Performs actions on LineItemCreativeAssociation objects that match the given Statement.query.
LineItemCreativeAssociation	updateLineItemCreativeAssociation(LineItemCreativeAssociation lineItemCreativeAssociation) Updates the specified LineItemCreativeAssociation.
LineItemCreativeAssociation[]	updateLineItemCreativeAssociations(LineItemCreativeAssociation[] lineItemCreativeAssociations) Updates the specified LineItemCreativeAssociation objects

Method Detail

createLineItemCreativeAssociation

LineItemCreativeAssociation createLineItemCreativeAssociation(LineItemCreativeAssociation lineItemCreativeAssociation)
                                                              throws RemoteException,
                                                                     ApiException

Creates a new LineItemCreativeAssociation. The following fields are required:

• LineItemCreativeAssociation.creativeId
• LineItemCreativeAssociation.lineItemId

Parameters:

lineItemCreativeAssociation - the line item creative association to create

Returns:

the new line item creative association with its ID set

Throws:

RemoteException

ApiException

createLineItemCreativeAssociations

LineItemCreativeAssociation[] createLineItemCreativeAssociations(LineItemCreativeAssociation[] lineItemCreativeAssociations)
                                                                 throws RemoteException,
                                                                        ApiException

Creates new LineItemCreativeAssociation objects

Parameters:

lineItemCreativeAssociations - the line item creative associations to create

Returns:

the created line item creative associations with their IDs filled in

Throws:

RemoteException

ApiException

getLineItemCreativeAssociation

LineItemCreativeAssociation getLineItemCreativeAssociation(Long lineItemId,
                                                         Long creativeId)
                                                           throws RemoteException,
                                                                  ApiException

Returns the LineItemCreativeAssociation uniquely identified by the given line item and creative IDs.

Parameters:

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

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

Returns:

the LineItemCreativeAssociation uniquely identified by the line item and creative IDs

Throws:

RemoteException

ApiException

getLineItemCreativeAssociationsByStatement

LineItemCreativeAssociationPage getLineItemCreativeAssociationsByStatement(Statement filterStatement)
                                                                           throws RemoteException,
                                                                                  ApiException

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

Returns:

the line item creative associations that match the given filter

Throws:

RemoteException

ApiException

getPreviewUrl

String getPreviewUrl(Long lineItemId,
                   Long creativeId,
                   String siteUrl)
                     throws RemoteException,
                            ApiException

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

Returns:

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

Throws:

RemoteException

ApiException

performLineItemCreativeAssociationAction

UpdateResult performLineItemCreativeAssociationAction(LineItemCreativeAssociationAction lineItemCreativeAssociationAction,
                                                    Statement filterStatement)
                                                      throws RemoteException,
                                                             ApiException

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

Returns:

the result of the action performed

Throws:

RemoteException

ApiException

updateLineItemCreativeAssociation

LineItemCreativeAssociation updateLineItemCreativeAssociation(LineItemCreativeAssociation lineItemCreativeAssociation)
                                                              throws RemoteException,
                                                                     ApiException

Updates the specified LineItemCreativeAssociation.

Parameters:

lineItemCreativeAssociation - the line item creative association to update

Returns:

the updated line item creative association

Throws:

RemoteException

ApiException

updateLineItemCreativeAssociations

LineItemCreativeAssociation[] updateLineItemCreativeAssociations(LineItemCreativeAssociation[] lineItemCreativeAssociations)
                                                                 throws RemoteException,
                                                                        ApiException

Updates the specified LineItemCreativeAssociation objects

Parameters:

lineItemCreativeAssociations - the line item creative associations to update

Returns:

the updated line item creative associations

Throws:

RemoteException

ApiException