{"_id":"56cf75f5336aa60b0086a496","editedParams2":true,"parentDoc":null,"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,"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"},"project":"56c35c56c0c4630d004e864c","__v":6,"user":"56c39c05bc41330d009f25d7","updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-02-25T21:45:25.197Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"settings":"","examples":{"codes":[{"code":"curl -X POST \"[host]/rest/campaign\" -b cookies.txt -d '{\"advertiser_id\":1, \"campaign_name\":\"foo\", \"campaign_budget\":1000, \"start_date\":\"1/1/2015\", \"frequency_cap\":[{\"duration\":500,\"impressions\":1},{\"duration\":1000,\"impressions\":2}],\"continents\":[\"NAM\",\"EMEA\"],\"currency\":\"CAD\"}'","language":"curl"}]},"method":"post","results":{"codes":[{"name":"","code":"{\n    \"success\": true,\n    \"message\": \"campaign created with ID = 1\",\n    \"payload\": {\n        \"id\": 1\n    }\n}","language":"json","status":200}]},"auth":"required","params":[{"_id":"56c38f9c2d97560d00e23cba","ref":"","in":"body","required":true,"desc":"Must belong to the same account as the Campaign and be active","default":"","type":"int","name":"advertiser_id"},{"_id":"56c38f9c2d97560d00e23cb9","ref":"","in":"body","required":false,"desc":"An alternative id to lookup the Campaign, if desired","default":"","type":"string","name":"alternative_id"},{"_id":"56c39b11e1e4190d003429b7","ref":"","in":"body","required":true,"desc":"Name of the Campaign, e.g. \"Winter lead generation\"","default":"","type":"string","name":"campaign_name"},{"_id":"56c39b11e1e4190d003429b6","ref":"","in":"body","required":true,"desc":"Maximum amount to spend on this Campaign","default":"","type":"double","name":"campaign_budget"},{"_id":"56c39b11e1e4190d003429b5","ref":"","in":"body","required":false,"desc":"Maximum amount to spend or deliver in a day, Cannot exceed `campaign_budget` or be so low as to prevent `campaign_budget` from being reached over the length of the campaign. Cannot be lower than the `daily_budget` for any Line Items associated with this campaign.","default":"","type":"double","name":"daily_budget"},{"_id":"56c39b11e1e4190d003429b4","ref":"","in":"body","required":true,"desc":"Type of budget, 0=spend, 1=impressions","default":"0","type":"int","name":"budget_type"},{"_id":"56c39b11e1e4190d003429b3","ref":"","in":"body","required":false,"desc":"Supported revenue types:  `CPM`, `CPC`, `CPCV`, `CPI`, `CPA`","default":"","type":"string","name":"revenue_type"},{"_id":"56cf74c86c5d7a13005eeb84","ref":"","in":"body","required":false,"desc":"If a revenue_type is set, this is field is the basis of calculation. For example, if revenue_type is `CPM` and revenue_amount is `5.12`, revenue will be calculated as a $5.12 CPM.","default":"","type":"double","name":"revenue_amount"},{"_id":"56cf74c86c5d7a13005eeb83","ref":"","in":"body","required":false,"desc":"This field is deprecated. Pacing is available at the Line Item level.","default":"0","type":"int","name":"pacing"},{"_id":"5a8c90bd04fb050045a1dae8","ref":"","in":"body","required":false,"desc":"ID of a Bid Modifier object to associate with the Campaign. If set, `max_bid` must also be set.","default":"","type":"int","name":"bid_modifier_id"},{"_id":"5a8c90bd04fb050045a1dae7","ref":"","in":"body","required":false,"desc":"Maximum bid after taking into consideration any Bid Modifiers.","default":"","type":"double","name":"max_bid"},{"_id":"56cf74c86c5d7a13005eeb82","ref":"","in":"body","required":true,"desc":"Start date of the Campaign. No Line Items associated with the Campaign can have start dates prior to this date.","default":"","type":"datetime","name":"start_date"},{"_id":"56cf74c86c5d7a13005eeb81","ref":"","in":"body","required":false,"desc":"End date of the Campaign. No Line Items associated with the Campaign can have end dates after this date. End date must be provided in order to pace.","default":"","type":"datetime","name":"end_date"},{"_id":"56cf74c86c5d7a13005eeb80","ref":"","in":"body","required":false,"desc":"Frequency cap JSON. For more information on frequency caps, see Frequency Caps.","default":"","type":"array_object","name":"frequency_cap"},{"_id":"57ed38e562436e0e00ea81ca","ref":"","in":"body","required":false,"desc":"Continents in which the Campaign is eligible to serve. Inherited from the Advertiser object if left blank.","default":"","type":"array_string","name":"continents"},{"_id":"58504b9d16482d0f00f3b0f5","ref":"","in":"body","required":false,"desc":"Currency in which all Line Items under this Campaign will bid. Cannot be changed once set. If a default is set at the Advertiser level, it will be inherited here.","default":"USD","type":"string","name":"currency"},{"_id":"56c39b11e1e4190d003429b2","ref":"","in":"body","required":false,"desc":"Notes, up to 255 chars","default":"","type":"string","name":"notes"},{"_id":"56c39b11e1e4190d003429b1","ref":"","in":"body","required":true,"desc":"Is it active?","default":"","type":"boolean","name":"active"}],"url":"/rest/campaign"},"isReference":true,"order":35,"body":"","excerpt":"","slug":"campaign-1","type":"endpoint","title":"campaign"}

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

advertiser_id:
required
integer
Must belong to the same account as the Campaign and be active
alternative_id:
string
An alternative id to lookup the Campaign, if desired
campaign_name:
required
string
Name of the Campaign, e.g. "Winter lead generation"
campaign_budget:
required
double
Maximum amount to spend on this Campaign
daily_budget:
double
Maximum amount to spend or deliver in a day, Cannot exceed `campaign_budget` or be so low as to prevent `campaign_budget` from being reached over the length of the campaign. Cannot be lower than the `daily_budget` for any Line Items associated with this campaign.
budget_type:
required
integer0
Type of budget, 0=spend, 1=impressions
revenue_type:
string
Supported revenue types: `CPM`, `CPC`, `CPCV`, `CPI`, `CPA`
revenue_amount:
double
If a revenue_type is set, this is field is the basis of calculation. For example, if revenue_type is `CPM` and revenue_amount is `5.12`, revenue will be calculated as a $5.12 CPM.
pacing:
integer0
This field is deprecated. Pacing is available at the Line Item level.
bid_modifier_id:
integer
ID of a Bid Modifier object to associate with the Campaign. If set, `max_bid` must also be set.
max_bid:
double
Maximum bid after taking into consideration any Bid Modifiers.
start_date:
required
datetime
Start date of the Campaign. No Line Items associated with the Campaign can have start dates prior to this date.
end_date:
datetime
End date of the Campaign. No Line Items associated with the Campaign can have end dates after this date. End date must be provided in order to pace.
frequency_cap:
array of objects
Frequency cap JSON. For more information on frequency caps, see Frequency Caps.
continents:
array of strings
Continents in which the Campaign is eligible to serve. Inherited from the Advertiser object if left blank.
currency:
stringUSD
Currency in which all Line Items under this Campaign will bid. Cannot be changed once set. If a default is set at the Advertiser level, it will be inherited here.
notes:
string
Notes, up to 255 chars
active:
required
boolean
Is it active?

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