{"_id":"56cf7a9544c5700b0095c207","__v":9,"githubsync":"","parentDoc":null,"project":"56c35c56c0c4630d004e864c","editedParams2":true,"user":"56c39c05bc41330d009f25d7","version":{"_id":"56c35c56c0c4630d004e864f","project":"56c35c56c0c4630d004e864c","__v":8,"createdAt":"2016-02-16T17:28:54.864Z","releaseDate":"2016-02-16T17:28:54.864Z","categories":["56c35c57c0c4630d004e8650","56c7b9e5379b311700ed8fe3","56c7bab4606ee717003c4766","56c7bb3613e5400d001e8cbd","56cf3f5a5267d70b00494c4b","56cf3f866c5d7a13005ee894","56fd3956caad892200847bce","599da256e7742b002588bb02"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"0.5.0","version":"0.5"},"category":{"_id":"56cf3f866c5d7a13005ee894","__v":67,"project":"56c35c56c0c4630d004e864c","version":"56c35c56c0c4630d004e864f","pages":["56cf5bb88629f91300fd97c5","56cf5bf68629f91300fd97c7","56cf5fd2287eb20b009f9f37","56cf631a44c5700b0095c1c8","56cf63ae6c5d7a13005eeb58","56cf6408287eb20b009f9f40","56cf643a287eb20b009f9f43","56cf65ba336aa60b0086a435","56cf66df336aa60b0086a440","56cf69b344c5700b0095c1cf","56cf6a3d44c5700b0095c1d3","56cf6ac6336aa60b0086a44e","56cf6b298acacb13008148c9","56cf6cd68629f91300fd97e3","56cf6e048acacb13008148cd","56cf6eac336aa60b0086a455","56cf6edf287eb20b009f9f5a","56cf6f6b336aa60b0086a462","56cf704e8629f91300fd97f0","56cf70bf6c5d7a13005eeb6f","56cf72c6287eb20b009f9f76","56cf74c86c5d7a13005eeb7f","56cf75f5336aa60b0086a496","56cf76b68629f91300fd9801","56cf76da8629f91300fd9805","56cf776c8acacb13008148dc","56cf77ca6c5d7a13005eeb92","56cf788044c5700b0095c1fe","56cf78c28acacb13008148e5","56cf7a9544c5700b0095c207","56cf7b9b44c5700b0095c20c","56cf7c268629f91300fd980f","56cf7c456c5d7a13005eeba4","56d097b1376b040b005b3029","56d0992940d36e1d00bc13dd","56d099ed167e1e1b008079d2","56d09afa376b040b005b3032","56d09ba01ecc471500f1794a","56d09c13376b040b005b3034","56d09cde167e1e1b008079d7","56d09f30167e1e1b008079e2","56d0a00b376b040b005b303d","56d0a063167e1e1b008079e6","56d0a11a7c2e100b000af929","56d0b072167e1e1b00807a2e","56d0b0fb7c2e100b000af98b","56d0b16d1ecc471500f179af","56d0b1ee7c2e100b000af991","56d0b2407c2e100b000af998","56d0b2e640d36e1d00bc1456","56d0b3511ecc471500f179bc","56d0b3aab2cb7013004de65b","56d0b3d1b2cb7013004de65e","56d0b3fe7c2e100b000af9a1","56d0b4d67c2e100b000af9a5","56d0b52fb2cb7013004de666","56d0b59db2cb7013004de66c","56d0b621167e1e1b00807a4c","56d0b787167e1e1b00807a54","56d0b82d167e1e1b00807a55","56d0b8a8167e1e1b00807a5d","56d0b8fe167e1e1b00807a60","56d0b9951ecc471500f179c7","56d0ba55376b040b005b30a1","56d0bac31ecc471500f179cc","56d0bb6e167e1e1b00807a64","56d0bc95167e1e1b00807a6a"],"sync":{"url":"","isSync":false},"reference":true,"createdAt":"2016-02-25T17:53:10.154Z","from_sync":false,"order":1,"slug":"buzz-api-reference","title":"Buzz API Reference"},"editedParams":true,"updates":["591b61057d2cb40f00d47062"],"next":{"pages":[],"description":""},"createdAt":"2016-02-25T22:05:09.226Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"settings":"","examples":{"codes":[{"language":"curl","code":"curl -X POST \"[host]/rest/creative\" -b cookies.txt -d '{\"advertiser_id\":1,\"creative_type\":0,\"width\":468,\"height\":60,\"creative_name\":\"test banner\",\"creative_template_id\":4,\"creative_rule_key\":\"dfa\",\"creative_content\":{\"TAG\":\"<SCRIPT language=\\\"JavaScript1.1\\\" SRC=\\\"https://ad.doubleclick.net/ddm/trackimpj/N9999.88888.SITE/B9058599.122522097;dc_trk_aid=295586985;dc_trk_cid=65391418;click=;ord=[timestamp]?\\\"></SCRIPT>\"},\"creative_attributes\":{\"advertiser\":{\"advertiser_category\":[\"IAB1\"],\"advertiser_index_id\":[1143]}},\"pixels\":[\"https://www.mysite.com/pixel?foo\"],\"scripts\":[\"https://www.mysite.com/pixel?bar\"],\"events\":[]}"}]},"method":"post","results":{"codes":[{"language":"json","status":200,"name":"","code":"{\n    \"success\": true,\n    \"message\": \"creative created with ID = 1\",\n    \"payload\": {\n        \"id\": 1\n    }\n}"}]},"auth":"required","params":[{"_id":"56c38f9c2d97560d00e23cba","ref":"","in":"body","required":true,"desc":"Must belong to the same account as the Advertiser and be active","default":"","type":"int","name":"advertiser_id"},{"_id":"56c38f9c2d97560d00e23cb9","ref":"","in":"body","required":false,"desc":"An alternative id to lookup the Creative, if desired","default":"","type":"string","name":"alternative_id"},{"_id":"56c39b11e1e4190d003429b7","ref":"","in":"body","required":true,"desc":"Name of the Creative, e.g. \"Blue Banner Ad\"","default":"","type":"string","name":"creative_name"},{"_id":"56c39b11e1e4190d003429b6","ref":"","in":"body","required":true,"desc":"The type of creative. `0`=banner, `1`=video, `2`=native","default":"0","type":"int","name":"creative_type"},{"_id":"56c39b11e1e4190d003429b5","ref":"","in":"body","required":false,"desc":"Width in pixels. Use the `creative_sizes` view to see all acceptable width and height combinations.","default":"","type":"int","name":"width"},{"_id":"56c39b11e1e4190d003429b4","ref":"","in":"body","required":false,"desc":"Height in pixels. Use the `creative_sizes` view to see all acceptable width and height combinations.","default":"","type":"int","name":"height"},{"_id":"56c39b11e1e4190d003429b3","ref":"","in":"body","required":false,"desc":"Is the creative sizeless, meaning it can match any size placement that is an interstitial. Native creatives should also be marked as sizeless.","default":"0","type":"boolean","name":"sizeless"},{"_id":"56cf74c86c5d7a13005eeb84","ref":"","in":"body","required":true,"desc":"Is the creative intended to serve in a secure (HTTPS) environment.","default":"0","type":"boolean","name":"secure"},{"_id":"56cf74c86c5d7a13005eeb83","ref":"","in":"body","required":false,"desc":"URL the ad should click or tap to, must be a valid URL. This field is required when using a Creative Template that is not a tag (e.g. an image or video)","default":"0","type":"string","name":"click_url"},{"_id":"575725ac29dbc43200abf04c","ref":"","in":"body","required":false,"desc":"A list of Creative Assets to be used to render the creative. This is DEPRECATED, use `primary_asset` and `secondary_asset` fields instead.","default":"","type":"array_int","name":"creative_assets"},{"_id":"593abd09ca061e00273cab61","ref":"","in":"body","required":false,"desc":"ID of the creative_asset to use in the Creative, for example the ID of an Image or Video.","default":"","type":"int","name":"primary_asset"},{"_id":"593abd09ca061e00273cab60","ref":"","in":"body","required":false,"desc":"ID of a secondary creative_asset to use in the Creative. Most commonly used for the companion asset within a Video Creative","default":"","type":"int","name":"secondary_asset"},{"_id":"593ac85eca061e00273cacc8","ref":"","in":"body","required":false,"desc":"For Native creatives, the NativeOffer to be used for the Creative content","default":"","type":"int","name":"native_offer"},{"_id":"56cf74c86c5d7a13005eeb82","ref":"","in":"body","required":false,"desc":"A JSON representation of the fields required by the Creative Template, validated against the Creative Template","default":"","type":"object","name":"creative_content"},{"_id":"5849b8dd0385050f00dd4125","ref":"","in":"body","required":false,"desc":"For tag creatives the tag can be placed in this field and on save the `creative_rule_key` will be applied to insert relevant macros. This is recommended vs completing the `creative_content` field directly.","default":"","type":"string","name":"creative_content_tag"},{"_id":"56cf74c86c5d7a13005eeb81","ref":"","in":"body","required":true,"desc":"The ID of the Creative Template to use for this creative. Must be a valid and active Creative Template that either belongs to this Account, OR is marked as \"global\".","default":"","type":"int","name":"creative_template_id"},{"_id":"56cf74c86c5d7a13005eeb80","ref":"","in":"body","required":false,"desc":"DEPRECATED","default":"","type":"int","name":"creative_rule_id"},{"_id":"5849b8dd0385050f00dd4124","ref":"","in":"body","required":false,"desc":"The key corresponding to the `creative_rule` to apply to the `creative_content_tag` field. The rule will insert click and timestamp macros. You can use `auto_detect` for easiest implementation.","default":"none","type":"string","name":"creative_rule_key"},{"_id":"56cf7a9544c5700b0095c20a","ref":"","in":"body","required":false,"desc":"Creative Attributes JSON.","default":"","type":"array_object","name":"attributes"},{"_id":"57bb8146013ba90e00e6476b","ref":"","in":"body","required":false,"desc":"List of URLs to be added to the Creative as scripts","default":"","type":"array_string","name":"scripts"},{"_id":"57bb8146013ba90e00e6476a","ref":"","in":"body","required":false,"desc":"List of URLs to be added to the Creative as pixels","default":"","type":"array_string","name":"pixels"},{"_id":"582ccab691a6922300422494","ref":"","in":"body","required":false,"desc":"Array of VAST tracking events and associated URLs to allow third party tracking of video events","default":"","type":"array_object","name":"events"},{"_id":"57bb8146013ba90e00e64769","ref":"","in":"body","required":false,"desc":"List of CreativeAddOn IDs to add to the Creative","default":"","type":"array_int","name":"creative_addons"},{"_id":"56cf7a9544c5700b0095c209","ref":"","in":"body","required":false,"desc":"URL to an image thumbnail for the creative. This field will be automatically set if you associate the creative with a Creative Asset that has a valid thumbnail but must be updated manually when using a tag-based Creative. Thumbnail is required by some exchanges to serve.","default":"","type":"string","name":"creative_thumbnail_url"},{"_id":"5b16943c2b375a00039e0e3c","ref":"","in":"body","required":false,"desc":"Start date for the creative, optional","default":"","type":"datetime","name":"start_date"},{"_id":"5b16943c2b375a00039e0e3b","ref":"","in":"body","required":false,"desc":"End date for the creative, optional","default":"","type":"datetime","name":"end_date"},{"_id":"56c39b11e1e4190d003429b2","ref":"","in":"body","required":false,"desc":"Notes about the Creative, up to 255 chars","default":"","type":"string","name":"notes"},{"_id":"56c39b11e1e4190d003429b1","ref":"","in":"body","required":true,"desc":"Is the Creative active?","default":"1","type":"boolean","name":"active"}],"url":"/rest/creative"},"isReference":true,"order":43,"body":"[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Events Tracking\"\n}\n[/block]\nFor video creatives, it is often a requirement to fire a pixel on video complete or another action within the video playback. The `events` field of the Creative object allows you to define up to 10 events, each based around a specific VAST-defined reporting metric.\n\nAn example of proper formatting for the `events` field:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"\\\"events\\\":[\\n  {\\\"play\\\":\\\"https://my.server/event?id=play\\\"},\\n  {\\\"pause\\\":\\\"https://my.server/event?id=pause\\\"}\\n]\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\nThe `events` field should be empty for banner (non-video) creatives.","excerpt":"","slug":"creative","type":"endpoint","title":"creative"}

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

