Ads API .NET library
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
Google.Api.Ads.AdManager.v202208.LineItemService Class Reference

Provides methods for creating, updating and retrieving LineItem objects. More...

Inheritance diagram for Google.Api.Ads.AdManager.v202208.LineItemService:
Google.Api.Ads.AdManager.v202208.ILineItemService Google.Api.Ads.AdManager.v202208.LineItemServiceInterface

Public Member Functions

 LineItemService ()
 Creates a new instance of the LineItemService class. More...
 
 LineItemService (string endpointConfigurationName)
 Creates a new instance of the LineItemService class. More...
 
 LineItemService (string endpointConfigurationName, string remoteAddress)
 Creates a new instance of the LineItemService class. More...
 
 LineItemService (string endpointConfigurationName, System.ServiceModel.EndpointAddress remoteAddress)
 Creates a new instance of the LineItemService class. More...
 
 LineItemService (System.ServiceModel.Channels.Binding binding, System.ServiceModel.EndpointAddress remoteAddress)
 Creates a new instance of the LineItemService class. More...
 
virtual
Google.Api.Ads.AdManager.v202208.LineItem[] 
createLineItems (Google.Api.Ads.AdManager.v202208.LineItem[] lineItems)
 Creates new LineItem objects. More...
 
virtual
System.Threading.Tasks.Task
< Google.Api.Ads.AdManager.v202208.LineItem[]> 
createLineItemsAsync (Google.Api.Ads.AdManager.v202208.LineItem[] lineItems)
 
virtual
Google.Api.Ads.AdManager.v202208.LineItemPage 
getLineItemsByStatement (Google.Api.Ads.AdManager.v202208.Statement filterStatement)
 Gets a LineItemPage of LineItem objects that satisfy the given Statement::query. The following fields are supported for filtering: More...
 
virtual
System.Threading.Tasks.Task
< Google.Api.Ads.AdManager.v202208.LineItemPage
getLineItemsByStatementAsync (Google.Api.Ads.AdManager.v202208.Statement filterStatement)
 
virtual
Google.Api.Ads.AdManager.v202208.UpdateResult 
performLineItemAction (Google.Api.Ads.AdManager.v202208.LineItemAction lineItemAction, Google.Api.Ads.AdManager.v202208.Statement filterStatement)
 Performs actions on LineItem objects that match the given Statement::query. More...
 
virtual
System.Threading.Tasks.Task
< Google.Api.Ads.AdManager.v202208.UpdateResult
performLineItemActionAsync (Google.Api.Ads.AdManager.v202208.LineItemAction lineItemAction, Google.Api.Ads.AdManager.v202208.Statement filterStatement)
 
virtual
Google.Api.Ads.AdManager.v202208.LineItem[] 
updateLineItems (Google.Api.Ads.AdManager.v202208.LineItem[] lineItems)
 Updates the specified LineItem objects. More...
 
virtual
System.Threading.Tasks.Task
< Google.Api.Ads.AdManager.v202208.LineItem[]> 
updateLineItemsAsync (Google.Api.Ads.AdManager.v202208.LineItem[] lineItems)
 

Detailed Description

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.

Constructor & Destructor Documentation

Google.Api.Ads.AdManager.v202208.LineItemService.LineItemService ( )
inline

Creates a new instance of the LineItemService class.

Google.Api.Ads.AdManager.v202208.LineItemService.LineItemService ( string  endpointConfigurationName)
inline

Creates a new instance of the LineItemService class.

Google.Api.Ads.AdManager.v202208.LineItemService.LineItemService ( string  endpointConfigurationName,
string  remoteAddress 
)
inline

Creates a new instance of the LineItemService class.

Google.Api.Ads.AdManager.v202208.LineItemService.LineItemService ( string  endpointConfigurationName,
System.ServiceModel.EndpointAddress  remoteAddress 
)
inline

Creates a new instance of the LineItemService class.

Google.Api.Ads.AdManager.v202208.LineItemService.LineItemService ( System.ServiceModel.Channels.Binding  binding,
System.ServiceModel.EndpointAddress  remoteAddress 
)
inline

