Creatives (coming soon)

Creatives represent the design files that the advertiser would like to appear on the ads.

We currently accept .jpg and .png file types.

The Creative Object

id: integer
name: string
url: string
advertiser_id
width: integer (width in pixels)
height: integer (height in pixels)
approvals: array
rejections: array
campaigns: array of campaing_id and approval status (PENDING | APPROVED | REJECTED)

Endpoints

Summary

POST /creatives #=> Create creative
GET /creatives #=>  List creatives
POST /creatives/:id/campaign/:campaign_id #=> Request approval for campaign
GET /creatives/:id #=> Get specific creative

Create Creative

create Creative

POSThttps://www.example.com/v1/campaigns/{campaign_token}/creatives

Path parameters

campaign_token*string

Header parameters

Body

application/json

file_url*string

Response

200

successful

Body

application/json

id*integer

programmatic_plan_id*integer

upload_id*integer

approved_atnull,string (date)

rejected_atnull,string (date)

created_at*string (date)

updated_at*string (date)

iab_category_id*nullinteger

width*string

height*string

external_id*string

error_atnull,string (date)

deleted_atnull,string (date)

ignore_videonull,string (date)

errornullstring

resolution_id*nullinteger

metadatanullobject

file_hash*string

dcm_tagnullstring

dcm_video_durationnullstring

dcm_video_bitratenullstring

Request

JavaScriptCurlPython

const response = await fetch('https://www.example.com/v1/campaigns/{campaign_token}/creatives', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "file_url": "text"
    }),
});
const data = await response.json();

Response

200

{
  "created_at": "2024-11-26",
  "updated_at": "2024-11-26",
  "width": "text",
  "height": "text",
  "external_id": "text",
  "file_hash": "text"
}

List Creatives

GET /creatives

Expects:
- advertiser_id (optional) #=> filters responses to only that advertiser

Returns: paginated array of creatives inside a "records" key

Request approval for campaign

POST /creatives/:id/campaign/:campaign_id

Expects:
- creative_id
- campaign_id

Returns: Creative Object

Get Creative

GET /creatives/:id

Expects:
- id

Returns: the creative object