Structured Data - v10 - Insertion Order

Io Id

Required only when editing existing insertion orders

integer

No

Numeric ID value of the insertion order. If left blank, a new Insertion Order ID will be created and a unique ID will be assigned. Optionally, when creating a new Insertion Order, you can use a custom identifier for the purpose of assigning Line Items to the new Insertion Order. 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, Line Item to Insertion Order) based on the custom identifiers.

Campaign Id

No

integer

No

Numeric ID value of the campaign. You can specify a custom identifier (for example, "ext[custom campaign identifier]") for a campaign that you are creating at the same time as this insertion order.

Name

Yes

string

Yes

The name of the entry.

Timestamp

Required when editing existing entries

integer

No

The timestamp for the entry, this is used by the system to verify that the entry has not changed between downloading and uploading.

Status

Yes

string

Yes

The status setting for the entry.

• Active
• Paused
• Draft
• Archived

Io Type

Yes

string

Yes

The type of the insertion order. Only settable on creation.

• standard

Io Subtype

Yes

string

Yes

Field required for Insertion Orders to distinguish between different formats. If the field is left empty 'default' value will be used'

• Default
• Regular Over The Top

Io Objective

Yes

string

Yes

The objective of the Insertion Order.

This field is in beta and currently only available to participating clients. This column will always be empty for customers not participating in the beta.

• Brand Awareness
• Click
• Conversion
• Custom
• No Objective

Fees

No

string, list of lists

Yes

All 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; Display & Video 360 Fee; False) ; (Media; 13; Default; True);'Acceptable values are provided in the following table:

Fee category	Fee Type	Invoiced option
CPM/Media	Default	Not permitted (leave blank)
CPM/Media	Third-Party Ad Server	Not permitted (leave blank)
CPM/Media	DoubleVerify	Permitted (True/False)
CPM/Media	Adsafe	Not permitted (leave blank)
CPM/Media	Adxpose	Not permitted (leave blank)
CPM/Media	Vizu	Not permitted (leave blank)
CPM/Media	Aggregate Knowledge	Not permitted (leave blank)
CPM/Media	Teracent	Not permitted (leave blank)
CPM/Media	Evidon	Not permitted (leave blank)
CPM/Media	Agency Trading Desk Fee	Not permitted (leave blank)
CPM/Media	Adloox	Permitted (True/False)
CPM	ShopLocal	Required (True)
CPM	TrustMetrics	Not permitted (leave blank)
CPM	Integral Ad Science Video	Permitted (True/False)
CPM	MOAT Video	Not permitted (leave blank)
Media	Display & Video 360 Fee	Required (True)
Media	Media Cost Data	Not permitted (leave blank)
Media	Scibids Fee	Required (True)

Integration Code

No

string

Yes

An optional code for tracking purposes.

Details

No

string

Yes

Entry details in string format.

Pacing

Yes

string

Yes

The time period used to spend to the pacing amount.

• Daily
• Monthly
• Flight

Pacing Rate

Yes

string

Yes

The rate of pacing for this entry.

• ASAP
• Even
• Ahead

'ASAP' is not compatible with 'Flight' pacing.

Pacing Amount

Yes

float

Yes

The amount to spend per the time period set by the pacing type.

Frequency Enabled

Yes

string

Yes

Enables/disables impression-based frequency capping on the insertion order.

• TRUE
• FALSE

Frequency Exposures

Required when "Frequency Enabled" is "TRUE"

integer

Yes

A 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 Period

Required when "Frequency Enabled" is "TRUE"

string

Yes

Specifies the time period unit for the frequency cap.

• Minutes
• Hours
• Days
• Weeks
• Months

Frequency Amount

Required when "Frequency Enabled" is "TRUE"

integer

Yes

Kpi Type

Yes

string

Yes

The KPI unit for the insertion order

• CPM
• CPA
• CPC
• CPV
• CPIAVC
• CTR
• % Viewability
• CPE
• Click CVR
• Impression CVR
• VCPM
• VTR
• Audio CR
• Video CR
• CPCL
• CPCV
• TOS10
• Maximize Pacing
• Custom impression value / cost
• None
• Other

Kpi Value

Yes

string

Yes

The KPI value in currency (CPM, CPA, CPC, CPV, CPIAVC, CPE, VCPM), percentage (% Viewability, CTR, Click CVR, Impression CVR, VTR, Audio CR, Video CR, CPCL, CPCA, TOS10), unitless (Custom impression value / cost), or as a string (Other). If the provided KPI type is 'Maximize Pacing' or 'None' then this column is ignored.

Kpi Algorithm Id

Required when "Kpi Type" is "Custom impression value / cost"

integer

Yes

The custom bidding algorithm ID associated with the Kpi if the Kpi type is CUSTOM_BIDDING_VALUE_COST. Otherwise, this column is ignored.

Budget Type

Yes

string

Yes

Specifies the type of budget in terms of an amount of "revenue" to spend (amount) or a number of impressions (impressions) to purchase.

• Amount
• Impressions

Budget Segments

Yes

string, list of lists

Yes

Specifies the specific budget segments. List format = (Budget, Start Date, End Date, Campaign Budget ID, Description). Budget is in currency floating format. Dates are in MM/DD/YYYY format. Campaign Budget ID is empty if not specified. Description cannot be empty for any budget segments. If an existing budget segment has an empty description, a description will need to be provided for the row to be uploaded. Example: "(100.50;01/01/2016;03/31/2016;12345;budget segment 1;);(200.00;04/01/2016;06/30/2016;;updated budget segment 1;);"

Auto Budget Allocation

Yes

string

Yes

Enables/disables auto-budget allocation

• TRUE
• FALSE

Insertion Order Optimization

Yes

string

Yes

Enables/disables insertion order optimization

If this column is set to 'TRUE', the line items under this insertion order will use the insertion order's bid strategy.

• TRUE
• FALSE

Bid Strategy Unit

Required when "Insertion Order Optimization" is "True"

string

Yes

Select bid strategy unit to optimize bidding:

• CPA
• CPC
• custom impr. value/cost
• CIVA
• IVO_TEN
• AV_VIEWED

Bid Strategy Do Not Exceed

Required when "Insertion Order Optimization" is "True"

float

Yes

Set a 'do not exceed' CPM value. If 0, 'do not exceed' is not enabled.

Apply Floor Price For Deals

Required when "Insertion Order Optimization" is "True"

string

Yes

Whether to prioritize deals over open auction inventory

• TRUE
• FALSE

Algorithm Id

Required when 'Bid Strategy Unit' custom impr. value/cost

integer

Yes

This corresponding algorithm ID must be used when Bid Strategy Unit is set to custom impr. value/cost.

Any floodlight activies used in the algorithm assigned to this column must be included in the 'Conversion Floodlight Activity Ids' column. Attempts to assign an algorithm without properly updating the 'Conversion Floodlight Activity Ids' column will result in an error.