com.google.api.ads.dfp.axis.v201403

Interface LineItemServiceInterface

All Superinterfaces:

Remote

All Known Implementing Classes:

LineItemServiceSoapBindingStub

public interface LineItemServiceInterface
extends Remote

Method Summary

Methods

Modifier and Type	Method and Description
LineItem[]	createLineItems(LineItem[] lineItems) Creates new LineItem objects.
LineItemPage	getLineItemsByStatement(Statement filterStatement) Gets a LineItemPage of LineItem objects that satisfy the given Statement.query.
UpdateResult	performLineItemAction(LineItemAction lineItemAction, Statement filterStatement) Performs actions on LineItem objects that match the given Statement.query.
LineItem[]	updateLineItems(LineItem[] lineItems) Updates the specified LineItem objects.

Method Detail

createLineItems

LineItem[] createLineItems(LineItem[] lineItems)
                           throws RemoteException,
                                  ApiException

Creates new LineItem objects.

Parameters:

lineItems - the line items to create

Returns:

the created line items with their IDs filled in

Throws:

RemoteException

ApiException

getLineItemsByStatement

LineItemPage getLineItemsByStatement(Statement filterStatement)
                                     throws RemoteException,
                                            ApiException

Gets a LineItemPage of LineItem objects that satisfy the given Statement.query. The following fields are supported for filtering:

PQL Property	Object Property
costType	LineItemSummary.costType
id	LineItemSummary.id
lineItemType	LineItemSummary.lineItemType
name	LineItemSummary.name
orderId	LineItemSummary.orderId
status	LineItemSummary.status
unitsBought	LineItemSummary.unitsBought
deliveryRateType	LineItemSummary.deliveryRateType
lastModifiedDateTime	LineItemSummary.lastModifiedDateTime
creationDateTime	LineItemSummary.creationDateTime
isMissingCreatives	LineItemSummary.isMissingCreatives

Parameters:

filterStatement - a Publisher Query Language statement used to filter a set of line items.

Returns:

the line items that match the given filter

Throws:

RemoteException

ApiException

performLineItemAction

UpdateResult performLineItemAction(LineItemAction lineItemAction,
                                 Statement filterStatement)
                                   throws RemoteException,
                                          ApiException

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

Parameters:

lineItemAction - the action to perform

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

Returns:

the result of the action performed

Throws:

RemoteException

ApiException

updateLineItems

LineItem[] updateLineItems(LineItem[] lineItems)
                           throws RemoteException,
                                  ApiException

Updates the specified LineItem objects.

Parameters:

lineItems - the line items to update

Returns:

the updated line items

Throws:

RemoteException

ApiException