Share your feedback about the Display & Video 360 API. Take the 2022 Display & Video 360 API Annual Survey.

Structured Data - v3.1 - Line Items

See the overview for an explanation of format.

FieldRequiredTypeWritableDescription
Line Item IdRequired only when editing existing Line ItemsintegerNoNumeric ID value of the line item. If left blank, a new line item will be created and a unique ID will be assigned. Optionally, when creating new Line Items, you can use a custom identifier for the purpose of assigning TrueView Ad Groups to the new Line Item. The format for a custom identifier is "ext[custom identifier]", for example, ext123. When the file is uploaded and processed, all custom identifiers will be replaced with DBM-assigned IDs and the objects will be associated (for example, Ad Group to Line Item) based on the custom identifiers.
Io IdYesintegerNoNumeric ID value of the insertion order. You can specify a custom identifier (for example, "ext[custom IO identifier]") for an insertion order that you are creating at the same time as this line item.
TypeYesstringYesThe type of entry. Only writable when creating, not editing.
  • Display
  • Video
  • TrueView
  • Audio
SubtypeYesstringYesField required for TrueView line items to distinguish between the Standard and Mobile App Install TrueView formats
  • Simple
  • Mobile App Install
NameYesstringYesThe name of the entry.
TimestampRequired when editing existing entriesintegerNoThe timestamp for the entry, this is used by the system to verify that the entry has not changed between downloading and uploading.
StatusYesstringYesThe status setting for the entry.
  • Active
  • Paused
  • Draft
  • Archived
  • Deleted
Start DateYesstringYesA timestamp for the flight start date of the entry in the format MM/DD/YYYY HH:mm.
End DateYesstringYesA timestamp for the flight end date of the entry in the format MM/DD/YYYY HH:mm.
Budget TypeYesstringYesSpecifies whether the budget is monetarily based or impression-based. If the IO for this entry is enabled for auto-budget allocation, you can set this to 'Automatic' to allow DBM to automatically budget for this entry.
  • Amount
  • Impressions
  • Unlimited
  • Automatic
  • TrueView Daily Budget
Budget AmountRequired when "Type" is "Display" or "Video" or "Audio"floatYesA positive budget amount for the budget type. This could be a simple integer impression value, or a float for a currency amount. Currencies will be shown in the advertiser's currency in standard units (not in 1/1,000,000s of a currency unit). If 'Automatic' budget allocation is set on the entry, you can specify a minimum amount to spend (for example, 'spend at least' this amount).
PacingYesstringYesThe time period used to spend to the pacing amount.
  • Daily
  • Monthly
  • Flight
Pacing RateYesstringYesThe rate of pacing for this entry.
  • ASAP
  • Even
  • Ahead
Pacing AmountYesfloatYesThe amount to spend per the time period set by the pacing type.
Frequency EnabledYesstringYesEnables/disables impression-based frequency capping on the line item.
  • TRUE
  • FALSE
Frequency ExposuresRequired when "Frequency Enabled" is "TRUE"integerYesA positive integer amount for the number of impressions in a given Frequency Amount, that is, the x in 'Show x impressions over y period'.
Frequency PeriodRequired when "Frequency Enabled" is "TRUE"stringYesSpecifies the time period unit for the frequency cap. For TrueView line items, supported periods are Days, Weeks, Months.
  • Minutes
  • Hours
  • Days
  • Weeks
  • Months
  • Lifetime
Frequency AmountRequired when "Frequency Enabled" is "TRUE"integerYesA positive integer amount for length of time of the Frequency Period type, that is, the y in 'Show x impressions over y period'. This amount is not supported for TrueView line items.
TrueView View Frequency EnabledRequired when "Type" is "TrueView"stringYesEnables/disables view-based frequency capping on the TrueView line item
  • TRUE
  • FALSE
