com.google.api.ads.dfp.axis.v201208
Interface OrderServiceInterface

All Superinterfaces:

Remote

All Known Implementing Classes:

OrderServiceSoapBindingStub

public interface OrderServiceInterface
extends Remote

Method Summary

Order	createOrder(Order order) Creates a new Order.
Order[]	createOrders(Order[] orders) Creates new Order objects.
Order	getOrder(Long orderId) Returns the Order uniquely identified by the given ID.
OrderPage	getOrdersByStatement(Statement filterStatement) Gets an OrderPage of Order objects that satisfy the given Statement.query.
UpdateResult	performOrderAction(OrderAction orderAction, Statement filterStatement) Performs actions on Order objects that match the given Statement.query.
Order	updateOrder(Order order) Updates the specified Order.
Order[]	updateOrders(Order[] orders) Updates the specified Order objects.

Method Detail

createOrder

Order createOrder(Order order)
                  throws RemoteException,
                         ApiException

Creates a new Order. The following fields are required:

• Order.advertiserId
• Order.name
• Order.traffickerId

Parameters:

order - the order to create

Returns:

the order with its ID filled in

Throws:

RemoteException

ApiException

createOrders

Order[] createOrders(Order[] orders)
                     throws RemoteException,
                            ApiException

Creates new Order objects.

Parameters:

orders - the orders to create

Returns:

the created orders with their IDs filled in

Throws:

RemoteException

ApiException

getOrder

Order getOrder(Long orderId)
               throws RemoteException,
                      ApiException

Returns the Order uniquely identified by the given ID.

Parameters:

orderId - the ID of the order, which must already exist

Returns:

the Order uniquely identified by the given ID

Throws:

RemoteException

ApiException

getOrdersByStatement

OrderPage getOrdersByStatement(Statement filterStatement)
                               throws RemoteException,
                                      ApiException

Gets an 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

Parameters:

filterStatement - a Publisher Query Language statement used to filter a set of orders

Returns:

the orders that match the given filter

Throws:

RemoteException

ApiException

performOrderAction

UpdateResult performOrderAction(OrderAction orderAction,
                                Statement filterStatement)
                                throws RemoteException,
                                       ApiException

Performs actions on Order objects that match the given Statement.query.

Parameters:

orderAction - the action to perform

filterStatement - a Publisher Query Language statement used to filter a set of orders

Returns:

the result of the action performed

Throws:

RemoteException

ApiException

updateOrder

Order updateOrder(Order order)
                  throws RemoteException,
                         ApiException

Updates the specified Order.

Parameters:

order - the order to update

Returns:

the updated order

Throws:

RemoteException

ApiException

updateOrders

Order[] updateOrders(Order[] orders)
                     throws RemoteException,
                            ApiException

Updates the specified Order objects.

Parameters:

orders - the orders to update

Returns:

the updated orders

Throws:

RemoteException

ApiException