line_items

Overview

Name	line_items
Type	Resource
Id	googledevelopers.displayvideo.line_items

Fields

Name	Datatype	Description
name	string	Output only. The resource name of the line item.
reservationType	string	Output only. The reservation type of the line item.
partnerCosts	array	The partner costs associated with the line item. If absent or empty in CreateLineItem method, the newly created line item will inherit partner costs from its parent insertion order.
excludeNewExchanges	boolean	Whether to exclude new exchanges from automatically being targeted by the line item. This field is false by default.
targetingExpansion	object	Settings that control the targeting expansion of the line item. Targeting expansion allows the line item to reach a larger audience based on the original audience list and the targeting expansion level. Beginning November 7, 2022, these settings may represent the optimized targeting feature in place of targeting expansion. This feature will be rolled out to all partners by November 9, 2022.
creativeIds	array	The IDs of the creatives associated with the line item.
updateTime	string	Output only. The timestamp when the line item was last updated. Assigned by the system.
warningMessages	array	Output only. The warning messages generated by the line item. These warnings do not block saving the line item, but some may block the line item from running.
pacing	object	Settings that control the rate at which a budget is spent.
partnerRevenueModel	object	Settings that control how partner revenue is calculated.
campaignId	string	Output only. The unique ID of the campaign that the line item belongs to.
conversionCounting	object	Settings that control how conversions are counted. All post-click conversions will be counted. A percentage value can be set for post-view conversions counting.
mobileApp	object	A mobile app promoted by a mobile app install line item.
flight	object	Settings that control the active duration of a line item.
displayName	string	Required. The display name of the line item. Must be UTF-8 encoded with a maximum size of 240 bytes.
entityStatus	string	Required. Controls whether or not the line item can spend its budget and bid on inventory. For CreateLineItem method, only ENTITY_STATUS_DRAFT is allowed. To activate a line item, use UpdateLineItem method and update the status to ENTITY_STATUS_ACTIVE after creation. A line item cannot be changed back to ENTITY_STATUS_DRAFT status from any other status. * If the line item's parent insertion order is not active, the line item can't spend its budget even if its own status is ENTITY_STATUS_ACTIVE.
integrationDetails	object	Integration details of an entry.
budget	object	Settings that control how budget is allocated.
lineItemType	string	Required. Immutable. The type of the line item.
lineItemId	string	Output only. The unique ID of the line item. Assigned by the system.
frequencyCap	object	Settings that control the number of times a user may be shown with the same ad during a given time period.
advertiserId	string	Output only. The unique ID of the advertiser the line item belongs to.
insertionOrderId	string	Required. Immutable. The unique ID of the insertion order that the line item belongs to.
youtubeAndPartnersSettings	object	Settings for YouTube and Partners line items.
bidStrategy	object	Settings that control the bid strategy. Bid strategy determines the bid price.

Methods

Name	Accessible by	Required Params	Description
advertisers_lineItems_get	SELECT	advertisersId, lineItemsId	Gets a line item.
advertisers_lineItems_list	SELECT	advertisersId	Lists line items in an advertiser. The order is defined by the order_by parameter. If a filter by entity_status is not specified, line items with ENTITY_STATUS_ARCHIVED will not be included in the results.
advertisers_lineItems_create	INSERT	advertisersId	Creates a new line item. Returns the newly created line item if successful.
advertisers_lineItems_delete	DELETE	advertisersId, lineItemsId	Deletes a line item. Returns error code NOT_FOUND if the line item does not exist. The line item should be archived first, i.e. set entity_status to ENTITY_STATUS_ARCHIVED, to be able to delete it.
advertisers_lineItems_bulkEditAssignedTargetingOptions	EXEC	advertisersId	Bulk edits targeting options under multiple line items. The operation will delete the assigned targeting options provided in BulkEditAssignedTargetingOptionsRequest.delete_requests and then create the assigned targeting options provided in BulkEditAssignedTargetingOptionsRequest.create_requests. Requests to this endpoint cannot be made concurrently with the following requests updating the same line item: BulkUpdate UpdateLineItem CreateLineItemAssignedTargetingOption DeleteLineItemAssignedTargetingOption
advertisers_lineItems_bulkListAssignedTargetingOptions	EXEC	advertisersId	Lists assigned targeting options for multiple line items across targeting types.
advertisers_lineItems_bulkUpdate	EXEC	advertisersId	Updates multiple line items. Requests to this endpoint cannot be made concurrently with the following requests updating the same line item: BulkEditAssignedTargetingOptions UpdateLineItem CreateLineItemAssignedTargetingOption DeleteLineItemAssignedTargetingOption
advertisers_lineItems_duplicate	EXEC	advertisersId, lineItemsId	Duplicates a line item. Returns the ID of the created line item if successful.
advertisers_lineItems_generateDefault	EXEC	advertisersId	Creates a new line item with settings (including targeting) inherited from the insertion order and an ENTITY_STATUS_DRAFT entity_status. Returns the newly created line item if successful. There are default values based on the three fields: The insertion order's insertion_order_type The insertion order's automation_type * The given line_item_type
advertisers_lineItems_patch	EXEC	advertisersId, lineItemsId	Updates an existing line item. Returns the updated line item if successful. Requests to this endpoint cannot be made concurrently with the following requests updating the same line item: BulkEditAssignedTargetingOptions BulkUpdateLineItems CreateLineItemAssignedTargetingOption DeleteLineItemAssignedTargetingOption