TrueView View Frequency ExposuresRequired when "TrueView View Frequency Enabled" is "TRUE"integerYesA positive integer amount for the number of TrueView views, that is, the x in 'Show x views over the period'
TrueView View Frequency PeriodRequired when "TrueView View Frequency Enabled" is "TRUE"stringYesSpecifies the time period unit for the TrueView view-based frequency cap
  • Days
  • Weeks
  • Months
Partner Revenue ModelYesstringYesA partner revenue model is the mechanism for controlling how revenue is calculated in Bid Manager. Use the partner revenue model to track the markup for your service fees.
  • TMCM - Total Media Cost Markup
  • MCM - Media Cost Markup
  • CPM - Cost Per thousand impressions
Partner Revenue AmountYesfloatYesA positive float value corresponding to the Partner Revenue Model.
Conversion Counting TypeRequired when "Type" is "Display" or "Video" or "Audio"stringYesChoose the kinds of conversions that are counted.
  • Count all
  • Count post-click
  • Count %
Conversion Counting PctRequired when "Type" is "Display" or "Video" or "Audio"floatYesSpecify the % for 'Count %' Conversion Counting Type. Format the % as a float (3.123% = 3.123), with precision limited to the thousands (3 decimal places).
Conversion Pixel IdsNostring, list of listsYesSpecify the conversion pixel(s) as a list of lists. Each pixel is specified as a pixel ID, post-view window (in minutes) and post-click window (in minutes). List format = (Pixel.common_data.id; view_window_minutes; click_window_minutes;).
FeesNostring, list of listsYesAll fees for this entry. List format = (Fee category; Fee amount; Fee type; Invoiced;).
  • Fee category
    • CPM
    • Media
  • Fee amount
    • Float
    • Pct as float
  • Fee type
    • (string, see table in fees)
  • Invoiced
    • True
    • False
    • blank

Example '(CPM; 2; Bid Manager Fee; False) ; (Media; 13; Default; True);'
Acceptable values are provided in the following table:

Note: Premium Fees CPM Fee is reserved by the system and is immutable. The cardinality of the Premium Fee is preserved across mutations by inserting Default CPM fees if needed.

Fee categoryFee TypeInvoiced option
CPM/MediaDefaultNot permitted (leave blank)
CPM/MediaThird-Party Ad ServerNot permitted (leave blank)
CPM/MediaDoubleVerifyPermitted (True/False)
CPM/MediaAdsafeNot permitted (leave blank)
CPM/MediaAdxposeNot permitted (leave blank)
CPM/MediaVizuNot permitted (leave blank)
CPM/MediaAggregate KnowledgeNot permitted (leave blank)
CPM/MediaTeracentNot permitted (leave blank)
CPM/MediaEvidonNot permitted (leave blank)
CPM/MediaAgency Trading Desk FeeNot permitted (leave blank)
CPM/MediaAdlooxPermitted (True/False)
CPMShopLocalRequired (True)
CPMTrustMetricsNot permitted (leave blank)
CPMIntegral Ad Science VideoPermitted (True/False)
CPMMOAT VideoNot permitted (leave blank)
MediaBid Manager FeeRequired (True)
MediaMedia Cost DataNot permitted (leave blank)
CPMPremium FeesNot permitted (leave blank)
Integration CodeNostringYesAn optional code for tracking purposes.
DetailsNostringYesEntry details in string format.
Bid Strategy TypeRequired when "Type" is "Display" or "Video" or "Audio"stringYes Select one of the applicable bid strategies:
  • Minimize: While spending the full budget, minimize CPA/CPC
  • Maximize: While spending the full budget, maximize Impression Value or Quality Impression
  • Beat: Meet or beat a goal of X CPA/CPC
  • Optimize vCPM: Optimize for viewable CPM bid of X
  • Fixed: Specify a fixed bid of X
