{"_id":"56d0a00b376b040b005b303d","parentDoc":null,"user":"56c39c05bc41330d009f25d7","__v":7,"project":"56c35c56c0c4630d004e864c","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"},"editedParams2":true,"githubsync":"","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"},"editedParams":true,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-02-26T18:57:15.952Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"language":"curl","code":"curl -X POST \"[host]/rest/creative_bulk_upload\" -b cookies.txt -d '{\"creative_name_prefix\":\"spring_\", \"advertiser_id\":1, \"click_url\":\"http://www.foo.com\", \"creative_template_id\":1, \"size_in_bytes\":10000, \"bulk_type\":\"image\", \"pixels\":[\"https://www.pixel.net/foo\"]}'\n# Get the ID from the first post and use the /upload/ID syntax to upload the file\ncurl -X POST \"[host]/rest/creative_bulk_upload/upload/1\" -b cookies.txt -F 'creative_content=:::at:::/local/path/foo.zip'"}]},"method":"post","results":{"codes":[{"name":"","code":"{\n    \"success\": true,\n    \"message\": \"creative_asset created with ID = 1\",\n    \"payload\": {\n        \"id\": 1\n    }\n}","language":"json","status":200}]},"settings":"","auth":"required","params":[{"_id":"56c38f9c2d97560d00e23cba","ref":"","in":"body","required":true,"desc":"Must be active","default":"","type":"int","name":"advertiser_id"},{"_id":"56c39b11e1e4190d003429b7","ref":"","in":"body","required":false,"desc":"A string to be added at the beginning of each filename. e.g. `spring_`. Cannot contain spaces of special characters. Max length 100 characters.","default":"","type":"string","name":"creative_name_prefix"},{"_id":"56c39b11e1e4190d003429b6","ref":"","in":"body","required":true,"desc":"Number of bytes of the file","default":"0","type":"int","name":"size_in_bytes"},{"_id":"56c39b11e1e4190d003429b2","ref":"","in":"body","required":false,"desc":"Whether the creatives should be marked as secure","default":"","type":"boolean","name":"secure"},{"_id":"56d0a00b376b040b005b3041","ref":"","in":"body","required":false,"desc":"URL the ad should click or tap to. Required for templates that require clicks (image templates)","default":"","type":"string","name":"click_url"},{"_id":"576029e2b82256240055c641","ref":"","in":"body","required":false,"desc":"Thumbnail to use for all creatives uploaded. Note, for image uploads this field will be ignored.","default":"","type":"string","name":"creative_thumbnail_url"},{"_id":"576029e2b82256240055c640","ref":"","in":"body","required":false,"desc":"Content to be added to all of the uploaded Creatives. Not typically used.","default":"","type":"array_object","name":"creative_content"},{"_id":"56d0a00b376b040b005b3040","ref":"","in":"body","required":true,"desc":"The ID of the Creative Template to use for this creative. Note, when bulk uploading tags, the template is automatically determined.","default":"","type":"int","name":"creative_template_id"},{"_id":"56d0a00b376b040b005b303f","ref":"","in":"body","required":false,"desc":"DEPRECATED","default":"","type":"int","name":"creative_rule_id"},{"_id":"5849bbe43bcfb30f00dde711","ref":"","in":"body","required":false,"desc":"The key corresponding to the `creative_rule` to apply to the tag based creatives. 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":"56d0a00b376b040b005b303e","ref":"","in":"body","required":true,"desc":"The type of creatives being uploaded. Currently `image`, `atlas_tag`, `sizmek_tag`, and `dfa_tag` are supported.","default":"","type":"string","name":"bulk_type"},{"_id":"58a37bfd7a856e31003c5cda","ref":"","in":"body","required":false,"desc":"List of pixel URLs to add to all uploaded Creatives","default":"","type":"array_string","name":"pixels"},{"_id":"58a37bfd7a856e31003c5cd9","ref":"","in":"body","required":false,"desc":"List of script URLs to add to all uploaded Creatives. Note, if your bulk upload includes VAST videos, including any scripts will cause an error.","default":"","type":"array_string","name":"scripts"},{"_id":"58a37bfd7a856e31003c5cd8","ref":"","in":"body","required":false,"desc":"List of Creative Addon IDs to add to all uploaded Creatives","default":"","type":"array_int","name":"creative_addons"}],"url":"/rest/creative_bulk_upload"},"isReference":true,"order":57,"body":"","excerpt":"","slug":"creativebulkupload","type":"endpoint","title":"creative_bulk_upload"}

postcreative_bulk_upload


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

advertiser_id:
required
integer
Must be active
creative_name_prefix:
string
A string to be added at the beginning of each filename. e.g. `spring_`. Cannot contain spaces of special characters. Max length 100 characters.
size_in_bytes:
required
integer0
Number of bytes of the file
secure:
boolean
Whether the creatives should be marked as secure
click_url:
string
URL the ad should click or tap to. Required for templates that require clicks (image templates)
creative_thumbnail_url:
string
Thumbnail to use for all creatives uploaded. Note, for image uploads this field will be ignored.
creative_content:
array of objects
Content to be added to all of the uploaded Creatives. Not typically used.
creative_template_id:
required
integer
The ID of the Creative Template to use for this creative. Note, when bulk uploading tags, the template is automatically determined.
creative_rule_id:
integer
DEPRECATED
creative_rule_key:
stringnone
The key corresponding to the `creative_rule` to apply to the tag based creatives. The rule will insert click and timestamp macros. You can use `auto_detect` for easiest implementation.
bulk_type:
required
string
The type of creatives being uploaded. Currently `image`, `atlas_tag`, `sizmek_tag`, and `dfa_tag` are supported.
pixels:
array of strings
List of pixel URLs to add to all uploaded Creatives
scripts:
array of strings
List of script URLs to add to all uploaded Creatives. Note, if your bulk upload includes VAST videos, including any scripts will cause an error.
creative_addons:
array of integers
List of Creative Addon IDs to add to all uploaded Creatives

Examples


Result Format


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 }}