This is a preview and draft version of the Proposed IO API v4. This document is subject to change as the implementation is completed, and will be updated accordingly.
Introduction
Proposal capability in MRM is enabled through a Network Function. Contact your account manager if you are interested in this functionality. Proposed IOs act as organizational groups of Proposed Placements.
You can use this API to:
List Proposed Insertion Orders
Create a Proposed Insertion Order
Update a Proposed Insertion Order
Show information about a Proposed Insertion Order
List Proposed Placements of a Proposed Insertion Order
The date/time format should follow the ISO-8061 format in UTC timezone for create requests, update requests and get responses; for example: 2018-01-20T13:00:00Z.
Valid and required only when budget_model == 'CURRENCY_TARGET'
impression
Integer
The impression goal of the insertion order
Required
Required
Valid and required only when budget_model == 'IMPRESSION_TARGET'
over_delivery
Float
The over delivery amount percentage
Yes
Yes
Valid only when budget_model == 'CURRENCY_TARGET' or 'IMPRESSION_TARGET'. When no custom value is set, we'll return the network default value and the over_delivery_type will be DEFAULT.
over_delivery_type
['CUSTOM', 'DEFAULT']
The over delivery type.
Yes
Yes
Valid only when budget_model == 'CURRENCY_TARGET' or 'IMPRESSION_TARGET'. In Create/Update request, when over_delivery_type = 'DEFAULT', any given over_delivery value is ignored.
