LineItem (Display & Video 360 API v2-rev20260505-2.0.0)

java.lang.Object
- java.util.AbstractMap<String,Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.displayvideo.v2.model.LineItem

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class LineItem
extends com.google.api.client.json.GenericJson
```
A single line item.
This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Display & Video 360 API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  com.google.api.client.util.GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

LineItem()

Constructors
Constructor and Description
`LineItem()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`LineItem`	`clone()`
`Long`	`getAdvertiserId()` Output only.
`BiddingStrategy`	`getBidStrategy()` Required.
`LineItemBudget`	`getBudget()` Required.
`Long`	`getCampaignId()` Output only.
`String`	`getContainsEuPoliticalAds()` Whether this line item will serve European Union political ads.
`ConversionCountingConfig`	`getConversionCounting()` The conversion tracking setting of the line item.
`List<Long>`	`getCreativeIds()` The IDs of the creatives associated with the line item.
`DemandGenSettings`	`getDemandGenSettings()` Optional.
`String`	`getDisplayName()` Required.
`String`	`getEntityStatus()` Required.
`Boolean`	`getExcludeNewExchanges()` Whether to exclude new exchanges from automatically being targeted by the line item.
`LineItemFlight`	`getFlight()` Required.
`FrequencyCap`	`getFrequencyCap()` Optional.
`Long`	`getInsertionOrderId()` Required.
`IntegrationDetails`	`getIntegrationDetails()` Integration details of the line item.
`Long`	`getLineItemId()` Output only.
`String`	`getLineItemType()` Required.
`MobileApp`	`getMobileApp()` The mobile app promoted by the line item.
`String`	`getName()` Output only.
`Boolean`	`getOptimizeFixedBidding()` Optional.
`Pacing`	`getPacing()` Required.
`List<PartnerCost>`	`getPartnerCosts()` The partner costs associated with the line item.
`PartnerRevenueModel`	`getPartnerRevenueModel()` Required.
`String`	`getReservationType()` Output only.
`TargetingExpansionConfig`	`getTargetingExpansion()` The [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item.
`String`	`getUpdateTime()` Output only.
`List<String>`	`getWarningMessages()` Output only.
`YoutubeAndPartnersSettings`	`getYoutubeAndPartnersSettings()` Output only.
`LineItem`	`set(String fieldName, Object value)`
`LineItem`	`setAdvertiserId(Long advertiserId)` Output only.
`LineItem`	`setBidStrategy(BiddingStrategy bidStrategy)` Required.
`LineItem`	`setBudget(LineItemBudget budget)` Required.
`LineItem`	`setCampaignId(Long campaignId)` Output only.
`LineItem`	`setContainsEuPoliticalAds(String containsEuPoliticalAds)` Whether this line item will serve European Union political ads.
`LineItem`	`setConversionCounting(ConversionCountingConfig conversionCounting)` The conversion tracking setting of the line item.
`LineItem`	`setCreativeIds(List<Long> creativeIds)` The IDs of the creatives associated with the line item.
`LineItem`	`setDemandGenSettings(DemandGenSettings demandGenSettings)` Optional.
`LineItem`	`setDisplayName(String displayName)` Required.
`LineItem`	`setEntityStatus(String entityStatus)` Required.
`LineItem`	`setExcludeNewExchanges(Boolean excludeNewExchanges)` Whether to exclude new exchanges from automatically being targeted by the line item.
`LineItem`	`setFlight(LineItemFlight flight)` Required.
`LineItem`	`setFrequencyCap(FrequencyCap frequencyCap)` Optional.
`LineItem`	`setInsertionOrderId(Long insertionOrderId)` Required.
`LineItem`	`setIntegrationDetails(IntegrationDetails integrationDetails)` Integration details of the line item.
`LineItem`	`setLineItemId(Long lineItemId)` Output only.
`LineItem`	`setLineItemType(String lineItemType)` Required.
`LineItem`	`setMobileApp(MobileApp mobileApp)` The mobile app promoted by the line item.
`LineItem`	`setName(String name)` Output only.
`LineItem`	`setOptimizeFixedBidding(Boolean optimizeFixedBidding)` Optional.
`LineItem`	`setPacing(Pacing pacing)` Required.
`LineItem`	`setPartnerCosts(List<PartnerCost> partnerCosts)` The partner costs associated with the line item.
`LineItem`	`setPartnerRevenueModel(PartnerRevenueModel partnerRevenueModel)` Required.
`LineItem`	`setReservationType(String reservationType)` Output only.
`LineItem`	`setTargetingExpansion(TargetingExpansionConfig targetingExpansion)` The [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item.
`LineItem`	`setUpdateTime(String updateTime)` Output only.
`LineItem`	`setWarningMessages(List<String> warningMessages)` Output only.
`LineItem`	`setYoutubeAndPartnersSettings(YoutubeAndPartnersSettings youtubeAndPartnersSettings)` Output only.

Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData
entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - LineItem
```
public LineItem()
```
- Method Detail
  - getAdvertiserId
```
public Long getAdvertiserId()
```
    Output only. The unique ID of the advertiser the line item belongs to.
    
    Returns:
    
    value or null for none
  - setAdvertiserId
```
public LineItem setAdvertiserId(Long advertiserId)
```
    Output only. The unique ID of the advertiser the line item belongs to.
    
    Parameters:
    
    advertiserId - advertiserId or null for none
  - getBidStrategy
```
public BiddingStrategy getBidStrategy()
```
    Required. The bidding strategy of the line item.
    
    Returns:
    
    value or null for none
  - setBidStrategy
```
public LineItem setBidStrategy(BiddingStrategy bidStrategy)
```
    Required. The bidding strategy of the line item.
    
    Parameters:
    
    bidStrategy - bidStrategy or null for none
  - getBudget
```
public LineItemBudget getBudget()
```
    Required. The budget allocation setting of the line item.
    
    Returns:
    
    value or null for none
  - setBudget
```
public LineItem setBudget(LineItemBudget budget)
```
    Required. The budget allocation setting of the line item.
    
    Parameters:
    
    budget - budget or null for none
  - getCampaignId
```
public Long getCampaignId()
```
    Output only. The unique ID of the campaign that the line item belongs to.
    
    Returns:
    
    value or null for none
  - setCampaignId
```
public LineItem setCampaignId(Long campaignId)
```
    Output only. The unique ID of the campaign that the line item belongs to.
    
    Parameters:
    
    campaignId - campaignId or null for none
  - getContainsEuPoliticalAds
```
public String getContainsEuPoliticalAds()
```
    Whether this line item will serve European Union political ads. If contains_eu_political_ads has been set to `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` in the parent advertiser, then this field will be assigned `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` if not otherwise specified. This field can then be updated using the UI, API, or Structured Data Files. This field must be assigned when creating a new line item. Otherwise, **the `advertisers.lineItems.create` request will fail**.
    
    Returns:
    
    value or null for none
  - setContainsEuPoliticalAds
```
public LineItem setContainsEuPoliticalAds(String containsEuPoliticalAds)
```
    Whether this line item will serve European Union political ads. If contains_eu_political_ads has been set to `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` in the parent advertiser, then this field will be assigned `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` if not otherwise specified. This field can then be updated using the UI, API, or Structured Data Files. This field must be assigned when creating a new line item. Otherwise, **the `advertisers.lineItems.create` request will fail**.
    
    Parameters:
    
    containsEuPoliticalAds - containsEuPoliticalAds or null for none
  - getConversionCounting
```
public ConversionCountingConfig getConversionCounting()
```
    The conversion tracking setting of the line item.
    
    Returns:
    
    value or null for none
  - setConversionCounting
```
public LineItem setConversionCounting(ConversionCountingConfig conversionCounting)
```
    The conversion tracking setting of the line item.
    
    Parameters:
    
    conversionCounting - conversionCounting or null for none
  - getCreativeIds
```
public List<Long> getCreativeIds()
```
    The IDs of the creatives associated with the line item.
    
    Returns:
    
    value or null for none
  - setCreativeIds
```
public LineItem setCreativeIds(List<Long> creativeIds)
```
    The IDs of the creatives associated with the line item.
    
    Parameters:
    
    creativeIds - creativeIds or null for none
  - getDemandGenSettings
```
public DemandGenSettings getDemandGenSettings()
```
    Optional. Settings specific to Demand Gen line items. Only applicable to Demand Gen line items. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users.
    
    Returns:
    
    value or null for none
  - setDemandGenSettings
```
public LineItem setDemandGenSettings(DemandGenSettings demandGenSettings)
```
    Optional. Settings specific to Demand Gen line items. Only applicable to Demand Gen line items. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users.
    
    Parameters:
    
    demandGenSettings - demandGenSettings or null for none
  - getDisplayName
```
public String getDisplayName()
```
    Required. The display name of the line item. Must be UTF-8 encoded with a maximum size of 240 bytes.
    
    Returns:
    
    value or null for none
  - setDisplayName
```
public LineItem setDisplayName(String displayName)
```
    Required. The display name of the line item. Must be UTF-8 encoded with a maximum size of 240 bytes.
    
    Parameters:
    
    displayName - displayName or null for none
  - getEntityStatus
```
public String getEntityStatus()
```
    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`.
    
    Returns:
    
    value or null for none
  - setEntityStatus
```
public LineItem setEntityStatus(String entityStatus)
```
    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`.
    
    Parameters:
    
    entityStatus - entityStatus or null for none
  - getExcludeNewExchanges
```
public Boolean getExcludeNewExchanges()
```
    Whether to exclude new exchanges from automatically being targeted by the line item. This field is false by default.
    
    Returns:
    
    value or null for none
  - setExcludeNewExchanges
```
public LineItem setExcludeNewExchanges(Boolean excludeNewExchanges)
```
    Whether to exclude new exchanges from automatically being targeted by the line item. This field is false by default.
    
    Parameters:
    
    excludeNewExchanges - excludeNewExchanges or null for none
  - getFlight
```
public LineItemFlight getFlight()
```
    Required. The start and end time of the line item's flight.
    
    Returns:
    
    value or null for none
  - setFlight
```
public LineItem setFlight(LineItemFlight flight)
```
    Required. The start and end time of the line item's flight.
    
    Parameters:
    
    flight - flight or null for none
  - getFrequencyCap
```
public FrequencyCap getFrequencyCap()
```
    Optional. Required if the line item type is not `LINE_ITEM_TYPE_DEMAND_GEN`. The impression frequency cap settings of the line item. The max_impressions field in this settings object must be used if assigning a limited cap.
    
    Returns:
    
    value or null for none
  - setFrequencyCap
```
public LineItem setFrequencyCap(FrequencyCap frequencyCap)
```
    Optional. Required if the line item type is not `LINE_ITEM_TYPE_DEMAND_GEN`. The impression frequency cap settings of the line item. The max_impressions field in this settings object must be used if assigning a limited cap.
    
    Parameters:
    
    frequencyCap - frequencyCap or null for none
  - getInsertionOrderId
```
public Long getInsertionOrderId()
```
    Required. Immutable. The unique ID of the insertion order that the line item belongs to.
    
    Returns:
    
    value or null for none
  - setInsertionOrderId
```
public LineItem setInsertionOrderId(Long insertionOrderId)
```
    Required. Immutable. The unique ID of the insertion order that the line item belongs to.
    
    Parameters:
    
    insertionOrderId - insertionOrderId or null for none
  - getIntegrationDetails
```
public IntegrationDetails getIntegrationDetails()
```
    Integration details of the line item.
    
    Returns:
    
    value or null for none
  - setIntegrationDetails
```
public LineItem setIntegrationDetails(IntegrationDetails integrationDetails)
```
    Integration details of the line item.
    
    Parameters:
    
    integrationDetails - integrationDetails or null for none
  - getLineItemId
```
public Long getLineItemId()
```
    Output only. The unique ID of the line item. Assigned by the system.
    
    Returns:
    
    value or null for none
  - setLineItemId
```
public LineItem setLineItemId(Long lineItemId)
```
    Output only. The unique ID of the line item. Assigned by the system.
    
    Parameters:
    
    lineItemId - lineItemId or null for none
  - getLineItemType
```
public String getLineItemType()
```
    Required. Immutable. The type of the line item.
    
    Returns:
    
    value or null for none
  - setLineItemType
```
public LineItem setLineItemType(String lineItemType)
```
    Required. Immutable. The type of the line item.
    
    Parameters:
    
    lineItemType - lineItemType or null for none
  - getMobileApp
```
public MobileApp getMobileApp()
```
    The mobile app promoted by the line item. This is applicable only when line_item_type is either `LINE_ITEM_TYPE_DISPLAY_MOBILE_APP_INSTALL` or `LINE_ITEM_TYPE_VIDEO_MOBILE_APP_INSTALL`.
    
    Returns:
    
    value or null for none
  - setMobileApp
```
public LineItem setMobileApp(MobileApp mobileApp)
```
    The mobile app promoted by the line item. This is applicable only when line_item_type is either `LINE_ITEM_TYPE_DISPLAY_MOBILE_APP_INSTALL` or `LINE_ITEM_TYPE_VIDEO_MOBILE_APP_INSTALL`.
    
    Parameters:
    
    mobileApp - mobileApp or null for none
  - getName
```
public String getName()
```
    Output only. The resource name of the line item.
    
    Returns:
    
    value or null for none
  - setName
```
public LineItem setName(String name)
```
    Output only. The resource name of the line item.
    
    Parameters:
    
    name - name or null for none
  - getOptimizeFixedBidding
```
public Boolean getOptimizeFixedBidding()
```
    Optional. Whether to enable DV360's bid optimization for fixed bid line items. By default, DV360 optimizes your fixed bid by automatically lowering bids for impressions that are less likely to perform well. This optimization is enabled by default (value is true). When this field is set to `false`, this optimization is disabled, and the bid will not be lowered for any reason. This setting only applies to line items with a `bidding_strategy` of type `FIXED_BID`.
    
    Returns:
    
    value or null for none
  - setOptimizeFixedBidding
```
public LineItem setOptimizeFixedBidding(Boolean optimizeFixedBidding)
```
    Optional. Whether to enable DV360's bid optimization for fixed bid line items. By default, DV360 optimizes your fixed bid by automatically lowering bids for impressions that are less likely to perform well. This optimization is enabled by default (value is true). When this field is set to `false`, this optimization is disabled, and the bid will not be lowered for any reason. This setting only applies to line items with a `bidding_strategy` of type `FIXED_BID`.
    
    Parameters:
    
    optimizeFixedBidding - optimizeFixedBidding or null for none
  - getPacing
```
public Pacing getPacing()
```
    Required. The budget spending speed setting of the line item.
    
    Returns:
    
    value or null for none
  - setPacing
```
public LineItem setPacing(Pacing pacing)
```
    Required. The budget spending speed setting of the line item.
    
    Parameters:
    
    pacing - pacing or null for none
  - getPartnerCosts
```
public List<PartnerCost> getPartnerCosts()
```
    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.
    
    Returns:
    
    value or null for none
  - setPartnerCosts
```
public LineItem setPartnerCosts(List<PartnerCost> partnerCosts)
```
    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.
    
    Parameters:
    
    partnerCosts - partnerCosts or null for none
  - getPartnerRevenueModel
```
public PartnerRevenueModel getPartnerRevenueModel()
```
    Required. The partner revenue model setting of the line item.
    
    Returns:
    
    value or null for none
  - setPartnerRevenueModel
```
public LineItem setPartnerRevenueModel(PartnerRevenueModel partnerRevenueModel)
```
    Required. The partner revenue model setting of the line item.
    
    Parameters:
    
    partnerRevenueModel - partnerRevenueModel or null for none
  - getReservationType
```
public String getReservationType()
```
    Output only. The reservation type of the line item.
    
    Returns:
    
    value or null for none
  - setReservationType
```
public LineItem setReservationType(String reservationType)
```
    Output only. The reservation type of the line item.
    
    Parameters:
    
    reservationType - reservationType or null for none
  - getTargetingExpansion
```
public TargetingExpansionConfig getTargetingExpansion()
```
    The [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. This config is only applicable for display, video, or audio line items that use automated bidding and positively target eligible audience lists.
    
    Returns:
    
    value or null for none
  - setTargetingExpansion
```
public LineItem setTargetingExpansion(TargetingExpansionConfig targetingExpansion)
```
    The [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. This config is only applicable for display, video, or audio line items that use automated bidding and positively target eligible audience lists.
    
    Parameters:
    
    targetingExpansion - targetingExpansion or null for none
  - getUpdateTime
```
public String getUpdateTime()
```
    Output only. The timestamp when the line item was last updated. Assigned by the system.
    
    Returns:
    
    value or null for none
  - setUpdateTime
```
public LineItem setUpdateTime(String updateTime)
```
    Output only. The timestamp when the line item was last updated. Assigned by the system.
    
    Parameters:
    
    updateTime - updateTime or null for none
  - getWarningMessages
```
public List<String> getWarningMessages()
```
    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.
    
    Returns:
    
    value or null for none
  - setWarningMessages
```
public LineItem setWarningMessages(List<String> warningMessages)
```
    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.
    
    Parameters:
    
    warningMessages - warningMessages or null for none
  - getYoutubeAndPartnersSettings
```
public YoutubeAndPartnersSettings getYoutubeAndPartnersSettings()
```
    Output only. Settings specific to YouTube and Partners line items.
    
    Returns:
    
    value or null for none
  - setYoutubeAndPartnersSettings
```
public LineItem setYoutubeAndPartnersSettings(YoutubeAndPartnersSettings youtubeAndPartnersSettings)
```
    Output only. Settings specific to YouTube and Partners line items.
    
    Parameters:
    
    youtubeAndPartnersSettings - youtubeAndPartnersSettings or null for none
  - set
```
public LineItem set(String fieldName,
                    Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public LineItem clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Class LineItem

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class com.google.api.client.json.GenericJson

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

LineItem

Method Detail

getAdvertiserId

setAdvertiserId

getBidStrategy

setBidStrategy

getBudget

setBudget

getCampaignId

setCampaignId

getContainsEuPoliticalAds

setContainsEuPoliticalAds

getConversionCounting

setConversionCounting

getCreativeIds

setCreativeIds

getDemandGenSettings

setDemandGenSettings

getDisplayName

setDisplayName

getEntityStatus

setEntityStatus

getExcludeNewExchanges

setExcludeNewExchanges

getFlight

setFlight

getFrequencyCap

setFrequencyCap

getInsertionOrderId

setInsertionOrderId

getIntegrationDetails

setIntegrationDetails

getLineItemId

setLineItemId

getLineItemType

setLineItemType

getMobileApp

setMobileApp

getName

setName

getOptimizeFixedBidding

setOptimizeFixedBidding

getPacing

setPacing

getPartnerCosts

setPartnerCosts

getPartnerRevenueModel

setPartnerRevenueModel

getReservationType

setReservationType

getTargetingExpansion

setTargetingExpansion

getUpdateTime

setUpdateTime

getWarningMessages

setWarningMessages

getYoutubeAndPartnersSettings

setYoutubeAndPartnersSettings

set

clone