API Reference
GuidesAPI ReferenceAuthentication

Programmatic Creative API V4

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

This object is used when updating a programmatic creative via PUT.

Field NameTypeValueDescription
idintegerProgrammatic ad ID
external_idstring1:4:34t52:342ID read from Demand Side Platform
industriesarray of Industry objectsRefer to the list of industries.
brandsarray of Brand objectsBrand object sample:

{
"id": 1,
"name": "Nissan"
}		If you want to update a brand, contact your account team for a file with the appropriate values.
durationinteger
created_attimestampRefers 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_statusstring enum
  • APPROVED
  • REJECTED
  • PENDING
approval_notesstring
clock_numberstring
universal_ad_idUniversalAdID Object{
"universal_ad_id": {
"id": "ABC/ABCD123/456",
"registry_id": 2,
"registry": "Clearcast"
}
}
clearcast_codesarray of Clearcast Code objectsClearcast code object sample:

{
"code": "C1",
"id": 500,
"name": "ccc1"
}
vod_final_actionobjectVod Final Action object sample:

{
"action_id": 15,
"code": "Advice: OK",
"type": "VOD"
}
linear_final_actionobjectSample:

{
"action_id": 9,
"code": "ACCEPTABLE",
"type": "Linear"
}
domainstring"domain": "testdomain.com"
vast_content_urlstringhttp://d329pke04dkw39.cloudfront.net/t/market-vast/145463/2019-12-06/vast.xml
vast_wrapper_urlstringFor 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.
dealsArray of Deal objectsSee Deal Object table
statusStringCreative Status:
  • ACTIVE
  • INACTIVE
Refers to whether there has been a bid with that creative in the last 90 days.
dsp_creative_updated_atTimestampThe 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.
external_approval_notesstringProvides the external approval notes. This is visible to demand partners using the Demand Partner APIs.

Deal Object

Field NameTypeValueDescription
idintegerDeal ID
deal_typestring
  • DEAL
  • PROGRAMMATIC_GUARANTEED_DEAL
  • FIRST_LOOK_DEAL
  • BIDDABLE_GUARANTEED_DEAL
  • BACKFILL_DEAL
deal_namestringAmazon TEST 2020 PMP
external_deal_idstringXYZ-LVC-00003
buyerArray of strings["Buyer test", "DO_NOT_TOUCH_Buyer_on_same_seat"]
deal_scheduleDeal Schedule objectDeal Schedule object sample:

{
"end_date": "2020-10-26T03:59:00.000Z",
"start_date": 2020-10-02T04:00:00.000Z,
"timezone": "EDT"
}
approval_typestring enum
  • NO_APPROVAL
  • GLOBAL
  • CLIENT

clearance_levelstring enum
  • PERMISSIBLE
  • RESTRICTIVE

dsp_buyer_platformstringPublica
shared_external_deal_idstringempty, or <=255 charactersA 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.