Warning
This is a preview and draft version of the Proposed Ad API v4. This document is subject to change as the implementation is completed, and will be updated accordingly.
Introduction
Proposed Ads are the ads booked in proposed placements. They are used to pair ad opportunities in a request with the appropriate ads in placements.
Proposal capability in MRM is enabled through a Network Function. Contact your Account Manager if you are interested in this functionality.
You can use this API to:
- Create a Proposed Ad
- Update a Proposed Ad
- Show information about a Proposed Ad
- Delete a Proposed Ad
Resources
URIs
| Environment | URI |
|---|---|
| Staging | https://api.stg.freewheel.tv/services/v4/proposed_ads |
| Production | https://api.freewheel.tv/services/v4/proposed_ads |
Basic Attributes
Note
Ad unit package is not supported at this time.
The following attributes are included in basic GET requests.
| Name | Type | Description | Creatable? | Updatable? | Notes |
|---|---|---|---|---|---|
| id | FW_ID | The ID of of the Proposed Ad | No | No | |
| placement_id | FW_ID | The ID of the parent proposed placement to which this Ad belongs | No | No | |
| name | String | The name of the Proposed Ad | No | No | |
| ad_unit_id | FW_ID | The ad_unit_id of the Proposed Ad | Required | No | |
| external_id | String | The external_id of the Proposed Ad | No | Yes | |
| status |
| The status of the Proposed Ad | Yes | Yes | These values must be provided in ALL CAPITAL letters |
| price_model |
| The price_model of the Proposed Ad | No | No | |
| price | Float | The price of the Proposed Ad | No | Yes | |
| budget | Custom Data Type | The budget info of the Proposed Ad | No | Yes | |
| type |
| The type of the Proposed Ad | No | No | |
| regulated_display | Boolean | Indicate if the ad unit node is a regulated display ad | No | Yes | Valid only when type == DISPLAY and link_method = LINK_WHERE_POSSIBLE or ALL_LINKED |
| created_at | DateTime | Time when the Proposed Ad is created | No | No | |
| updated_at | DateTime | Time when the Proposed Ad is updated most recently | No | No |
Ad Budget Attributes - Child Attributes
Both of the following attributes are updatable.
| Name | Type | Description | Creatable?` | Notes |
|---|---|---|---|---|
| impression_cap | Integer | The impression cap of the Ad | No` | Valid only when link_method is NOT_LINKED, LINK_WHERE_POSSIBLE or advanced linking. |
| exclude_from_budget | Boolean | Excluded from budget or not | No | Valid only when link_method is LINK_WHERE_POSSIBLE, ALL_LINKED or custom set. |