com.google.api.ads.dfp.axis.v201211

Class LineItemServiceSoapBindingStub

java.lang.Object

org.apache.axis.client.Stub

com.google.api.ads.dfp.axis.v201211.LineItemServiceSoapBindingStub

All Implemented Interfaces:

LineItemServiceInterface, Remote, javax.xml.rpc.Stub

public class LineItemServiceSoapBindingStub
extends org.apache.axis.client.Stub
implements LineItemServiceInterface

Field Summary

Fields inherited from class org.apache.axis.client.Stub

_call, cachedEndpoint, cachedPassword, cachedPortName, cachedProperties, cachedTimeout, cachedUsername, maintainSession, maintainSessionSet, service

Fields inherited from interface javax.xml.rpc.Stub

ENDPOINT_ADDRESS_PROPERTY, PASSWORD_PROPERTY, SESSION_MAINTAIN_PROPERTY, USERNAME_PROPERTY

Constructor Summary

Constructors

Constructor and Description
LineItemServiceSoapBindingStub()
LineItemServiceSoapBindingStub(javax.xml.rpc.Service service)
LineItemServiceSoapBindingStub(URL endpointURL, javax.xml.rpc.Service service)

Method Summary

Methods

Modifier and Type	Method and Description
protected org.apache.axis.client.Call	createCall()
LineItem	createLineItem(LineItem lineItem) Creates a new LineItem.
LineItem[]	createLineItems(LineItem[] lineItems) Creates new LineItem objects.
LineItem	getLineItem(Long lineItemId) Returns the LineItem uniquely identified by the given ID.
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	updateLineItem(LineItem lineItem) Updates the specified LineItem.
LineItem[]	updateLineItems(LineItem[] lineItems) Updates the specified LineItem objects.

Methods inherited from class org.apache.axis.client.Stub

_createCall, _getCall, _getProperty, _getPropertyNames, _getService, _setProperty, addAttachment, clearAttachments, clearHeaders, extractAttachments, firstCall, getAttachments, getHeader, getHeaders, getPassword, getPortName, getResponseHeader, getResponseHeaders, getResponseHeaders, getTimeout, getUsername, removeProperty, setAttachments, setHeader, setHeader, setMaintainSession, setPassword, setPortName, setPortName, setRequestHeaders, setTimeout, setUsername

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LineItemServiceSoapBindingStub

public LineItemServiceSoapBindingStub()
                               throws org.apache.axis.AxisFault

Throws:

org.apache.axis.AxisFault

LineItemServiceSoapBindingStub

public LineItemServiceSoapBindingStub(URL endpointURL,
                              javax.xml.rpc.Service service)
                               throws org.apache.axis.AxisFault

Throws:

org.apache.axis.AxisFault

LineItemServiceSoapBindingStub

public LineItemServiceSoapBindingStub(javax.xml.rpc.Service service)
                               throws org.apache.axis.AxisFault

Throws:

org.apache.axis.AxisFault

Method Detail

createCall

protected org.apache.axis.client.Call createCall()
                                          throws RemoteException

Throws:

RemoteException

createLineItem

public LineItem createLineItem(LineItem lineItem)
                        throws RemoteException,
                               ApiException

Description copied from interface: LineItemServiceInterface

Creates a new LineItem. These fields are required:

• LineItemSummary.costPerUnit
• LineItemSummary.costType
• LineItemSummary.endDateTime
• LineItemSummary.lineItemType
• LineItemSummary.name
• LineItemSummary.orderId
• LineItemSummary.startDateTime
• LineItemSummary.unitsBought
• LineItemSummary.creativePlaceholders
• LineItem.targeting

Specified by:

createLineItem in interface LineItemServiceInterface

Parameters:

lineItem - the line item to create

Returns:

the line item with its ID filled in

Throws:

RemoteException

ApiException

createLineItems

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

Description copied from interface: LineItemServiceInterface

Creates new LineItem objects.

Specified by:

createLineItems in interface LineItemServiceInterface

Parameters:

lineItems - the line items to create

Returns:

the created line items with their IDs filled in

Throws:

RemoteException

ApiException

getLineItem

public LineItem getLineItem(Long lineItemId)
                     throws RemoteException,
                            ApiException

Description copied from interface: LineItemServiceInterface

Returns the LineItem uniquely identified by the given ID.

Specified by:

getLineItem in interface LineItemServiceInterface

Parameters:

lineItemId - the ID of the line item, which must already exist

Returns:

the LineItem uniquely identified by the given ID

Throws:

RemoteException

ApiException

getLineItemsByStatement

public LineItemPage getLineItemsByStatement(Statement filterStatement)
                                     throws RemoteException,
                                            ApiException

Description copied from interface: LineItemServiceInterface

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	LineItem#creationDateTime
isMissingCreatives	LineItem#isMissingCreatives

Specified by:

getLineItemsByStatement in interface LineItemServiceInterface

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

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

Description copied from interface: LineItemServiceInterface

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

Specified by:

performLineItemAction in interface LineItemServiceInterface

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

updateLineItem

public LineItem updateLineItem(LineItem lineItem)
                        throws RemoteException,
                               ApiException

Description copied from interface: LineItemServiceInterface

Updates the specified LineItem.

Specified by:

updateLineItem in interface LineItemServiceInterface

Parameters:

lineItem - the line item to update

Returns:

the updated line item

Throws:

RemoteException

ApiException

updateLineItems

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

Description copied from interface: LineItemServiceInterface

Updates the specified LineItem objects.

Specified by:

updateLineItems in interface LineItemServiceInterface

Parameters:

lineItems - the line items to update

Returns:

the updated line items

Throws:

RemoteException

ApiException