Introduction
The Programmatic Creative API enables you to interact with programmatic creatives from the Programmatic Creative Library and the Creative Approval Queue outside of MRM.
With the Programmatic Creative API, you can:
- Retrieve and update programmatic creatives
- Review programmatic creatives to make sure the information is synced with the creatives in your upstream system
- Approve programmatic creatives
NOTE
Because of database capacity issues, the Programmatic Creative API V4 returns a maximum of 50 creatives per page, even if you request a larger number than that.
After 30 seconds, requests time out and receive a 500 error.
Programmatic Creative Approval Sequence Diagram
Note
Steps marked with an asterisk (*) in the diagram above are optional.
Programmatic Creative Object
| Field Name | Type | Value | Description |
|---|---|---|---|
| id | integer | Programmatic ad ID | |
| external_id | string | 1:4:34t52:342 | ID read from Demand Side Platform |
| industries | array of Industry objects | Refer to the list of industries. | |
| brands | array of Brand objects | Brand object sample: { "id": 1, "name": "Nissan" } | If you want to update a brand, contact your account team for a file with the appropriate values. |
| duration | integer | ||
| created_at | timestamp | Refers to the earliest date that the programmatic creative was created as an instance with a deal id in in your network. The value for this timestamp is usually later than that for dsp_creative_updated_at as programmatic creatives are ingested into your network. See Programmatic Creative Approval Workflow Diagram above. | |
| approval_status | string enum |
| |
| approval_notes | string | ||
| clock_number | string | ||
| universal_ad_id | UniversalAdID Object | { "universal_ad_id": { "id": "ABC/ABCD123/456", "registry_id": 2, "registry": "Clearcast" } } | |
| clearcast_codes | array of Clearcast Code objects | Clearcast code object sample: { "code": "C1", "id": 500, "name": "ccc1" } | |
| vod_final_action | object | Vod Final Action object sample: { "action_id": 15, "code": "Advice: OK", "type": "VOD" } | |
| linear_final_action | object | Sample: { "action_id": 9, "code": "ACCEPTABLE", "type": "Linear" } | |
| domain | string | "domain": "testdomain.com" | |
| vast_content_url | string | http://d329pke04dkw39.cloudfront.net/t/market-vast/145463/2019-12-06/vast.xml | |
| vast_wrapper_url | string | For Programmatic, this attribute provides the cURL URL that is pre-ingested by the DSP provided in the Demand Creative API. For the Private Marketplace Platform (PMP), this attribute provides the DSP Wrapper URL from the bid. | |
| deals | Array of Deal objects | ||
| status | String | Creative Status:
| Refers to whether there has been a bid with that creative in the last 90 days. |
| dsp_creative_updated_at | Timestamp | The dsp_creative_updated_at time refers to when a creative is first created in the MRM system globally or updated after it is ingested into your network. See Programmatic Creative Approval Workflow Diagram above. |
Deal Object
| Field Name | Type | Value | Description |
|---|---|---|---|
| id | integer | Deal ID | |
| deal_type | string |
| |
| deal_name | string | Amazon TEST 2020 PMP | |
| external_deal_id | string | XYZ-LVC-00003 | |
| buyer | Array of strings | ["Buyer test", "DO_NOT_TOUCH_Buyer_on_same_seat"] | |
| deal_schedule | Deal Schedule object | Deal Schedule object sample: { "end_date": "2020-10-26T03:59:00.000Z", "start_date": 2020-10-02T04:00:00.000Z, "timezone": "EDT" } | |
| approval_type | string enum |
| |
| clearance_level | string enum |
| |
| dsp_buyer_platform | string | Publica | |
| shared_external_deal_id | string | empty, or <=255 characters | A globally unique identifier. Represents a grouping of multiple Programmatic Module deals. Numerous deals can be linked to a single ID and viewed as one deal when interacting with DSPs. |