com.google.api.ads.dfp.axis.v201311

Interface ReconciliationOrderReportServiceInterface

All Superinterfaces:

Remote

All Known Implementing Classes:

ReconciliationOrderReportServiceSoapBindingStub

public interface ReconciliationOrderReportServiceInterface
extends Remote

Method Summary

Methods

Modifier and Type	Method and Description
ReconciliationOrderReport	getReconciliationOrderReport(Long reconciliationOrderReportId) Returns the ReconciliationOrderReport object uniquely identified by given ID.
ReconciliationOrderReportPage	getReconciliationOrderReportsByStatement(Statement filterStatement) Gets an ReconciliationOrderReportPage of ReconciliationOrderReport objects that satisfy the given Statement.query.
UpdateResult	performReconciliationOrderReportAction(ReconciliationOrderReportAction reconciliationOrderReportAction, Statement filterStatement) Performs actions on the ReconciliationOrderReport objects that match the given Statement.query.

Method Detail

getReconciliationOrderReport

ReconciliationOrderReport getReconciliationOrderReport(Long reconciliationOrderReportId)
                                                       throws RemoteException,
                                                              ApiException

Returns the ReconciliationOrderReport object uniquely identified by given ID.

Parameters:

reconciliationOrderReportId - the ID of the ReconciliationOrderReport, which must already exist.

Returns:

the ReconciliationOrderReport uniquely identified by given ID.

Throws:

RemoteException

ApiException

getReconciliationOrderReportsByStatement

ReconciliationOrderReportPage getReconciliationOrderReportsByStatement(Statement filterStatement)
                                                                       throws RemoteException,
                                                                              ApiException

Gets an ReconciliationOrderReportPage of ReconciliationOrderReport objects that satisfy the given Statement.query. The following fields are supported for filtering:

PQL Property	Object Property
reconciliationReportId	ReconciliationOrderReport.reconciliationReportId
id	ReconciliationOrderReport.id
orderId	ReconciliationOrderReport.orderId
status	ReconciliationOrderReport.status
submissionDateTime	ReconciliationOrderReport.submissionDateTime
submitterId	ReconciliationOrderReport.submitterId

The reconciliationReportId field is required and can only be combined with an AND to other conditions. Furthermore, the results may only belong to one ReconciliationReport.

Parameters:

filterStatement - a Publisher Query Language statement used to filter a set of reconciliation order reports.

Returns:

the reconciliation order reports that match the given filter.

Throws:

RemoteException

ApiException

performReconciliationOrderReportAction

UpdateResult performReconciliationOrderReportAction(ReconciliationOrderReportAction reconciliationOrderReportAction,
                                                  Statement filterStatement)
                                                    throws RemoteException,
                                                           ApiException

Performs actions on the ReconciliationOrderReport objects that match the given Statement.query. The following fields are supported for filtering:

PQL Property	Object Property
orderId	ReconciliationOrderReport.orderId
reconciliationReportId	ReconciliationOrderReport.reconciliationReportId

The reconciliationReportId field and orderId are required and can only be combined with an AND. Furthermore, the results may only belong to one ReconciliationReport. Only orders to which the API user has access will be included.

Parameters:

reconciliationOrderReportAction - the action to perform.

filterStatement - a Publisher Query Language statement used to filter a set of orders and one reconciliation report.

Returns:

the result of the action performed.

Throws:

RemoteException

ApiException