Overview
The Marketplace Creative API V4 allows publishers to update the creative metadata of Marketplace Exchange programmatic creatives, Marketplace Private direct sold creatives, and Marketplace Private programmatic creatives. This API's main function is to approve or reject creatives that appear in the Creative Approval Queue. Publishers can also use approval notes to elaborate on a creative's approval decision, as well as assign creatives to industries and brands.
Use the Marketplace Creative API V4 to accomplish the following tasks:
- Update creative approval status to Approved, Pending, or Rejected
- Add internal and external approval notes
- Set industries and brands for programmatic creatives
General Resource Uniform Resource Identifiers (URI)
| Type | Production URI | Staging URI |
|---|---|---|
| Marketplace Exchange Programmatic | https://api.freewheel.tv/services/v4/mkpl_exchange_programmatic_creatives | https://api.stg.freewheel.tv/services/v4/mkpl_exchange_programmatic_creatives |
| Marketplace Private Direct Sold | https://api.freewheel.tv/services/v4/mkpl_private_direct_sold_creatives | https://api.stg.freewheel.tv/services/v4/mkpl_private_direct_sold_creatives |
| Marketplace Private Programmatic | https://api.freewheel.tv/services/v4/mkpl_private_programmatic_creatives | https://api.stg.freewheel.tv/services/v4/mkpl_private_programmatic_creatives |
Attributes
Users can include these attributes when updating a creative's metadata with the PUT method. For interactive examples, please see the endpoint subpages.
Note
Currently, only programmatic creatives support
industriesandbrands.
| Name | Type | Description |
|---|---|---|
| mkpl_exchange_programmatic_creative_id mkpl_private_direct_sold_market_ad_id mkpl_private_programmatic_market_ad_id | integer | FreeWheel-assigned creative identifier |
| approval_status | string | New status of the creative Valid values: Approved Rejected Pending |
| approval_notes | string | Internal approval notes |
| external_approval_notes | string | External approval notes, visible to demand partners via the Deal Sync API |
| industries | object | Ad industries |
| brands | object | Ad brands |
Industries Child Attributes
| Name | Type | Description |
|---|---|---|
| values | array of strings | Key-value pairs of industries |
Brands Child Attributes
| Name | Type | Description |
|---|---|---|
| values | array of strings | Key-value pairs of brands |