Getting StartedAPI ReferenceAuthentication

Partner Tag Creative API V4

Introduction

The Partner Tag Creative API enables you to interact with partner-tag creatives from the creative approval queue outside of MRM.

With the Partner Tag Creative API, you can:

  • Update partner-tag creatives
  • Approve partner-tag creatives

Objects

Partner Tag Creative Object

Field Name Type Sample Value
id int 100000
external_id string "pt:doubleclick.net/123"
industries list of Industry Object [

  {
    "id": 96,
    "type": "INDUSTRY",
    "name": "Automobile Manufacture"
  },
  {
    "id": 97,
    "type": "INDUSTRY",
    "name": "Automobile Parts and Accessories Manufacture"
  }

]
brands list of Brand Object [

  {
    "id": 1079143,
    "name": "Cadillac"
  }

]
duration int 30
created_at time

"2022-05-11T15:00:30Z",
universal_ad_id UniversalAdID Object

{
    "id": "ABCD1234000H",
    "registry": "Ad-ID",
    "registry_id": 1
}
domain string "cadillac.com"
approval_status string enum
  • PENDING
  • APPROVED
  • REJECTED
approval_notes string "SK 5/12/22 - Submitted"
external_approval_notes string "external approval notes"
vast_content_url string

"http://dcmzycmaqpxf5.cloudfront.net/t/market-vast/123/2022-05-11/vast.xml"
vast_wrapper_url string "http://dcmzycmaqpxf5.cloudfront.net/t/market-vast-wrapper/123/2022-05-11/wrapper_vast.xml"
status string enum
  • ACTIVE
  • INACTIVE
partner_tag_creative_updated_at time "2022-05-11T00:00:30Z",
order_ids list of int [ 61000, 61001]

Deal Object

Field NameTypeValueDescription
mkpl_order.idintegerDeal ID
order_typestring
  • DEAL
  • PROGRAMMATIC_GUARANTEED_DEAL
  • FIRST_LOOK_DEAL
  • BIDDABLE_GUARANTEED_DEAL
  • BACKFILL_DEAL
order_namestringAmazon TEST 2020 PMP
external_order_idstringXYZ-LVC-00003
marketplace_partner_nameArray of strings["Buyer test", "DO_NOT_TOUCH_Buyer_on_same_seat"]This should be the partner name from the Marketplace Order.
order_scheduleDeal Schedule objectDeal Schedule object sample:

{
"end_date": "2020-10-26T03:59:00.000Z",
"start_date": 2020-10-02T04:00:00.000Z,
"timezone": "EDT"
}
order_approval_typestring enum
  • NO_APPROVAL
  • GLOBAL (Same as the Managed Approval setting in the MRM UI)
  • CLIENT
order_clearance_levelstring enum
  • PERMISSIBLE
  • RESTRICTIVE

dsp_buyer_platformstringPublica

Universal Ad ID Object

Field Name Type Sample Values
id string

"ABCD1234000H" (Ad-ID format)

"AAA/BBBB123/456" (Clearcast format)
registry string enum
  • Ad-ID
  • Clearcast
registry_id int enum
  • 1 (Ad-ID)
  • 2 (Clearcast)

INDUSTRY OBJECT

Field Name Type Sample Values
id int 96
type string enum
  • INDUSTRY
  • GROUP
name string

"name": "Automobile Manufacture"

BRAND OBJECT

Field Name Type Sample Values
id int 1079143
name string

"Cadillac"