Creatives : Delta Projects

Creatives represent visible ad materials, provided as ad server tags, native ad declarations or VAST URLs.

Contact your Delta Projects representative to get your mediaAgencyId!

List Creatives

Description: List creatives on bidding plan
Verb: GET
Path:/api/v1/media_agency/<mediaAgencyId>/client/<clientId>/campaign/<campaignId>/activity/<activityId>/bidding_plan/<biddingPlanId>/creative

Request Parameters

Parameter	Type	Required	Description	Example
mediaAgencyId	Path	Yes	Id of media agency	86b35325-794c-11e4-8425-daf437376f87
clientId	Path	Yes	Id of client	86b35326-794c-11e4-8425-daf437376f87
campaignId	Path	Yes	Id of campaign. Must be "default" in v1	default
activityId	Path	Yes	Id of activity	86b35327-794c-11e4-8425-daf437376f87
biddingPlanId	Path	Yes	Id of bidding plan	86b35328-794c-11e4-8425-daf437376f87
apikey	Query	Yes	API key for authentication and authorization	secretkey123

Response JSON Body

Parameter	Parameter Type	Description	Example
`top level`	Array of Creative	creatives	See below

Creative Object

Parameter	Parameter Type	Description	Example
`id`	String	Id of creative	86b35328-794c-11e4-8425-daf437376fff
`type`	String	Creative type	"DISPLAY", "NATIVE" or "VAST"

Example Request

GET /api/v1/media_agency/86b35325-794c-11e4-8425-daf437376f87/client/86b35326-794c-11e4-8425-daf437376f87/campaign/default/activity/86b35327-794c-11e4-8425-daf437376f87/bidding_plan/86b35328-794c-11e4-8425-daf437376f87/creative?apikey=secret123

Example Response

[
  {
    "id": "86b35328-794c-11e4-8425-daf437376eee",
    "type": "DISPLAY",
  },
  {
    "id": "86b35328-794c-11e4-8425-daf437376fff",
    "type": "DISPLAY",
  }
]

Retrieve Creative

Description: Retrieve given creative
Verb: GET
Path: /api/v1/media_agency/<mediaAgencyId>/client/<clientId>/campaign/<campaignId>/activity/<activityId>/bidding_plan/<biddingPlanId>/creative/<creativeId>

Request Parameters

Parameter	Type	Required	Description	Example
`mediaAgencyId`	Path	Yes	Id of media agency	86b35325-794c-11e4-8425-daf437376f87
`clientId`	Path	Yes	Id of client	86b35326-794c-11e4-8425-daf437376f87
`campaignId`	Path	Yes	Id of campaign. Must be "default" in v1	default
`activityId`	Path	Yes	Id of activity	86b35327-794c-11e4-8425-daf437376f87
`biddingPlanId`	Path	Yes	Id of bidding plan	86b35328-794c-11e4-8425-daf437376f87
`creativeId`	Path	Yes	Id of creative	86b35328-794c-11e4-8425-daf437376fff
`apikey`	Query	Yes	API key for authentication and authorization	secretkey123

Response JSON Body

Parameter	Parameter Type	Description	Example
`id`	String	Id of creative	86b35328-794c-11e4-8425-daf437376fff
`type`	String	Creative type	"DISPLAY", "NATIVE" or "VAST"
`width`	Integer	Creative width (for DISPLAY only)	250
`height`	Integer	Creative height (for DISPLAY only)	240
`state`	String	Creative state	"PROCESSED"
`preview_image`	String	URL to creative preview (PNG) (for DISPLAY only)
`preview_video`	String	URL to creative preview (MP4) (for DISPLAY only)
`audit_statuses`	Array of AuditStatus	Creative audit statuses	See below

Creative preview URL´s are displayed without the apikey. To use to Url´s, remember to append your apikey!

Available Creative States:

"PROCESSED"
"PROCESSING"
"UNPROCESSED"
"UNPROCESSABLE"
"FETCHING_METADATA"

AuditStatus Object

Parameter	Parameter Type	Description	Example
`type`	String	Creative audit status type	"APPNEXUS"
`state`	String	Creative audit state	"ACCEPTED"
`reason`	String	Creative audit state reason	"audited"

Example Request

GET /api/v1/media_agency/86b35325-794c-11e4-8425-daf437376f87/client/86b35326-794c-11e4-8425-daf437376f87/campaign/default/activity/86b35327-794c-11e4-8425-daf437376f87/bidding_plan/86b35328-794c-11e4-8425-daf437376f87/creative/86b35328-794c-11e4-8425-daf437376fff?apikey=secret123

Example Response

{
  "id": "86b35328-794c-11e4-8425-daf437376fff",
  "type": "DISPLAY",
  "width": 250,
  "height": 240,
  "state": "PROCESSED",
  "audit_statuses": [
    {
      "type": "APPNEXUS",
      "state": "ACCEPTED",
      "reason": "audited"
    }
  ]
}

Upload Creative

Description: Upload a creative
Verb: POST
Path:/api/v1/media_agency/<mediaAgencyId>/client/<clientId>/campaign/<campaignId>/activity/<activityId>/bidding_plan/<biddingPlanId>/creative