Bid Strategy ValueRequired unless "Bid Strategy Type" is "Minimize", "Maximize" or "Type" is "TrueView"floatYesFor Beat, Optimize VCPM, Fixed strategy types, choose a value for the goal bid.
Note that no Bid Strategy Value is required for the Bid Strategy Type 'Minimize' or 'Maximize'
Bid Strategy UnitRequired when "Bid Strategy Type" is "Beat" ,"Minimize" or "Maximize"stringYesFor Beat, Minimize or Maximize strategy types, select the corresponding unit:
  • CPA
  • CPC
  • custom impr. value/cost
  • CIVA
  • IVO_TEN
  • AV_VIEWED
  • INCREMENTAL_CONVERSIONS
Bid Strategy Do Not ExceedRequired when "Type" is "Display" or "Video" or "Audio"floatYesSet a 'do not exceed' CPM value. If 0, 'do not exceed' is not enabled. This is available only if the Bid Strategy is 'Minimize', 'Maximize' or 'Beat'.
Creative AssignmentsNostring, listYesList of Creative IDs to assign to the entry. List format = (Creative.common_data.id;Creative.common_data_id;etc.).
Geography Targeting - IncludeNostring, listYesList of geographies to include in targeting. List format = (GeoLocation.id; GeoLocation.id;etc.).
Geography Targeting - ExcludeNostring, listYesList of geographies to exclude in targeting. List format = (GeoLocation.id;GeoLocation.id; etc.).
Language Targeting - IncludeNostring, listYesList of languages to include in targeting. List format = (Language.id;Language.id;etc.).
Language Targeting - ExcludeNostring, listYesList of languages to exclude in targeting. List format = (Language.id;Language.id;etc.).
Device Targeting - IncludeNostring, listYesList of devices to include in targeting. List format = (DeviceCriteria.id;DeviceCriteria.id;etc.).
Device Targeting - ExcludeNostring, listYesList of devices to exclude in targeting. List format = (DeviceCriteria.id;DeviceCriteria.id;etc.).
Browser Targeting - IncludeNostring, listYesList of browser to include in targeting. List format = (Browser.id;Browser.id;etc.).
Browser Targeting - ExcludeNostring, listYesList of browser to exclude in targeting. List format = (Browser.id;Browser.id;etc.).
Brand Safety LabelsNostring, listYesList of the digital content labels to target. List format = (G;PG; etc.).
  • G
  • PG
  • T
  • MA
  • ?
Brand Safety Sensitivity SettingNostringYesChoose the sensitivity setting to block inventory based on the subject matter of its surrounding content.
  • Do not block
  • Use DoubleClick Verification
  • Use custom
Brand Safety Custom SettingsRequired when "Brand Safety Custom Setting" is "Use Custom"string, listYesIf the Brand Safety Sensitivity Setting is 'Use custom', specify the list of standard content classifiers. For example, (Adult;Alcohol;Tobacco;etc.).
  • Adult
  • Derogatory
  • Downloads & Sharing
  • Weapons
  • Gambling
  • Violence
  • Suggestive
  • Profanity
  • Alcohol
  • Drugs
  • Tobacco
  • Politics
  • Religion
  • Tragedy
  • Transportation Accidents
  • Sensitive social issues
  • Shocking
Third Party Verification ServicesNostringYesThird party verification services provider.
  • None
  • Integral Ad Science
  • DoubleVerify
  • Adloox
