com.google.api.ads.admanager.axis.v201905

Interface LineItemServiceInterface

All Superinterfaces:

Remote

All Known Implementing Classes:

LineItemServiceSoapBindingStub

public interface LineItemServiceInterface
extends Remote

Method Summary

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.
Boolean	hasCustomPacingCurve(Long lineItemId) Returns whether a custom pacing curve has been uploaded to Google Cloud Storage for a line item.
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	Entity property
CostType	LineItemSummary.costType
CreationDateTime	LineItemSummary.creationDateTime
DeliveryRateType	LineItemSummary.deliveryRateType
EndDateTime	LineItemSummary.endDateTime
ExternalId	LineItemSummary.externalId
Id	LineItemSummary.id
IsMissingCreatives	LineItemSummary.isMissingCreatives
IsSetTopBoxEnabled	LineItemSummary.isSetTopBoxEnabled
LastModifiedDateTime	LineItemSummary.lastModifiedDateTime
LineItemType	LineItemSummary.lineItemType
Name	LineItemSummary.name
OrderId	LineItemSummary.orderId
StartDateTime	LineItemSummary.startDateTime
Status	LineItemSummary.status
UnitsBought	LineItem#unitsBought

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

hasCustomPacingCurve

Boolean hasCustomPacingCurve(Long lineItemId)
                      throws RemoteException,
                             ApiException

Returns whether a custom pacing curve has been uploaded to Google Cloud Storage for a line item.

Parameters:

lineItemId - the ID of the line item

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