com.google.api.ads.dfp.axis.v201306

Interface ProposalLineItemServiceInterface

All Superinterfaces:

Remote

All Known Implementing Classes:

ProposalLineItemServiceSoapBindingStub

public interface ProposalLineItemServiceInterface
extends Remote

Method Summary

Methods

Modifier and Type	Method and Description
ProposalLineItem	createProposalLineItem(ProposalLineItem proposalLineItem) Creates a new ProposalLineItem.
ProposalLineItem[]	createProposalLineItems(ProposalLineItem[] proposalLineItems) Creates new ProposalLineItem objects.
ProposalLineItem	getProposalLineItem(Long proposalLineItemId) Returns the ProposalLineItem uniquely identified by the given ID.
ProposalLineItemPage	getProposalLineItemsByStatement(Statement filterStatement) Gets a ProposalLineItemPage of ProposalLineItem objects that satisfy the given Statement.query.
UpdateResult	performProposalLineItemAction(ProposalLineItemAction proposalLineItemAction, Statement filterStatement) Performs actions on ProposalLineItem objects that match the given Statement.query.
ProposalLineItem	updateProposalLineItem(ProposalLineItem proposalLineItem) Updates the specified ProposalLineItem.
ProposalLineItem[]	updateProposalLineItems(ProposalLineItem[] proposalLineItems) Updates the specified ProposalLineItem objects.

Method Detail

createProposalLineItem

ProposalLineItem createProposalLineItem(ProposalLineItem proposalLineItem)
                                        throws RemoteException,
                                               ApiException

Creates a new ProposalLineItem. The following fields are required:

• ProposalLineItem.proposalId
• ProposalLineItem.rateCardId
• ProposalLineItem.productId
• ProposalLineItem.name
• ProposalLineItem.startDateTime
• ProposalLineItem.endDateTime

Parameters:

proposalLineItem - the proposal line item to create

Returns:

the created proposal line item with its ID filled in

Throws:

RemoteException

ApiException

createProposalLineItems

ProposalLineItem[] createProposalLineItems(ProposalLineItem[] proposalLineItems)
                                           throws RemoteException,
                                                  ApiException

Creates new ProposalLineItem objects. For each proposal line item, the following fields are required:

• ProposalLineItem.proposalId
• ProposalLineItem.rateCardId
• ProposalLineItem.productId
• ProposalLineItem.name
• ProposalLineItem.startDateTime
• ProposalLineItem.endDateTime

Parameters:

proposalLineItems - the proposal line items to create

Returns:

the created proposal line items with their IDs filled in

Throws:

RemoteException

ApiException

getProposalLineItem

ProposalLineItem getProposalLineItem(Long proposalLineItemId)
                                     throws RemoteException,
                                            ApiException

Returns the ProposalLineItem uniquely identified by the given ID.

Parameters:

proposalLineItemId - the ID of the proposal line item, which must already exist

Returns:

the proposal line item uniquely identified by the given ID

Throws:

RemoteException

ApiException

getProposalLineItemsByStatement

ProposalLineItemPage getProposalLineItemsByStatement(Statement filterStatement)
                                                     throws RemoteException,
                                                            ApiException

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

PQL Property	Object Property
id	ProposalLineItem.id
name	ProposalLineItem.name
proposalId	ProposalLineItem.proposalId
isArchived	ProposalLineItem.isArchived
lastModifiedDateTime	ProposalLineItem#lastModifiedDateTime
useThirdPartyAdServerFromProposal	ProposalLineItem#useThirdPartyAdServerFromProposal
thirdPartyAdServerId	ProposalLineItem#thirdPartyAdServerId
customThirdPartyAdServerName	ProposalLineItem#customThirdPartyAdServerName

Parameters:

filterStatement - a Publisher Query Language statement used to filter a set of proposal line items

Returns:

the proposal line items that match the given filter

Throws:

RemoteException

ApiException

performProposalLineItemAction

UpdateResult performProposalLineItemAction(ProposalLineItemAction proposalLineItemAction,
                                         Statement filterStatement)
                                           throws RemoteException,
                                                  ApiException

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

Parameters:

proposalLineItemAction - the action to perform

filterStatement - a Publisher Query Language statement used to filter a set of proposal line items

Returns:

the result of the action performed

Throws:

RemoteException

ApiException

updateProposalLineItem

ProposalLineItem updateProposalLineItem(ProposalLineItem proposalLineItem)
                                        throws RemoteException,
                                               ApiException

Updates the specified ProposalLineItem.

Parameters:

proposalLineItem - the proposal line item to update

Returns:

the updated proposal line item

Throws:

RemoteException

ApiException

updateProposalLineItems

ProposalLineItem[] updateProposalLineItems(ProposalLineItem[] proposalLineItems)
                                           throws RemoteException,
                                                  ApiException

Updates the specified ProposalLineItem objects.

Parameters:

proposalLineItems - the proposal line items to update

Returns:

the updated proposal line items

Throws:

RemoteException

ApiException