Request Parameters

Parameter	Type	Required	Description	Example
`mediaAgencyId`	Path	Yes	Id of media agency	86b35325-794c-11e4-8425-daf437376f87
`clientId`	Path	Yes	Id of client	86b35326-794c-11e4-8425-daf437376f87
`campaignId`	Path	Yes	Id of campaign. Must be "default" in v1	default
`activityId`	Path	Yes	Id of activity	86b35327-794c-11e4-8425-daf437376f87
`biddingPlanId`	Path	Yes	Id of bidding plan	86b35328-794c-11e4-8425-daf437376f87
`apikey`	Query	Yes	API key for authentication and authorization	secretkey123

JSON body

Parameter	Type	Required	Description	Example
`type`	String	Yes	Creative type	`"DISPLAY"`, `"NATIVE"` or `"VAST"`
`appnexus_audit`	Boolean	No (default false)	true if the creative should be sent to AppNexus for auditing (may result in additional costs)	false
`payload`	String	Yes	Base64 encoded ad tag for `DISPLAY`, Base64 encoded ad declaration (see Native ads) for `NATIVE`, VAST URL for `VAST`	See below

Response

HTTP 202 Accepted

The uploaded creative will be asynchronously processed. Status of the process can be viewed by listing the creatives.

Example Request

POST /api/v1/media_agency/86b35325-794c-11e4-8425-daf437376f87/client/86b35326-794c-11e4-8425-daf437376f87/campaign/default/activity/86b35327-794c-11e4-8425-daf437376f87/bidding_plan/86b35328-794c-11e4-8425-daf437376f87/creative?apikey=secret123

Request Body DISPLAY

{
  "type":"DISPLAY",
  "payload": "ISEhIEJhc2U2NCBkZWNvZGluZyBhY2hpZXZlbWVudCBhd2FyZGVkICEhIQ0KDQpEZWx0YSBQcm9qZWN0c+KAmSBidXNpbmVzcyBpZGVhIGlzIHRvIG9mZmVyIHNvbHV0aW9ucyBmb3IgZWZmaWNpZW50IG9ubGluZSBtYXJrZXRpbmcuIFRoZSBpbnRlcm5ldCBhcyBhIHNhbGVzIGFuZCBtYXJrZXRpbmcgY2hhbm5lbCBoYXMgYSB2YXN0bHkgdW5leHBsb2l0ZWQgcG90ZW50aWFsLiBPdXIgbWlzc2lvbiBpcyB0byBzdXBwb3J0IHBlb3BsZSBhbmQgY29tcGFuaWVzIHV0aWxpemluZyB0aGUgZnVsbCBwb3RlbnRpYWwgb2YgaW50ZXJuZXQgaW4gYW4gb3B0aW1hbCBhbmQgY3JlYXRpdmUgd2F5Lg0KDQpDaGVlcnMNCi9EZWx0YSBkZXZlbG9wbWVudCB0ZWFt"
}

Request Body NATIVE

{
  "type":"NATIVE",
  "payload": "ewoJImxpbmsiIDogewoJCSJ1cmwiIDogImh0dHBzOi8vd3d3LmFjbWUuY29tIgoKCX0sCgkiYXNzZXRzIiA6IFsKCXsKCQkidGl0bGUiIDogewoJCQkidGV4dCIgOiAiV2UgTWFudWZhY3R1cmUgRXZlcnl0aGluZyIKCQl9Cgl9LAoJewoJCSJkYXRhIiA6IHsKCQkJImxhYmVsIiA6ICJzcG9uc29yZWQiLAoJCQkidmFsdWUiIDogIkFDTUUiCgkJfQoJfSwKCXsKCQkiaW1nIiA6IHsKCQkJInR5cGUiIDogIm1haW4iLAoJCQkidXJsIiA6ICJodHRwczovL3N0aW5nLmRlMTdhLmNvbS9maWxlcy8xNTE3NTgyNzAyMDAwLzAwMC8wMDAvMDAxLzYwMHgzNzUuanBnIgoKCQl9Cgl9LAoJewoJCSJpbWciIDogewoJCQkidHlwZSIgOiAiaWNvbiIsCgkJCSJ1cmwiIDogImh0dHBzOi8vc3RpbmcuZGUxN2EuY29tL2ZpbGVzLzE1MTc1ODI3MDIwMDAvMDAwLzAwMC8wMDIvNjAweDM3NS5wbmciCgkJfQoJfQoJXQp9"
}

Request Body VAST

{
  "type":"VAST",
  "payload":"http://vast.provider.com/adServer.php?cn=is&c=23&pl=VAST&pli=10962754&PluID=0&pos=9979⩝=[timestamp]&cim=1"
}

Creatives Print

List Creatives

Request Parameters

Response JSON Body

Creative Object

Example Request

Example Response

Retrieve Creative

Request Parameters

Response JSON Body

AuditStatus Object

Example Request

Example Response

Upload Creative

Request Parameters

Response

Example Request

Request Body DISPLAY

Request Body NATIVE

Request Body VAST

Related Articles