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

Interface WorkflowRequestServiceInterface

public interface WorkflowRequestServiceInterface

Provides methods to retrieve and perform actions on WorkflowRequest 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
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

@RequestWrapper(localName="getWorkflowRequestsByStatement",
                targetNamespace="https://www.google.com/apis/ads/publisher/v201802",
                className="com.google.api.ads.dfp.jaxws.v201802.WorkflowRequestServiceInterfacegetWorkflowRequestsByStatement")
 @ResponseWrapper(localName="getWorkflowRequestsByStatementResponse",
                 targetNamespace="https://www.google.com/apis/ads/publisher/v201802",
                 className="com.google.api.ads.dfp.jaxws.v201802.WorkflowRequestServiceInterfacegetWorkflowRequestsByStatementResponse")
WorkflowRequestPage getWorkflowRequestsByStatement(Statement filterStatement)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  throws ApiException_Exception

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

The type filter is required in v201705 and earlier.

Parameters:

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

filterStatement -

Returns:

the workflow requests that match the given filter

Throws:

ApiException_Exception

performWorkflowRequestAction

@RequestWrapper(localName="performWorkflowRequestAction",
                targetNamespace="https://www.google.com/apis/ads/publisher/v201802",
                className="com.google.api.ads.dfp.jaxws.v201802.WorkflowRequestServiceInterfaceperformWorkflowRequestAction")
 @ResponseWrapper(localName="performWorkflowRequestActionResponse",
                 targetNamespace="https://www.google.com/apis/ads/publisher/v201802",
                 className="com.google.api.ads.dfp.jaxws.v201802.WorkflowRequestServiceInterfaceperformWorkflowRequestActionResponse")
UpdateResult performWorkflowRequestAction(WorkflowRequestAction action,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Statement filterStatement)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 throws ApiException_Exception

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

filterStatement -

action -

Returns:

the result of the action performed

Throws:

ApiException_Exception