com.google.api.ads.dfp.axis.v201405

Interface WorkflowRequestServiceInterface

All Superinterfaces:

Remote

All Known Implementing Classes:

WorkflowRequestServiceSoapBindingStub

public interface WorkflowRequestServiceInterface
extends Remote

Method Summary

Methods

Modifier and Type	Method and Description
WorkflowRequestPage	getWorkflowRequestsByStatement(Statement filterStatement) Gets a list of WorkflowRequest objects that satisfy the given Statement.query.
UpdateResult	performWorkflowRequestAction(WorkflowRequestAction action, Statement filterStatement) Perform actions on WorkflowRequest objects that match the given Statement.query.

Method Detail

getWorkflowRequestsByStatement

WorkflowRequestPage getWorkflowRequestsByStatement(Statement filterStatement)
                                                   throws RemoteException,
                                                          ApiException

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

PQL Property	Object Property
id	WorkflowRequest.id
workflowRuleName	WorkflowRequest.workflowRuleName
entityType	WorkflowRequest.entityType
entityId	WorkflowRequest.entityId
approvalStatus	WorkflowApprovalRequest.status
conditionStatus	WorkflowExternalConditionRequest.status
type	WorkflowRequest.type

Starting in V201405 a type filter must be used

Parameters:

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

Returns:

the workflow requests that match the given filter

Throws:

RemoteException

ApiException

performWorkflowRequestAction

UpdateResult performWorkflowRequestAction(WorkflowRequestAction action,
                                        Statement filterStatement)
                                          throws RemoteException,
                                                 ApiException

Perform actions on WorkflowRequest objects that match the given Statement.query.

Parameters:

action - the action to perform

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

Returns:

the result of the action performed

Throws:

RemoteException

ApiException