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

Interface ProposalServiceInterface

public interface ProposalServiceInterface

Provides methods for adding, updating and retrieving Proposal 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<Proposal>	createProposals(List<Proposal> proposals) Creates new Proposal objects.
MarketplaceCommentPage	getMarketplaceCommentsByStatement(Statement filterStatement) Gets a MarketplaceCommentPage of MarketplaceComment objects that satisfy the given Statement.query.
ProposalPage	getProposalsByStatement(Statement filterStatement) Gets a ProposalPage of Proposal objects that satisfy the given Statement.query.
UpdateResult	performProposalAction(ProposalAction proposalAction, Statement filterStatement) Performs actions on Proposal objects that match the given Statement.query.
List<Proposal>	updateProposals(List<Proposal> proposals) Updates the specified Proposal objects.

Method Detail

createProposals

@RequestWrapper(localName="createProposals",
                targetNamespace="https://www.google.com/apis/ads/publisher/v201802",
                className="com.google.api.ads.dfp.jaxws.v201802.ProposalServiceInterfacecreateProposals")
 @ResponseWrapper(localName="createProposalsResponse",
                 targetNamespace="https://www.google.com/apis/ads/publisher/v201802",
                 className="com.google.api.ads.dfp.jaxws.v201802.ProposalServiceInterfacecreateProposalsResponse")
List<Proposal> createProposals(List<Proposal> proposals)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    throws ApiException_Exception

Creates new Proposal objects. For each proposal, the following fields are required:

• Proposal.name

Parameters:

proposals - the proposals to create

proposals -

Returns:

the created proposals with their IDs filled in

Throws:

ApiException_Exception

getMarketplaceCommentsByStatement

@RequestWrapper(localName="getMarketplaceCommentsByStatement",
                targetNamespace="https://www.google.com/apis/ads/publisher/v201802",
                className="com.google.api.ads.dfp.jaxws.v201802.ProposalServiceInterfacegetMarketplaceCommentsByStatement")
 @ResponseWrapper(localName="getMarketplaceCommentsByStatementResponse",
                 targetNamespace="https://www.google.com/apis/ads/publisher/v201802",
                 className="com.google.api.ads.dfp.jaxws.v201802.ProposalServiceInterfacegetMarketplaceCommentsByStatementResponse")
MarketplaceCommentPage getMarketplaceCommentsByStatement(Statement filterStatement)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      throws ApiException_Exception

Gets a MarketplaceCommentPage of MarketplaceComment objects that satisfy the given Statement.query. This method only returns comments already sent to Marketplace, local draft ProposalMarketplaceInfo.marketplaceComment are not included. The following fields are supported for filtering:

PQL Property	Object Property
proposalId	MarketplaceComment.proposalId

The query must specify a proposalId, and only supports a subset of PQL syntax:
[WHERE {AND ...}]
[ORDER BY [ASC | DESC]]
[LIMIT {[,] } | { OFFSET }]

:= =
:= IN
Only supports ORDER BY MarketplaceComment.creationTime.

Parameters:

filterStatement - a Publisher Query Language statement used to filter a set of marketplace comments

filterStatement -

Returns:

the marketplace comments that match the given filter

Throws:

ApiException_Exception

getProposalsByStatement

@RequestWrapper(localName="getProposalsByStatement",
                targetNamespace="https://www.google.com/apis/ads/publisher/v201802",
                className="com.google.api.ads.dfp.jaxws.v201802.ProposalServiceInterfacegetProposalsByStatement")
 @ResponseWrapper(localName="getProposalsByStatementResponse",
                 targetNamespace="https://www.google.com/apis/ads/publisher/v201802",
                 className="com.google.api.ads.dfp.jaxws.v201802.ProposalServiceInterfacegetProposalsByStatementResponse")
ProposalPage getProposalsByStatement(Statement filterStatement)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          throws ApiException_Exception

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

PQL Property	Object Property
id	Proposal.id
dfpOrderId	Proposal.dfpOrderId
name	Proposal.name
status	Proposal.status
isArchived	Proposal.isArchived
approvalStatus Only applicable for proposals using sales management	Proposal.approvalStatus
lastModifiedDateTime	Proposal.lastModifiedDateTime
thirdPartyAdServerId Only applicable for non-programmatic proposals using sales management	Proposal.thirdPartyAdServerId
customThirdPartyAdServerName Only applicable for non-programmatic proposals using sales management	Proposal.customThirdPartyAdServerName
hasOfflineErrors	Proposal.hasOfflineErrors
isProgrammatic	Proposal.isProgrammatic
negotiationStatus Only applicable for programmatic proposals	ProposalMarketplaceInfo.negotiationStatus

Parameters:

filterStatement - a Publisher Query Language statement used to filter a set of proposals

filterStatement -

Returns:

the proposals that match the given filter

Throws:

ApiException_Exception

performProposalAction

@RequestWrapper(localName="performProposalAction",
                targetNamespace="https://www.google.com/apis/ads/publisher/v201802",
                className="com.google.api.ads.dfp.jaxws.v201802.ProposalServiceInterfaceperformProposalAction")
 @ResponseWrapper(localName="performProposalActionResponse",
                 targetNamespace="https://www.google.com/apis/ads/publisher/v201802",
                 className="com.google.api.ads.dfp.jaxws.v201802.ProposalServiceInterfaceperformProposalActionResponse")
UpdateResult performProposalAction(ProposalAction proposalAction,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       Statement filterStatement)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                throws ApiException_Exception

Performs actions on Proposal objects that match the given Statement.query. The following fields are also required when submitting proposals for approval:

• Proposal.advertiser
• Proposal.primarySalesperson
• Proposal.primaryTraffickerId

Parameters:

proposalAction - the action to perform

filterStatement - a Publisher Query Language statement used to filter a set of proposals

filterStatement -

proposalAction -

Returns:

the result of the action performed

Throws:

ApiException_Exception

updateProposals

@RequestWrapper(localName="updateProposals",
                targetNamespace="https://www.google.com/apis/ads/publisher/v201802",
                className="com.google.api.ads.dfp.jaxws.v201802.ProposalServiceInterfaceupdateProposals")
 @ResponseWrapper(localName="updateProposalsResponse",
                 targetNamespace="https://www.google.com/apis/ads/publisher/v201802",
                 className="com.google.api.ads.dfp.jaxws.v201802.ProposalServiceInterfaceupdateProposalsResponse")
List<Proposal> updateProposals(List<Proposal> proposals)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    throws ApiException_Exception

Updates the specified Proposal objects.

Parameters:

proposals - the proposals to update

proposals -

Returns:

the updated proposals

Throws:

ApiException_Exception