com.google.api.ads.dfp.axis.v201311

Interface ProposalServiceInterface

All Superinterfaces:

Remote

All Known Implementing Classes:

ProposalServiceSoapBindingStub

public interface ProposalServiceInterface
extends Remote

Method Summary

Methods

Modifier and Type	Method and Description
Proposal	createProposal(Proposal proposal) Creates a new Proposal.
Proposal[]	createProposals(Proposal[] proposals) Creates new Proposal objects.
Proposal	getProposal(Long proposalId) Returns the Proposal uniquely identified by the given ID.
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	updateProposal(Proposal proposal) Updates the specified Proposal.
Proposal[]	updateProposals(Proposal[] proposals) Updates the specified Proposal objects.

Method Detail

createProposal

Proposal createProposal(Proposal proposal)
                        throws RemoteException,
                               ApiException

Creates a new Proposal. The following fields are required:

• Proposal.name

Parameters:

proposal - the proposal to create

Returns:

the created proposal with its ID filled in

Throws:

RemoteException

ApiException

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

getProposal

Proposal getProposal(Long proposalId)
                     throws RemoteException,
                            ApiException

Returns the Proposal uniquely identified by the given ID.

Parameters:

proposalId - the ID of the proposal, which must already exist

Returns:

the proposal uniquely identified by the given ID

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
name	Proposal.name
status	Proposal.status
isArchived	Proposal.isArchived
approvalStatus	Proposal.approvalStatus
lastModifiedDateTime	Proposal.lastModifiedDateTime

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

updateProposal

Proposal updateProposal(Proposal proposal)
                        throws RemoteException,
                               ApiException

Updates the specified Proposal.

Parameters:

proposal - the proposal to update

Returns:

the updated proposal

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