Create Creative
This endpoint allows you to create a creative in the Life platform Creative Library. There are three different objects available on this endpoint which allows you to distinguish the type of 3rd party ad tag you will be sending:
- HTML Display: Standard display ads
- Expandable HTML Display: These are banner ads that start at a standard size (like 300x250) but can expand to a larger size when a user interacts with them—typically on hover or click.
- Video Creative: These are video ad units that play within a video player, either before (pre-roll), during (mid-roll), or after (post-roll) video content, or as standalone outstream/in-banner video.
You will only send in one of these objects in the request. If the creative type you have is not one of these three, it is not yet supported to be created via API.
Endpoint
Method: POST
https://lifeapi.pulsepoint.com/RestApi/v2/lifecreative/account/{accountId}
Path Parameter: The account ID that you want the creative to belong to via an advertiser.
Field List
HTMLCreativeRequestDTO
| Name | Data Type | Required | Notes |
|---|---|---|---|
| name | string | Yes | creative name |
| advertiserName | string | Yes | |
| adSizeHeight | numeric | Yes | |
| adSizeWidth | numeric | Yes | |
| domainLandingPage | string | Yes | |
| adChoicesIcon | string, ENUM | Yes | Valid Values: TopRight, TopLeft, BottomRight, BottomLeft, None |
| notes | string | No | |
| placementId | string | No | 3rd party adserver ID |
| campaignRestrictName | string | No | If you want to ensure that this creative doesn't display alongside another campaign's creative, you will submit the Life campaign name in this field. |
| categoryName | array of strings | No | IAB Pharma Categories |
| dsaAdvertiser | string | No/Yes | It is only a required field if set to be required at the account level. |
| financier | string | No/Yes | It is only a required field if dsaAdvertiser is set to be required at the account level. |
| creativeType | string, ENUM | Yes | For this object it should only be "html" |
| creativeHtml | string | Yes |
ExpandableHTMLCreativeRequestDTO
| Name | Data Type | Required | Notes |
|---|---|---|---|
| name | string | Yes | creative name |
| advertiserName | string | Yes | |
| adSizeHeight | numeric | Yes | |
| adSizeWidth | numeric | Yes | |
| domainLandingPage | string | Yes | |
| adChoicesIcon | string, ENUM | Yes | Valid Values: TopRight, TopLeft, BottomRight, BottomLeft, None |
| notes | string | No | |
| placementId | string | No | 3rd party adserver ID |
| campaignRestrictName | string | No | If you want to ensure that this creative doesn't display alongside another campaign's creative, you will submit the Life campaign name in this field. |
| categoryName | array of strings | No | IAB Pharma Categories |
| dsaAdvertiser | string | No/Yes | It is only a required field if set to be required at the account level. |
| financier | string | No/Yes | It is only a required field if dsaAdvertiser is set to be required at the account level. |
| creativeType | string, ENUM | Yes | For this object it should only be "expandable" |
| creativeHtml | string | Yes | |
| expandDirection | string, ENUM | Yes | Valid Values: Up, Down, Left, Right, Up Left, Up Right, Down Left, Down Right |
VideoCreativeRequestDTO
| Name | Data Type | Required | Notes |
|---|---|---|---|
| name | string | Yes | creative name |
| advertiserName | string | Yes | |
| adSizeHeight | numeric | Yes | |
| adSizeWidth | numeric | Yes | |
| domainLandingPage | string | Yes | |
| adChoicesIcon | string, ENUM | Yes | Valid Values: TopRight, TopLeft, BottomRight, BottomLeft, None |
| notes | string | No | |
| placementId | string | No | 3rd party adserver ID |
| campaignRestrictName | string | No | If you want to ensure that this creative doesn't display alongside another campaign's creative, you will submit the Life campaign name in this field. |
| categoryName | array of strings | No | IAB Pharma Categories |
| dsaAdvertiser | string | No/Yes | It is only a required field if set to be required at the account level. |
| financier | string | No/Yes | It is only a required field if dsaAdvertiser is set to be required at the account level. |
| creativeType | string, ENUM | Yes | For this object it should only be "video" |
| source | string, ENUM | Yes | Valid Values: VAST_Doc (when type is HTML5_VPAID or MP4_VIDEO), VAST_URL (when type is HTML5_VPAID or MP4_VIDEO), URL (when type is FLV, MP4_VIDEO) |
| type | string, ENUM | Yes | Valid Values: FLV, MP4_VIDEO, HTML5_VPAID |
| duration | numeric | Yes | The length of the view in seconds |
| clickThroughURL | string | Yes | |
| bitRate | numeric | No | |
| videoURL | string | No | |
| videoSkippingAfter | numeric | No | Seconds before skip button appears |
Example Request
{
"adChoicesIcon": "TopRight",
"creativeType": "html",
"advertiserName": "TAMTESTING ACCOUNT",
"name": "Rachel Testing API",
"adSizeHeight": 90,
"adSizeWidth": 728,
"domainLandingPage": "http://cookmedical.com",
"creativeHtml": "<div style=\"width: 728px; height: 90px; position:relative;\"><div style=\"position:absolute;z-index:1;width: 728px; height: 90px; cursor:pointer\" id=\"PPclickTagLayer\"></div><IFRAME style=\"position:absolute; width:728px; height:90px; z-index:-1\" frameborder=0 src=\"https://media-active.contextweb.com/creatives/5132/1749676267164/PI-WF324450-EN-F 2/index.html\"></IFRAME> </div><script type=\"text/javascript\"> var clickTag = \"%%PRECLICKURL%%https%3A%2F%2Fwww.cookmedical.com%2Fproducts%2F3901d990-413b-493d-8445-44a72334cb6d%2F\"; (function() { var layer = document.getElementById(\"PPclickTagLayer\"); if (layer) { var listen = function(obj, e, fn) {if (obj.addEventListener) { obj.addEventListener(e, fn, false); } else { obj.attachEvent(\"on\"+e, fn); }};listen(layer, 'click', function (evt) {evt.stopPropagation(); try { evt.cancelBubble(); } catch (e) { /* ignore */ } window.open(window.clickTag, '_blank'); }); }})();</script>"
}Response
{
"creativeType":"html",
"id":976317,
"name":"Rachel Testing API",
"adSizeWidth":728,
"adSizeHeight":90,
"domainLandingPage":"http://cookmedical.com",
"obaIconOnly":false,
"accountId":561939,
"categoryNames":[
],
"advertiserId":5132,
"adFormat":"GenericHtml",
"creativeHtml":"<div style=\"width: 728px; height: 90px; position:relative;\"><div style=\"position:absolute;z-index:1;width: 728px; height: 90px; cursor:pointer\" id=\"PPclickTagLayer\"></div><IFRAME style=\"position:absolute; width:728px; height:90px; z-index:-1\" frameborder=0 src=\"https://media-active.contextweb.com/creatives/5132/1749676267164/PI-WF324450-EN-F 2/index.html\"></IFRAME> </div><script type=\"text/javascript\"> var clickTag = \"%%PRECLICKURL%%https%3A%2F%2Fwww.cookmedical.com%2Fproducts%2F3901d990-413b-493d-8445-44a72334cb6d%2F\"; (function() { var layer = document.getElementById(\"PPclickTagLayer\"); if (layer) { var listen = function(obj, e, fn) {if (obj.addEventListener) { obj.addEventListener(e, fn, false); } else { obj.attachEvent(\"on\"+e, fn); }};listen(layer, click, function (evt) {evt.stopPropagation(); try { evt.cancelBubble(); } catch (e) { /* ignore */ } window.open(window.clickTag, _blank); }); }})();</script>",
"html5":false
}Updated 4 months ago
