• Home
• com.google.api-ads
• dfp-appengine
• 2.14.0
• source code
• WorkflowRequestServiceInterface.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

com.google.api.ads.dfp.jaxws.v201505.WorkflowRequestServiceInterface Maven / Gradle / Ivy

package com.google.api.ads.dfp.jaxws.v201505;

import javax.jws.WebMethod;
import javax.jws.WebParam;
import javax.jws.WebResult;
import javax.jws.WebService;
import javax.xml.bind.annotation.XmlSeeAlso;
import javax.xml.ws.RequestWrapper;
import javax.xml.ws.ResponseWrapper;


/**
 * 
 *       Provides methods to retrieve and perform actions on {@link 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
 * 
 */
@WebService(name = "WorkflowRequestServiceInterface", targetNamespace = "https://www.google.com/apis/ads/publisher/v201505")
@XmlSeeAlso({
    ObjectFactory.class
})
public interface WorkflowRequestServiceInterface {


    /**
     * 
     *         Gets a list of {@link WorkflowRequest} objects that satisfy the given {@link Statement#query}.
     *         The following fields are supported for filtering:
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
PQL Property
Object Property
{@code id}
{@link WorkflowRequest#id}
{@code workflowRuleName}
{@link WorkflowRequest#workflowRuleName}
{@code entityType}
{@link WorkflowRequest#entityType}
{@code entityId}
{@link WorkflowRequest#entityId}
{@code approvalStatus}
{@link WorkflowApprovalRequest#status}
{@code conditionStatus}
{@link WorkflowExternalConditionRequest#status}
{@code type}
{@link WorkflowRequest#type}
     *         
Starting in V201405 a {@code type} filter must be used
     *         @param filterStatement a Publisher Query Language statement used to filter a set of proposals
     *         @return the workflow requests that match the given filter
     *       
     * 
     * @param filterStatement
     * @return
     *     returns com.google.api.ads.dfp.jaxws.v201505.WorkflowRequestPage
     * @throws ApiException_Exception
     */
    @WebMethod
    @WebResult(name = "rval", targetNamespace = "https://www.google.com/apis/ads/publisher/v201505")
    @RequestWrapper(localName = "getWorkflowRequestsByStatement", targetNamespace = "https://www.google.com/apis/ads/publisher/v201505", className = "com.google.api.ads.dfp.jaxws.v201505.WorkflowRequestServiceInterfacegetWorkflowRequestsByStatement")
    @ResponseWrapper(localName = "getWorkflowRequestsByStatementResponse", targetNamespace = "https://www.google.com/apis/ads/publisher/v201505", className = "com.google.api.ads.dfp.jaxws.v201505.WorkflowRequestServiceInterfacegetWorkflowRequestsByStatementResponse")
    public WorkflowRequestPage getWorkflowRequestsByStatement(
        @WebParam(name = "filterStatement", targetNamespace = "https://www.google.com/apis/ads/publisher/v201505")
        Statement filterStatement)
        throws ApiException_Exception
    ;

    /**
     * 
     *         Perform actions on {@link WorkflowRequest} objects that match the given
     *         {@link Statement#query}.
     *         
     *         @param action the action to perform
     *         @param filterStatement a Publisher Query Language statement used to filter a set of workflow
     *         requests
     *         @return the result of the action performed
     *       
     * 
     * @param filterStatement
     * @param action
     * @return
     *     returns com.google.api.ads.dfp.jaxws.v201505.UpdateResult
     * @throws ApiException_Exception
     */
    @WebMethod
    @WebResult(name = "rval", targetNamespace = "https://www.google.com/apis/ads/publisher/v201505")
    @RequestWrapper(localName = "performWorkflowRequestAction", targetNamespace = "https://www.google.com/apis/ads/publisher/v201505", className = "com.google.api.ads.dfp.jaxws.v201505.WorkflowRequestServiceInterfaceperformWorkflowRequestAction")
    @ResponseWrapper(localName = "performWorkflowRequestActionResponse", targetNamespace = "https://www.google.com/apis/ads/publisher/v201505", className = "com.google.api.ads.dfp.jaxws.v201505.WorkflowRequestServiceInterfaceperformWorkflowRequestActionResponse")
    public UpdateResult performWorkflowRequestAction(
        @WebParam(name = "action", targetNamespace = "https://www.google.com/apis/ads/publisher/v201505")
        WorkflowRequestAction action,
        @WebParam(name = "filterStatement", targetNamespace = "https://www.google.com/apis/ads/publisher/v201505")
        Statement filterStatement)
        throws ApiException_Exception
    ;

}