com.google.api.ads.dfp.axis.v201605

Interface ProposalServiceInterface

All Superinterfaces:

Remote

All Known Implementing Classes:

ProposalServiceSoapBindingStub

public interface ProposalServiceInterface
extends Remote

Method Summary

Modifier and Type	Method and Description
Proposal[]	createProposals(Proposal[] proposals) Creates new Proposal objects.
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.
Proposal[]	updateProposals(Proposal[] proposals) Updates the specified Proposal objects.

Method Detail

createProposals

Proposal[] createProposals(Proposal[] proposals)
                    throws RemoteException,
                           ApiException

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

• Proposal.name

Parameters:

proposals - the proposals to create

Returns:

the created proposals with their IDs filled in

Throws:

RemoteException

ApiException

getProposalsByStatement

ProposalPage getProposalsByStatement(Statement filterStatement)
                              throws RemoteException,
                                     ApiException

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

Returns:

the proposals that match the given filter

Throws:

RemoteException

ApiException

performProposalAction

UpdateResult performProposalAction(ProposalAction proposalAction,
                                   Statement filterStatement)
                            throws RemoteException,
                                   ApiException

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

Returns:

the result of the action performed

Throws:

RemoteException

ApiException

updateProposals

Proposal[] updateProposals(Proposal[] proposals)
                    throws RemoteException,
                           ApiException

Updates the specified Proposal objects.

Parameters:

proposals - the proposals to update

Returns:

the updated proposals

Throws:

RemoteException

ApiException