com.google.api.ads.admanager.axis.v201808

Interface ReconciliationOrderReportServiceInterface

All Superinterfaces:

Remote

All Known Implementing Classes:

ReconciliationOrderReportServiceSoapBindingStub

public interface ReconciliationOrderReportServiceInterface
extends Remote

Method Summary

Modifier and Type	Method and Description
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.
ReconciliationOrderReport[]	updateReconciliationOrderReports(ReconciliationOrderReport[] reconciliationOrderReports) Updates a list of reconciliation order reports which belong to a ReconciliationReport.

Method Detail

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
proposalId	ReconciliationOrderReport.proposalId
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
proposalId	ReconciliationOrderReport.proposalId
reconciliationReportId	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.

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

updateReconciliationOrderReports

ReconciliationOrderReport[] updateReconciliationOrderReports(ReconciliationOrderReport[] reconciliationOrderReports)
                                                      throws RemoteException,
                                                             ApiException

Updates a list of reconciliation order reports which belong to a ReconciliationReport.

Parameters:

reconciliationOrderReports - a list of reconciliation order reports to update

Returns:

the updated reconciliation order reports

Throws:

RemoteException

ApiException