GoogleApi.DisplayVideo.V3.Model.LineItem (google_api_display_video v0.39.0)
View SourceA single line item.
Attributes
-
advertiserId
(type:String.t
, default:nil
) - Output only. The unique ID of the advertiser the line item belongs to. -
bidStrategy
(type:GoogleApi.DisplayVideo.V3.Model.BiddingStrategy.t
, default:nil
) - Required. The bidding strategy of the line item. -
budget
(type:GoogleApi.DisplayVideo.V3.Model.LineItemBudget.t
, default:nil
) - Required. The budget allocation setting of the line item. -
campaignId
(type:String.t
, default:nil
) - Output only. The unique ID of the campaign that the line item belongs to. -
conversionCounting
(type:GoogleApi.DisplayVideo.V3.Model.ConversionCountingConfig.t
, default:nil
) - The conversion tracking setting of the line item. Warning: Starting April 1, 2025, the floodlight_activity_configs field will no longer be writable while a custom bidding algorithm is assigned to the line item. If you set this field and assign a custom bidding algorithm in the same request, the floodlight activities must match the ones used by the custom bidding algorithm. Read more about this announced change. -
creativeIds
(type:list(String.t)
, default:nil
) - The IDs of the creatives associated with the line item. -
displayName
(type:String.t
, default:nil
) - Required. The display name of the line item. Must be UTF-8 encoded with a maximum size of 240 bytes. -
entityStatus
(type:String.t
, default:nil
) - Required. Controls whether or not the line item can spend its budget and bid on inventory. For CreateLineItem method, onlyENTITY_STATUS_DRAFT
is allowed. To activate a line item, use UpdateLineItem method and update the status toENTITY_STATUS_ACTIVE
after creation. A line item cannot be changed back toENTITY_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 isENTITY_STATUS_ACTIVE
. -
excludeNewExchanges
(type:boolean()
, default:nil
) - Whether to exclude new exchanges from automatically being targeted by the line item. This field is false by default. -
flight
(type:GoogleApi.DisplayVideo.V3.Model.LineItemFlight.t
, default:nil
) - Required. The start and end time of the line item's flight. -
frequencyCap
(type:GoogleApi.DisplayVideo.V3.Model.FrequencyCap.t
, default:nil
) - Required. 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. -
insertionOrderId
(type:String.t
, default:nil
) - Required. Immutable. The unique ID of the insertion order that the line item belongs to. -
integrationDetails
(type:GoogleApi.DisplayVideo.V3.Model.IntegrationDetails.t
, default:nil
) - Integration details of the line item. -
lineItemId
(type:String.t
, default:nil
) - Output only. The unique ID of the line item. Assigned by the system. -
lineItemType
(type:String.t
, default:nil
) - Required. Immutable. The type of the line item. -
mobileApp
(type:GoogleApi.DisplayVideo.V3.Model.MobileApp.t
, default:nil
) - The mobile app promoted by the line item. This is applicable only when line_item_type is eitherLINE_ITEM_TYPE_DISPLAY_MOBILE_APP_INSTALL
orLINE_ITEM_TYPE_VIDEO_MOBILE_APP_INSTALL
. -
name
(type:String.t
, default:nil
) - Output only. The resource name of the line item. -
pacing
(type:GoogleApi.DisplayVideo.V3.Model.Pacing.t
, default:nil
) - Required. The budget spending speed setting of the line item. -
partnerCosts
(type:list(GoogleApi.DisplayVideo.V3.Model.PartnerCost.t)
, default:nil
) - 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. -
partnerRevenueModel
(type:GoogleApi.DisplayVideo.V3.Model.PartnerRevenueModel.t
, default:nil
) - Required. The partner revenue model setting of the line item. -
reservationType
(type:String.t
, default:nil
) - Output only. The reservation type of the line item. -
targetingExpansion
(type:GoogleApi.DisplayVideo.V3.Model.TargetingExpansionConfig.t
, default:nil
) - The optimized targeting 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. -
updateTime
(type:DateTime.t
, default:nil
) - Output only. The timestamp when the line item was last updated. Assigned by the system. -
warningMessages
(type:list(String.t)
, default:nil
) - 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. -
youtubeAndPartnersSettings
(type:GoogleApi.DisplayVideo.V3.Model.YoutubeAndPartnersSettings.t
, default:nil
) - Output only. Settings specific to YouTube and Partners line items.
Summary
Functions
Unwrap a decoded JSON object into its complex fields.
Types
@type t() :: %GoogleApi.DisplayVideo.V3.Model.LineItem{ advertiserId: String.t() | nil, bidStrategy: GoogleApi.DisplayVideo.V3.Model.BiddingStrategy.t() | nil, budget: GoogleApi.DisplayVideo.V3.Model.LineItemBudget.t() | nil, campaignId: String.t() | nil, conversionCounting: GoogleApi.DisplayVideo.V3.Model.ConversionCountingConfig.t() | nil, creativeIds: [String.t()] | nil, displayName: String.t() | nil, entityStatus: String.t() | nil, excludeNewExchanges: boolean() | nil, flight: GoogleApi.DisplayVideo.V3.Model.LineItemFlight.t() | nil, frequencyCap: GoogleApi.DisplayVideo.V3.Model.FrequencyCap.t() | nil, insertionOrderId: String.t() | nil, integrationDetails: GoogleApi.DisplayVideo.V3.Model.IntegrationDetails.t() | nil, lineItemId: String.t() | nil, lineItemType: String.t() | nil, mobileApp: GoogleApi.DisplayVideo.V3.Model.MobileApp.t() | nil, name: String.t() | nil, pacing: GoogleApi.DisplayVideo.V3.Model.Pacing.t() | nil, partnerCosts: [GoogleApi.DisplayVideo.V3.Model.PartnerCost.t()] | nil, partnerRevenueModel: GoogleApi.DisplayVideo.V3.Model.PartnerRevenueModel.t() | nil, reservationType: String.t() | nil, targetingExpansion: GoogleApi.DisplayVideo.V3.Model.TargetingExpansionConfig.t() | nil, updateTime: DateTime.t() | nil, warningMessages: [String.t()] | nil, youtubeAndPartnersSettings: GoogleApi.DisplayVideo.V3.Model.YoutubeAndPartnersSettings.t() | nil }