com.google.api.ads.dfp.jaxws.v201708

Interface LineItemServiceInterface

public interface LineItemServiceInterface

Provides methods for creating, updating and retrieving LineItem objects.

Line items define the campaign. For example, line items define:

• a budget
• a span of time to run
• ad unit targeting

In short, line items connect all of the elements of an ad campaign.

Line items and creatives can be associated with each other through LineItemCreativeAssociation objects. An ad unit will host a creative through both this association and the LineItem.targeting to it. The delivery of a line item depends on its priority. More information on line item priorities can be found on the DFP Help Center. This class was generated by the JAX-WS RI. JAX-WS RI 2.2.9-b130926.1035 Generated source version: 2.1

Method Summary

Modifier and Type	Method and Description
List<LineItem>	createLineItems(List<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.
List<LineItem>	updateLineItems(List<LineItem> lineItems) Updates the specified LineItem objects.

Method Detail

createLineItems

@RequestWrapper(localName="createLineItems",
                targetNamespace="https://www.google.com/apis/ads/publisher/v201708",
                className="com.google.api.ads.dfp.jaxws.v201708.LineItemServiceInterfacecreateLineItems")
 @ResponseWrapper(localName="createLineItemsResponse",
                 targetNamespace="https://www.google.com/apis/ads/publisher/v201708",
                 className="com.google.api.ads.dfp.jaxws.v201708.LineItemServiceInterfacecreateLineItemsResponse")
List<LineItem> createLineItems(List<LineItem> lineItems)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    throws ApiException_Exception

Creates new LineItem objects.

Parameters:

lineItems - the line items to create

lineItems -

Returns:

the created line items with their IDs filled in

Throws:

ApiException_Exception

getLineItemsByStatement

@RequestWrapper(localName="getLineItemsByStatement",
                targetNamespace="https://www.google.com/apis/ads/publisher/v201708",
                className="com.google.api.ads.dfp.jaxws.v201708.LineItemServiceInterfacegetLineItemsByStatement")
 @ResponseWrapper(localName="getLineItemsByStatementResponse",
                 targetNamespace="https://www.google.com/apis/ads/publisher/v201708",
                 className="com.google.api.ads.dfp.jaxws.v201708.LineItemServiceInterfacegetLineItemsByStatementResponse")
LineItemPage getLineItemsByStatement(Statement filterStatement)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          throws ApiException_Exception

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
Targeting	LineItem.targeting
UnitsBought	LineItem#unitsBought

Parameters:

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

filterStatement -

Returns:

the line items that match the given filter

Throws:

ApiException_Exception

performLineItemAction

@RequestWrapper(localName="performLineItemAction",
                targetNamespace="https://www.google.com/apis/ads/publisher/v201708",
                className="com.google.api.ads.dfp.jaxws.v201708.LineItemServiceInterfaceperformLineItemAction")
 @ResponseWrapper(localName="performLineItemActionResponse",
                 targetNamespace="https://www.google.com/apis/ads/publisher/v201708",
                 className="com.google.api.ads.dfp.jaxws.v201708.LineItemServiceInterfaceperformLineItemActionResponse")
UpdateResult performLineItemAction(LineItemAction lineItemAction,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       Statement filterStatement)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                throws ApiException_Exception

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

filterStatement -

lineItemAction -

Returns:

the result of the action performed

Throws:

ApiException_Exception

updateLineItems

@RequestWrapper(localName="updateLineItems",
                targetNamespace="https://www.google.com/apis/ads/publisher/v201708",
                className="com.google.api.ads.dfp.jaxws.v201708.LineItemServiceInterfaceupdateLineItems")
 @ResponseWrapper(localName="updateLineItemsResponse",
                 targetNamespace="https://www.google.com/apis/ads/publisher/v201708",
                 className="com.google.api.ads.dfp.jaxws.v201708.LineItemServiceInterfaceupdateLineItemsResponse")
List<LineItem> updateLineItems(List<LineItem> lineItems)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    throws ApiException_Exception

Updates the specified LineItem objects.

Parameters:

lineItems - the line items to update

lineItems -

Returns:

the updated line items

Throws:

ApiException_Exception