Third Party Verification LabelsNostring, listYesIf Third Party Verification Services is not "None", specify a list of labels supported by the selected provider.
Channel Targeting - IncludeNostring, listYesList of channels to include in targeting. List format = (UniversalChannel.id;UniversalChannel.id; etc.).
Channel Targeting - ExcludeNostring, listYesList of channels to include in targeting. List format = (UniversalChannel.id;UniversalChannel.id; etc.).
Site Targeting - IncludeNostring, listYesList of sites to include in targeting. The list can include a set of site IDs or strings of URLs, if not found in the Universal Site table. List format = (UniversalSite.Id;'http://someurl.com';etc.).
Site Targeting - ExcludeNostring, listYesList of sites to exclude in targeting. The list can include a set of site IDs or strings of URLs, if not found in the Universal Site table. List format = (UniversalSite.Id;'http://someurl.com';etc.).
App Targeting - IncludeNostring, listYesList of apps to include in targeting. The list can include a set of UniversalSite IDs or strings of app packages, if not found in the Universal Site table. List format = (UniversalSite.Id; 'some.app.package';etc.).
App Targeting - ExcludeNostring, listYesList of apps to exclude in targeting. The list can include a set of UniversalSite IDs or strings of app packages, if not found in the Universal Site table. List format = (UniversalSite.Id; 'some.app.package';etc.).
Category Targeting - IncludeNostring, listYesList of categories to include in targeting, from AdX vertical IDs. List format = (Verticals.Id;Verticals.Id;etc.).
Category Targeting - ExcludeNostring, listYesList of categories to exclude in targeting, from AdX vertical IDs. List format = (Verticals.Id;Verticals.Id;etc.).
Keyword Targeting - IncludeNostring, listYesList of keyword strings to include in targeting.
Keyword Targeting - ExcludeNostring, listYesList of keyword strings to exclude in targeting.
Audience Targeting - Similar AudiencesRequired when "Type" is "Display" or "Video" or "Audio"stringYes Enable similar audiences for positively targeted first-party lists.
  • TRUE
  • FALSE
Audience Targeting - IncludeNostring, list of list of pairsYesList of audience lists to include in targeting. For first-party audience lists, each audience is listed as a pair of UserList ID and recency setting. A pair is (1;1d;), where 1d is a sample recency representing 1 day recency. Recency is not available for third-party audiences, so the list format is (3;);(4;);. To "AND" and "OR" groups of audiences, follow this example: To combine pairs with and without recency: ' ((1;1d;);(2;365d;));((3;);(4;5m;);(5;all;));'. This means (list 1 with 1 day recency OR list 2 with 365day recency ) AND (list 3 without a specified recency OR list 4 with 5 minute recency OR list 5 with all users).
Valid recency values are:
all, 1m, 5m, 10m, 15m, 30m, 1h, 2h, 3h, 6h, 12h, 1d, 2d, 3d, 5d, 7d, 10d, 14d, 15d, 21d, 28d, 30d, 45d, 60d, 90d, 120d, 180d, 270d, 365d
Audience Targeting - ExcludeNostring, list of list of pairsYesList of audience lists to exclude in targeting. Each audience is listed as a pair of UserList ID and recency setting, if the audience list is a 1P audience list. A pair is (1;1d;), where 1d is a sample recency representing 1 day recency. However, for 3P audiences, recency is not available, so the list format is (3;);(4;);. List format= (UserList.id; recency optional;); (UserList.id; recency optional;);
Example: "(1;1d;);(2;);".
Valid recency values are:
all, 1m, 5m, 10m, 15m, 30m, 1h, 2h, 3h, 6h, 12h, 1d, 2d, 3d, 5d, 7d, 10d, 14d, 15d, 21d, 28d, 30d, 45d, 60d, 90d, 120d, 180d, 270d, 365d
Affinity & In Market Targeting - IncludeNostring, listYesList of affinity and/or in-market audience lists to include. List format= UserList ID; UserList ID;
Affinity & In Market Targeting - ExcludeNostring, listYesList of affinity and/or in-market audience lists to exclude. List format= UserList ID; UserList ID;
Custom Affinity TargetingNostring, listYesList of custom lists to target. List format= UserList ID; UserList ID;
Inventory Source Targeting - IncludeRequired when "Type" is "Display" or "Video" or "Audio"string, listYesList of inventory to include in targeting. List format = (InventorySource.id; InventorySource.id;).
Inventory Source Targeting - ExcludeNostring, listYesList of inventory to exclude in targeting. List format = (InventorySource.id; InventorySource.id;).
Daypart TargetingNostring, listYesList of IDs, where each daypart ID is constructed in the following format:
daypart_id = base_dayparting_id
+ days_since_monday * 10000
+ start * 100
+ end