advertiser_id:
required
integer
Must belong to the same account as the Advertiser and be active
alternative_id:
string
An alternative id to lookup the Creative, if desired
creative_name:
required
string
Name of the Creative, e.g. "Blue Banner Ad"
creative_type:
required
integer0
The type of creative. `0`=banner, `1`=video, `2`=native
width:
integer
Width in pixels. Use the `creative_sizes` view to see all acceptable width and height combinations.
height:
integer
Height in pixels. Use the `creative_sizes` view to see all acceptable width and height combinations.
sizeless:
boolean0
Is the creative sizeless, meaning it can match any size placement that is an interstitial. Native creatives should also be marked as sizeless.
secure:
required
boolean0
Is the creative intended to serve in a secure (HTTPS) environment.
click_url:
string0
URL the ad should click or tap to, must be a valid URL. This field is required when using a Creative Template that is not a tag (e.g. an image or video)
creative_assets:
array of integers
A list of Creative Assets to be used to render the creative. This is DEPRECATED, use `primary_asset` and `secondary_asset` fields instead.
primary_asset:
integer
ID of the creative_asset to use in the Creative, for example the ID of an Image or Video.
secondary_asset:
integer
ID of a secondary creative_asset to use in the Creative. Most commonly used for the companion asset within a Video Creative
native_offer:
integer
For Native creatives, the NativeOffer to be used for the Creative content
creative_content:
object
A JSON representation of the fields required by the Creative Template, validated against the Creative Template
creative_content_tag:
string
For tag creatives the tag can be placed in this field and on save the `creative_rule_key` will be applied to insert relevant macros. This is recommended vs completing the `creative_content` field directly.
creative_template_id:
required
integer
The ID of the Creative Template to use for this creative. Must be a valid and active Creative Template that either belongs to this Account, OR is marked as "global".
creative_rule_id:
integer
DEPRECATED
creative_rule_key:
stringnone
The key corresponding to the `creative_rule` to apply to the `creative_content_tag` field. The rule will insert click and timestamp macros. You can use `auto_detect` for easiest implementation.
attributes:
array of objects
Creative Attributes JSON.
scripts:
array of strings
List of URLs to be added to the Creative as scripts
pixels:
array of strings
List of URLs to be added to the Creative as pixels
events:
array of objects
Array of VAST tracking events and associated URLs to allow third party tracking of video events
creative_addons:
array of integers
List of CreativeAddOn IDs to add to the Creative
creative_thumbnail_url:
string
URL to an image thumbnail for the creative. This field will be automatically set if you associate the creative with a Creative Asset that has a valid thumbnail but must be updated manually when using a tag-based Creative. Thumbnail is required by some exchanges to serve.
start_date:
datetime
Start date for the creative, optional
end_date:
datetime
End date for the creative, optional
notes:
string
Notes about the Creative, up to 255 chars
active:
required
boolean1
Is the Creative active?

Examples


Result Format


Documentation

[block:api-header] { "type": "basic", "title": "Events Tracking" } [/block] For video creatives, it is often a requirement to fire a pixel on video complete or another action within the video playback. The `events` field of the Creative object allows you to define up to 10 events, each based around a specific VAST-defined reporting metric. An example of proper formatting for the `events` field: [block:code] { "codes": [ { "code": "\"events\":[\n {\"play\":\"https://my.server/event?id=play\"},\n {\"pause\":\"https://my.server/event?id=pause\"}\n]", "language": "json" } ] } [/block] The `events` field should be empty for banner (non-video) creatives.

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}