Component Creatives
/
Get Details of a Creative

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.

Download OpenAPI description
component-creatives.json
component-creatives.yaml
Overview
URL https://www.mediamath.com/contact-us/
API Support developers@mediamath.com
License Apache 2.0
Languages
Servers
https://t1.mediamath.com/

Component Creatives

Operations

Get Creative's Eligibility Details

Request

Get creative's eligibility details

Path
atomic_creative_idstringrequired

See below

curl -i -X GET \
  'https://t1.mediamath.com/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

curl -i -X GET \
  'https://t1.mediamath.com/component_creatives/v1.0/creatives/{atomic_creative_id}'

Responses

start_date and end_date are not required fields, but they either both exist or don't exist per creative.

If the asset_type is text, asset_value is defined, otherwise, the 5 parameters that begin "image_" are defined.

Bodyapplication/json
Response
application/json
{
  "data": {
    "advertiser_id": 166476,
    "advertiser_name": "000Adam Test Advertiser",
    "assets": [ … ],
    "atomic_creative_id": 4813554,
    "concept_id": "1432620",
    "concept_name": "LVR_US_IN_New Collection_Female_23June2017",
    "created_at": "2017-09-25T19:22:41.788Z",
    "creative_id": 1205,
    "creative_name": "LVR_US_IN_NewCollection_612x612_28June_06",
    "external_identifier": "NA",
    "last_modified": "2017-09-25T19:22:00",
    "last_published": "2018-03-06T16:00:27.624Z",
    "status": "1",
    "unpublished": false,
    "updated_at": "2018-03-06T16:00:27.624Z"
  },
  "meta": {
    "code": 200,
    "status": "success",
    "type": "creative"
  }
}

Update Creatives Details

Request

Update creatives details

Caution

If the the parameter assets is defined, then all previous assets belonging to this creative are replaced with this new array of assets. You can avoid deleting assets by adding the asset by id to the assets param like so [{"asset_id":34223}] :::

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_filename 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"}]"

Path
atomic_creative_idstringrequired

atomic_creative_id

Headers
adama_sessionstring

See below

Bodyapplication/json

See below

any
curl -i -X POST \
  'https://t1.mediamath.com/component_creatives/v1.0/creatives/{atomic_creative_id}' \
  -H 'Content-Type: application/json' \
  -H 'adama_session: string'

Responses

Different asset types use different parameters

Bodyapplication/json
Response
application/json
{
  "data": {
    "advertiser_id": 100178,
    "assets": [ … ],
    "atomic_creative_id": 3200795,
    "created_at": "2016-11-17T17:29:39.607Z",
    "creative_id": 261,
    "creative_name": "The updated name of the creative",
    "end_date": "2016-10-17T00:00:00",
    "external_identifier": "NA",
    "last_modified": "2016-11-17T17:47:43",
    "last_published": "2016-11-17T17:29:39.607Z",
    "start_date": "2016-10-15T00:00:00",
    "status": "1",
    "unpublished": false,
    "updated_at": "2016-11-17T17:29:39.607Z"
  },
  "meta": {
    "code": 200,
    "status": "updated",
    "type": "creative"
  }
}