base_dayparting_id = 300000
days_since_monday: 0=Monday, 1=Tuesday, ..., 6=Sunday
start: 0..95 (00:00--23:45) an integer from 0-95, representing 15min slots
end: 1..96 (00:15--24:00); an integer from 0-95, representing 15min slots
start < end
For new entities, times will be set in the timezone of your users (i.e., "Local"). For existing entities, the timezone will not be changed.
Environment TargetingRequired when "Type" is "Display" or "Video" or "Audio"string, listYesList of environments to target. List format = (Desktop Web; Mobile App; etc.).
For Display Environment:
  • Desktop Web
  • Mobile Web
  • Mobile App
  • Mobile App Interstitial
  • Desktop Web on Mobile
For Video:
  • Desktop Web Video
  • Desktop Web Game
  • Desktop Web In-Read
  • Desktop Web In-Feed
  • Mobile Web Video
  • Mobile App Video
  • Mobile App Video Interstitial
For Audio:
  • Desktop Web Audio
  • Mobile Web Audio
  • Mobile App Audio
Viewability Targeting Active ViewNostringYesTarget predicted viewability percentages. Percentages are represented as floats. One of {0.1,0.2,0.3,0.4,0.5,0.6,0.7,0.8,0.9}
Viewability Targeting Ad Position - IncludeNostringYesTarget ad positions. Select one or none of the acceptable values:
  • All
  • ATF
  • BTF
  • Unknown
Viewability Targeting Ad Position - ExcludeNostringYesExclude ad positions in targeting. Select one or none of the acceptable values:
  • ATF
  • BTF
  • Unknown
Video Ad Position TargetingNostring, listYesList of video ad positions to target. Select one or more of the acceptable values:
  • unknown
  • Pre-roll
  • Mid-roll
  • Post-roll
Video Player Size TargetingNostring, listYesList of video ad player size to target. Select one or more of the acceptable values:
  • unknown
  • small
  • large
  • HD
Demographic Targeting GenderNostring, listYesList of genders to target. Select one or more of the acceptable values:
  • Female
  • Male
  • Unknown
Demographic Targeting AgeNostring, listYesTarget to a user age range. Specify a from/to range by selecting a single From age and a single To age and whether to include unknown ages true/false. See the list of acceptable From/To ages.
Example 1: to target 18-55 and include unknown ages, specify the format {From; To ; Include unknown True/False} = 18;55;true;
Example 2: to target only users >35 years old and exclude unknown ages, specify the following = 35;+;false;.
Acceptable values for From:
  • 18
  • 25
  • 35
  • 45
  • 55
  • 65

Acceptable values for To:
  • 25
  • 35
  • 45
  • 55
  • 65
  • +
Connection Speed TargetingNostringYesTarget to a specific connection speed. Select one of the acceptable values:
  • All
  • 2G
  • 3G
  • DSL
  • 4G
Carrier Targeting - IncludeNostring, listYesList of ISPs or Carriers to target. List format = {ISP.id; ISP.id;}
Carrier Targeting - ExcludeNostring, listYesList of ISPs or Carriers to exclude. List format = {ISP.id; ISP.id;}
TrueView Mobile Bid Adjustment OptionNostringYesEither 'Increase' or 'Decrease'
  • Increase
  • Decrease
TrueView Mobile Bid Adjustment PercentageNointegerYesBid adjustment to increase chances of showing ads on Mobile. Acceptable adjustments are for Bid Adjustment Option 'Increase': [0;900%]; and for 'Decrease': [0;90%] or 100%
TrueView Category Exclusions TargetingNostring, listYesList of categories to exclude. List format = Games; Tragedy and conflict; etc
  • Embedded Videos
  • Live Streaming
  • Games
  • Tragedy And Conflict
  • Sensitive Social Issues
  • Families
  • All Audiences
  • Younger Teens
  • Teens
  • Adults
  • Not Yet Rated
  • Sexually suggestive content
  • Sensational and shocking
  • Profanity and rough language
TrueView Inventory Source TargetingNostring, listYesLists of TrueView inventory sources to include
  • YouTube Search
  • YouTube Videos
  • Video Partners