• Home
• com.google.api-ads
• dfp-appengine
• 2.14.0
• source code
• ReconciliationOrderReportServiceInterface.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.v201511.ReconciliationOrderReportServiceInterface Maven / Gradle / Ivy

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

import java.util.List;
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 for retrieving, reconciling, and reverting {@link ReconciliationOrderReport}
 *       objects.
 *     
 * 
 * This class was generated by the JAX-WS RI.
 * JAX-WS RI 2.2.9-b130926.1035
 * Generated source version: 2.1
 * 
 */
@WebService(name = "ReconciliationOrderReportServiceInterface", targetNamespace = "https://www.google.com/apis/ads/publisher/v201511")
@XmlSeeAlso({
    ObjectFactory.class
})
public interface ReconciliationOrderReportServiceInterface {


    /**
     * 
     *         Gets an {@link ReconciliationOrderReportPage} of {@link ReconciliationOrderReport} objects
     *         that satisfy the given {@link Statement#query}.
     *         The following fields are supported for filtering:
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
PQL Property
 
Object Property
{@code reconciliationReportId}
{@link ReconciliationOrderReport#reconciliationReportId}
{@code id}
{@link ReconciliationOrderReport#id}
{@code orderId}
{@link ReconciliationOrderReport#orderId}
{@code proposalId}
{@link ReconciliationOrderReport#proposalId}
{@code status}
{@link ReconciliationOrderReport#status}
{@code submissionDateTime}
{@link ReconciliationOrderReport#submissionDateTime}
{@code submitterId}
{@link ReconciliationOrderReport#submitterId}
     *         
     *         The {@code reconciliationReportId} field is required and can only be combined with an
     *         {@code AND} to other conditions. Furthermore, the results may only belong to
     *         one {@link ReconciliationReport}.
     *         
     *         @param filterStatement a Publisher Query Language statement used to filter
     *         a set of reconciliation order reports.
     *         @return the reconciliation order reports that match the given filter.
     *       
     * 
     * @param filterStatement
     * @return
     *     returns com.google.api.ads.dfp.jaxws.v201511.ReconciliationOrderReportPage
     * @throws ApiException_Exception
     */
    @WebMethod
    @WebResult(name = "rval", targetNamespace = "https://www.google.com/apis/ads/publisher/v201511")
    @RequestWrapper(localName = "getReconciliationOrderReportsByStatement", targetNamespace = "https://www.google.com/apis/ads/publisher/v201511", className = "com.google.api.ads.dfp.jaxws.v201511.ReconciliationOrderReportServiceInterfacegetReconciliationOrderReportsByStatement")
    @ResponseWrapper(localName = "getReconciliationOrderReportsByStatementResponse", targetNamespace = "https://www.google.com/apis/ads/publisher/v201511", className = "com.google.api.ads.dfp.jaxws.v201511.ReconciliationOrderReportServiceInterfacegetReconciliationOrderReportsByStatementResponse")
    public ReconciliationOrderReportPage getReconciliationOrderReportsByStatement(
        @WebParam(name = "filterStatement", targetNamespace = "https://www.google.com/apis/ads/publisher/v201511")
        Statement filterStatement)
        throws ApiException_Exception
    ;

    /**
     * 
     *         Performs actions on the {@link ReconciliationOrderReport} objects that match the given
     *         {@link Statement#query}. The following fields are supported for filtering:
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
     *         
PQL Property
 
Object Property
{@code orderId}
{@link ReconciliationOrderReport#orderId}
{@code proposalId}
{@link ReconciliationOrderReport#proposalId}
{@code reconciliationReportId}
{@link ReconciliationOrderReport#reconciliationReportId}
     *         The following statement patterns are supported:
     *         

     *         
reconciliationReportId = :reconciliationReportId AND orderId = :orderId
     *         
reconciliationReportId = :reconciliationReportId AND proposalId = :proposalId
     *         
reconciliationReportId = :reconciliationReportId
     *         AND (orderId IN (...) OR proposalId IN (...))
     *         
     *         The IN clause could be expanded to multiple OR expressions like
     *         (orderId = :orderId OR orderId = :orderId OR ...)
     *         Only orders to which the API user has access will be included.
     *         
     *         @param reconciliationOrderReportAction the action to perform.
     *         @param filterStatement a Publisher Query Language statement used to filter a set of orders and
     *         one reconciliation report.
     *         @return the result of the action performed.
     *       
     * 
     * @param reconciliationOrderReportAction
     * @param filterStatement
     * @return
     *     returns com.google.api.ads.dfp.jaxws.v201511.UpdateResult
     * @throws ApiException_Exception
     */
    @WebMethod
    @WebResult(name = "rval", targetNamespace = "https://www.google.com/apis/ads/publisher/v201511")
    @RequestWrapper(localName = "performReconciliationOrderReportAction", targetNamespace = "https://www.google.com/apis/ads/publisher/v201511", className = "com.google.api.ads.dfp.jaxws.v201511.ReconciliationOrderReportServiceInterfaceperformReconciliationOrderReportAction")
    @ResponseWrapper(localName = "performReconciliationOrderReportActionResponse", targetNamespace = "https://www.google.com/apis/ads/publisher/v201511", className = "com.google.api.ads.dfp.jaxws.v201511.ReconciliationOrderReportServiceInterfaceperformReconciliationOrderReportActionResponse")
    public UpdateResult performReconciliationOrderReportAction(
        @WebParam(name = "reconciliationOrderReportAction", targetNamespace = "https://www.google.com/apis/ads/publisher/v201511")
        ReconciliationOrderReportAction reconciliationOrderReportAction,
        @WebParam(name = "filterStatement", targetNamespace = "https://www.google.com/apis/ads/publisher/v201511")
        Statement filterStatement)
        throws ApiException_Exception
    ;

    /**
     * 
     *         Updates a list of {@link ReconciliationOrderReport reconciliation order reports}
     *         which belong to a {@link ReconciliationReport}.
     *         
     *         @param reconciliationOrderReports a list of
     *         {@link ReconciliationOrderReport reconciliation order reports} to update
     *         @return the updated reconciliation order reports
     *       
     * 
     * @param reconciliationOrderReports
     * @return
     *     returns java.util.List
     * @throws ApiException_Exception
     */
    @WebMethod
    @WebResult(name = "rval", targetNamespace = "https://www.google.com/apis/ads/publisher/v201511")
    @RequestWrapper(localName = "updateReconciliationOrderReports", targetNamespace = "https://www.google.com/apis/ads/publisher/v201511", className = "com.google.api.ads.dfp.jaxws.v201511.ReconciliationOrderReportServiceInterfaceupdateReconciliationOrderReports")
    @ResponseWrapper(localName = "updateReconciliationOrderReportsResponse", targetNamespace = "https://www.google.com/apis/ads/publisher/v201511", className = "com.google.api.ads.dfp.jaxws.v201511.ReconciliationOrderReportServiceInterfaceupdateReconciliationOrderReportsResponse")
    public List updateReconciliationOrderReports(
        @WebParam(name = "reconciliationOrderReports", targetNamespace = "https://www.google.com/apis/ads/publisher/v201511")
        List reconciliationOrderReports)
        throws ApiException_Exception
    ;

}