public interface OrderServiceInterface
Order objects.
An order is a grouping of LineItem objects. Line items have a
many-to-one relationship with orders, meaning each line item can belong to only one
order, but orders can have multiple line items. An order can be used to
manage the line items it contains.
| Modifier and Type | Method and Description |
|---|---|
List<Order> |
createOrders(List<Order> orders)
Creates new
Order objects. |
OrderPage |
getOrdersByStatement(Statement filterStatement)
|
UpdateResult |
performOrderAction(OrderAction orderAction,
Statement filterStatement)
Performs actions on
Order objects that match the given
Statement.query. |
List<Order> |
updateOrders(List<Order> orders)
Updates the specified
Order objects. |
@RequestWrapper(localName="createOrders", targetNamespace="https://www.google.com/apis/ads/publisher/v201708", className="com.google.api.ads.dfp.jaxws.v201708.OrderServiceInterfacecreateOrders") @ResponseWrapper(localName="createOrdersResponse", targetNamespace="https://www.google.com/apis/ads/publisher/v201708", className="com.google.api.ads.dfp.jaxws.v201708.OrderServiceInterfacecreateOrdersResponse") List<Order> createOrders(List<Order> orders) throws ApiException_Exception
Order objects.orders - the orders to createorders - ApiException_Exception@RequestWrapper(localName="getOrdersByStatement", targetNamespace="https://www.google.com/apis/ads/publisher/v201708", className="com.google.api.ads.dfp.jaxws.v201708.OrderServiceInterfacegetOrdersByStatement") @ResponseWrapper(localName="getOrdersByStatementResponse", targetNamespace="https://www.google.com/apis/ads/publisher/v201708", className="com.google.api.ads.dfp.jaxws.v201708.OrderServiceInterfacegetOrdersByStatementResponse") OrderPage getOrdersByStatement(Statement filterStatement) throws ApiException_Exception
OrderPage of Order objects that satisfy the given
Statement.query. The following fields are supported for filtering:
| PQL Property | Object Property |
|---|---|
advertiserId |
Order.advertiserId |
endDateTime |
Order.endDateTime |
id |
Order.id |
name |
Order.name |
salespersonId |
Order.salespersonId |
startDateTime |
Order.startDateTime |
status |
Order.status |
traffickerId |
Order.traffickerId |
lastModifiedDateTime |
Order.lastModifiedDateTime |
filterStatement - a Publisher Query Language statement used to filter
a set of ordersfilterStatement - ApiException_Exception@RequestWrapper(localName="performOrderAction", targetNamespace="https://www.google.com/apis/ads/publisher/v201708", className="com.google.api.ads.dfp.jaxws.v201708.OrderServiceInterfaceperformOrderAction") @ResponseWrapper(localName="performOrderActionResponse", targetNamespace="https://www.google.com/apis/ads/publisher/v201708", className="com.google.api.ads.dfp.jaxws.v201708.OrderServiceInterfaceperformOrderActionResponse") UpdateResult performOrderAction(OrderAction orderAction, Statement filterStatement) throws ApiException_Exception
Order objects that match the given
Statement.query.orderAction - the action to performfilterStatement - a Publisher Query Language statement used to filter
a set of ordersfilterStatement - orderAction - ApiException_Exception@RequestWrapper(localName="updateOrders", targetNamespace="https://www.google.com/apis/ads/publisher/v201708", className="com.google.api.ads.dfp.jaxws.v201708.OrderServiceInterfaceupdateOrders") @ResponseWrapper(localName="updateOrdersResponse", targetNamespace="https://www.google.com/apis/ads/publisher/v201708", className="com.google.api.ads.dfp.jaxws.v201708.OrderServiceInterfaceupdateOrdersResponse") List<Order> updateOrders(List<Order> orders) throws ApiException_Exception
Order objects.orders - the orders to updateorders - ApiException_ExceptionCopyright © 2018. All Rights Reserved.