Component Creatives API (1.0)

The terms creative components and native components may be used interchangeably. The front part of the endpoint is:

QA API Base: https://t1qa1.mediamath.com/component_creatives/v1.0/ (or whichever QA server is being used)

Prod API Base: https://t1.mediamath.com/component_creatives/v1.0

Component Creatives are uploaded in the "Creatives Tab" within the Creatives Module, and is where creatives for native campaigns are uploaded.

Languages
Servers
Mock server
https://apidocs.mediamath.com/_mock/apis/component-creatives/
https://t1.mediamath.com/

Component Creatives

Operations

List Creatives

Request

List creatives

Query
statusinteger[ 0 .. 1 ]

status

sort_bystring

sort_by

Enum"atomic_creative_id""advertiser_id""advertiser_name""concept_name""start_date""end_date""concept_id""creative_name""last_modified""external_identifier"
page_limitinteger[ 1 .. 100 ]

page_limit

Default 20
page_offsetinteger

page_offset

Default 0
advertiser_idinteger

advertiser_id

curl -i -X GET \
  'https://apidocs.mediamath.com/_mock/apis/component-creatives/component_creatives/v1.0/creatives?advertiser_id=0&page_limit=20&page_offset=0&sort_by=atomic_creative_id&status=1'

Responses

Bodyapplication/json
Response
application/json
{ "data": [ {}, {} ], "meta": { "code": 200, "count": 2, "next_page": "http://component-creative-api.prod.cbe.mediamath.com/v1.0/creatives?page_offset=2&page_limit=2", "offset": 0, "status": "success", "total_count": 864, "type": "creatives" } }

Create a New Creative

Request

Create a new creative

Bodyapplication/json

See below

any
curl -i -X POST \
  https://apidocs.mediamath.com/_mock/apis/component-creatives/component_creatives/v1.0/creatives \
  -H 'Content-Type: application/json'

Responses

Remember, assets have different schema depending on asset type.

Header: Cookie: adama_session={adama_session}

Headers
new1579011858564string
Bodyapplication/json
Response
application/json
{ "data": { "advertiser_id": 100178, "advertiser_name": "Brooklyn Bubblegum Co.", "assets": [], "atomic_creative_id": 3200795, "created_at": "2016-11-17T17:29:39.607Z", "creative_id": 261, "creative_name": "test creative", "end_date": "2016-11-30T00:00:00", "external_identifier": "NA", "last_modified": "2016-11-17T17:30:55", "last_published": "2016-11-17T17:29:39.607Z", "start_date": "2016-09-30T00:00:00", "status": "1", "unpublished": false, "updated_at": "2016-11-17T17:29:39.607Z" }, "meta": { "code": 201, "status": "created", "type": "creative" } }

Get Group Version Info

Request

Get group version info

curl -i -X GET \
  https://apidocs.mediamath.com/_mock/apis/component-creatives/component_creatives/v1.0/version

Responses

Bodyapplication/json
Response
application/json
{ "version": "cfb1074-20190419202430" }

List Creative Approvals

Request

List Creative Approvals

Query
atomic_creative_idsstringrequired

Actually, an integer or comma-delimited list not to exceed 50 items

curl -i -X GET \
  'https://apidocs.mediamath.com/_mock/apis/component-creatives/component_creatives/v1.0/approvals?atomic_creative_ids=string'

Responses

See below

Bodyapplication/json
Response
application/json
{ "data": [ {}, {}, {} ], "meta": { "code": 200, "status": "success", "type": "approvals" } }

Post an Image or Subtitle Asset

Request

Note about image assets:

Base64 encoded image assets can be uploaded via this endpoint. This new image asset is represented in the assets param as an object containing an encoded_image_file and image_name properties. Example assets: "[{"encoded_image_file": base64_data_here, "image_filename":"logo.png"}]"

Note about subtitle assets:

Base64 encoded subtitle assets can be uploaded via this endpoint. This new subtitle asset is represented in the assets param as an object containing an encoded_subtitle_file and subtitle_filename properties. Example assets: "[{"encoded_subtitle_file": base64_data_here, "subtitle_filename":"test.srt"}]"

Header should be of format: Cookie: adama_session={adama_session}

Headers
adama_sessionstring

See below

Bodyapplication/json

See below

any
curl -i -X POST \
  https://apidocs.mediamath.com/_mock/apis/component-creatives/component_creatives/v1.0/approvals \
  -H 'Content-Type: application/json' \
  -H 'adama_session: string'

Responses

All assets have asset_id, asset_type, component_id, and component_human_name. asset_type=text also have asset_value. asset_type=image have the 5 parameters that start with "image_"

Bodyapplication/json
Response
application/json
{ "data": { "advertiser_id": 100178, "advertiser_name": "Brooklyn Bubblegum Co.", "assets": [], "atomic_creative_id": 3200795, "created_at": "2016-11-17T17:29:39.607Z", "creative_id": 261, "creative_name": "test creative", "end_date": "2016-11-30T00:00:00", "external_identifier": "NA", "fb_status": "UNKNOWN", "last_modified": "2016-11-17T17:30:55", "start_date": "2016-09-30T00:00:00", "status": "1", "updated_at": "2016-11-17T17:29:39.607Z" }, "meta": { "code": 201, "status": "created", "type": "creative" } }

Get Creative's Eligibility Details

Request

Get creative's eligibility details

Path
atomic_creative_idstringrequired

See below

curl -i -X GET \
  'https://apidocs.mediamath.com/_mock/apis/component-creatives/component_creatives/v1.0/creatives/{atomic_creative_id}/eligibility'

Responses

Bodyapplication/json
Response
application/json
{ "data": [ {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {} ], "meta": { "code": 200, "status": "success", "type": "creative_eligibility" } }

Get Details of a Creative

Request

Get details of a creative

Path
atomic_creative_idintegerrequired

See below