com.google.api.ads.dfp.jaxws.v201802

Interface ProposalLineItemServiceInterface

public interface ProposalLineItemServiceInterface

Provides methods for creating, updating and retrieving ProposalLineItem objects.

To use this service, you need to have the new sales management solution enabled on your network. If you do not see a "Sales" tab in DoubleClick for Publishers (DFP), you will not be able to use this service. 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<ProposalLineItem>	createProposalLineItems(List<ProposalLineItem> proposalLineItems) Creates new ProposalLineItem objects.
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.
List<ProposalLineItem>	updateProposalLineItems(List<ProposalLineItem> proposalLineItems) Updates the specified ProposalLineItem objects.

Method Detail

createProposalLineItems

@RequestWrapper(localName="createProposalLineItems",
                targetNamespace="https://www.google.com/apis/ads/publisher/v201802",
                className="com.google.api.ads.dfp.jaxws.v201802.ProposalLineItemServiceInterfacecreateProposalLineItems")
 @ResponseWrapper(localName="createProposalLineItemsResponse",
                 targetNamespace="https://www.google.com/apis/ads/publisher/v201802",
                 className="com.google.api.ads.dfp.jaxws.v201802.ProposalLineItemServiceInterfacecreateProposalLineItemsResponse")
List<ProposalLineItem> createProposalLineItems(List<ProposalLineItem> proposalLineItems)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    throws ApiException_Exception

Creates new ProposalLineItem objects.

Parameters:

proposalLineItems - the proposal line items to create

proposalLineItems -

Returns:

the created proposal line items with their IDs filled in

Throws:

ApiException_Exception

getProposalLineItemsByStatement

@RequestWrapper(localName="getProposalLineItemsByStatement",
                targetNamespace="https://www.google.com/apis/ads/publisher/v201802",
                className="com.google.api.ads.dfp.jaxws.v201802.ProposalLineItemServiceInterfacegetProposalLineItemsByStatement")
 @ResponseWrapper(localName="getProposalLineItemsByStatementResponse",
                 targetNamespace="https://www.google.com/apis/ads/publisher/v201802",
                 className="com.google.api.ads.dfp.jaxws.v201802.ProposalLineItemServiceInterfacegetProposalLineItemsByStatementResponse")
ProposalLineItemPage getProposalLineItemsByStatement(Statement filterStatement)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          throws ApiException_Exception

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
startDateTime	ProposalLineItem.startDateTime
endDateTime	ProposalLineItem.endDateTime
isArchived	ProposalLineItem.isArchived
lastModifiedDateTime	ProposalLineItem.lastModifiedDateTime
useThirdPartyAdServerFromProposal Only applicable for non-programmatic proposal line items using sales management	ProposalLineItem.useThirdPartyAdServerFromProposal
thirdPartyAdServerId Only applicable for non-programmatic proposal line items using sales management	ProposalLineItem.thirdPartyAdServerId
customThirdPartyAdServerName Only applicable for non-programmatic proposal line items using sales management	ProposalLineItem.customThirdPartyAdServerName
isProgrammatic	ProposalLineItem.isProgrammatic

Parameters:

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

filterStatement -

Returns:

the proposal line items that match the given filter

Throws:

ApiException_Exception

performProposalLineItemAction

@RequestWrapper(localName="performProposalLineItemAction",
                targetNamespace="https://www.google.com/apis/ads/publisher/v201802",
                className="com.google.api.ads.dfp.jaxws.v201802.ProposalLineItemServiceInterfaceperformProposalLineItemAction")
 @ResponseWrapper(localName="performProposalLineItemActionResponse",
                 targetNamespace="https://www.google.com/apis/ads/publisher/v201802",
                 className="com.google.api.ads.dfp.jaxws.v201802.ProposalLineItemServiceInterfaceperformProposalLineItemActionResponse")
UpdateResult performProposalLineItemAction(ProposalLineItemAction proposalLineItemAction,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               Statement filterStatement)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        throws ApiException_Exception

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

filterStatement -

proposalLineItemAction -

Returns:

the result of the action performed

Throws:

ApiException_Exception

updateProposalLineItems

@RequestWrapper(localName="updateProposalLineItems",
                targetNamespace="https://www.google.com/apis/ads/publisher/v201802",
                className="com.google.api.ads.dfp.jaxws.v201802.ProposalLineItemServiceInterfaceupdateProposalLineItems")
 @ResponseWrapper(localName="updateProposalLineItemsResponse",
                 targetNamespace="https://www.google.com/apis/ads/publisher/v201802",
                 className="com.google.api.ads.dfp.jaxws.v201802.ProposalLineItemServiceInterfaceupdateProposalLineItemsResponse")
List<ProposalLineItem> updateProposalLineItems(List<ProposalLineItem> proposalLineItems)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    throws ApiException_Exception

Updates the specified ProposalLineItem objects. If free editing mode is enabled, this will trigger inventory reservation and cause the proposal to be pushed to DFP again.

Parameters:

proposalLineItems - the proposal line items to update

proposalLineItems -

Returns:

the updated proposal line items

Throws:

ApiException_Exception