com.google.api.ads.admanager.axis.v202108

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.
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.
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

getMarketplaceCommentsByStatement

MarketplaceCommentPage getMarketplaceCommentsByStatement(Statement filterStatement)
                                                  throws RemoteException,
                                                         ApiException

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

Returns:

the marketplace comments that match the given filter

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
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