Creates a new instance of the LineItemService class.

Member Function Documentation

virtual Google.Api.Ads.AdManager.v202208.LineItem [] Google.Api.Ads.AdManager.v202208.LineItemService.createLineItems ( Google.Api.Ads.AdManager.v202208.LineItem[]  lineItems)
inlinevirtual

Creates new LineItem objects.

Parameters
lineItemsthe line items to create
Returns
the created line items with their IDs filled in

Implements Google.Api.Ads.AdManager.v202208.ILineItemService.

virtual System.Threading.Tasks.Task<Google.Api.Ads.AdManager.v202208.LineItem[]> Google.Api.Ads.AdManager.v202208.LineItemService.createLineItemsAsync ( Google.Api.Ads.AdManager.v202208.LineItem[]  lineItems)
inlinevirtual
virtual Google.Api.Ads.AdManager.v202208.LineItemPage Google.Api.Ads.AdManager.v202208.LineItemService.getLineItemsByStatement ( Google.Api.Ads.AdManager.v202208.Statement  filterStatement)
inlinevirtual

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

PQL property

Entity property

CostType

LineItem::costType

CreationDateTime

LineItem::creationDateTime

DeliveryRateType

LineItem::deliveryRateType

EndDateTime

LineItem::endDateTime

ExternalId

LineItem::externalId

Id

LineItem::id

IsMissingCreatives

LineItem::isMissingCreatives

IsSetTopBoxEnabled

LineItem::isSetTopBoxEnabled

LastModifiedDateTime

LineItem::lastModifiedDateTime

LineItemType

LineItem::lineItemType

Name

LineItem::name

OrderId

LineItem::orderId

StartDateTime

LineItem::startDateTime

Status

LineItem::status

UnitsBought

LineItem::unitsBought </tbody>

Parameters
filterStatementa Publisher Query Language statement used to filter a set of line items.
Returns
the line items that match the given filter

Implements Google.Api.Ads.AdManager.v202208.LineItemServiceInterface.

virtual System.Threading.Tasks.Task<Google.Api.Ads.AdManager.v202208.LineItemPage> Google.Api.Ads.AdManager.v202208.LineItemService.getLineItemsByStatementAsync ( Google.Api.Ads.AdManager.v202208.Statement  filterStatement)
inlinevirtual
virtual Google.Api.Ads.AdManager.v202208.UpdateResult Google.Api.Ads.AdManager.v202208.LineItemService.performLineItemAction ( Google.Api.Ads.AdManager.v202208.LineItemAction  lineItemAction,
Google.Api.Ads.AdManager.v202208.Statement  filterStatement 
)
inlinevirtual

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

Parameters
lineItemActionthe action to perform
filterStatementa Publisher Query Language statement used to filter a set of line items
Returns
the result of the action performed

Implements Google.Api.Ads.AdManager.v202208.LineItemServiceInterface.

virtual System.Threading.Tasks.Task<Google.Api.Ads.AdManager.v202208.UpdateResult> Google.Api.Ads.AdManager.v202208.LineItemService.performLineItemActionAsync ( Google.Api.Ads.AdManager.v202208.LineItemAction  lineItemAction,
Google.Api.Ads.AdManager.v202208.Statement  filterStatement 
)
inlinevirtual
virtual Google.Api.Ads.AdManager.v202208.LineItem [] Google.Api.Ads.AdManager.v202208.LineItemService.updateLineItems ( Google.Api.Ads.AdManager.v202208.LineItem[]  lineItems)
inlinevirtual

Updates the specified LineItem objects.

Parameters
lineItemsthe line items to update
Returns
the updated line items

Implements Google.Api.Ads.AdManager.v202208.ILineItemService.

virtual System.Threading.Tasks.Task<Google.Api.Ads.AdManager.v202208.LineItem[]> Google.Api.Ads.AdManager.v202208.LineItemService.updateLineItemsAsync ( Google.Api.Ads.AdManager.v202208.LineItem[]  lineItems)
inlinevirtual

The documentation for this class was generated from the following file: